Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Modified some functions and datatypes. Simix API changed too.
[simgrid.git] / src / include / simix / simix.h
1 /*      $Id$     */
2
3 /* Copyright (c) 2007 Arnaud Legrand, Bruno Donnassolo.
4    All rights reserved.                                          */
5
6 /* This program is free software; you can redistribute it and/or modify it
7  * under the terms of the license (GNU LGPL) which comes with this package. */
8
9 #ifndef _SIMIX_SIMIX_H
10 #define _SIMIX_SIMIX_H
11
12 #include "xbt/misc.h"
13 #include "xbt/fifo.h"
14 #include "simix/datatypes.h"
15
16 SG_BEGIN_DECL()
17
18
19 /************************** Global ******************************************/
20 XBT_PUBLIC(void) SIMIX_config(const char *name, ...);
21 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
22 XBT_PUBLIC(void) SIMIX_global_init_args(int *argc, char **argv);
23 XBT_PUBLIC(void) SIMIX_clean(void);
24 XBT_PUBLIC(void) SIMIX_function_register(const char *name, smx_process_code_t code);
25 XBT_PUBLIC(smx_process_code_t) SIMIX_get_registered_function(const char *name);
26
27 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
28
29 XBT_PUBLIC(double) SIMIX_get_clock(void);
30 XBT_PUBLIC(double) SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed);
31
32 /* Timer functions */
33 XBT_PUBLIC(void) SIMIX_timer_set (double date, void *function, void *arg);
34 XBT_PUBLIC(int) SIMIX_timer_get(void **function, void **arg);
35
36 /* only for tests */
37 XBT_PUBLIC(void) __SIMIX_main(void);
38 /************************** Host handling ***********************************/
39
40 XBT_PUBLIC(void) SIMIX_host_set_data(smx_host_t host, void *data);
41 XBT_PUBLIC(void*) SIMIX_host_get_data(smx_host_t host);
42
43 XBT_PUBLIC(const char *) SIMIX_host_get_name(smx_host_t host);
44 XBT_PUBLIC(smx_host_t) SIMIX_host_self(void);
45 XBT_PUBLIC(double) SIMIX_host_get_speed(smx_host_t host);
46 XBT_PUBLIC(double) SIMIX_host_get_available_speed(smx_host_t host);
47
48 XBT_PUBLIC(int) SIMIX_host_get_number(void);
49 XBT_PUBLIC(smx_host_t *)SIMIX_host_get_table(void);
50
51 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
52 XBT_PUBLIC(smx_host_t) SIMIX_host_get_by_name(const char *name);
53
54 /* Two possible states, 1 - CPU ON and 0 CPU OFF */
55 XBT_PUBLIC(int) SIMIX_host_get_state(smx_host_t host);
56
57 /************************** Process handling *********************************/
58 XBT_PUBLIC(smx_process_t) SIMIX_process_create(const char *name,
59                                smx_process_code_t code, void *data,
60                                smx_host_t host);
61 XBT_PUBLIC(smx_process_t) SIMIX_process_create_with_arguments(const char *name,
62                                               smx_process_code_t code, void *data,
63                                               smx_host_t host, int argc, char **argv);
64 XBT_PUBLIC(void) SIMIX_process_kill(smx_process_t process);
65 XBT_PUBLIC(void) SIMIX_process_killall(void);
66
67 //above layer
68 XBT_PUBLIC(void*) SIMIX_process_get_data(smx_process_t process);
69 XBT_PUBLIC(void) SIMIX_process_set_data(smx_process_t process, void *data);
70
71 XBT_PUBLIC(smx_host_t) SIMIX_process_get_host(smx_process_t process);
72 XBT_PUBLIC(const char *)SIMIX_process_get_name(smx_process_t process);
73 XBT_PUBLIC(smx_process_t) SIMIX_process_self(void);
74
75 XBT_PUBLIC(void) SIMIX_process_suspend(smx_process_t process);
76 XBT_PUBLIC(void) SIMIX_process_resume(smx_process_t process);
77 XBT_PUBLIC(int) SIMIX_process_is_suspended(smx_process_t process);
78
79
80 /************************** Synchro handling **********************************/
81
82 /******Mutex******/
83 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_init(void);
84 XBT_PUBLIC(void) SIMIX_mutex_lock(smx_mutex_t mutex);
85 XBT_PUBLIC(int) SIMIX_mutex_trylock(smx_mutex_t mutex);
86 XBT_PUBLIC(void) SIMIX_mutex_unlock(smx_mutex_t mutex);
87 XBT_PUBLIC(void) SIMIX_mutex_destroy(smx_mutex_t mutex);
88
89 /*****Conditional*****/
90 XBT_PUBLIC(smx_cond_t) SIMIX_cond_init(void);
91 XBT_PUBLIC(void) SIMIX_cond_signal(smx_cond_t cond);
92 XBT_PUBLIC(void) SIMIX_cond_wait(smx_cond_t cond,smx_mutex_t mutex);
93 XBT_PUBLIC(void) SIMIX_cond_wait_timeout(smx_cond_t cond,smx_mutex_t mutex, double max_duration);
94 XBT_PUBLIC(void) SIMIX_cond_broadcast(smx_cond_t cond);
95 XBT_PUBLIC(void) SIMIX_cond_destroy(smx_cond_t cond);
96 XBT_PUBLIC(void) SIMIX_register_condition_to_action(smx_action_t action, smx_cond_t cond);
97
98
99 /************************** Action handling ************************************/
100 XBT_PUBLIC(smx_action_t) SIMIX_action_communicate(smx_host_t sender,smx_host_t receiver, char *name,
101                                                                                                                                                                                                         double size, double rate);
102 XBT_PUBLIC(smx_action_t) SIMIX_action_execute(smx_host_t host,char *name, double amount);
103 XBT_PUBLIC(smx_action_t) SIMIX_action_sleep(smx_host_t host, double amount);
104 XBT_PUBLIC(void) SIMIX_action_cancel(smx_action_t action);
105 XBT_PUBLIC(void) SIMIX_action_set_priority(smx_action_t action, double priority);
106 XBT_PUBLIC(void) SIMIX_action_destroy(smx_action_t action);
107 XBT_PUBLIC(void) SIMIX_register_action_to_condition(smx_action_t action, smx_cond_t cond);
108
109 /*Not implemented yet */
110 XBT_PUBLIC(smx_action_t) SIMIX_action_parallel_execute(int workstation_nb,      
111                                                                                                                                                                                                                         void **workstation_list,
112                                                                                                                                                                                                                         double *computation_amount,
113                                                                                                                                                                                                                         double *communication_amount,
114                                                                                                                                                                                                                         double amount,
115                                                                                                                                                                                                                         double rate);
116
117
118 SG_END_DECL()
119
120 #endif                          /* _SIMIX_SIMIX_H */