1 /* Copyright (c) 2007, 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #ifndef _SIMIX_SMURF_PRIVATE_H
8 #define _SIMIX_SMURF_PRIVATE_H
10 /********************************* Simcalls *********************************/
12 /* we want to build the e_smx_simcall_t enumeration and the table of the
13 * corresponding strings automatically, using macros */
15 #define SIMCALL_LIST1 \
16 SIMCALL_ENUM_ELEMENT(SIMCALL_NONE),\
17 SIMCALL_ENUM_ELEMENT(SIMCALL_HOST_GET_BY_NAME),\
18 SIMCALL_ENUM_ELEMENT(SIMCALL_HOST_GET_NAME),\
19 SIMCALL_ENUM_ELEMENT(SIMCALL_HOST_GET_PROPERTIES),\
20 SIMCALL_ENUM_ELEMENT(SIMCALL_HOST_GET_SPEED),\
21 SIMCALL_ENUM_ELEMENT(SIMCALL_HOST_GET_AVAILABLE_SPEED),\
22 SIMCALL_ENUM_ELEMENT(SIMCALL_HOST_GET_STATE),\
23 SIMCALL_ENUM_ELEMENT(SIMCALL_HOST_GET_DATA),\
24 SIMCALL_ENUM_ELEMENT(SIMCALL_HOST_SET_DATA),\
25 SIMCALL_ENUM_ELEMENT(SIMCALL_HOST_EXECUTE),\
26 SIMCALL_ENUM_ELEMENT(SIMCALL_HOST_PARALLEL_EXECUTE),\
27 SIMCALL_ENUM_ELEMENT(SIMCALL_HOST_EXECUTION_DESTROY),\
28 SIMCALL_ENUM_ELEMENT(SIMCALL_HOST_EXECUTION_CANCEL),\
29 SIMCALL_ENUM_ELEMENT(SIMCALL_HOST_EXECUTION_GET_REMAINS),\
30 SIMCALL_ENUM_ELEMENT(SIMCALL_HOST_EXECUTION_GET_STATE),\
31 SIMCALL_ENUM_ELEMENT(SIMCALL_HOST_EXECUTION_SET_PRIORITY),\
32 SIMCALL_ENUM_ELEMENT(SIMCALL_HOST_EXECUTION_WAIT),\
33 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_CREATE),\
34 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_KILL),\
35 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_KILLALL),\
36 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_CLEANUP),\
37 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_CHANGE_HOST),\
38 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_SUSPEND),\
39 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_RESUME),\
40 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_COUNT),\
41 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_GET_DATA),\
42 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_SET_DATA),\
43 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_GET_HOST),\
44 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_GET_NAME),\
45 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_IS_SUSPENDED),\
46 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_GET_PROPERTIES),\
47 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_SLEEP),\
48 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_ON_EXIT),\
49 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_AUTO_RESTART_SET),\
50 SIMCALL_ENUM_ELEMENT(SIMCALL_PROCESS_RESTART),\
51 SIMCALL_ENUM_ELEMENT(SIMCALL_RDV_CREATE),\
52 SIMCALL_ENUM_ELEMENT(SIMCALL_RDV_DESTROY),\
53 SIMCALL_ENUM_ELEMENT(SIMCALL_RDV_GEY_BY_NAME),\
54 SIMCALL_ENUM_ELEMENT(SIMCALL_RDV_COMM_COUNT_BY_HOST),\
55 SIMCALL_ENUM_ELEMENT(SIMCALL_RDV_GET_HEAD),\
56 SIMCALL_ENUM_ELEMENT(SIMCALL_RDV_SET_RECV),\
57 SIMCALL_ENUM_ELEMENT(SIMCALL_RDV_GET_RECV),\
58 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_SEND),\
59 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_ISEND),\
60 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_RECV),\
61 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_IRECV),\
62 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_DESTROY),\
63 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_CANCEL),\
64 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_WAITANY),\
65 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_WAIT),\
66 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_TEST),\
67 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_TESTANY),\
68 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_IPROBE),\
69 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_GET_REMAINS),\
70 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_GET_STATE),\
71 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_GET_SRC_DATA),\
72 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_GET_DST_DATA),\
73 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_GET_SRC_PROC),\
74 SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_GET_DST_PROC),\
75 SIMCALL_ENUM_ELEMENT(SIMCALL_MUTEX_INIT),\
76 SIMCALL_ENUM_ELEMENT(SIMCALL_MUTEX_DESTROY),\
77 SIMCALL_ENUM_ELEMENT(SIMCALL_MUTEX_LOCK),\
78 SIMCALL_ENUM_ELEMENT(SIMCALL_MUTEX_TRYLOCK),\
79 SIMCALL_ENUM_ELEMENT(SIMCALL_MUTEX_UNLOCK),\
80 SIMCALL_ENUM_ELEMENT(SIMCALL_COND_INIT),\
81 SIMCALL_ENUM_ELEMENT(SIMCALL_COND_DESTROY),\
82 SIMCALL_ENUM_ELEMENT(SIMCALL_COND_SIGNAL),\
83 SIMCALL_ENUM_ELEMENT(SIMCALL_COND_WAIT),\
84 SIMCALL_ENUM_ELEMENT(SIMCALL_COND_WAIT_TIMEOUT),\
85 SIMCALL_ENUM_ELEMENT(SIMCALL_COND_BROADCAST),\
86 SIMCALL_ENUM_ELEMENT(SIMCALL_SEM_INIT),\
87 SIMCALL_ENUM_ELEMENT(SIMCALL_SEM_DESTROY),\
88 SIMCALL_ENUM_ELEMENT(SIMCALL_SEM_RELEASE),\
89 SIMCALL_ENUM_ELEMENT(SIMCALL_SEM_WOULD_BLOCK),\
90 SIMCALL_ENUM_ELEMENT(SIMCALL_SEM_ACQUIRE),\
91 SIMCALL_ENUM_ELEMENT(SIMCALL_SEM_ACQUIRE_TIMEOUT),\
92 SIMCALL_ENUM_ELEMENT(SIMCALL_SEM_GET_CAPACITY),\
93 SIMCALL_ENUM_ELEMENT(SIMCALL_FILE_READ),\
94 SIMCALL_ENUM_ELEMENT(SIMCALL_FILE_WRITE),\
95 SIMCALL_ENUM_ELEMENT(SIMCALL_FILE_OPEN),\
96 SIMCALL_ENUM_ELEMENT(SIMCALL_FILE_CLOSE),\
97 SIMCALL_ENUM_ELEMENT(SIMCALL_FILE_STAT), \
98 SIMCALL_ENUM_ELEMENT(SIMCALL_FILE_UNLINK),\
99 SIMCALL_ENUM_ELEMENT(SIMCALL_FILE_LS),\
100 SIMCALL_ENUM_ELEMENT(SIMCALL_ASR_GET_PROPERTIES), \
101 /* ****************************************************************************************** */ \
102 /* TUTORIAL: New API */ \
103 /* ****************************************************************************************** */ \
104 SIMCALL_ENUM_ELEMENT(SIMCALL_NEW_API_INIT)
106 /* SIMCALL_COMM_IS_LATENCY_BOUNDED and SIMCALL_SET_CATEGORY make things complicated
107 * because they are not always present */
108 #ifdef HAVE_LATENCY_BOUND_TRACKING
109 #define SIMCALL_LIST2 \
110 ,SIMCALL_ENUM_ELEMENT(SIMCALL_COMM_IS_LATENCY_BOUNDED)
112 #define SIMCALL_LIST2
116 #define SIMCALL_LIST3 \
117 ,SIMCALL_ENUM_ELEMENT(SIMCALL_SET_CATEGORY)
119 #define SIMCALL_LIST3
123 #define SIMCALL_LIST4 \
124 ,SIMCALL_ENUM_ELEMENT(SIMCALL_MC_SNAPSHOT) \
125 ,SIMCALL_ENUM_ELEMENT(SIMCALL_MC_COMPARE_SNAPSHOTS)
127 #define SIMCALL_LIST4
130 /* SIMCALL_LIST is the final macro to use */
131 #define SIMCALL_LIST SIMCALL_LIST1 SIMCALL_LIST2 SIMCALL_LIST3 SIMCALL_LIST4
133 /* you can redefine the following macro differently to generate something else
134 * with the list of enumeration values (e.g. a table of strings or a table of function pointers) */
135 #define SIMCALL_ENUM_ELEMENT(x) x
138 * \brief All possible simcalls.
145 * \brief Represents a simcall to the kernel.
147 typedef struct s_smx_simcall {
148 e_smx_simcall_t call;
149 smx_process_t issuer;
150 union u_smx_scalar *args;
151 //FIXME: union u_smx_scalar retval;
168 } host_get_properties;
178 } host_get_available_speed;
198 double computation_amount;
206 smx_host_t *host_list;
207 double *computation_amount;
208 double *communication_amount;
212 } host_parallel_execute;
215 smx_action_t execution;
216 } host_execution_destroy;
219 smx_action_t execution;
220 } host_execution_cancel;
223 smx_action_t execution;
225 } host_execution_get_remains;
228 smx_action_t execution;
229 e_smx_state_t result;
230 } host_execution_get_state;
233 smx_action_t execution;
235 } host_execution_set_priority;
238 smx_action_t execution;
239 e_smx_state_t result;
240 } host_execution_wait;
243 smx_process_t *process;
245 xbt_main_func_t code;
247 const char *hostname;
251 xbt_dict_t properties;
256 smx_process_t process;
260 smx_process_t process;
264 smx_process_t process;
266 } process_change_host;
269 smx_process_t process;
273 smx_process_t process;
281 smx_process_t process;
286 smx_process_t process;
291 smx_process_t process;
296 smx_process_t process;
301 smx_process_t process;
303 } process_is_suspended;
306 smx_process_t process;
308 } process_get_properties;
312 e_smx_state_t result;
316 smx_process_t process;
322 smx_process_t process;
324 } process_auto_restart;
327 smx_process_t process;
328 smx_process_t result;
349 } rdv_comm_count_by_host;
358 smx_process_t receiver;
363 smx_process_t result;
371 size_t src_buff_size;
372 int (*match_fun)(void *, void *, smx_action_t);
382 size_t src_buff_size;
383 int (*match_fun)(void *, void *, smx_action_t);
384 void (*clean_fun)(void *);
393 size_t *dst_buff_size;
394 int (*match_fun)(void *, void *, smx_action_t);
402 size_t *dst_buff_size;
403 int (*match_fun)(void *, void *, smx_action_t);
412 int (*match_fun)(void *, void *, smx_action_t);
452 e_smx_state_t result;
467 smx_process_t result;
472 smx_process_t result;
475 #ifdef HAVE_LATENCY_BOUND_TRACKING
479 } comm_is_latency_bounded;
485 const char *category;
562 } sem_acquire_timeout;
617 } asr_get_properties;
627 } mc_compare_snapshots;
629 /* ****************************************************************************************** */
630 /* TUTORIAL: New API */
631 /* ****************************************************************************************** */
639 } s_smx_simcall_t, *smx_simcall_t;
641 /******************************** General *************************************/
643 void SIMIX_simcall_push(smx_process_t self);
644 void SIMIX_simcall_answer(smx_simcall_t);
645 void SIMIX_simcall_pre(smx_simcall_t, int);
646 void SIMIX_simcall_post(smx_action_t);
647 smx_simcall_t SIMIX_simcall_mine(void);
648 const char *SIMIX_simcall_name(e_smx_simcall_t kind);
650 /*************************** New simcall interface ****************************/
652 /* Pack all possible scalar types in an union */
653 typedef union u_smx_scalar {
668 * Define scalar type wrappers to ease the use of simcalls.
669 * These are used to wrap the arguments in SIMIX_simcall macro.
671 #define CHAR(x) (c,x)
672 #define SHORT(x) (s,x)
674 #define LONG(x) (l,x)
675 #define UCHAR(x) (uc,x)
676 #define USHORT(x) (us,x)
677 #define UINT(x) (ui,x)
678 #define ULONG(x) (ul,x)
679 #define FLOAT(x) (f,x)
680 #define DOUBLE(x) (d,x)
686 * Some macro machinery to get a MAP over the arguments of a variadic macro.
687 * It uses a FOLD to apply a macro to every argument, and because there is
688 * no recursion in the C preprocessor we must create a new macro for every
689 * depth of FOLD's recursion.
693 #define FE_1(WHAT, X) WHAT(X)
694 #define FE_2(WHAT, X, ...) WHAT(X), FE_1(WHAT, __VA_ARGS__)
695 #define FE_3(WHAT, X, ...) WHAT(X), FE_2(WHAT, __VA_ARGS__)
696 #define FE_4(WHAT, X, ...) WHAT(X), FE_3(WHAT, __VA_ARGS__)
697 #define FE_5(WHAT, X, ...) WHAT(X), FE_4(WHAT, __VA_ARGS__)
698 /* NOTE: add as many FE_n as needed (maximum number of simcall arguments )*/
700 /* Make a MAP macro usgin FOLD (will apply 'action' to the arguments.
701 * GET_MACRO is a smart hack that counts the number of arguments passed to
702 * the variadic macro, and it is used to invoke the right FOLD depth.
704 #define GET_MACRO(_1,_2,_3,_4,_5,NAME,...) NAME
705 #define MAP(action,...) \
706 GET_MACRO(__VA_ARGS__,FE_5,FE_4,FE_3,FE_2,FE_1) (action, __VA_ARGS__)
709 /* Generate code to initialize the field 'x' with value 'y' of an structure or union */
710 #define INIT_FIELD_(x,y) {.x = y}
711 #define INIT_FIELD(t) INIT_FIELD_ t
713 /* Project the second element of a tuple */
714 #define SECOND_(x, y) y
715 #define SECOND(t) SECOND_ t
718 * \brief Simcall invocation macro
719 * It calls a dummy function that uses the format attribute to ensure typesafety (see
720 * gcc format attribute), then it invokes the real simcall function packing the
721 * user provided arguments in an array.
722 * \param id a simcall id (from the simcall enumeration ids)
725 #define SIMIX_simcall(id, ...) \
726 SIMIX_simcall_typecheck(simcall_types[id], MAP(SECOND, __VA_ARGS__)); \
727 __SIMIX_simcall(id, (u_smx_scalar_t[]){MAP(INIT_FIELD, __VA_ARGS__)})
729 void __SIMIX_simcall(e_smx_simcall_t simcall_id, u_smx_scalar_t *args);
732 * \biref Dummy variadic function used to typecheck the arguments of a simcall
733 * \param fmt A format string following printf style
735 void SIMIX_simcall_typecheck(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
737 typedef smx_action_t (*simcall_handler_t)(u_smx_scalar_t *);
739 extern const char *simcall_types[];
740 extern simcall_handler_t simcall_table[];