Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Python: Add Comm.wait_any
[simgrid.git] / src / simix / simcalls.in
index e3cce1a..a657616 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2016. The SimGrid Team. All rights reserved.
+# Copyright (c) 2014-2019. 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.
 # int foo(int x, int y) [[nohandler]];
 # int foo(int x, int y) [[block, nohandler]];
 #
-# The `block` attribut is used for calls which do not return in the same
+# The `block` attribute is used for calls which do not return in the same
 # scheduling round. The answer requires some interaction with SURF,
-# even if this can still occure at the same timestamp under some
-# circonstances (eg if the surf_action cannot start because of resources
+# even if this can still occur at the same timestamp under some
+# circumstances (eg if the surf_action cannot start because of resources
 # that are down) examples: things that last some time (communicate, execute,
 # mutex_lock).
 #
 # The `nohandler` is used to disable handlers.
 # I wish we could completely remove the handlers as their only use is
 # to adapt the interface between the exported symbol that is visible
-# by the user applications and the internal symbol that is implemented 
-# by the kernel. 
+# by the user applications and the internal symbol that is implemented
+# by the kernel.
 # The only remaining use of that mechanism is to add the caller
 # identity as a parameter of internal call, but that could be
-# automatized too (eg by having a special parameter type called "self")
+# automated too (eg by having a special parameter type called "self")
 
 # Please note that in addition to completing this file with your new simcall,
 # you should complete the libsmx.c file by adding the corresponding function
-# (aka. stub). Anyway, if you omit to do it, the invocation of ./simcalls.py will notify you ;)
+# (a.k.a. stub). Anyway, if you omit to do it, the invocation of ./simcalls.py will notify you ;)
 # If you want to remove an handler, it is important to remove although
-# the corresponding code (simcall_HANDLER_name_of_simcall(xxx) (note that comment the code 
+# the corresponding code (simcall_HANDLER_name_of_simcall(xxx) (note that comment the code
 # is not sufficient, the python script does not check whether the code is commented or not).
 # Last but not the least, you should declare the new simix call in
-# ./include/simgrid/simix.h (otherwise you will get a warning at the
-# compilation time)
+# ./include/simgrid/simix.h (otherwise you will get a warning at compile time)
 
-void process_kill(smx_actor_t process);
-void process_killall(int reset_pid);
-void process_cleanup(smx_actor_t process) [[nohandler]];
 void process_suspend(smx_actor_t process) [[block]];
-void process_resume(smx_actor_t process) [[nohandler]];
-void process_set_host(smx_actor_t process, sg_host_t dest);
-int  process_is_suspended(smx_actor_t process) [[nohandler]];
 int  process_join(smx_actor_t process, double timeout) [[block]];
 int  process_sleep(double duration) [[block]];
 
-boost::intrusive_ptr<simgrid::kernel::activity::ExecImpl> execution_start(const char* name, double flops_amount, double priority, double bound);
-boost::intrusive_ptr<simgrid::kernel::activity::ExecImpl> execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount, double amount, double rate, double timeout) [[nohandler]];
-void          execution_cancel(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> execution) [[nohandler]];
-void          execution_set_priority(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> execution, double priority) [[nohandler]];
-void          execution_set_bound(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> execution, double bound) [[nohandler]];
-int           execution_wait(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> execution) [[block]];
+int           execution_wait(simgrid::kernel::activity::ExecImpl* execution) [[block]];
+int           execution_test(simgrid::kernel::activity::ExecImpl* execution) [[block]];
 
-void          process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data) [[nohandler]];
-void          process_auto_restart_set(smx_actor_t process, int auto_restart) [[nohandler]];
-smx_actor_t   process_restart(smx_actor_t process);
-
-boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> comm_iprobe(smx_mailbox_t mbox, int type, int src, int tag, simix_match_func_t match_fun, void* data);
 void           comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff, size_t src_buff_size, simix_match_func_t match_fun, simix_copy_data_func_t copy_data_fun, void* data, double timeout) [[block]];
 boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff, size_t src_buff_size, simix_match_func_t match_fun, simix_clean_func_t clean_fun, simix_copy_data_func_t copy_data_fun, void* data, int detached);
 void           comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size, simix_match_func_t match_fun, simix_copy_data_func_t copy_data_fun, void* data, double timeout, double rate) [[block]];
 boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size, simix_match_func_t match_fun, simix_copy_data_func_t copy_data_fun, void* data, double rate);
-int            comm_waitany(xbt_dynar_t comms, double timeout) [[block]];
-void           comm_wait(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> comm, double timeout) [[block]];
-int            comm_test(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> comm) [[block]];
-int            comm_testany(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl>* comms, size_t count) [[block]];
+int            comm_waitany(simgrid::kernel::activity::CommImpl** comms, size_t count, double timeout) [[block]];
+void           comm_wait(simgrid::kernel::activity::CommImpl* comm, double timeout) [[block]];
+int            comm_test(simgrid::kernel::activity::CommImpl* comm) [[block]];
+int            comm_testany(simgrid::kernel::activity::CommImpl** comms, size_t count) [[block]];
 
-smx_mutex_t mutex_init();
 void        mutex_lock(smx_mutex_t mutex) [[block]];
 int         mutex_trylock(smx_mutex_t mutex);
 void        mutex_unlock(smx_mutex_t mutex);
 
-smx_cond_t cond_init() [[nohandler]];
-void       cond_signal(smx_cond_t cond) [[nohandler]];
 void       cond_wait(smx_cond_t cond, smx_mutex_t mutex) [[block]];
-void       cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout) [[block]];
-void       cond_broadcast(smx_cond_t cond) [[nohandler]];
+int        cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout) [[block]];
 
-smx_sem_t sem_init(unsigned int capacity) [[nohandler]];
-void      sem_release(smx_sem_t sem);
-int       sem_would_block(smx_sem_t sem);
 void      sem_acquire(smx_sem_t sem) [[block]];
-void      sem_acquire_timeout(smx_sem_t sem, double timeout) [[block]];
-int       sem_get_capacity(smx_sem_t sem);
+int       sem_acquire_timeout(smx_sem_t sem, double timeout) [[block]];
 
-sg_size_t   file_read(surf_file_t fd, sg_size_t size, sg_host_t host) [[block]];
-sg_size_t   file_write(surf_file_t fd, sg_size_t size, sg_host_t host) [[block]];
-surf_file_t  file_open(const char* mount, const char* path, sg_storage_t st) [[block]];
-int         file_close(surf_file_t fd, sg_host_t host) [[block]];
+sg_size_t io_wait(simgrid::kernel::activity::IoImpl* io) [[block]];
 
 int        mc_random(int min, int max);
-void       set_category(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> synchro, const char* category) [[nohandler]];
 
 void       run_kernel(std::function<void()> const* code) [[nohandler]];
 void       run_blocking(std::function<void()> const* code) [[block,nohandler]];