1 This file lists the symbols ignored in the documentation.
2 It follows the RST syntact but is completely ignored by sphinx.
3 It is only used by find-missing, that will not report any definition linked here as missing.
5 # These ones trigger a bug in autodoxy, that get confused with the const in the function parameter
6 # So I document them manually in the rst for now. Shame, weak.
7 .. autodoxyvar:: simgrid::s4u::Link::on_communicate
8 .. autodoxyvar:: simgrid::s4u::Actor::on_host_change
9 .. autodoxyvar:: simgrid::s4u::Exec::on_completion
10 .. autodoxyvar:: simgrid::s4u::Exec::on_start
12 # This is a bug in find-missing, as these symbols are actually documented
13 .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency)
14 .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl * > &links, double *latency)
17 # These could be hidden as private things, eg in s4u_Exec.cpp
18 .. autodoxymethod:: simgrid::s4u::ExecPar::get_remaining()
19 .. autodoxymethod:: simgrid::s4u::ExecPar::get_remaining_ratio()
20 .. autodoxymethod:: simgrid::s4u::ExecPar::start()
21 .. autodoxymethod:: simgrid::s4u::ExecSeq::get_remaining()
22 .. autodoxymethod:: simgrid::s4u::ExecSeq::get_remaining_ratio()
23 .. autodoxymethod:: simgrid::s4u::ExecSeq::set_host(Host *host)
24 .. autodoxymethod:: simgrid::s4u::ExecSeq::start()
26 # I don't plan to document MSG in the new way.
27 .. autodoxymethod:: ::MSG_barrier_destroy(const_sg_bar_t bar)
28 .. autodoxymethod:: ::MSG_barrier_init(unsigned int count)
29 .. autodoxymethod:: ::MSG_barrier_wait(msg_bar_t bar)
30 .. autodoxymethod:: ::MSG_comm_destroy(const_msg_comm_t comm)
31 .. autodoxymethod:: ::MSG_comm_get_status(const_msg_comm_t comm)
32 .. autodoxymethod:: ::MSG_comm_get_task(const_msg_comm_t comm)
33 .. autodoxymethod:: ::MSG_comm_test(msg_comm_t comm)
34 .. autodoxymethod:: ::MSG_comm_testany(const_xbt_dynar_t comms)
35 .. autodoxymethod:: ::MSG_comm_wait(msg_comm_t comm, double timeout)
36 .. autodoxymethod:: ::MSG_comm_waitall(msg_comm_t *comm, int nb_elem, double timeout)
37 .. autodoxymethod:: ::MSG_comm_waitany(const_xbt_dynar_t comms)
38 .. autodoxymethod:: ::MSG_config(const char *key, const char *value)
39 .. autodoxymethod:: ::MSG_create_environment(const char *file)
40 .. autodoxymethod:: ::MSG_function_register(const char *name, xbt_main_func_t code)
41 .. autodoxymethod:: ::MSG_function_register_default(xbt_main_func_t code)
42 .. autodoxymethod:: ::MSG_get_clock()
43 .. autodoxymethod:: ::MSG_get_host_by_name(const char *name)
44 .. autodoxymethod:: ::MSG_get_host_number()
45 .. autodoxymethod:: ::MSG_get_sent_msg()
46 .. autodoxymethod:: ::MSG_host_by_name(const char *name)
47 .. autodoxymethod:: ::MSG_host_get_attached_storage_lists(const_sg_host_t host)
48 .. autodoxymethod:: ::MSG_host_get_core_number(const_sg_host_t host)
49 .. autodoxymethod:: ::MSG_host_get_data(const_sg_host_t host)
50 .. autodoxymethod:: ::MSG_host_get_load(const_sg_host_t host)
51 .. autodoxymethod:: ::MSG_host_get_mounted_storage_list(sg_host_t host)
52 .. autodoxymethod:: ::MSG_host_get_name(const_sg_host_t host)
53 .. autodoxymethod:: ::MSG_host_get_nb_pstates(const_sg_host_t host)
54 .. autodoxymethod:: ::MSG_host_get_power_peak_at(const_sg_host_t host, int pstate_index)
55 .. autodoxymethod:: ::MSG_host_get_process_list(const_sg_host_t host, xbt_dynar_t whereto)
56 .. autodoxymethod:: ::MSG_host_get_properties(const_sg_host_t host)
57 .. autodoxymethod:: ::MSG_host_get_property_value(const_sg_host_t host, const char *name)
58 .. autodoxymethod:: ::MSG_host_get_pstate(const_sg_host_t host)
59 .. autodoxymethod:: ::MSG_host_get_speed(const_sg_host_t host)
60 .. autodoxymethod:: ::MSG_host_is_on(const_sg_host_t h)
61 .. autodoxymethod:: ::MSG_host_off(sg_host_t h)
62 .. autodoxymethod:: ::MSG_host_on(sg_host_t h)
63 .. autodoxymethod:: ::MSG_host_self()
64 .. autodoxymethod:: ::MSG_host_set_data(sg_host_t host, void *data)
65 .. autodoxymethod:: ::MSG_host_set_property_value(sg_host_t host, const char *name, const char *value)
66 .. autodoxymethod:: ::MSG_host_set_pstate(sg_host_t host, int pstate)
67 .. autodoxymethod:: ::MSG_hosts_as_dynar()
68 .. autodoxymethod:: ::MSG_init_nocheck(int *argc, char **argv)
69 .. autodoxymethod:: ::MSG_launch_application(const char *file)
70 .. autodoxymethod:: ::MSG_mailbox_set_async(const char *alias)
71 .. autodoxymethod:: ::MSG_main()
72 .. autodoxymethod:: ::MSG_parallel_task_create(const char *name, int host_nb, const msg_host_t *host_list, double *flops_amount, double *bytes_amount, void *data)
73 .. autodoxymethod:: ::MSG_parallel_task_execute(msg_task_t task)
74 .. autodoxymethod:: ::MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout)
75 .. autodoxymethod:: ::MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
76 .. autodoxymethod:: ::MSG_process_auto_restart_set(msg_process_t process, int auto_restart)
77 .. autodoxymethod:: ::MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
78 .. autodoxymethod:: ::MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host, int argc, char **argv)
79 .. autodoxymethod:: ::MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host, int argc, char **argv, xbt_dict_t properties)
80 .. autodoxymethod:: ::MSG_process_daemonize(msg_process_t process)
81 .. autodoxymethod:: ::MSG_process_detach()
82 .. autodoxymethod:: ::MSG_process_from_PID(int pid)
83 .. autodoxymethod:: ::MSG_process_get_PID(const_sg_actor_t process)
84 .. autodoxymethod:: ::MSG_process_get_PPID(const_sg_actor_t process)
85 .. autodoxymethod:: ::MSG_process_get_data(const_sg_actor_t process)
86 .. autodoxymethod:: ::MSG_process_get_host(const_sg_actor_t process)
87 .. autodoxymethod:: ::MSG_process_get_name(const_sg_actor_t process)
88 .. autodoxymethod:: ::MSG_process_get_number()
89 .. autodoxymethod:: ::MSG_process_get_properties(const_sg_actor_t process)
90 .. autodoxymethod:: ::MSG_process_get_property_value(const_sg_actor_t process, const char *name)
91 .. autodoxymethod:: ::MSG_process_is_suspended(msg_process_t process)
92 .. autodoxymethod:: ::MSG_process_join(msg_process_t process, double timeout)
93 .. autodoxymethod:: ::MSG_process_kill(msg_process_t process)
94 .. autodoxymethod:: ::MSG_process_killall()
95 .. autodoxymethod:: ::MSG_process_migrate(msg_process_t process, msg_host_t host)
96 .. autodoxymethod:: ::MSG_process_on_exit(int_f_int_pvoid_t fun, void *data)
97 .. autodoxymethod:: ::MSG_process_ref(const_sg_actor_t process)
98 .. autodoxymethod:: ::MSG_process_restart(msg_process_t process)
99 .. autodoxymethod:: ::MSG_process_resume(msg_process_t process)
100 .. autodoxymethod:: ::MSG_process_self()
101 .. autodoxymethod:: ::MSG_process_self_PID()
102 .. autodoxymethod:: ::MSG_process_self_PPID()
103 .. autodoxymethod:: ::MSG_process_self_name()
104 .. autodoxymethod:: ::MSG_process_set_data(msg_process_t process, void *data)
105 .. autodoxymethod:: ::MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
106 .. autodoxymethod:: ::MSG_process_set_kill_time(msg_process_t process, double kill_time)
107 .. autodoxymethod:: ::MSG_process_sleep(double nb_sec)
108 .. autodoxymethod:: ::MSG_process_suspend(msg_process_t process)
109 .. autodoxymethod:: ::MSG_process_unref(const_sg_actor_t process)
110 .. autodoxymethod:: ::MSG_process_yield()
111 .. autodoxymethod:: ::MSG_processes_as_dynar()
112 .. autodoxymethod:: ::MSG_sem_acquire(msg_sem_t sem)
113 .. autodoxymethod:: ::MSG_sem_acquire_timeout(msg_sem_t sem, double timeout)
114 .. autodoxymethod:: ::MSG_sem_destroy(const_sg_sem_t sem)
115 .. autodoxymethod:: ::MSG_sem_get_capacity(msg_sem_t sem)
116 .. autodoxymethod:: ::MSG_sem_init(int initial_value)
117 .. autodoxymethod:: ::MSG_sem_release(msg_sem_t sem)
118 .. autodoxymethod:: ::MSG_sem_would_block(msg_sem_t sem)
119 .. autodoxymethod:: ::MSG_storage_get_by_name(const char *name)
120 .. autodoxymethod:: ::MSG_storage_get_data(const_sg_storage_t storage)
121 .. autodoxymethod:: ::MSG_storage_get_host(const_sg_storage_t storage)
122 .. autodoxymethod:: ::MSG_storage_get_name(const_sg_storage_t storage)
123 .. autodoxymethod:: ::MSG_storage_get_properties(const_sg_storage_t storage)
124 .. autodoxymethod:: ::MSG_storage_get_property_value(const_sg_storage_t storage, const char *name)
125 .. autodoxymethod:: ::MSG_storage_read(msg_storage_t storage, sg_size_t size)
126 .. autodoxymethod:: ::MSG_storage_set_data(msg_storage_t storage, void *data)
127 .. autodoxymethod:: ::MSG_storage_set_property_value(msg_storage_t storage, const char *name, const char *value)
128 .. autodoxymethod:: ::MSG_storage_write(msg_storage_t storage, sg_size_t size)
129 .. autodoxymethod:: ::MSG_storages_as_dynar()
130 .. autodoxymethod:: ::MSG_task_cancel(msg_task_t task)
131 .. autodoxymethod:: ::MSG_task_create(const char *name, double flops_amount, double bytes_amount, void *data)
132 .. autodoxymethod:: ::MSG_task_destroy(msg_task_t task)
133 .. autodoxymethod:: ::MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup)
134 .. autodoxymethod:: ::MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate)
135 .. autodoxymethod:: ::MSG_task_execute(msg_task_t task)
136 .. autodoxymethod:: ::MSG_task_get_bytes_amount(const_msg_task_t task)
137 .. autodoxymethod:: ::MSG_task_get_category(const_msg_task_t task)
138 .. autodoxymethod:: ::MSG_task_get_data(const_msg_task_t task)
139 .. autodoxymethod:: ::MSG_task_get_flops_amount(const_msg_task_t task)
140 .. autodoxymethod:: ::MSG_task_get_name(const_msg_task_t task)
141 .. autodoxymethod:: ::MSG_task_get_remaining_communication(const_msg_task_t task)
142 .. autodoxymethod:: ::MSG_task_get_remaining_work_ratio(const_msg_task_t task)
143 .. autodoxymethod:: ::MSG_task_get_sender(const_msg_task_t task)
144 .. autodoxymethod:: ::MSG_task_get_source(const_msg_task_t task)
145 .. autodoxymethod:: ::MSG_task_irecv(msg_task_t *task, const char *alias)
146 .. autodoxymethod:: ::MSG_task_irecv_bounded(msg_task_t *task, const char *alias, double rate)
147 .. autodoxymethod:: ::MSG_task_isend(msg_task_t task, const char *alias)
148 .. autodoxymethod:: ::MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate)
149 .. autodoxymethod:: ::MSG_task_listen(const char *alias)
150 .. autodoxymethod:: ::MSG_task_listen_from(const char *alias)
151 .. autodoxymethod:: ::MSG_task_receive(msg_task_t *task, const char *alias)
152 .. autodoxymethod:: ::MSG_task_receive_bounded(msg_task_t *task, const char *alias, double rate)
153 .. autodoxymethod:: ::MSG_task_receive_with_timeout(msg_task_t *task, const char *alias, double timeout)
154 .. autodoxymethod:: ::MSG_task_receive_with_timeout_bounded(msg_task_t *task, const char *alias, double timeout, double rate)
155 .. autodoxymethod:: ::MSG_task_send(msg_task_t task, const char *alias)
156 .. autodoxymethod:: ::MSG_task_send_bounded(msg_task_t task, const char *alias, double rate)
157 .. autodoxymethod:: ::MSG_task_send_with_timeout(msg_task_t task, const char *alias, double timeout)
158 .. autodoxymethod:: ::MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate)
159 .. autodoxymethod:: ::MSG_task_set_bound(msg_task_t task, double bound)
160 .. autodoxymethod:: ::MSG_task_set_bytes_amount(msg_task_t task, double bytes_amount)
161 .. autodoxymethod:: ::MSG_task_set_category(msg_task_t task, const char *category)
162 .. autodoxymethod:: ::MSG_task_set_data(msg_task_t task, void *data)
163 .. autodoxymethod:: ::MSG_task_set_flops_amount(msg_task_t task, double flops_amount)
164 .. autodoxymethod:: ::MSG_task_set_name(msg_task_t task, const char *name)
165 .. autodoxymethod:: ::MSG_task_set_priority(msg_task_t task, double priority)
166 .. autodoxymethod:: ::MSG_vm_create_core(msg_host_t pm, const char *name)
167 .. autodoxymethod:: ::MSG_vm_create_multicore(msg_host_t pm, const char *name, int coreAmount)
168 .. autodoxymethod:: ::MSG_vm_destroy(msg_vm_t vm)
169 .. autodoxymethod:: ::MSG_vm_get_name(const_sg_vm_t vm)
170 .. autodoxymethod:: ::MSG_vm_get_pm(const_sg_vm_t vm)
171 .. autodoxymethod:: ::MSG_vm_get_ramsize(const_sg_vm_t vm)
172 .. autodoxymethod:: ::MSG_vm_is_created(msg_vm_t vm)
173 .. autodoxymethod:: ::MSG_vm_is_running(msg_vm_t vm)
174 .. autodoxymethod:: ::MSG_vm_is_suspended(msg_vm_t vm)
175 .. autodoxymethod:: ::MSG_vm_resume(msg_vm_t vm)
176 .. autodoxymethod:: ::MSG_vm_set_bound(msg_vm_t vm, double bound)
177 .. autodoxymethod:: ::MSG_vm_set_ramsize(msg_vm_t vm, size_t size)
178 .. autodoxymethod:: ::MSG_vm_shutdown(msg_vm_t vm)
179 .. autodoxymethod:: ::MSG_vm_start(msg_vm_t vm)
180 .. autodoxymethod:: ::MSG_vm_suspend(msg_vm_t vm)
181 .. autodoxymethod:: ::MSG_zone_get_by_name(const char *name)
182 .. autodoxymethod:: ::MSG_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto)
183 .. autodoxymethod:: ::MSG_zone_get_name(const_sg_netzone_t zone)
184 .. autodoxymethod:: ::MSG_zone_get_property_value(const_sg_netzone_t zone, const char *name)
185 .. autodoxymethod:: ::MSG_zone_get_root()
186 .. autodoxymethod:: ::MSG_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
187 .. autodoxymethod:: ::MSG_zone_set_property_value(msg_netzone_t zone, const char *name, const char *value)
188 member ::MIN is of kind define
189 member ::MAX is of kind define
190 member ::MSG_TASK_UNINITIALIZED is of kind define
191 member ::MSG_init is of kind define
192 member ::MSG_task_recv is of kind define
193 member ::MSG_task_recv_bounded is of kind define
194 member ::msg_error_t is of kind enum
197 .. autodoxymethod:: sg_host_get_attached_storage_list(const_sg_host_t host)
198 .. autodoxymethod:: sg_host_get_mounted_storage_list(sg_host_t host)
199 .. autodoxymethod:: simgrid::s4u::Host::get_attached_storages()
200 .. autodoxymethod:: simgrid::s4u::Host::get_mounted_storages()
202 # These should not be public
203 .. autodoxymethod:: simgrid::s4u::Link::get_impl()
204 .. autodoxymethod:: simgrid::s4u::NetZone::get_impl()
205 .. autodoxymethod:: simgrid::s4u::VirtualMachine::get_impl()
206 .. autodoxymethod:: simgrid::s4u::Activity::get_impl()
207 .. autodoxymethod:: simgrid::s4u::Comm::~Comm()
208 .. autodoxymethod:: simgrid::s4u::Exec::~Exec()
209 .. autodoxymethod:: simgrid::s4u::ExecPar::~ExecPar()
210 .. autodoxymethod:: simgrid::s4u::ExecSeq::~ExecSeq()
211 .. autodoxymethod:: simgrid::s4u::Io::~Io()
213 # These ones are a bug of Doxygen, that parse them as variables instead of types.
214 # So we don't use this bogus parse result, but go directly for cpp:type directives in app_s4u.rst
215 .. autodoxyvar:: ::const_sg_actor_t
216 .. autodoxyvar:: ::const_sg_bar_t
217 .. autodoxyvar:: ::const_sg_mutex_t
218 .. autodoxyvar:: ::const_sg_sem_t
219 .. autodoxyvar:: ::const_sg_host_t
220 .. autodoxyvar:: ::const_sg_storage_t
221 .. autodoxyvar:: ::const_msg_comm_t
222 .. autodoxyvar:: ::const_msg_task_t
223 .. autodoxyvar:: ::const_sg_cond_t
224 .. autodoxyvar:: ::const_sg_disk_t
225 .. autodoxyvar:: ::const_sg_file_t
226 .. autodoxyvar:: ::const_sg_link_t
227 .. autodoxyvar:: ::const_sg_netzone_t
228 .. autodoxyvar:: ::const_sg_vm_t
