Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot/simgrid/simgrid
[simgrid.git] / 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 process_kill(smx_actor_t process);
40 void process_killall(int reset_pid);
41 void process_cleanup(smx_actor_t process) [[nohandler]];
42 void process_suspend(smx_actor_t process) [[block]];
43 void process_resume(smx_actor_t process) [[nohandler]];
44 void process_set_host(smx_actor_t process, sg_host_t dest);
45 int  process_is_suspended(smx_actor_t process) [[nohandler]];
46 int  process_join(smx_actor_t process, double timeout) [[block]];
47 int  process_sleep(double duration) [[block]];
48
49 boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> execution_start(const char* name, double flops_amount, double priority, double bound);
50 boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount, double amount, double rate, double timeout) [[nohandler]];
51 void          execution_cancel(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> execution) [[nohandler]];
52 void          execution_set_priority(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> execution, double priority) [[nohandler]];
53 void          execution_set_bound(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> execution, double bound) [[nohandler]];
54 int           execution_wait(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> execution) [[block]];
55
56 void          process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void* data) [[nohandler]];
57 void          process_auto_restart_set(smx_actor_t process, int auto_restart) [[nohandler]];
58 smx_actor_t   process_restart(smx_actor_t process);
59
60 boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> comm_iprobe(smx_mailbox_t mbox, int type, int src, int tag, simix_match_func_t match_fun, void* data);
61 void           comm_send(smx_actor_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]];
62 boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> comm_isend(smx_actor_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);
63 void           comm_recv(smx_actor_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]];
64 boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> comm_irecv(smx_actor_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);
65 int            comm_waitany(xbt_dynar_t comms, double timeout) [[block]];
66 void           comm_wait(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> comm, double timeout) [[block]];
67 int            comm_test(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> comm) [[block]];
68 int            comm_testany(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl>* comms, size_t count) [[block]];
69
70 smx_mutex_t mutex_init();
71 void        mutex_lock(smx_mutex_t mutex) [[block]];
72 int         mutex_trylock(smx_mutex_t mutex);
73 void        mutex_unlock(smx_mutex_t mutex);
74
75 smx_cond_t cond_init() [[nohandler]];
76 void       cond_signal(smx_cond_t cond) [[nohandler]];
77 void       cond_wait(smx_cond_t cond, smx_mutex_t mutex) [[block]];
78 void       cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout) [[block]];
79 void       cond_broadcast(smx_cond_t cond) [[nohandler]];
80
81 smx_sem_t sem_init(unsigned int capacity) [[nohandler]];
82 void      sem_release(smx_sem_t sem);
83 int       sem_would_block(smx_sem_t sem);
84 void      sem_acquire(smx_sem_t sem) [[block]];
85 void      sem_acquire_timeout(smx_sem_t sem, double timeout) [[block]];
86 int       sem_get_capacity(smx_sem_t sem);
87
88 sg_size_t   file_read(smx_file_t fd, sg_size_t size, sg_host_t host) [[block]];
89 sg_size_t   file_write(smx_file_t fd, sg_size_t size, sg_host_t host) [[block]];
90 smx_file_t  file_open(const char* mount, const char* path, sg_storage_t st) [[block]];
91 int         file_close(smx_file_t fd, sg_host_t host) [[block]];
92 int         file_unlink(smx_file_t fd, sg_host_t host) [[nohandler]];
93 sg_size_t   file_get_size(smx_file_t fd);
94 sg_size_t   file_tell(smx_file_t fd);
95 int         file_seek(smx_file_t fd, sg_offset_t offset, int origin);
96 int         file_move(smx_file_t fd, const char* fullpath);
97
98 int        mc_random(int min, int max);
99 void       set_category(boost::intrusive_ptr<simgrid::kernel::activity::ActivityImpl> synchro, const char* category) [[nohandler]];
100
101 void       run_kernel(std::function<void()> const* code) [[nohandler]];
102 void       run_blocking(std::function<void()> const* code) [[block,nohandler]];