Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
a5932f27e376d09d68f54cae7521f20a1d1b8ab7
[simgrid.git] / src / include / simix / simix.h
1 /*      $Id$     */
2
3 /* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved.        */
4
5 /* This program is free software; you can redistribute it and/or modify it
6  * under the terms of the license (GNU LGPL) which comes with this package. */
7
8 #ifndef _SIMIX_SIMIX_H
9 #define _SIMIX_SIMIX_H
10
11 #include "xbt/misc.h"
12 #include "simix/datatypes.h"
13
14 SG_BEGIN_DECL()
15
16
17 /************************** Global ******************************************/
18 XBT_PUBLIC(void) SIMIX_config(const char *name, ...);
19 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
20 XBT_PUBLIC(void) SIMIX_global_init_args(int *argc, char **argv);
21 XBT_PUBLIC(SIMIX_error_t) SIMIX_main(void);
22 XBT_PUBLIC(SIMIX_error_t) SIMIX_clean(void);
23 XBT_PUBLIC(void) SIMIX_function_register(const char *name, smx_process_code_t code);
24 XBT_PUBLIC(smx_process_code_t) SIMIX_get_registered_function(const char *name);
25 // SIMIX_deploy_application???
26 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
27
28 XBT_PUBLIC(double) SIMIX_get_clock(void);
29
30 /************************** Host handling ***********************************/
31 //pointer to above layer
32 XBT_PUBLIC(SIMIX_error_t) SIMIX_host_set_data(smx_host_t host, void *data);
33 XBT_PUBLIC(void*) SIMIX_host_get_data(smx_host_t host);
34
35 XBT_PUBLIC(const char *) SIMIX_host_get_name(smx_host_t host);
36 XBT_PUBLIC(smx_host_t) SIMIX_host_self(void);
37 /* int SIMIX_get_msgload(void); This function lacks specification; discard it */
38 XBT_PUBLIC(double) SIMIX_get_host_speed(smx_host_t h);
39 XBT_PUBLIC(int) SIMIX_host_is_avail (smx_host_t h);
40
41 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
42
43 XBT_PUBLIC(smx_host_t) SIMIX_get_host_by_name(const char *name);
44 XBT_PUBLIC(int) SIMIX_get_host_number(void);
45 XBT_PUBLIC(smx_host_t *)SIMIX_get_host_table(void);
46
47 /************************** Process handling *********************************/
48 XBT_PUBLIC(smx_process_t) SIMIX_process_create(const char *name,
49                                smx_process_code_t code, void *data,
50                                smx_host_t host);
51 XBT_PUBLIC(smx_process_t) SIMIX_process_create_with_arguments(const char *name,
52                                               smx_process_code_t code, void *data,
53                                               smx_host_t host, int argc, char **argv);
54 XBT_PUBLIC(void) SIMIX_process_kill(smx_process_t process);
55 XBT_PUBLIC(void) SIMIX_process_killall(void);
56
57 XBT_PUBLIC(SIMIX_error_t) SIMIX_process_change_host(smx_process_t process, smx_host_t host);
58 //above layer
59 XBT_PUBLIC(void*) SIMIX_process_get_data(smx_process_t process);
60 XBT_PUBLIC(SIMIX_error_t) SIMIX_process_set_data(smx_process_t process, void *data);
61
62 XBT_PUBLIC(smx_host_t) SIMIX_process_get_host(smx_process_t process);
63 XBT_PUBLIC(const char *)SIMIX_process_get_name(smx_process_t process);
64 XBT_PUBLIC(smx_process_t) SIMIX_process_self(void);
65
66 XBT_PUBLIC(SIMIX_error_t) SIMIX_process_suspend(smx_process_t process);
67 XBT_PUBLIC(SIMIX_error_t) SIMIX_process_resume(smx_process_t process);
68 XBT_PUBLIC(int) SIMIX_process_is_suspended(smx_process_t process);
69
70 XBT_PUBLIC(SIMIX_error_t) SIMIX_process_sleep(double nb_sec);
71 XBT_PUBLIC(SIMIX_error_t) SIMIX_get_errno(void);
72
73 /************************** Synchro handling **********************************/
74
75 /******Mutex******/
76 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_init(void);
77 XBT_PUBLIC(void) SIMIX_mutex_lock(smx_mutex_t mutex);
78 XBT_PUBLIC(void) SIMIX_mutex_trylock(smx_mutex_t mutex);
79 XBT_PUBLIC(void) SIMIX_mutex_unlock(smx_mutex_t mutex);
80 XBT_PUBLIC(void) SIMIX_mutex_destroy(smx_mutex_t mutex);
81
82 /*****Conditional*****/
83 XBT_PUBLIC(smx_cond_t) SIMIX_cond_init(void);
84 XBT_PUBLIC(void) SIMIX_cond_signal(smx_cond_t cond);
85 XBT_PUBLIC(void) SIMIX_cond_wait(smx_cond_t cond,smx_mutex_t mutex);
86 XBT_PUBLIC(void) SIMIX_cond_wait_timeout(smx_cond_t cond,smx_mutex_t mutex, double max_duration);
87 XBT_PUBLIC(void) SIMIX_cond_broadcast(smx_cond_t cond);
88 XBT_PUBLIC(void) SIMIX_cond_destroy(smx_cond_t cond);
89
90
91 /************************** Action handling ************************************/
92 XBT_PUBLIC(smx_action_t) SIMIX_communicate(smx_host_t sender,smx_host_t receiver, double size);
93 XBT_PUBLIC(smx_action_t) SIMIX_execute(smx_host_t host,double amount);
94 XBT_PUBLIC(SIMIX_error_t) SIMIX_action_cancel(smx_action_t action);
95 XBT_PUBLIC(void) SIMIX_action_set_priority(smx_action_t action, double priority);
96 XBT_PUBLIC(SIMIX_error_t) SIMIX_action_destroy(smx_action_t action);
97
98 //SIMIX_action_wait_for_computation(smx_process_t process, smx_action_t action);
99
100 SG_END_DECL()
101 #endif                          /* _SIMIX_SIMIX_H */