X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ca3a892303ccd7bfa16360486ee43bb0f41154f0..b23e21f8228228b65702ca054fccf092b73e8aab:/include/simgrid/simix.h diff --git a/include/simgrid/simix.h b/include/simgrid/simix.h index 210c3b5052..1ab0b9361b 100644 --- a/include/simgrid/simix.h +++ b/include/simgrid/simix.h @@ -1,4 +1,4 @@ -/* Copyright (c) 2007-2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2007-2020. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -17,55 +17,11 @@ #include #endif -/* ******************************** Host ************************************ */ -/** @brief Host datatype - @ingroup simix_host_management - - A location (or host) is any possible place where - a process may run. Thus it is represented as a physical - resource with computing capabilities, some mailboxes - to enable running process to communicate with remote ones, and - some private data that can be only accessed by local - process. - - @see m_host_management - @{ */ -typedef enum { - SIMIX_WAITING, - SIMIX_READY, - SIMIX_RUNNING, - SIMIX_DONE, - SIMIX_CANCELED, - SIMIX_FAILED, - SIMIX_SRC_HOST_FAILURE, - SIMIX_DST_HOST_FAILURE, - SIMIX_TIMEOUT, - SIMIX_SRC_TIMEOUT, - SIMIX_DST_TIMEOUT, - SIMIX_LINK_FAILURE -} e_smx_state_t; -/** @} */ - -/* ******************************** Synchro ************************************ */ - -/** @ingroup simix_synchro_management */ -typedef struct s_smx_sem_t* smx_sem_t; - -/* ****************************** Process *********************************** */ - -typedef enum { - SMX_EXIT_SUCCESS = 0, - SMX_EXIT_FAILURE = 1 -} smx_process_exit_status_t; -/** @} */ - /******************************* Networking ***********************************/ extern unsigned smx_context_stack_size; -extern int smx_context_stack_size_was_set; extern unsigned smx_context_guard_size; -extern int smx_context_guard_size_was_set; -SG_BEGIN_DECL() +SG_BEGIN_DECL XBT_PUBLIC smx_actor_t SIMIX_process_from_PID(aid_t PID); @@ -93,89 +49,61 @@ XBT_PUBLIC void SIMIX_set_maestro(void (*code)(void*), void* data); XBT_PUBLIC void SIMIX_run(); XBT_PUBLIC double SIMIX_get_clock(); -/* Timer functions FIXME: should these be public? */ -typedef struct s_smx_timer_t* smx_timer_t; - -XBT_PUBLIC smx_timer_t SIMIX_timer_set(double date, void (*function)(void*), void* arg); -XBT_PUBLIC void SIMIX_timer_remove(smx_timer_t timer); -XBT_PUBLIC double SIMIX_timer_next(); -XBT_PUBLIC double SIMIX_timer_get_date(smx_timer_t timer); +XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::set()") XBT_PUBLIC smx_timer_t + SIMIX_timer_set(double date, void (*function)(void*), void* arg); +XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::remove()") XBT_PUBLIC + void SIMIX_timer_remove(smx_timer_t timer); +XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::next()") XBT_PUBLIC double SIMIX_timer_next(); +XBT_ATTRIB_DEPRECATED_v329("Please use simgrid::simix::Timer::get_date()") XBT_PUBLIC + double SIMIX_timer_get_date(smx_timer_t timer); -XBT_PUBLIC void SIMIX_display_process_status(); -SG_END_DECL() - -/******************************* Environment **********************************/ -SG_BEGIN_DECL() -XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_load_platform()") XBT_PUBLIC - void SIMIX_create_environment(const char* file); -SG_END_DECL() - -#ifdef __cplusplus -XBT_PUBLIC void SIMIX_create_environment(std::string file); -#endif +XBT_ATTRIB_DEPRECATED_v329("Please use simix_global->display_all_actor_status()") XBT_PUBLIC + void SIMIX_display_process_status(); +SG_END_DECL /******************************** Deployment **********************************/ -SG_BEGIN_DECL() -XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_register_function()") XBT_PUBLIC - void SIMIX_function_register(const char* name, xbt_main_func_t code); -XBT_ATTRIB_DEPRECATED_v324("Please use simgrid_load_deployment()") XBT_PUBLIC - void SIMIX_launch_application(const char* file); -XBT_PUBLIC void SIMIX_function_register_default(xbt_main_func_t code); - -XBT_PUBLIC void SIMIX_init_application(); +SG_BEGIN_DECL +XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_default() or Engine::register_default()") XBT_PUBLIC + void SIMIX_function_register_default(xbt_main_func_t code); +XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC void SIMIX_init_application(); + XBT_PUBLIC void SIMIX_process_set_function(const char* process_host, const char* process_function, xbt_dynar_t arguments, double process_start_time, double process_kill_time); -SG_END_DECL() +SG_END_DECL #ifdef __cplusplus -XBT_PUBLIC void SIMIX_function_register(std::string name, void (*code)(std::vector)); -XBT_PUBLIC void SIMIX_function_register(std::string name, xbt_main_func_t code); -XBT_PUBLIC void SIMIX_launch_application(std::string file); +XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_function() or Engine::register_function()") XBT_PUBLIC + void SIMIX_function_register(const std::string& name, void (*code)(std::vector)); +XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_register_function() or Engine::register_function()") XBT_PUBLIC + void SIMIX_function_register(const std::string& name, xbt_main_func_t code); +XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_load_deployment() or Engine::load_deployment()") XBT_PUBLIC + void SIMIX_launch_application(const std::string& file); #endif -/*********************************** Host *************************************/ -/* Functions for running a process in main() - * - * 1. create the maestro process - * 2. attach (create a context and wait for maestro to give control back to you) - * 3. do you process job - * 4. detach (this waits for the simulation to terminate) - */ - -SG_BEGIN_DECL() -XBT_PUBLIC void SIMIX_maestro_create(void (*code)(void*), void* data); -SG_END_DECL() -#ifdef __cplusplus -XBT_PUBLIC smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname, - std::unordered_map* properties, - smx_actor_t parent_process); -#endif -SG_BEGIN_DECL() -XBT_PUBLIC void SIMIX_process_detach(); -SG_END_DECL() - /********************************* Process ************************************/ -SG_BEGIN_DECL() -XBT_PUBLIC int SIMIX_process_count(); +SG_BEGIN_DECL +XBT_ATTRIB_DEPRECATED_v329("Please use simgrid_get_actor_count()") XBT_PUBLIC int SIMIX_process_count(); XBT_PUBLIC smx_actor_t SIMIX_process_self(); XBT_PUBLIC const char* SIMIX_process_self_get_name(); -XBT_PUBLIC void SIMIX_process_self_set_data(void* data); -XBT_PUBLIC void* SIMIX_process_self_get_data(); -XBT_PUBLIC int SIMIX_process_has_pending_comms(smx_actor_t process); -XBT_PUBLIC void SIMIX_process_on_exit_runall(smx_actor_t process); -XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data); -SG_END_DECL() +XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC + void SIMIX_process_self_set_data(void* data); +XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC void* SIMIX_process_self_get_data(); +SG_END_DECL #ifdef __cplusplus -XBT_PUBLIC void SIMIX_process_on_exit(smx_actor_t process, std::function fun, void* data); +XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") XBT_PUBLIC + void SIMIX_process_on_exit(smx_actor_t process, const std::function& fun); #endif /****************************** Communication *********************************/ -XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(smx_activity_t, void*, size_t)); -XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(smx_activity_t comm, void* buff, size_t buff_size); -XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(smx_activity_t comm, void* buff, size_t buff_size); - -XBT_PUBLIC void SIMIX_comm_finish(smx_activity_t synchro); +#ifdef __cplusplus +XBT_PUBLIC void SIMIX_comm_set_copy_data_callback(void (*callback)(simgrid::kernel::activity::CommImpl*, void*, + size_t)); +XBT_PUBLIC void SIMIX_comm_copy_pointer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff, + size_t buff_size); +XBT_PUBLIC void SIMIX_comm_copy_buffer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff, + size_t buff_size); +#endif /******************************************************************************/ /* SIMIX simcalls */ @@ -186,106 +114,118 @@ XBT_PUBLIC void SIMIX_comm_finish(smx_activity_t synchro); /******************************* Host simcalls ********************************/ #ifdef __cplusplus -XBT_PUBLIC smx_activity_t simcall_execution_start(std::string name, std::string category, double flops_amount, - double priority, double bound, sg_host_t host); -XBT_PUBLIC smx_activity_t simcall_execution_parallel_start(std::string name, int host_nb, sg_host_t* host_list, - double* flops_amount, double* bytes_amount, double rate, - double timeout); -#endif -XBT_PUBLIC void simcall_execution_cancel(smx_activity_t execution); -XBT_PUBLIC void simcall_execution_set_priority(smx_activity_t execution, double priority); -XBT_PUBLIC void simcall_execution_set_bound(smx_activity_t execution, double bound); -XBT_PUBLIC e_smx_state_t simcall_execution_wait(smx_activity_t execution); -XBT_PUBLIC e_smx_state_t simcall_execution_test(smx_activity_t execution); +XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State + simcall_execution_wait(simgrid::kernel::activity::ActivityImpl* execution, double timeout); +XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State + simcall_execution_wait(const simgrid::kernel::activity::ActivityImplPtr& execution, double timeout); +XBT_PUBLIC unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count, + double timeout); +XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::test()") XBT_PUBLIC + bool simcall_execution_test(simgrid::kernel::activity::ActivityImpl* execution); +XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Exec::test()") XBT_PUBLIC + bool simcall_execution_test(const simgrid::kernel::activity::ActivityImplPtr& execution); -/**************************** Process simcalls ********************************/ -SG_BEGIN_DECL() -/* Constructor and Destructor */ -#ifdef __cplusplus -XBT_PUBLIC smx_actor_t simcall_process_create(std::string name, xbt_main_func_t code, void* data, sg_host_t host, - int argc, char** argv, - std::unordered_map* properties); #endif -XBT_ATTRIB_DEPRECATED_v324("Please use ActorImpl::throw_exception") XBT_PUBLIC - void SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char* mesg); +/**************************** Process simcalls ********************************/ +SG_BEGIN_DECL +XBT_ATTRIB_DEPRECATED_v329("This function will be removed in 3.29") void simcall_process_set_data(smx_actor_t process, + void* data); +XBT_ATTRIB_DEPRECATED_v328("Please use sg_actor_suspend()") XBT_PUBLIC + void simcall_process_suspend(smx_actor_t process); -/* Process handling */ -XBT_PUBLIC void simcall_process_suspend(smx_actor_t process); +XBT_ATTRIB_DEPRECATED_v328("Please use sg_actor_join()") XBT_PUBLIC + void simcall_process_join(smx_actor_t process, double timeout); -/* Getters and Setters */ -XBT_PUBLIC void simcall_process_set_data(smx_actor_t process, void* data); -XBT_PUBLIC void simcall_process_set_kill_time(smx_actor_t process, double kill_time); -XBT_PUBLIC void simcall_process_join(smx_actor_t process, double timeout); -/* Sleep control */ -XBT_PUBLIC e_smx_state_t simcall_process_sleep(double duration); -SG_END_DECL() +XBT_ATTRIB_DEPRECATED_v329("Please use sg_actor_sleep_for()") XBT_PUBLIC +#ifdef __cplusplus + simgrid::kernel::activity::State +#else + enum kernel_activity_state +#endif + simcall_process_sleep(double duration); +SG_END_DECL -/************************** Comunication simcalls *****************************/ +/************************** Communication simcalls ****************************/ #ifdef __cplusplus XBT_PUBLIC void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff, size_t src_buff_size, - int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), - void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout); + bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), + void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), + void* data, double timeout); -XBT_PUBLIC smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, - void* src_buff, size_t src_buff_size, - int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), - void (*clean_fun)(void*), - void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, - int detached); +XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr +simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff, + size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), + void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), + void* data, bool detached); XBT_PUBLIC void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size, - int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), - void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout, - double rate); - -XBT_PUBLIC smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, - size_t* dst_buff_size, - int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), - void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, - double rate); - -XBT_PUBLIC smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type, - int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), - void* data); -#endif -XBT_PUBLIC void simcall_comm_cancel(smx_activity_t comm); - -/* FIXME: waitany is going to be a vararg function, and should take a timeout */ -XBT_PUBLIC unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout); -XBT_PUBLIC void simcall_comm_wait(smx_activity_t comm, double timeout); -XBT_PUBLIC int simcall_comm_test(smx_activity_t comm); -XBT_PUBLIC int simcall_comm_testany(smx_activity_t* comms, size_t count); - -/************************** Tracing handling **********************************/ -#ifdef __cplusplus -XBT_PUBLIC void simcall_set_category(smx_activity_t synchro, std::string category); + bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), + void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), + void* data, double timeout, double rate); + +XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr +simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size, + bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), + void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate); + +XBT_ATTRIB_DEPRECATED_v330("Please use Mailbox::iprobe()") XBT_PUBLIC simgrid::kernel::activity::ActivityImplPtr + simcall_comm_iprobe(smx_mailbox_t mbox, int type, + bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data); + +XBT_ATTRIB_DEPRECATED_v330("Please use a CommImpl*[] for first parameter") XBT_PUBLIC + unsigned int simcall_comm_waitany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count, double timeout); +XBT_PUBLIC unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, + double timeout); +XBT_PUBLIC void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout); +XBT_PUBLIC bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm); +XBT_ATTRIB_DEPRECATED_v330("Please use a CommImpl*[] for first parameter") XBT_PUBLIC + int simcall_comm_testany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count); +XBT_PUBLIC int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count); + +XBT_ATTRIB_DEPRECATED_v330("Please use a ActivityImpl* for first parameter") inline void simcall_comm_wait( + const simgrid::kernel::activity::ActivityImplPtr& comm, double timeout) +{ + simcall_comm_wait(comm.get(), timeout); +} +XBT_ATTRIB_DEPRECATED_v330("Please use a ActivityImpl* for first parameter") inline bool simcall_comm_test( + const simgrid::kernel::activity::ActivityImplPtr& comm) +{ + return simcall_comm_test(comm.get()); +} #endif /************************** Synchro simcalls **********************************/ -SG_BEGIN_DECL() -XBT_PUBLIC smx_mutex_t simcall_mutex_init(); -XBT_PUBLIC smx_mutex_t SIMIX_mutex_ref(smx_mutex_t mutex); -XBT_PUBLIC void SIMIX_mutex_unref(smx_mutex_t mutex); +SG_BEGIN_DECL +XBT_ATTRIB_DEPRECATED_v330("Please use sg_mutex_init()") XBT_PUBLIC smx_mutex_t simcall_mutex_init(); XBT_PUBLIC void simcall_mutex_lock(smx_mutex_t mutex); XBT_PUBLIC int simcall_mutex_trylock(smx_mutex_t mutex); XBT_PUBLIC void simcall_mutex_unlock(smx_mutex_t mutex); -XBT_PUBLIC smx_cond_t simcall_cond_init(); +XBT_ATTRIB_DEPRECATED_v330("Please use sg_cond_init()") XBT_PUBLIC smx_cond_t simcall_cond_init(); XBT_PUBLIC void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex); XBT_PUBLIC int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration); -XBT_PUBLIC void SIMIX_sem_destroy(smx_sem_t sem); XBT_PUBLIC void simcall_sem_acquire(smx_sem_t sem); XBT_PUBLIC int simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration); +SG_END_DECL /***************************** Io **************************************/ -XBT_PUBLIC e_smx_state_t simcall_io_wait(smx_activity_t io); +#ifdef __cplusplus +XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State + simcall_io_wait(simgrid::kernel::activity::ActivityImpl* io, double timeout); +XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::wait_for()") XBT_PUBLIC simgrid::kernel::activity::State + simcall_io_wait(const simgrid::kernel::activity::ActivityImplPtr& io, double timeout); +XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::test()") XBT_PUBLIC + bool simcall_io_test(simgrid::kernel::activity::ActivityImpl* io); +XBT_ATTRIB_DEPRECATED_v330("Please use s4u::Io::test()") XBT_PUBLIC + bool simcall_io_test(const simgrid::kernel::activity::ActivityImplPtr& io); +#endif /************************** MC simcalls **********************************/ +SG_BEGIN_DECL XBT_PUBLIC int simcall_mc_random(int min, int max); - -SG_END_DECL() +SG_END_DECL #endif