1 /* Copyright (c) 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 #include "simgrid_config.h" //For getline, keep that include first
9 #include "msg_private.h"
11 #include "xbt/dynar.h"
12 #include "xbt/replay_trace_reader.h"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_action, msg,
15 "MSG actions for trace driven simulation");
17 static xbt_dict_t action_funs;
18 static xbt_dict_t action_queues;
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;
25 static const char **action_get_action(char *name);
27 /** \ingroup msg_actions
28 * \brief Registers a function to handle a kind of action
30 * Registers a function to handle a kind of action
31 * This table is then used by #MSG_action_trace_run
33 * The argument of the function is the line describing the action, splitted on spaces with xbt_str_split_quoted()
35 * \param name the reference name of the action.
36 * \param code the function; prototype given by the type: void...(xbt_dynar_t action)
38 void MSG_action_register(const char *action_name, msg_action_fun function)
40 xbt_dict_set(action_funs, action_name, function, NULL);
43 /** \ingroup msg_actions
44 * \brief Unregisters a function, which handled a kind of action
46 * \param name the reference name of the action.
48 void MSG_action_unregister(const char *action_name)
50 xbt_dict_remove(action_funs, action_name);
53 static int MSG_action_runner(int argc, char *argv[])
56 if (action_fp) { // A unique trace file
58 while ((evt = action_get_action(argv[0]))) {
59 msg_action_fun function = xbt_dict_get(action_funs, evt[1]);
63 } else { // Should have got my trace file in argument
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.",
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]);
76 XBT_WARN("%s: Ignore trace element not for me",
77 xbt_replay_trace_reader_position(reader));
80 xbt_replay_trace_reader_free(&reader);
85 void _MSG_action_init()
87 action_funs = xbt_dict_new_homogeneous(NULL);
88 action_queues = xbt_dict_new_homogeneous(NULL);
89 MSG_function_register_default(MSG_action_runner);
92 void _MSG_action_exit()
94 xbt_dict_free(&action_queues);
95 xbt_dict_free(&action_funs);
99 static const char **action_get_action(char *name)
102 xbt_dynar_t evt = NULL;
103 char *evtname = NULL;
105 xbt_dynar_t myqueue = xbt_dict_get_or_null(action_queues, name);
106 if (myqueue == NULL || xbt_dynar_is_empty(myqueue)) { // nothing stored for me. Read the file further
108 if (action_fp == NULL) { // File closed now. There's nothing more to read. I'm out of here
111 // Read lines until I reach something for me (which breaks in loop body)
112 // or end of file reached
113 while ((read = getline(&action_line, &action_len, action_fp)) != -1) {
114 // cleanup and split the string I just read
115 char *comment = strchr(action_line, '#');
118 xbt_str_trim(action_line, NULL);
119 if (action_line[0] == '\0')
121 /* we cannot split in place here because we parse&store several lines for
122 * the colleagues... */
123 evt = xbt_str_split_quoted(action_line);
125 // if it's for me, I'm done
126 evtname = xbt_dynar_get_as(evt, 0, char *);
127 if (!strcmp(name, evtname)) {
128 return xbt_dynar_to_array(evt);
130 // Else, I have to store it for the relevant colleague
131 xbt_dynar_t otherqueue =
132 xbt_dict_get_or_null(action_queues, evtname);
133 if (otherqueue == NULL) { // Damn. Create the queue of that guy
135 xbt_dynar_new(sizeof(xbt_dynar_t), xbt_dynar_free_voidp);
136 xbt_dict_set(action_queues, evtname, otherqueue, NULL);
138 xbt_dynar_push(otherqueue, &evt);
141 goto todo_done; // end of file reached while searching in vain for more work
143 // Get something from my queue and return it
144 xbt_dynar_shift(myqueue, &evt);
145 return xbt_dynar_to_array(evt);
149 // I did all my actions for me in the file (either I closed the file, or a colleague did)
150 // Let's cleanup before leaving
152 if (myqueue != NULL) {
153 xbt_dynar_free(&myqueue);
154 xbt_dict_remove(action_queues, name);
159 /** \ingroup msg_actions
160 * \brief A trace loader
162 * If path!=NULL, load a trace file containing actions, and execute them.
163 * Else, assume that each process gets the path in its deployment file
165 MSG_error_t MSG_action_trace_run(char *path)
170 xbt_dict_cursor_t cursor;
173 action_fp = fopen(path, "r");
174 xbt_assert(action_fp != NULL, "Cannot open %s: %s", path,
179 if (!xbt_dict_is_empty(action_queues)) {
181 ("Not all actions got consumed. If the simulation ended successfully (without deadlock), you may want to add new processes to your deployment file.");
184 xbt_dict_foreach(action_queues, cursor, name, todo) {
185 XBT_WARN("Still %lu actions for %s", xbt_dynar_length(todo), name);
192 xbt_dict_free(&action_queues);
193 action_queues = xbt_dict_new_homogeneous(NULL);