Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[simix] Infer Proc/Func type from signature and use attribute for blocking simcalls
[simgrid.git] / src / simix / simcalls.in
index 469b171..53c0ef3 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (c) 2014. The SimGrid Team. All rights reserved.
+# Copyright (c) 2014-2016. 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.
@@ -8,7 +8,7 @@
 # CallType must be one of the three:
 #
 #  - Func: returning a value immediately (within the same scheduling round)
-#    examples: all getters that only retrieve informations with no side effect
+#    examples: all getters that only retrieve information with no side effect
 #
 #  - Proc: not returning any value (but doing so immediately) 
 #    examples: all setters, *_cancel 
 # ./include/simgrid/simix.h (otherwise you will get a warning at the
 # compilation time)
 
-Proc H host_off (void) (host, void*, sg_host_t)
-
-Proc H vm_suspend (void) (ind_vm, void*, sg_host_t)
-Proc H vm_resume (void) (ind_vm, void*, sg_host_t)
-Proc H vm_shutdown (void) (ind_vm, void*, sg_host_t)
-Proc H vm_save (void) (ind_vm, void*, sg_host_t)
-Proc H vm_restore (void) (ind_vm, void*, sg_host_t)
-
-Func H process_create (void*) (name, const char*) (code, FPtr, xbt_main_func_t) (data, void*) (hostname, const char*) (kill_time, double) (argc, int) (argv, void*, char**) (properties, void*, xbt_dict_t) (auto_restart, int)
-Proc H process_kill (void) (process, void*, smx_process_t)
-Proc H process_killall (void) (reset_pid, int)
-Proc - process_cleanup (void) (process, void*, smx_process_t)
-Blck H process_suspend (void) (process, void*, smx_process_t)
-Proc H process_resume (void) (process, void*, smx_process_t)
-Proc H process_set_host (void) (process, void*, smx_process_t) (dest, void*, sg_host_t)
-Func - process_is_suspended (int) (process, void*, smx_process_t)
-Blck H process_join (int) (process, void*, smx_process_t) (timeout, double)
-Blck H process_sleep (int) (duration, double)
-Func H process_execute (void*, smx_synchro_t) (name, const char*) (flops_amount, double) (priority, double) (bound, double) (affinity_mask, unsigned long)
-
-Func - process_parallel_execute (void*, smx_synchro_t) (name, const char*) (host_nb, int) (host_list, void*, sg_host_t*) (flops_amount, void*, double*) (bytes_amount, void*, double*) (amount, double) (rate, double)
-Proc - process_execution_destroy (void) (execution, void*, smx_synchro_t)
-Proc - process_execution_cancel (void) (execution, void*, smx_synchro_t)
-Func - process_execution_get_remains (double) (execution, void*, smx_synchro_t)
-Func - process_execution_get_state (int, e_smx_state_t) (execution, void*, smx_synchro_t)
-Proc - process_execution_set_priority (void) (execution, void*, smx_synchro_t) (priority, double)
-Proc - process_execution_set_bound (void) (execution, void*, smx_synchro_t) (bound, double)
-Proc - process_execution_set_affinity (void) (execution, void*, smx_synchro_t) (ws, void*, sg_host_t) (mask, unsigned long)
-Blck H process_execution_wait (int) (execution, void*, smx_synchro_t)
-
-Proc - process_on_exit (void) (process, void*, smx_process_t) (fun, FPtr, int_f_pvoid_pvoid_t) (data, void*)
-Proc - process_auto_restart_set (void) (process, void*, smx_process_t) (auto_restart, int)
-Func H process_restart (void*, smx_process_t) (process, void*, smx_process_t)
-
-Func - rdv_create (void*, smx_rdv_t) (name, const char*)
-Proc - rdv_destroy (void) (rdv, void*, smx_rdv_t)
-Func - rdv_comm_count_by_host (unsigned int) (rdv, void*, smx_rdv_t) (host, void*, sg_host_t)
-Func - rdv_get_head (void*, smx_synchro_t) (rdv, void*, smx_rdv_t)
-Proc - rdv_set_receiver (void) (rdv, void*, smx_rdv_t) (receiver, void*, smx_process_t)
-Func - rdv_get_receiver (void*, smx_process_t) (rdv, void*, smx_rdv_t)
-
-Func H comm_iprobe (void*, smx_synchro_t) (rdv, void*, smx_rdv_t) (type, int) (src, int) (tag, int) (match_fun, FPtr, simix_match_func_t) (data, void*)
-Blck H comm_send (void)                  (sender, void*, smx_process_t) (rdv, void*, smx_rdv_t)  (task_size, double) (rate, double) (src_buff, void*) (src_buff_size, size_t) (match_fun, FPtr, simix_match_func_t) (copy_data_fun, FPtr, simix_copy_data_func_t) (data, void*) (timeout, double)
-Func H comm_isend (void*, smx_synchro_t) (sender, void*, smx_process_t) (rdv, void*, smx_rdv_t) (task_size, double) (rate, double) (src_buff, void*) (src_buff_size, size_t) (match_fun, FPtr, simix_match_func_t) (clean_fun, FPtr, simix_clean_func_t) (copy_data_fun, FPtr, simix_copy_data_func_t) (data, void*) (detached, int)
-Blck H comm_recv (void)                  (receiver, void*, smx_process_t) (rdv, void*, smx_rdv_t) (dst_buff, void*) (dst_buff_size, void*, size_t*) (match_fun, FPtr, simix_match_func_t) (copy_data_fun, FPtr, simix_copy_data_func_t) (data, void*) (timeout, double) (rate, double)
-Func H comm_irecv (void*, smx_synchro_t) (receiver, void*, smx_process_t) (rdv, void*, smx_rdv_t) (dst_buff, void*) (dst_buff_size, void*, size_t*) (match_fun, FPtr, simix_match_func_t) (copy_data_fun, FPtr, simix_copy_data_func_t) (data, void*) (rate, double)
-Proc - comm_cancel (void) (comm, void*, smx_synchro_t)
-Blck H comm_waitany (int) (comms, void*, xbt_dynar_t)
-Blck H comm_wait (void) (comm, void*, smx_synchro_t) (timeout, double)
-Blck H comm_test (int) (comm, void*, smx_synchro_t)
-Blck H comm_testany (int) (comms, void*, xbt_dynar_t)
-Func - comm_get_remains (double) (comm, void*, smx_synchro_t)
-Func - comm_get_state (int, e_smx_state_t) (comm, void*, smx_synchro_t)
-Func - comm_get_src_data (void*) (comm, void*, smx_synchro_t)
-Func - comm_get_dst_data (void*) (comm, void*, smx_synchro_t)
-Func - comm_get_src_proc (void*, smx_process_t) (comm, void*, smx_synchro_t)
-Func - comm_get_dst_proc (void*, smx_process_t) (comm, void*, smx_synchro_t)
-
-Func H mutex_init (void*, smx_mutex_t)
-Proc - mutex_destroy (void) (mutex, void*, smx_mutex_t)
-Blck H mutex_lock (void) (mutex, void*, smx_mutex_t)
-Func H mutex_trylock (int) (mutex, void*, smx_mutex_t)
-Proc H mutex_unlock (void) (mutex, void*, smx_mutex_t)
-
-Func - cond_init (void*, smx_cond_t)
-Proc - cond_destroy (void) (cond, void*, smx_cond_t)
-Proc - cond_signal (void) (cond, void*, smx_cond_t)
-Blck H cond_wait (void) (cond, void*, smx_cond_t) (mutex, void*, smx_mutex_t)
-Blck H cond_wait_timeout (void) (cond, void*, smx_cond_t) (mutex, void*, smx_mutex_t) (timeout, double)
-Proc - cond_broadcast (void) (cond, void*, smx_cond_t)
-
-Func - sem_init (void*, smx_sem_t) (capacity, unsigned int)
-Proc - sem_destroy (void) (sem, void*, smx_sem_t)
-Proc H sem_release (void) (sem, void*, smx_sem_t)
-Func H sem_would_block (int) (sem, void*, smx_sem_t)
-Blck H sem_acquire (void) (sem, void*, smx_sem_t)
-Blck H sem_acquire_timeout (void) (sem, void*, smx_sem_t) (timeout, double)
-Func H sem_get_capacity (int) (sem, void*, smx_sem_t)
-
-Blck H file_read (sg_size_t) (fd, void*, smx_file_t) (size, sg_size_t) (host, void*, sg_host_t)
-Blck H file_write (sg_size_t) (fd, void*, smx_file_t) (size, sg_size_t) (host, void*, sg_host_t)
-Blck H file_open (void*, smx_file_t) (fullpath, const char*) (host, void*, sg_host_t)
-Blck H file_close (int) (fd, void*, smx_file_t) (host, void*, sg_host_t)
-Func - file_unlink (int) (fd, void*, smx_file_t) (host, void*, sg_host_t)
-Func H file_get_size (sg_size_t) (fd, void*, smx_file_t)
-Func H file_tell (sg_size_t) (fd, void*, smx_file_t)
-Func H file_seek (int) (fd, void*, smx_file_t) (offset, sg_offset_t) (origin, int)
-Func H file_get_info (void*, xbt_dynar_t) (fd, void*, smx_file_t)
-Func H file_move (int) (fd, void*, smx_file_t) (fullpath, const char*)
-
-Func H storage_get_free_size (sg_size_t) (storage, void*, smx_storage_t)
-Func H storage_get_used_size (sg_size_t) (name, void*, smx_storage_t)
-Func - storage_get_properties (void*, xbt_dict_t) (storage, void*, smx_storage_t)
-Func - storage_get_content (void*, xbt_dict_t) (storage, void*, smx_storage_t)
-
-Func H asr_get_properties (void*, xbt_dict_t) (name, const char*)
-Func H mc_random (int) (min, int) (max, int)
-Proc - set_category (void) (synchro, void*, smx_synchro_t) (category, const char*)
-
-Proc - run_kernel (void) (code, void*)
-
-## HAVE_LATENCY_BOUND_TRACKING
-Func - comm_is_latency_bounded (int) (comm, void*, smx_synchro_t)
-## HAVE_MC
-Func H mc_snapshot (void*, mc_snapshot_t)
-Func H mc_compare_snapshots (int) (s1, void*, mc_snapshot_t) (s2, void*, mc_snapshot_t)
+void vm_suspend (sg_host_t ind_vm);
+void vm_resume (sg_host_t ind_vm);
+void vm_shutdown (sg_host_t ind_vm);
+void vm_save (sg_host_t ind_vm);
+void vm_restore (sg_host_t ind_vm);
+
+void process_kill (smx_process_t process);
+void process_killall (int reset_pid);
+void process_cleanup (smx_process_t process) [[nohandler]];
+void process_suspend (smx_process_t process) [[block]];
+void process_resume (smx_process_t process);
+void process_set_host (smx_process_t process, sg_host_t dest);
+int  process_is_suspended (smx_process_t process) [[nohandler]];
+int  process_join (smx_process_t process, double timeout) [[block]];
+int  process_sleep (double duration) [[block]];
+
+smx_synchro_t execution_start (const char* name, double flops_amount, double priority, double bound, unsigned long affinity_mask);
+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]];
+void          execution_cancel (smx_synchro_t execution) [[nohandler]];
+void          execution_set_priority (smx_synchro_t execution, double priority) [[nohandler]];
+void          execution_set_bound (smx_synchro_t execution, double bound) [[nohandler]];
+void          execution_set_affinity (smx_synchro_t execution, sg_host_t ws, unsigned long mask) [[nohandler]];
+int           execution_wait (smx_synchro_t execution) [[block]];
+
+void          process_on_exit (smx_process_t process, int_f_pvoid_pvoid_t fun, void* data) [[nohandler]];
+void          process_auto_restart_set (smx_process_t process, int auto_restart) [[nohandler]];
+smx_process_t process_restart (smx_process_t process);
+
+smx_mailbox_t mbox_create (const char* name) [[nohandler]];
+void          mbox_set_receiver (smx_mailbox_t mbox, smx_process_t receiver) [[nohandler]];
+
+smx_synchro_t comm_iprobe (smx_mailbox_t mbox, int type, int src, int tag, simix_match_func_t match_fun, void* data);
+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]];
+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);
+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]];
+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);
+int           comm_waitany (xbt_dynar_t comms) [[block]];
+void          comm_wait (smx_synchro_t comm, double timeout) [[block]];
+int           comm_test (smx_synchro_t comm) [[block]];
+int           comm_testany (xbt_dynar_t comms) [[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]];
+
+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);
+
+sg_size_t   file_read (smx_file_t fd, sg_size_t size, sg_host_t host) [[block]];
+sg_size_t   file_write (smx_file_t fd, sg_size_t size, sg_host_t host) [[block]];
+smx_file_t  file_open (const char* fullpath, sg_host_t host) [[block]];
+int         file_close (smx_file_t fd, sg_host_t host) [[block]];
+int         file_unlink (smx_file_t fd, sg_host_t host) [[nohandler]];
+sg_size_t   file_get_size (smx_file_t fd);
+sg_size_t   file_tell (smx_file_t fd);
+int         file_seek (smx_file_t fd, sg_offset_t offset, int origin);
+xbt_dynar_t file_get_info (smx_file_t fd);
+int         file_move (smx_file_t fd, const char* fullpath);
+
+sg_size_t  storage_get_free_size (smx_storage_t storage);
+sg_size_t  storage_get_used_size (smx_storage_t name);
+xbt_dict_t storage_get_properties (smx_storage_t storage) [[nohandler]];
+xbt_dict_t storage_get_content (smx_storage_t storage) [[nohandler]];
+
+xbt_dict_t asr_get_properties (const char* name);
+int        mc_random (int min, int max);
+void       set_category (smx_synchro_t synchro, const char* category) [[nohandler]];
+
+void run_kernel (void* code) [[nohandler]];