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` attribut 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 occure at the same timestamp under some
  16 # circonstances (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 # automatized 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 # (aka. 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 the
  37 # compilation time)
  38
  39 void vm_suspend(sg_host_t ind_vm);
  40 void vm_resume(sg_host_t ind_vm) [[nohandler]];
  41 void vm_shutdown(sg_host_t ind_vm);
  42
  43 void process_kill(smx_actor_t process);
  44 void process_killall(int reset_pid);
  45 void process_cleanup(smx_actor_t process) [[nohandler]];
  46 void process_suspend(smx_actor_t process) [[block]];
  47 void process_resume(smx_actor_t process) [[nohandler]];
  48 void process_set_host(smx_actor_t process, sg_host_t dest);
  49 int  process_is_suspended(smx_actor_t process) [[nohandler]];
  50 int  process_join(smx_actor_t process, double timeout) [[block]];
  51 int  process_sleep(double duration) [[block]];
  52
  53 smx_activity_t execution_start(const char* name, double flops_amount, double priority, double bound);
  54 smx_activity_t 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]];
  55 void          execution_cancel(smx_activity_t execution) [[nohandler]];
  56 void          execution_set_priority(smx_activity_t execution, double priority) [[nohandler]];
  57 void          execution_set_bound(smx_activity_t execution, double bound) [[nohandler]];
  58 int           execution_wait(smx_activity_t execution) [[block]];
  59
  60 void          process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data) [[nohandler]];
  61 void          process_auto_restart_set(smx_actor_t process, int auto_restart) [[nohandler]];
  62 smx_actor_t process_restart(smx_actor_t process);
  63
  64 smx_mailbox_t mbox_create(const char* name) [[nohandler]];
  65 void          mbox_set_receiver(smx_mailbox_t mbox, smx_actor_t receiver) [[nohandler]];
  66
  67 smx_activity_t comm_iprobe(smx_mailbox_t mbox, int type, int src, int tag, simix_match_func_t match_fun, void* data);
  68 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]];
  69 smx_activity_t 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);
  70 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]];
  71 smx_activity_t 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);
  72 int           comm_waitany(xbt_dynar_t comms, double timeout) [[block]];
  73 void          comm_wait(smx_activity_t comm, double timeout) [[block]];
  74 int           comm_test(smx_activity_t comm) [[block]];
  75 int           comm_testany(smx_activity_t* comms, size_t count) [[block]];
  76
  77 smx_mutex_t mutex_init();
  78 void        mutex_lock(smx_mutex_t mutex) [[block]];
  79 int         mutex_trylock(smx_mutex_t mutex);
  80 void        mutex_unlock(smx_mutex_t mutex);
  81
  82 smx_cond_t cond_init() [[nohandler]];
  83 void       cond_signal(smx_cond_t cond) [[nohandler]];
  84 void       cond_wait(smx_cond_t cond, smx_mutex_t mutex) [[block]];
  85 void       cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout) [[block]];
  86 void       cond_broadcast(smx_cond_t cond) [[nohandler]];
  87
  88 smx_sem_t sem_init(unsigned int capacity) [[nohandler]];
  89 void      sem_release(smx_sem_t sem);
  90 int       sem_would_block(smx_sem_t sem);
  91 void      sem_acquire(smx_sem_t sem) [[block]];
  92 void      sem_acquire_timeout(smx_sem_t sem, double timeout) [[block]];
  93 int       sem_get_capacity(smx_sem_t sem);
  94
  95 sg_size_t   file_read(smx_file_t fd, sg_size_t size, sg_host_t host) [[block]];
  96 sg_size_t   file_write(smx_file_t fd, sg_size_t size, sg_host_t host) [[block]];
  97 smx_file_t  file_open(const char* fullpath, sg_host_t host) [[block]];
  98 int         file_close(smx_file_t fd, sg_host_t host) [[block]];
  99 int         file_unlink(smx_file_t fd, sg_host_t host) [[nohandler]];
 100 sg_size_t   file_get_size(smx_file_t fd);
 101 sg_size_t   file_tell(smx_file_t fd);
 102 int         file_seek(smx_file_t fd, sg_offset_t offset, int origin);
 103 xbt_dynar_t file_get_info(smx_file_t fd);
 104 int         file_move(smx_file_t fd, const char* fullpath);
 105
 106 sg_size_t  storage_get_free_size(smx_storage_t storage);
 107 sg_size_t  storage_get_used_size(smx_storage_t name);
 108 xbt_dict_t storage_get_properties(smx_storage_t storage) [[nohandler]];
 109 xbt_dict_t storage_get_content(smx_storage_t storage) [[nohandler]];
 110
 111 int        mc_random(int min, int max);
 112 void       set_category(smx_activity_t synchro, const char* category) [[nohandler]];
 113
 114 void       run_kernel(std::function<void()> const* code) [[nohandler]];
 115 void       run_blocking(std::function<void()> const* code) [[block,nohandler]];