src/simix/simcalls.in

   1 # Copyright (c) 2014-2016. The SimGrid Team. All rights reserved.
   2
   3 # This program is free software; you can redistribute it and/or modify it
   4 # under the terms of the license (GNU LGPL) which comes with this package.
   5
   6 # The simcalls are given as C-like signatures (one per line):
   7 #
   8 # int foo(int x, int y);
   9 # int foo(int x, int y) [[block]];
  10 # int foo(int x, int y) [[nohandler]];
  11 # int foo(int x, int y) [[block, nohandler]];
  12 #
  13 # The `block` attribute is used for calls which do not return in the same
  14 # scheduling round. The answer requires some interaction with SURF,
  15 # even if this can still occur at the same timestamp under some
  16 # circumstances (eg if the surf_action cannot start because of resources
  17 # that are down) examples: things that last some time (communicate, execute,
  18 # mutex_lock).
  19 #
  20 # The `nohandler` is used to disable handlers.
  21 # I wish we could completely remove the handlers as their only use is
  22 # to adapt the interface between the exported symbol that is visible
  23 # by the user applications and the internal symbol that is implemented
  24 # by the kernel.
  25 # The only remaining use of that mechanism is to add the caller
  26 # identity as a parameter of internal call, but that could be
  27 # automated too (eg by having a special parameter type called "self")
  28
  29 # Please note that in addition to completing this file with your new simcall,
  30 # you should complete the libsmx.c file by adding the corresponding function
  31 # (a.k.a. stub). Anyway, if you omit to do it, the invocation of ./simcalls.py will notify you ;)
  32 # If you want to remove an handler, it is important to remove although
  33 # the corresponding code (simcall_HANDLER_name_of_simcall(xxx) (note that comment the code
  34 # is not sufficient, the python script does not check whether the code is commented or not).
  35 # Last but not the least, you should declare the new simix call in
  36 # ./include/simgrid/simix.h (otherwise you will get a warning at compile time)
  37
  38 void process_kill(smx_actor_t process);
  39 void process_killall(int reset_pid);
  40 void process_cleanup(smx_actor_t process) [[nohandler]];
  41 void process_suspend(smx_actor_t process) [[block]];
  42 int  process_join(smx_actor_t process, double timeout) [[block]];
  43 int  process_sleep(double duration) [[block]];
  44
  45 boost::intrusive_ptr<simgrid::kernel::activity::ExecImpl> execution_start(const char* name, double flops_amount, double priority, double bound);
  46 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 rate, double timeout) [[nohandler]];
  47 void          execution_cancel(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> execution) [[nohandler]];
  48 void          execution_set_priority(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> execution, double priority) [[nohandler]];
  49 void          execution_set_bound(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> execution, double bound) [[nohandler]];
  50 int           execution_wait(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> execution) [[block]];
  51
  52 void          process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data) [[nohandler]];
  53
  54 boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> comm_iprobe(smx_mailbox_t mbox, int type, simix_match_func_t match_fun, void* data);
  55 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]];
  56 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);
  57 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]];
  58 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);
  59 int            comm_waitany(xbt_dynar_t comms, double timeout) [[block]];
  60 void           comm_wait(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> comm, double timeout) [[block]];
  61 int            comm_test(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> comm) [[block]];
  62 int            comm_testany(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl>* comms, size_t count) [[block]];
  63
  64 void        mutex_lock(smx_mutex_t mutex) [[block]];
  65 int         mutex_trylock(smx_mutex_t mutex);
  66 void        mutex_unlock(smx_mutex_t mutex);
  67
  68 smx_cond_t cond_init() [[nohandler]];
  69 void       cond_signal(smx_cond_t cond) [[nohandler]];
  70 void       cond_wait(smx_cond_t cond, smx_mutex_t mutex) [[block]];
  71 void       cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout) [[block]];
  72 void       cond_broadcast(smx_cond_t cond) [[nohandler]];
  73
  74 void      sem_acquire(smx_sem_t sem) [[block]];
  75 void      sem_acquire_timeout(smx_sem_t sem, double timeout) [[block]];
  76
  77 sg_size_t   file_read(surf_file_t fd, sg_size_t size) [[block]];
  78 sg_size_t   file_write(surf_file_t fd, sg_size_t size) [[block]];
  79
  80 int        mc_random(int min, int max);
  81 void       set_category(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> synchro, const char* category) [[nohandler]];
  82
  83 void       run_kernel(std::function<void()> const* code) [[nohandler]];
  84 void       run_blocking(std::function<void()> const* code) [[block,nohandler]];