# CallType handler? name (resulttype,resultcast) (arg0name,arg0type,arg0cast) (arg1name,arg1type,arg1cast)
# CallType must be one of the three:
-# - Func: returning a value immediately
-# - Blck: Blocking call that does not return in the same scheduling round
+#
+# - Func: returning a value immediately (within the same scheduling round)
+# examples: all getters that only retrieve informations with no side effect
+#
# - Proc: not returning any value (but doing so immediately)
+# examples: all setters, *_cancel
+#
+# - Blck: Blocking call that does not return in the same scheduling round.
+# The answer requires some interaction with SURF, even if this can
+# still occure at the same timestamp under some circonstances (eg
+# if the surf_action cannot start because of resources that are down)
+# examples: things that last some time (communicate, execute, mutex_lock)
+#
+# In a perfect world, these answers would also be handled by the
+# script, but we are not there yet. Instead, the answer is manually
+# generated in one of the SIMIX_post_*() functions, that are called
+# when we unpack the done and failed actions returned by surf after
+# a surf simulation round. Weird things happen if you forget to
+# answer a given simcall in there...
# Handler? is either "H" if we need to generate a handler or "-" if we should go without handlers
+# I wish we could completely remove the handlers as their only use is
+# to adapt the interface between the exported symbol that is visible
+# by the user applications and the internal symbol that is implemented
+# by the kernel.
+# The only remaining use of that mechanism is to add the caller
+# identity as a parameter of internal call, but that could be
+# automatized too (eg by having a special parameter type called "self")
+
+# Please note that in addition to completing this file with your new simcall,
+# you should complete the libsmx.c file by adding the corresponding function
+# (aka. stub). Anyway, if you omit to do it, the invocation of ./simcalls.py will notify you ;)
+# Finally, if you want to remove an handler, it is important to remove although
+# the corresponding code (simcall_HANDLER_name_of_simcall(xxx) (note that comment the code
+# is not sufficient, the python script does not check whether the code is commented or not).
+
Func - host_get_by_name (void*, smx_host_t) (name, const char*)
Func - host_get_name (const char*) (host, void*, smx_host_t)
Proc - host_on (void) (host, void*, smx_host_t)
Proc - host_set_power_peak_at (void) (host, void*, smx_host_t) (pstate_index, int)
Func - host_get_consumed_energy (double) (host, void*, smx_host_t)
-Func - host_execute (void*, smx_synchro_t) (name, const char*) (host, void*, smx_host_t) (computation_amount, double) (priority, double) (bound, double) (affinity_mask, unsigned long)
-Func - host_parallel_execute (void*, smx_synchro_t) (name, const char*) (host_nb, int) (host_list, void*, smx_host_t*) (computation_amount, void*, double*) (communication_amount, void*, double*) (amount, double) (rate, double)
+Func - host_execute (void*, smx_synchro_t) (name, const char*) (host, void*, smx_host_t) (flops_amount, double) (priority, double) (bound, double) (affinity_mask, unsigned long)
+Func - host_parallel_execute (void*, smx_synchro_t) (name, const char*) (host_nb, int) (host_list, void*, smx_host_t*) (flops_amount, void*, double*) (bytes_amount, void*, double*) (amount, double) (rate, double)
Proc - host_execution_destroy (void) (execution, void*, smx_synchro_t)
Proc - host_execution_cancel (void) (execution, void*, smx_synchro_t)
Func - host_execution_get_remains (double) (execution, void*, smx_synchro_t)
Proc H vm_shutdown (void) (ind_vm, void*, smx_host_t)
Proc H vm_save (void) (ind_vm, void*, smx_host_t)
Proc H vm_restore (void) (ind_vm, void*, smx_host_t)
+Proc - vm_migratefrom_resumeto (void) (vm, void*, smx_host_t)(src_pm, void*, smx_host_t) (dst_pm, void*, smx_host_t)
Proc H process_create (void) (process, void*, smx_process_t*) (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)
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*)
## HAVE_LATENCY_BOUND_TRACKING
Func - comm_is_latency_bounded (int) (comm, void*, smx_synchro_t)
-## HAVE_TRACING
-Proc - set_category (void) (synchro, void*, smx_synchro_t) (category, const char*)
## 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)
-Func H mc_random (int) (min, int) (max, int)
