X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f3ae712a1b95294052b6e8136d0f0f2d4b30e6eb..f9d7b35c174d52377ef297f786129e0340ae0778:/src/simix/simcalls.in diff --git a/src/simix/simcalls.in b/src/simix/simcalls.in index d4b61ae8ff..7d6ec3b059 100644 --- a/src/simix/simcalls.in +++ b/src/simix/simcalls.in @@ -1,133 +1,173 @@ -# Copyright (c) 2014. The SimGrid Team. -# All rights reserved. +# Copyright (c) 2014. 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. -# name has_answer (restype,rescast) (arg0name,arg0type,arg0cast) (arg1name,arg1type,arg1cast) -host_get_by_name True (void*, smx_host_t) (name, const char*) -host_get_name True (const char*) (host, void*, smx_host_t) -host_on True (void) (host, void*, smx_host_t) -host_off True (void) (host, void*, smx_host_t) -host_get_properties True (void*, xbt_dict_t) (host, void*, smx_host_t) -host_get_core True (int) (host, void*, smx_host_t) -host_get_process_list True (void*, xbt_swag_t) (host, void*, smx_host_t) -host_get_speed True (double) (host, void*, smx_host_t) -host_get_available_speed True (double) (host, void*, smx_host_t) -host_get_state True (int) (host, void*, smx_host_t) -host_get_current_power_peak True (double) (host, void*, smx_host_t) -host_get_power_peak_at True (double) (host, void*, smx_host_t) (pstate_index, int) -host_get_nb_pstates True (int) (host, void*, smx_host_t) -host_set_power_peak_at True (void) (host, void*, smx_host_t) (pstate_index, int) -host_get_consumed_energy True (double) (host, void*, smx_host_t) -host_execute True (void*, smx_action_t) (name, const char*) (host, void*, smx_host_t) (computation_amount, double) (priority, double) (bound, double) (affinity_mask, unsigned long) -host_parallel_execute True (void*, smx_action_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) -host_execution_destroy True (void) (execution, void*, smx_action_t) -host_execution_cancel True (void) (execution, void*, smx_action_t) -host_execution_get_remains True (double) (execution, void*, smx_action_t) -host_execution_get_state True (int) (execution, void*, smx_action_t) -host_execution_set_priority True (void) (execution, void*, smx_action_t) (priority, double) -host_execution_set_bound True (void) (execution, void*, smx_action_t) (bound, double) -host_execution_set_affinity True (void) (execution, void*, smx_action_t) (ws, void*, smx_host_t) (mask, unsigned long) -host_execution_wait False (int) (execution, void*, smx_action_t) -host_get_mounted_storage_list True (void*, xbt_dict_t) (host, void*, smx_host_t) -host_get_attached_storage_list True (void*, xbt_dynar_t) (host, void*, smx_host_t) -host_get_params True (void) (ind_vm, void*, smx_host_t) (params, void*, ws_params_t) -host_set_params True (void) (ind_vm, void*, smx_host_t) (params, void*, ws_params_t) -vm_create True (void*) (name, const char*) (ind_pm, void*, smx_host_t) -vm_start True (void) (ind_vm, void*, smx_host_t) -vm_get_state True (int) (ind_vm, void*, smx_host_t) -vm_migrate True (void) (ind_vm, void*, smx_host_t) (ind_dst_pm, void*, smx_host_t) -vm_get_pm True (void*) (ind_vm, void*, smx_host_t) -vm_set_bound True (void) (ind_vm, void*, smx_host_t) (bound, double) -vm_set_affinity True (void) (ind_vm, void*, smx_host_t) (ind_pm, void*, smx_host_t) (mask, unsigned long) -vm_destroy True (void) (ind_vm, void*, smx_host_t) -vm_suspend True (void) (ind_vm, void*, smx_host_t) -vm_resume True (void) (ind_vm, void*, smx_host_t) -vm_shutdown True (void) (ind_vm, void*, smx_host_t) -vm_save True (void) (ind_vm, void*, smx_host_t) -vm_restore True (void) (ind_vm, void*, smx_host_t) -process_create True (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) -process_kill True (void) (process, void*, smx_process_t) -process_killall True (void) (reset_pid, int) -process_cleanup True (void) (process, void*, smx_process_t) -process_change_host True (void) (process, void*, smx_process_t) (dest, void*, smx_host_t) -process_suspend False (void) (process, void*, smx_process_t) -process_resume True (void) (process, void*, smx_process_t) -process_count True (int) -process_get_PID True (int) (process, void*, smx_process_t) -process_get_PPID True (int) (process, void*, smx_process_t) -process_get_data True (void*) (process, void*, smx_process_t) -process_set_data True (void) (process, void*, smx_process_t) (data, void*) -process_get_host True (void*, smx_host_t) (process, void*, smx_process_t) -process_get_name True (const char*) (process, void*, smx_process_t) -process_is_suspended True (int) (process, void*, smx_process_t) -process_get_properties True (void*, xbt_dict_t) (process, void*, smx_process_t) -process_sleep False (int) (duration, double) -process_on_exit True (void) (process, void*, smx_process_t) (fun, FPtr, int_f_pvoid_t) (data, void*) -process_auto_restart_set True (void) (process, void*, smx_process_t) (auto_restart, int) -process_restart True (void*, smx_process_t) (process, void*, smx_process_t) -rdv_create True (void*, smx_rdv_t) (name, const char*) -rdv_destroy True (void) (rdv, void*, smx_rdv_t) -#rdv_get_by_name True (void*, smx_host_t) (name, const char*) -rdv_comm_count_by_host True (unsigned int) (rdv, void*, smx_rdv_t) (host, void*, smx_host_t) -rdv_get_head True (void*, smx_action_t) (rdv, void*, smx_rdv_t) -rdv_set_receiver True (void) (rdv, void*, smx_rdv_t) (receiver, void*, smx_process_t) -rdv_get_receiver True (void*, smx_process_t) (rdv, void*, smx_rdv_t) -comm_iprobe True (void*, smx_action_t) (rdv, void*, smx_rdv_t) (src, int) (tag, int) (match_fun, FPtr, simix_match_func_t) (data, void*) -comm_send False (void) (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) (data, void*) (timeout, double) -comm_isend True (void*, smx_action_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) (data, void*) (detached, int) -comm_recv False (void) (rdv, void*, smx_rdv_t) (dst_buff, void*) (dst_buff_size, void*, size_t*) (match_fun, FPtr, simix_match_func_t) (data, void*) (timeout, double) (rate, double) -comm_irecv True (void*, smx_action_t) (rdv, void*, smx_rdv_t) (dst_buff, void*) (dst_buff_size, void*, size_t*) (match_fun, FPtr, simix_match_func_t) (data, void*) (rate, double) -comm_cancel True (void) (comm, void*, smx_action_t) -comm_waitany False (int) (comms, void*, xbt_dynar_t) -comm_wait False (void) (comm, void*, smx_action_t) (timeout, double) -comm_test False (int) (comm, void*, smx_action_t) -comm_testany False (int) (comms, void*, xbt_dynar_t) -comm_get_remains True (double) (comm, void*, smx_action_t) -comm_get_state True (int) (comm, void*, smx_action_t) -comm_get_src_data True (void*) (comm, void*, smx_action_t) -comm_get_dst_data True (void*) (comm, void*, smx_action_t) -comm_get_src_proc True (void*, smx_process_t) (comm, void*, smx_action_t) -comm_get_dst_proc True (void*, smx_process_t) (comm, void*, smx_action_t) -mutex_init True (void*, smx_mutex_t) -mutex_destroy True (void) (mutex, void*, smx_mutex_t) -mutex_lock False (void) (mutex, void*, smx_mutex_t) -mutex_trylock True (int) (mutex, void*, smx_mutex_t) -mutex_unlock True (void) (mutex, void*, smx_mutex_t) -cond_init True (void*, smx_cond_t) -cond_destroy True (void) (cond, void*, smx_cond_t) -cond_signal True (void) (cond, void*, smx_cond_t) -cond_wait False (void) (cond, void*, smx_cond_t) (mutex, void*, smx_mutex_t) -cond_wait_timeout False (void) (cond, void*, smx_cond_t) (mutex, void*, smx_mutex_t) (timeout, double) -cond_broadcast True (void) (cond, void*, smx_cond_t) -sem_init True (void*, smx_sem_t) (capacity, int) -sem_destroy True (void) (sem, void*, smx_sem_t) -sem_release True (void) (sem, void*, smx_sem_t) -sem_would_block True (int) (sem, void*, smx_sem_t) -sem_acquire False (void) (sem, void*, smx_sem_t) -sem_acquire_timeout False (void) (sem, void*, smx_sem_t) (timeout, double) -sem_get_capacity True (int) (sem, void*, smx_sem_t) -file_read False (sg_size_t) (fd, void*, smx_file_t) (size, sg_size_t) (host, void*, smx_host_t) -file_write False (sg_size_t) (fd, void*, smx_file_t) (size, sg_size_t) (host, void*, smx_host_t) -file_open False (void*, smx_file_t) (fullpath, const char*) (host, void*, smx_host_t) -file_close False (int) (fd, void*, smx_file_t) (host, void*, smx_host_t) -file_unlink True (int) (fd, void*, smx_file_t) -file_get_size True (sg_size_t) (fd, void*, smx_file_t) -file_tell True (sg_size_t) (fd, void*, smx_file_t) -file_seek True (int) (fd, void*, smx_file_t) (offset, sg_size_t) (origin, int) -file_get_info True (void*, xbt_dynar_t) (fd, void*, smx_file_t) -file_move True (int) (fd, void*, smx_file_t) (fullpath, const char*) -storage_get_free_size True (sg_size_t) (storage, void*, smx_storage_t) -storage_get_used_size True (sg_size_t) (name, void*, smx_storage_t) -storage_get_properties True (void*, xbt_dict_t) (storage, void*, smx_storage_t) -storage_get_content True (void*, xbt_dict_t) (storage, void*, smx_storage_t) -asr_get_properties True (void*, xbt_dict_t) (name, const char*) +# CallType handler? name (resulttype,resultcast) (arg0name,arg0type,arg0cast) (arg1name,arg1type,arg1cast) + +# 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 +# +# - 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 ;) +# 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). +# Last but not the least, you should declare the new simix call in +# ./include/simgrid/simix.h (otherwise you will get a warning at the +# compilation time) + +Proc - host_on (void) (host, void*, sg_host_t) +Proc H host_off (void) (host, void*, sg_host_t) +Func - host_get_properties (void*, xbt_dict_t) (host, void*, sg_host_t) +Func - host_get_process_list (void*, xbt_swag_t) (host, void*, sg_host_t) +Func - host_get_current_power_peak (double) (host, void*, sg_host_t) +Func - host_get_power_peak_at (double) (host, void*, sg_host_t) (pstate_index, int) +Func - host_get_wattmin_at (double) (host, void*, sg_host_t) (pstate_index, int) +Func - host_get_wattmax_at (double) (host, void*, sg_host_t) (pstate_index, int) +Proc - host_set_pstate (void) (host, void*, sg_host_t) (pstate_index, int) + +Func - host_get_mounted_storage_list (void*, xbt_dict_t) (host, void*, sg_host_t) +Func - host_get_attached_storage_list (void*, xbt_dynar_t) (host, void*, sg_host_t) +Proc - host_get_params (void) (ind_vm, void*, sg_host_t) (params, void*, vm_params_t) +Proc - host_set_params (void) (ind_vm, void*, sg_host_t) (params, void*, vm_params_t) +Func - vm_create (void*, sg_host_t) (name, const char*) (ind_pm, void*, sg_host_t) +Proc - vm_start (void) (ind_vm, void*, sg_host_t) +Func - vm_get_state (int) (ind_vm, void*, sg_host_t) +Proc - vm_migrate (void) (ind_vm, void*, sg_host_t) (ind_dst_pm, void*, sg_host_t) +Func - vm_get_pm (void*) (ind_vm, void*, sg_host_t) +Proc - vm_set_bound (void) (ind_vm, void*, sg_host_t) (bound, double) +Proc - vm_set_affinity (void) (ind_vm, void*, sg_host_t) (ind_pm, void*, sg_host_t) (mask, unsigned long) +Proc - vm_destroy (void) (ind_vm, 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) +Proc - vm_migratefrom_resumeto (void) (vm, void*, sg_host_t)(src_pm, void*, sg_host_t) (dst_pm, 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) +Func - process_count (int) +Func - process_get_PID (int) (process, void*, smx_process_t) +Func - process_get_PPID (int) (process, void*, smx_process_t) +Func - process_get_data (void*) (process, void*, smx_process_t) +Proc - process_set_data (void) (process, void*, smx_process_t) (data, void*) +Proc H process_set_host (void) (process, void*, smx_process_t) (dest, void*, sg_host_t) +Func - process_get_host (void*, sg_host_t) (process, void*, smx_process_t) +Func - process_get_name (const char*) (process, void*, smx_process_t) +Func - process_is_suspended (int) (process, void*, smx_process_t) +Func - process_get_properties (void*, xbt_dict_t) (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 -comm_is_latency_bounded True (int) (comm, void*, smx_action_t) -## HAVE_TRACING -set_category True (void) (action, void*, smx_action_t) (category, const char*) +Func - comm_is_latency_bounded (int) (comm, void*, smx_synchro_t) ## HAVE_MC -mc_snapshot True (void*) -mc_compare_snapshots True (int) (s1, void*) (s2, void*) -mc_random True (int) (min, int) (max, int) +Func H mc_snapshot (void*, mc_snapshot_t) +Func H mc_compare_snapshots (int) (s1, void*, mc_snapshot_t) (s2, void*, mc_snapshot_t)