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