3 /* Copyright (c) 2007 Arnaud Legrand, Bruno Donnassolo.
4 All rights reserved. */
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. */
10 #define _SIMIX_SIMIX_H
14 #include "simix/datatypes.h"
15 #include "surf/surf.h"
20 /************************** Global ******************************************/
21 XBT_PUBLIC(void) SIMIX_config(const char *name, va_list pa);
22 XBT_PUBLIC(void) SIMIX_global_init(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);
27 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
29 XBT_PUBLIC(double) SIMIX_get_clock(void);
30 XBT_PUBLIC(double) SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed);
33 XBT_PUBLIC(void) SIMIX_timer_set (double date, void *function, void *arg);
34 XBT_PUBLIC(int) SIMIX_timer_get(void **function, void **arg);
37 XBT_PUBLIC(void) __SIMIX_main(void);
39 /* User create and kill process, the function must accept the folling parameters:
40 * const char *name: a name for the object. It is for user-level information and can be NULL
41 * smx_process_code_t code: is a function describing the behavior of the agent
42 * void *data: data a pointer to any data one may want to attach to the new object.
43 * smx_host_t host: the location where the new agent is executed
44 * int argc, char **argv: parameters passed to code
47 XBT_PUBLIC(void) SIMIX_function_register_process_create(void * function);
48 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void * function);
50 /************************** Host handling ***********************************/
52 XBT_PUBLIC(void) SIMIX_host_set_data(smx_host_t host, void *data);
53 XBT_PUBLIC(void*) SIMIX_host_get_data(smx_host_t host);
55 XBT_PUBLIC(const char *) SIMIX_host_get_name(smx_host_t host);
56 XBT_PUBLIC(smx_host_t) SIMIX_host_self(void);
57 XBT_PUBLIC(double) SIMIX_host_get_speed(smx_host_t host);
58 XBT_PUBLIC(double) SIMIX_host_get_available_speed(smx_host_t host);
60 XBT_PUBLIC(int) SIMIX_host_get_number(void);
61 XBT_PUBLIC(smx_host_t *)SIMIX_host_get_table(void);
63 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
64 XBT_PUBLIC(smx_host_t) SIMIX_host_get_by_name(const char *name);
66 /* Two possible states, 1 - CPU ON and 0 CPU OFF */
67 XBT_PUBLIC(int) SIMIX_host_get_state(smx_host_t host);
69 /************************** Process handling *********************************/
70 XBT_PUBLIC(smx_process_t) SIMIX_process_create(const char *name,
71 smx_process_code_t code, void *data,
72 const char * hostname, int argc, char **argv,
73 void * clean_process_function);
75 XBT_PUBLIC(void) SIMIX_jprocess_create(const char *name,
78 void *jprocess, void *jenv,
79 void * clean_process_function,
82 XBT_PUBLIC(void) SIMIX_process_kill(smx_process_t process);
83 XBT_PUBLIC(void) SIMIX_process_cleanup(void *arg);
84 XBT_PUBLIC(void) SIMIX_process_killall(void);
87 XBT_PUBLIC(void*) SIMIX_process_get_data(smx_process_t process);
88 XBT_PUBLIC(void) SIMIX_process_set_data(smx_process_t process, void *data);
90 XBT_PUBLIC(smx_host_t) SIMIX_process_get_host(smx_process_t process);
91 XBT_PUBLIC(const char *)SIMIX_process_get_name(smx_process_t process);
92 XBT_PUBLIC(smx_process_t) SIMIX_process_self(void);
94 XBT_PUBLIC(void) SIMIX_process_suspend(smx_process_t process);
95 XBT_PUBLIC(void) SIMIX_process_resume(smx_process_t process);
96 XBT_PUBLIC(int) SIMIX_process_is_suspended(smx_process_t process);
99 /************************** Synchro handling **********************************/
102 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_init(void);
103 XBT_PUBLIC(void) SIMIX_mutex_lock(smx_mutex_t mutex);
104 XBT_PUBLIC(int) SIMIX_mutex_trylock(smx_mutex_t mutex);
105 XBT_PUBLIC(void) SIMIX_mutex_unlock(smx_mutex_t mutex);
106 XBT_PUBLIC(void) SIMIX_mutex_destroy(smx_mutex_t mutex);
108 /*****Conditional*****/
109 XBT_PUBLIC(smx_cond_t) SIMIX_cond_init(void);
110 XBT_PUBLIC(void) SIMIX_cond_signal(smx_cond_t cond);
111 XBT_PUBLIC(void) SIMIX_cond_wait(smx_cond_t cond,smx_mutex_t mutex);
112 XBT_PUBLIC(void) SIMIX_cond_wait_timeout(smx_cond_t cond,smx_mutex_t mutex, double max_duration);
113 XBT_PUBLIC(void) SIMIX_cond_broadcast(smx_cond_t cond);
114 XBT_PUBLIC(void) SIMIX_cond_destroy(smx_cond_t cond);
115 XBT_PUBLIC(void) SIMIX_register_condition_to_action(smx_action_t action, smx_cond_t cond);
116 XBT_PUBLIC(xbt_fifo_t) SIMIX_cond_get_actions(smx_cond_t cond);
119 /************************** Action handling ************************************/
120 XBT_PUBLIC(smx_action_t) SIMIX_action_communicate(smx_host_t sender,smx_host_t receiver, char *name,
121 double size, double rate);
122 XBT_PUBLIC(smx_action_t) SIMIX_action_execute(smx_host_t host,char *name, double amount);
123 XBT_PUBLIC(smx_action_t) SIMIX_action_sleep(smx_host_t host, double amount);
124 XBT_PUBLIC(void) SIMIX_action_cancel(smx_action_t action);
125 XBT_PUBLIC(void) SIMIX_action_set_priority(smx_action_t action, double priority);
126 XBT_PUBLIC(void) SIMIX_action_destroy(smx_action_t action);
127 XBT_PUBLIC(void) SIMIX_register_action_to_condition(smx_action_t action, smx_cond_t cond);
128 XBT_PUBLIC(double) SIMIX_action_get_remains(smx_action_t action);
130 XBT_PUBLIC(e_surf_action_state_t) SIMIX_action_get_state(smx_action_t action);
132 /*Not implemented yet */
133 XBT_PUBLIC(smx_action_t) SIMIX_action_parallel_execute(char * name,
135 void **workstation_list,
136 double *computation_amount,
137 double *communication_amount,
141 void SIMIX_display_process_status(void);
143 /* Helper functions for jMSG: manipulate the context data without breaking the module separation */
144 void SIMIX_process_set_jprocess(smx_process_t process, void *jp);
145 void* SIMIX_process_get_jprocess(smx_process_t process);
146 void SIMIX_process_set_jmutex(smx_process_t process, void *jm);
147 void* SIMIX_process_get_jmutex(smx_process_t process);
148 void SIMIX_process_set_jcond(smx_process_t process, void *jc);
149 void* SIMIX_process_get_jcond(smx_process_t process);
150 void SIMIX_process_set_jenv(smx_process_t process, void *je);
151 void* SIMIX_process_get_jenv(smx_process_t process);
156 #endif /* _SIMIX_SIMIX_H */