Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
refactor rdv to mailbox for consistency
[simgrid.git] / src / simix / simcalls.in
1 # Copyright (c) 2014. 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 # CallType handler? name (resulttype,resultcast) (arg0name,arg0type,arg0cast) (arg1name,arg1type,arg1cast)
7
8 # CallType must be one of the three:
9 #
10 #  - Func: returning a value immediately (within the same scheduling round)
11 #    examples: all getters that only retrieve informations with no side effect
12 #
13 #  - Proc: not returning any value (but doing so immediately) 
14 #    examples: all setters, *_cancel 
15 #
16 #  - Blck: Blocking call that does not return in the same scheduling round.
17 #    The answer requires some interaction with SURF, even if this can
18 #    still occure at the same timestamp under some circonstances (eg
19 #    if the surf_action cannot start because of resources that are down)
20 #    examples: things that last some time (communicate, execute, mutex_lock)
21 #
22 #    In a perfect world, these answers would also be handled by the
23 #    script, but we are not there yet. Instead, the answer is manually
24 #    generated in one of the SIMIX_post_*() functions, that are called
25 #    when we unpack the done and failed actions returned by surf after
26 #    a surf simulation round. Weird things happen if you forget to
27 #    answer a given simcall in there...
28
29 # Handler? is either "H" if we need to generate a handler or "-" if we should go without handlers
30
31 # I wish we could completely remove the handlers as their only use is
32 # to adapt the interface between the exported symbol that is visible
33 # by the user applications and the internal symbol that is implemented 
34 # by the kernel. 
35 # The only remaining use of that mechanism is to add the caller
36 # identity as a parameter of internal call, but that could be
37 # automatized too (eg by having a special parameter type called "self")
38
39 # Please note that in addition to completing this file with your new simcall,
40 # you should complete the libsmx.c file by adding the corresponding function
41 # (aka. stub). Anyway, if you omit to do it, the invocation of ./simcalls.py will notify you ;)
42 # If you want to remove an handler, it is important to remove although
43 # the corresponding code (simcall_HANDLER_name_of_simcall(xxx) (note that comment the code 
44 # is not sufficient, the python script does not check whether the code is commented or not).
45 # Last but not the least, you should declare the new simix call in
46 # ./include/simgrid/simix.h (otherwise you will get a warning at the
47 # compilation time)
48
49 Proc H vm_suspend (void) (ind_vm, void*, sg_host_t)
50 Proc H vm_resume (void) (ind_vm, void*, sg_host_t)
51 Proc H vm_shutdown (void) (ind_vm, void*, sg_host_t)
52 Proc H vm_save (void) (ind_vm, void*, sg_host_t)
53 Proc H vm_restore (void) (ind_vm, void*, sg_host_t)
54
55 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)
56 Proc H process_kill (void) (process, void*, smx_process_t)
57 Proc H process_killall (void) (reset_pid, int)
58 Proc - process_cleanup (void) (process, void*, smx_process_t)
59 Blck H process_suspend (void) (process, void*, smx_process_t)
60 Proc H process_resume (void) (process, void*, smx_process_t)
61 Proc H process_set_host (void) (process, void*, smx_process_t) (dest, void*, sg_host_t)
62 Func - process_is_suspended (int) (process, void*, smx_process_t)
63 Blck H process_join (int) (process, void*, smx_process_t) (timeout, double)
64 Blck H process_sleep (int) (duration, double)
65
66 Func H execution_start (void*, smx_synchro_t) (name, const char*) (flops_amount, double) (priority, double) (bound, double) (affinity_mask, unsigned long)
67 Func - execution_parallel_start (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)
68 Proc - execution_destroy (void) (execution, void*, smx_synchro_t)
69 Proc - execution_cancel (void) (execution, void*, smx_synchro_t)
70 Func - execution_get_remains (double) (execution, void*, smx_synchro_t)
71 Func - execution_get_state (int, e_smx_state_t) (execution, void*, smx_synchro_t)
72 Proc - execution_set_priority (void) (execution, void*, smx_synchro_t) (priority, double)
73 Proc - execution_set_bound (void) (execution, void*, smx_synchro_t) (bound, double)
74 Proc - execution_set_affinity (void) (execution, void*, smx_synchro_t) (ws, void*, sg_host_t) (mask, unsigned long)
75 Blck H execution_wait (int) (execution, void*, smx_synchro_t)
76
77 Proc - process_on_exit (void) (process, void*, smx_process_t) (fun, FPtr, int_f_pvoid_pvoid_t) (data, void*)
78 Proc - process_auto_restart_set (void) (process, void*, smx_process_t) (auto_restart, int)
79 Func H process_restart (void*, smx_process_t) (process, void*, smx_process_t)
80
81 Func - mbox_create (void*, smx_mailbox_t) (name, const char*)
82 Proc - mbox_destroy (void) (mbox, void*, smx_mailbox_t)
83 Func - mbox_comm_count_by_host (unsigned int) (mbox, void*, smx_mailbox_t) (host, void*, sg_host_t)
84 Func - mbox_get_head (void*, smx_synchro_t) (mbox, void*, smx_mailbox_t)
85 Proc - mbox_set_receiver (void) (mbox, void*, smx_mailbox_t) (receiver, void*, smx_process_t)
86 Func - mbox_get_receiver (void*, smx_process_t) (mbox, void*, smx_mailbox_t)
87
88 Func H comm_iprobe (void*, smx_synchro_t) (mbox, void*, smx_mailbox_t) (type, int) (src, int) (tag, int) (match_fun, FPtr, simix_match_func_t) (data, void*)
89 Blck H comm_send (void)                  (sender, void*, smx_process_t) (mbox, void*, smx_mailbox_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)
90 Func H comm_isend (void*, smx_synchro_t) (sender, void*, smx_process_t) (mbox, void*, smx_mailbox_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)
91 Blck H comm_recv (void)                  (receiver, void*, smx_process_t) (mbox, void*, smx_mailbox_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)
92 Func H comm_irecv (void*, smx_synchro_t) (receiver, void*, smx_process_t) (mbox, void*, smx_mailbox_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)
93 Proc - comm_cancel (void) (comm, void*, smx_synchro_t)
94 Blck H comm_waitany (int) (comms, void*, xbt_dynar_t)
95 Blck H comm_wait (void) (comm, void*, smx_synchro_t) (timeout, double)
96 Blck H comm_test (int) (comm, void*, smx_synchro_t)
97 Blck H comm_testany (int) (comms, void*, xbt_dynar_t)
98 Func - comm_get_remains (double) (comm, void*, smx_synchro_t)
99 Func - comm_get_state (int, e_smx_state_t) (comm, void*, smx_synchro_t)
100 Func - comm_get_src_data (void*) (comm, void*, smx_synchro_t)
101 Func - comm_get_dst_data (void*) (comm, void*, smx_synchro_t)
102 Func - comm_get_src_proc (void*, smx_process_t) (comm, void*, smx_synchro_t)
103 Func - comm_get_dst_proc (void*, smx_process_t) (comm, void*, smx_synchro_t)
104
105 Func H mutex_init (void*, smx_mutex_t)
106 Blck H mutex_lock (void) (mutex, void*, smx_mutex_t)
107 Func H mutex_trylock (int) (mutex, void*, smx_mutex_t)
108 Proc H mutex_unlock (void) (mutex, void*, smx_mutex_t)
109
110 Func - cond_init (void*, smx_cond_t)
111 Proc - cond_signal (void) (cond, void*, smx_cond_t)
112 Blck H cond_wait (void) (cond, void*, smx_cond_t) (mutex, void*, smx_mutex_t)
113 Blck H cond_wait_timeout (void) (cond, void*, smx_cond_t) (mutex, void*, smx_mutex_t) (timeout, double)
114 Proc - cond_broadcast (void) (cond, void*, smx_cond_t)
115
116 Func - sem_init (void*, smx_sem_t) (capacity, unsigned int)
117 Proc H sem_release (void) (sem, void*, smx_sem_t)
118 Func H sem_would_block (int) (sem, void*, smx_sem_t)
119 Blck H sem_acquire (void) (sem, void*, smx_sem_t)
120 Blck H sem_acquire_timeout (void) (sem, void*, smx_sem_t) (timeout, double)
121 Func H sem_get_capacity (int) (sem, void*, smx_sem_t)
122
123 Blck H file_read (sg_size_t) (fd, void*, smx_file_t) (size, sg_size_t) (host, void*, sg_host_t)
124 Blck H file_write (sg_size_t) (fd, void*, smx_file_t) (size, sg_size_t) (host, void*, sg_host_t)
125 Blck H file_open (void*, smx_file_t) (fullpath, const char*) (host, void*, sg_host_t)
126 Blck H file_close (int) (fd, void*, smx_file_t) (host, void*, sg_host_t)
127 Func - file_unlink (int) (fd, void*, smx_file_t) (host, void*, sg_host_t)
128 Func H file_get_size (sg_size_t) (fd, void*, smx_file_t)
129 Func H file_tell (sg_size_t) (fd, void*, smx_file_t)
130 Func H file_seek (int) (fd, void*, smx_file_t) (offset, sg_offset_t) (origin, int)
131 Func H file_get_info (void*, xbt_dynar_t) (fd, void*, smx_file_t)
132 Func H file_move (int) (fd, void*, smx_file_t) (fullpath, const char*)
133
134 Func H storage_get_free_size (sg_size_t) (storage, void*, smx_storage_t)
135 Func H storage_get_used_size (sg_size_t) (name, void*, smx_storage_t)
136 Func - storage_get_properties (void*, xbt_dict_t) (storage, void*, smx_storage_t)
137 Func - storage_get_content (void*, xbt_dict_t) (storage, void*, smx_storage_t)
138
139 Func H asr_get_properties (void*, xbt_dict_t) (name, const char*)
140 Func H mc_random (int) (min, int) (max, int)
141 Proc - set_category (void) (synchro, void*, smx_synchro_t) (category, const char*)
142
143 Proc - run_kernel (void) (code, void*)