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;
166 } host_get_properties;
176 } host_get_available_speed;
196 double computation_amount;
204 smx_host_t *host_list;
205 double *computation_amount;
206 double *communication_amount;
210 } host_parallel_execute;
213 smx_action_t execution;
214 } host_execution_destroy;
217 smx_action_t execution;
218 } host_execution_cancel;
221 smx_action_t execution;
223 } host_execution_get_remains;
226 smx_action_t execution;
227 e_smx_state_t result;
228 } host_execution_get_state;
231 smx_action_t execution;
233 } host_execution_set_priority;
236 smx_action_t execution;
237 e_smx_state_t result;
238 } host_execution_wait;
241 smx_process_t *process;
243 xbt_main_func_t code;
245 const char *hostname;
249 xbt_dict_t properties;
254 smx_process_t process;
258 smx_process_t process;
262 smx_process_t process;
264 } process_change_host;
267 smx_process_t process;
271 smx_process_t process;
279 smx_process_t process;
284 smx_process_t process;
289 smx_process_t process;
294 smx_process_t process;
299 smx_process_t process;
301 } process_is_suspended;
304 smx_process_t process;
306 } process_get_properties;
310 e_smx_state_t result;
314 smx_process_t process;
320 smx_process_t process;
322 } process_auto_restart;
325 smx_process_t process;
326 smx_process_t result;
347 } rdv_comm_count_by_host;
356 smx_process_t receiver;
361 smx_process_t result;
369 size_t src_buff_size;
370 int (*match_fun)(void *, void *, smx_action_t);
380 size_t src_buff_size;
381 int (*match_fun)(void *, void *, smx_action_t);
382 void (*clean_fun)(void *);
391 size_t *dst_buff_size;
392 int (*match_fun)(void *, void *, smx_action_t);
400 size_t *dst_buff_size;
401 int (*match_fun)(void *, void *, smx_action_t);
410 int (*match_fun)(void *, void *, smx_action_t);
450 e_smx_state_t result;
465 smx_process_t result;
470 smx_process_t result;
473 #ifdef HAVE_LATENCY_BOUND_TRACKING
477 } comm_is_latency_bounded;
483 const char *category;
560 } sem_acquire_timeout;
615 } asr_get_properties;
625 } mc_compare_snapshots;
627 /* ****************************************************************************************** */
628 /* TUTORIAL: New API */
629 /* ****************************************************************************************** */
637 } s_smx_simcall_t, *smx_simcall_t;
639 /******************************** General *************************************/
641 void SIMIX_simcall_push(smx_process_t self);
642 void SIMIX_simcall_answer(smx_simcall_t);
643 void SIMIX_simcall_pre(smx_simcall_t, int);
644 void SIMIX_simcall_post(smx_action_t);
645 smx_simcall_t SIMIX_simcall_mine(void);
646 const char *SIMIX_simcall_name(e_smx_simcall_t kind);
648 /*************************** New simcall interface ****************************/
650 /* Pack all possible scalar types in an union */
666 * Define scalar type wrappers to ease the use of simcalls.
667 * These are used to wrap the arguments in SIMIX_simcall macro.
669 #define CHAR(x) (c,x)
670 #define SHORT(x) (s,x)
672 #define LONG(x) (l,x)
673 #define UCHAR(x) (uc,x)
674 #define USHORT(x) (us,x)
675 #define UINT(x) (ui,x)
676 #define ULONG(x) (ul,x)
677 #define FLOAT(x) (f,x)
678 #define DOUBLE(x) (d,x)
682 * Some macro machinery to get a MAP over the arguments of a variadic macro.
683 * It uses a FOLD to apply a macro to every argument, and because there is
684 * no recursion in the C preprocessor we must create a new macro for every
685 * depth of FOLD's recursion.
689 #define FE_1(WHAT, X) WHAT(X)
690 #define FE_2(WHAT, X, ...) WHAT(X), FE_1(WHAT, __VA_ARGS__)
691 #define FE_3(WHAT, X, ...) WHAT(X), FE_2(WHAT, __VA_ARGS__)
692 #define FE_4(WHAT, X, ...) WHAT(X), FE_3(WHAT, __VA_ARGS__)
693 #define FE_5(WHAT, X, ...) WHAT(X), FE_4(WHAT, __VA_ARGS__)
694 /* NOTE: add as many FE_n as needed (maximum number of simcall arguments )*/
696 /* Make a MAP macro usgin FOLD (will apply 'action' to the arguments.
697 * GET_MACRO is a smart hack that counts the number of arguments passed to
698 * the variadic macro, and it is used to invoke the right FOLD depth.
700 #define GET_MACRO(_1,_2,_3,_4,_5,NAME,...) NAME
701 #define MAP(action,...) \
702 GET_MACRO(__VA_ARGS__,FE_5,FE_4,FE_3,FE_2,FE_1) (action, __VA_ARGS__)
705 /* Generate code to initialize the field 'x' with value 'y' of an structure or union */
706 #define INIT_FIELD_(x,y) {.x = y}
707 #define INIT_FIELD(t) INIT_FIELD t
709 /* Project the second element of a tuple */
710 #define SECOND_(x, y) y
711 #define SECOND(t) SECOND_ t
714 * \brief Simcall invocation macro
715 * It calls a dummy function that uses the format attribute to ensure typesafety (see
716 * gcc format attribute), then it invokes the real simcall function packing the
717 * user provided arguments in an array.
718 * \param id a simcall id (from the simcall enumeration ids)
721 #define SIMIX_simcall(id, ...) \
722 SIMIX_simcall_typecheck(simcall_types[id], MAP(SECOND, __VA_ARGS__)); \
723 __SIMIX_simcall(id, (mytype_t[]){MAP(INIT_FIELD, __VA_ARGS__)})
725 void __SIMIX_simcall(e_smx_simcall_t simcall_id, u_smx_scalar_t *args);
728 * \biref Dummy variadic function used to typecheck the arguments of a simcall
729 * \param fmt A format string following printf style
731 void SIMIX_simcall_typecheck(const char *fmt, ...) __attribute__ ((format (printf, 1, 2)));