Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
4218ab18f58db68801063c4c20e015ae63bbef5c
[simgrid.git] / src / msg / msg_actions.c
1 /* Copyright (c) 2009, 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #include "simgrid_config.h" //For getline, keep that include first
8
9 #include "msg_private.h"
10 #include "xbt/str.h"
11 #include "xbt/dynar.h"
12 #include "xbt/replay_trace_reader.h"
13
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_action, msg,
15                                 "MSG actions for trace driven simulation");
16
17 static xbt_dict_t action_funs;
18 static xbt_dict_t action_queues;
19
20 /* To split the file if a unique one is given (specific variable for the other case live in runner()) */
21 static FILE *action_fp = NULL;
22 static char *action_line = NULL;
23 static size_t action_len = 0;
24
25 static const char **action_get_action(char *name);
26
27 /** \ingroup msg_actions
28  * \brief Registers a function to handle a kind of action
29  *
30  * Registers a function to handle a kind of action
31  * This table is then used by #MSG_action_trace_run
32  *
33  * The argument of the function is the line describing the action, splitted on spaces with xbt_str_split_quoted()
34  *
35  * \param name the reference name of the action.
36  * \param code the function; prototype given by the type: void...(xbt_dynar_t action)
37  */
38 void MSG_action_register(const char *action_name, msg_action_fun function)
39 {
40   xbt_dict_set(action_funs, action_name, function, NULL);
41 }
42
43 /** \ingroup msg_actions
44  * \brief Unregisters a function, which handled a kind of action
45  *
46  * \param name the reference name of the action.
47  */
48 void MSG_action_unregister(const char *action_name)
49 {
50   xbt_dict_remove(action_funs, action_name);
51 }
52
53 static int MSG_action_runner(int argc, char *argv[])
54 {
55   const char **evt;
56   if (action_fp) {              // A unique trace file
57
58     while ((evt = action_get_action(argv[0]))) {
59       msg_action_fun function = xbt_dict_get(action_funs, evt[1]);
60       function(evt);
61       free(evt);
62     }
63   } else {                      // Should have got my trace file in argument
64     xbt_assert(argc >= 2,
65                 "No '%s' agent function provided, no simulation-wide trace file provided to MSG_action_trace_run(), "
66                 "and no process-wide trace file provided in deployment file. Aborting.",
67                 argv[0]
68         );
69     xbt_replay_trace_reader_t reader = xbt_replay_trace_reader_new(argv[1]);
70     while ((evt=xbt_replay_trace_reader_get(reader))) {
71       if (!strcmp(argv[0],evt[0])) {
72         msg_action_fun function = xbt_dict_get(action_funs, evt[1]);
73         function(evt);
74         free(evt);
75       } else {
76         XBT_WARN("%s: Ignore trace element not for me",
77               xbt_replay_trace_reader_position(reader));
78       }
79     }
80     xbt_replay_trace_reader_free(&reader);
81   }
82   return 0;
83 }
84
85 void _MSG_action_init()
86 {
87   action_funs = xbt_dict_new_homogeneous(NULL);
88   action_queues = xbt_dict_new_homogeneous(NULL);
89   MSG_function_register_default(MSG_action_runner);
90 }
91
92 void _MSG_action_exit()
93 {
94   xbt_dict_free(&action_queues);
95   xbt_dict_free(&action_funs);
96 }
97
98
99 static const char **action_get_action(char *name)
100 {
101   xbt_dynar_t evt = NULL;
102   char *evtname = NULL;
103
104   xbt_dynar_t myqueue = xbt_dict_get_or_null(action_queues, name);
105   if (myqueue == NULL || xbt_dynar_is_empty(myqueue)) {      // nothing stored for me. Read the file further
106
107     if (action_fp == NULL) {    // File closed now. There's nothing more to read. I'm out of here
108       goto todo_done;
109     }
110     // Read lines until I reach something for me (which breaks in loop body)
111     // or end of file reached
112     while (getline(&action_line, &action_len, action_fp) != -1) {
113       // cleanup and split the string I just read
114       char *comment = strchr(action_line, '#');
115       if (comment != NULL)
116         *comment = '\0';
117       xbt_str_trim(action_line, NULL);
118       if (action_line[0] == '\0')
119         continue;
120       /* we cannot split in place here because we parse&store several lines for
121        * the colleagues... */
122       evt = xbt_str_split_quoted(action_line);
123
124       // if it's for me, I'm done
125       evtname = xbt_dynar_get_as(evt, 0, char *);
126       if (!strcmp(name, evtname)) {
127         return xbt_dynar_to_array(evt);
128       } else {
129         // Else, I have to store it for the relevant colleague
130         xbt_dynar_t otherqueue =
131             xbt_dict_get_or_null(action_queues, evtname);
132         if (otherqueue == NULL) {       // Damn. Create the queue of that guy
133           otherqueue =
134               xbt_dynar_new(sizeof(xbt_dynar_t), xbt_dynar_free_voidp);
135           xbt_dict_set(action_queues, evtname, otherqueue, NULL);
136         }
137         xbt_dynar_push(otherqueue, &evt);
138       }
139     }
140     goto todo_done;             // end of file reached while searching in vain for more work
141   } else {
142     // Get something from my queue and return it
143     xbt_dynar_shift(myqueue, &evt);
144     return xbt_dynar_to_array(evt);
145   }
146
147
148   // I did all my actions for me in the file (either I closed the file, or a colleague did)
149   // Let's cleanup before leaving
150 todo_done:
151   if (myqueue != NULL) {
152     xbt_dynar_free(&myqueue);
153     xbt_dict_remove(action_queues, name);
154   }
155   return NULL;
156 }
157
158 /** \ingroup msg_actions
159  * \brief A trace loader
160  *
161  *  If path!=NULL, load a trace file containing actions, and execute them.
162  *  Else, assume that each process gets the path in its deployment file
163  */
164 MSG_error_t MSG_action_trace_run(char *path)
165 {
166   MSG_error_t res;
167   char *name;
168   xbt_dynar_t todo;
169   xbt_dict_cursor_t cursor;
170
171   if (path) {
172     action_fp = fopen(path, "r");
173     xbt_assert(action_fp != NULL, "Cannot open %s: %s", path,
174                 strerror(errno));
175   }
176   res = MSG_main();
177
178   if (!xbt_dict_is_empty(action_queues)) {
179     XBT_WARN
180         ("Not all actions got consumed. If the simulation ended successfully (without deadlock), you may want to add new processes to your deployment file.");
181
182
183     xbt_dict_foreach(action_queues, cursor, name, todo) {
184       XBT_WARN("Still %lu actions for %s", xbt_dynar_length(todo), name);
185     }
186   }
187
188   free(action_line);
189   if (path)
190     fclose(action_fp);
191   xbt_dict_free(&action_queues);
192   action_queues = xbt_dict_new_homogeneous(NULL);
193
194   return res;
195 }