Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
make it easier to write tesh files by removing the full path to scripts from logs
[simgrid.git] / src / smpi / smpi_global.c
1 /* Copyright (c) 2007-2014. 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 "private.h"
8 #include "smpi_mpi_dt_private.h"
9 #include "mc/mc.h"
10 #include "xbt/replay.h"
11 #include "surf/surf.h"
12 #include "simix/smx_private.h"
13 #include "simgrid/sg_config.h"
14
15 #include <float.h>              /* DBL_MAX */
16 #include <stdint.h>
17 #include <stdio.h>
18 #include <stdlib.h>
19
20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_kernel, smpi,
21                                 "Logging specific to SMPI (kernel)");
22
23 typedef struct s_smpi_process_data {
24   double simulated;
25   int *argc;
26   char ***argv;
27   smx_rdv_t mailbox;
28   smx_rdv_t mailbox_small;
29   xbt_os_timer_t timer;
30   MPI_Comm comm_self;
31   MPI_Comm* comm_world;
32   void *data;                   /* user data */
33   int index;
34   char state;
35   int sampling;                 /* inside an SMPI_SAMPLE_ block? */
36   char* instance_id;
37   xbt_bar_t finalization_barrier;
38 } s_smpi_process_data_t;
39
40 static smpi_process_data_t *process_data = NULL;
41 int process_count = 0;
42 int* index_to_process_data = NULL;
43
44
45 MPI_Comm MPI_COMM_WORLD = MPI_COMM_UNINITIALIZED;
46 int MPI_UNIVERSE_SIZE;
47
48 MPI_Errhandler *MPI_ERRORS_RETURN = NULL;
49 MPI_Errhandler *MPI_ERRORS_ARE_FATAL = NULL;
50 MPI_Errhandler *MPI_ERRHANDLER_NULL = NULL;
51
52 #define MAILBOX_NAME_MAXLEN (5 + sizeof(int) * 2 + 1)
53
54 static char *get_mailbox_name(char *str, int index)
55 {
56   snprintf(str, MAILBOX_NAME_MAXLEN, "SMPI-%0*x", (int) (sizeof(int) * 2),
57            index);
58   return str;
59 }
60
61 static char *get_mailbox_name_small(char *str, int index)
62 {
63   snprintf(str, MAILBOX_NAME_MAXLEN, "small%0*x", (int) (sizeof(int) * 2),
64            index);
65   return str;
66 }
67
68 void smpi_process_init(int *argc, char ***argv)
69 {
70   int index=-1;
71   smpi_process_data_t data;
72   smx_process_t proc;
73
74   if (argc && argv) {
75     proc = SIMIX_process_self();
76     //FIXME: dirty cleanup method to avoid using msg cleanup functions on these processes when using MSG+SMPI
77     proc->context->cleanup_func=SIMIX_process_cleanup;
78     char* instance_id = (*argv)[1];
79     int rank = atoi((*argv)[2]);
80     index =  SIMIX_process_get_PID(proc) -1;
81
82     if(!index_to_process_data){
83         index_to_process_data=(int*)xbt_malloc(SIMIX_process_count()*sizeof(int));
84     }
85     MPI_Comm* temp_comm_world;
86     xbt_bar_t temp_bar;
87     smpi_deployment_register_process(instance_id, rank, index, &temp_comm_world ,&temp_bar);
88     data = smpi_process_remote_data(index);
89     data->comm_world = temp_comm_world;
90     if(temp_bar != NULL) data->finalization_barrier = temp_bar;
91     data->index = index;
92     data->instance_id = instance_id;
93     xbt_free(simcall_process_get_data(proc));
94     simcall_process_set_data(proc, data);
95     if (*argc > 3) {
96       free((*argv)[1]);
97       free((*argv)[2]);
98       memmove(&(*argv)[1], &(*argv)[3], sizeof(char *) * (*argc - 3));
99       (*argv)[(*argc) - 1] = NULL;
100       (*argv)[(*argc) - 2] = NULL;
101     }
102     (*argc)-=2;
103     data->argc = argc;
104     data->argv = argv;
105     // set the process attached to the mailbox
106     simcall_rdv_set_receiver(data->mailbox_small, proc);
107     XBT_DEBUG("<%d> New process in the game: %p", index, proc);
108
109     if(smpi_privatize_global_variables){
110       switch_data_segment(index);
111     }
112
113   }
114   if (smpi_process_data() == NULL)
115     xbt_die("smpi_process_data() returned NULL. You probably gave a NULL parameter to MPI_Init. Although it's required by MPI-2, this is currently not supported by SMPI.");
116 }
117
118 void smpi_process_destroy(void)
119 {
120   int index = smpi_process_index();
121   if(smpi_privatize_global_variables){
122     switch_data_segment(index);
123   }
124   process_data[index_to_process_data[index]]->state = SMPI_FINALIZED;
125   XBT_DEBUG("<%d> Process left the game", index);
126 }
127
128 /**
129  * @brief Prepares the current process for termination.
130  */
131 void smpi_process_finalize(void)
132 {
133     int index = smpi_process_index();
134     // wait for all pending asynchronous comms to finish
135     xbt_barrier_wait(process_data[index_to_process_data[index]]->finalization_barrier);
136
137 }
138
139 /**
140  * @brief Check if a process is finalized
141  */
142 int smpi_process_finalized()
143 {
144   int index = smpi_process_index();
145     if (index != MPI_UNDEFINED)
146       return (process_data[index_to_process_data[index]]->state == SMPI_FINALIZED);
147     else
148       return 0;
149 }
150
151 /**
152  * @brief Check if a process is initialized
153  */
154 int smpi_process_initialized(void)
155 {
156   int index = smpi_process_index();
157   return ( (index != MPI_UNDEFINED)
158           && (process_data[index_to_process_data[index]]->state == SMPI_INITIALIZED));
159 }
160
161 /**
162  * @brief Mark a process as initialized (=MPI_Init called)
163  */
164 void smpi_process_mark_as_initialized(void)
165 {
166   int index = smpi_process_index();
167   if ((index != MPI_UNDEFINED) && (!process_data[index_to_process_data[index]]->state != SMPI_FINALIZED))
168     process_data[index_to_process_data[index]]->state = SMPI_INITIALIZED;
169 }
170
171
172 int smpi_global_size(void)
173 {
174   char *value = getenv("SMPI_GLOBAL_SIZE");
175
176   if (!value) {
177     fprintf(stderr,
178             "Please set env var SMPI_GLOBAL_SIZE to expected number of processes.\n");
179     xbt_abort();
180   }
181   return atoi(value);
182 }
183
184 smpi_process_data_t smpi_process_data(void)
185 {
186   return SIMIX_process_self_get_data(SIMIX_process_self());
187 }
188
189 smpi_process_data_t smpi_process_remote_data(int index)
190 {
191   return process_data[index_to_process_data[index]];
192 }
193
194 void smpi_process_set_user_data(void *data)
195 {
196   smpi_process_data_t process_data = smpi_process_data();
197   process_data->data = data;
198 }
199
200 void *smpi_process_get_user_data()
201 {
202   smpi_process_data_t process_data = smpi_process_data();
203   return process_data->data;
204 }
205
206 int smpi_process_count(void)
207 {
208   return process_count;
209 }
210
211 int smpi_process_index(void)
212 {
213   smpi_process_data_t data = smpi_process_data();
214   //return -1 if not initialized
215   return data ? data->index : MPI_UNDEFINED;
216 }
217
218 MPI_Comm smpi_process_comm_world(void)
219 {
220   smpi_process_data_t data = smpi_process_data();
221   //return MPI_COMM_NULL if not initialized
222   return data ? *data->comm_world : MPI_COMM_NULL;
223 }
224
225 smx_rdv_t smpi_process_mailbox(void)
226 {
227   smpi_process_data_t data = smpi_process_data();
228   return data->mailbox;
229 }
230
231 smx_rdv_t smpi_process_mailbox_small(void)
232 {
233   smpi_process_data_t data = smpi_process_data();
234   return data->mailbox_small;
235 }
236
237 smx_rdv_t smpi_process_remote_mailbox(int index)
238 {
239   smpi_process_data_t data = smpi_process_remote_data(index);
240   return data->mailbox;
241 }
242
243
244 smx_rdv_t smpi_process_remote_mailbox_small(int index)
245 {
246   smpi_process_data_t data = smpi_process_remote_data(index);
247   return data->mailbox_small;
248 }
249
250 xbt_os_timer_t smpi_process_timer(void)
251 {
252   smpi_process_data_t data = smpi_process_data();
253   return data->timer;
254 }
255
256 void smpi_process_simulated_start(void)
257 {
258   smpi_process_data_t data = smpi_process_data();
259   data->simulated = SIMIX_get_clock();
260 }
261
262 double smpi_process_simulated_elapsed(void)
263 {
264   smpi_process_data_t data = smpi_process_data();
265   return SIMIX_get_clock() - data->simulated;
266 }
267
268 MPI_Comm smpi_process_comm_self(void)
269 {
270   smpi_process_data_t data = smpi_process_data();
271   if(data->comm_self==MPI_COMM_NULL){
272     MPI_Group group = smpi_group_new(1);
273     data->comm_self = smpi_comm_new(group, NULL);
274     smpi_group_set_mapping(group, smpi_process_index(), 0);
275   }
276
277   return data->comm_self;
278 }
279
280 void smpi_process_set_sampling(int s)
281 {
282   smpi_process_data_t data = smpi_process_data();
283   data->sampling = s;
284 }
285
286 int smpi_process_get_sampling(void)
287 {
288   smpi_process_data_t data = smpi_process_data();
289   return data->sampling;
290 }
291
292 void print_request(const char *message, MPI_Request request)
293 {
294   XBT_DEBUG
295       ("%s  request %p  [buf = %p, size = %zu, src = %d, dst = %d, tag = %d, flags = %x]",
296        message, request, request->buf, request->size, request->src,
297        request->dst, request->tag, request->flags);
298 }
299
300 void smpi_comm_copy_buffer_callback(smx_action_t comm,
301                                            void *buff, size_t buff_size)
302 {
303   XBT_DEBUG("Copy the data over");
304   if(_xbt_replay_is_active()) return;
305   void* tmpbuff=buff;
306
307   if((smpi_privatize_global_variables)
308       && ((char*)buff >= start_data_exe)
309       && ((char*)buff < start_data_exe + size_data_exe )
310     ){
311        XBT_DEBUG("Privatization : We are copying from a zone inside global memory... Saving data to temp buffer !");
312        switch_data_segment(((smpi_process_data_t)SIMIX_process_get_data(comm->comm.src_proc))->index);
313        tmpbuff = (void*)xbt_malloc(buff_size);
314        memcpy(tmpbuff, buff, buff_size);
315   }
316
317
318   if((smpi_privatize_global_variables)
319       && ((char*)comm->comm.dst_buff >= start_data_exe)
320       && ((char*)comm->comm.dst_buff < start_data_exe + size_data_exe )
321     ){
322        XBT_DEBUG("Privatization : We are copying to a zone inside global memory - Switch data segment");
323        switch_data_segment(((smpi_process_data_t)SIMIX_process_get_data(comm->comm.dst_proc))->index);
324   }
325
326
327   memcpy(comm->comm.dst_buff, tmpbuff, buff_size);
328   if (comm->comm.detached) {
329     // if this is a detached send, the source buffer was duplicated by SMPI
330     // sender to make the original buffer available to the application ASAP
331     xbt_free(buff);
332     //It seems that the request is used after the call there this should
333     //be free somewhereelse  but where???
334     //xbt_free(comm->comm.src_data);// inside SMPI the request is keep
335     //inside the user data and should be free
336     comm->comm.src_buff = NULL;
337   }
338
339   if(tmpbuff!=buff)xbt_free(tmpbuff);
340
341 }
342
343 static void smpi_check_options(){
344   //check correctness of MPI parameters
345
346    xbt_assert(sg_cfg_get_int("smpi/async_small_thres") <=
347               sg_cfg_get_int("smpi/send_is_detached_thres"));
348
349    if (sg_cfg_is_default_value("smpi/running_power")) {
350      XBT_INFO("You did not set the power of the host running the simulation.  "
351               "The timings will certainly not be accurate.  "
352               "Use the option \"--cfg=smpi/running_power:<flops>\" to set its value."
353               "Check http://simgrid.org/simgrid/latest/doc/options.html#options_smpi_bench for more information. ");
354    }
355 }
356
357 int smpi_enabled(void) {
358   return process_data != NULL;
359 }
360
361 void smpi_global_init(void)
362 {
363   int i;
364   MPI_Group group;
365   char name[MAILBOX_NAME_MAXLEN];
366   int smpirun=0;
367
368
369   if (process_count == 0){
370     process_count = SIMIX_process_count();
371     smpirun=1;
372   }
373   process_data = xbt_new0(smpi_process_data_t, process_count);
374   for (i = 0; i < process_count; i++) {
375     process_data[i] = xbt_new(s_smpi_process_data_t, 1);
376     //process_data[i]->index = i;
377     process_data[i]->argc = NULL;
378     process_data[i]->argv = NULL;
379     process_data[i]->mailbox = simcall_rdv_create(get_mailbox_name(name, i));
380     process_data[i]->mailbox_small =
381         simcall_rdv_create(get_mailbox_name_small(name, i));
382     process_data[i]->timer = xbt_os_timer_new();
383     if (MC_is_active())
384       MC_ignore_heap(process_data[i]->timer, xbt_os_timer_size());
385     process_data[i]->comm_self = MPI_COMM_NULL;
386     process_data[i]->comm_world = NULL;
387     process_data[i]->state = SMPI_UNINITIALIZED;
388     process_data[i]->sampling = 0;
389     process_data[i]->finalization_barrier = NULL;
390   }
391   //if the process was launched through smpirun script
392   //we generate a global mpi_comm_world
393   //if not, we let MPI_COMM_NULL, and the comm world
394   //will be private to each mpi instance
395   if(smpirun){
396     group = smpi_group_new(process_count);
397     MPI_COMM_WORLD = smpi_comm_new(group, NULL);
398     xbt_bar_t bar=xbt_barrier_init(process_count);
399
400     MPI_UNIVERSE_SIZE = smpi_comm_size(MPI_COMM_WORLD);
401     for (i = 0; i < process_count; i++) {
402       smpi_group_set_mapping(group, i, i);
403       process_data[i]->finalization_barrier = bar;
404     }
405   }
406 }
407
408 void smpi_global_destroy(void)
409 {
410   int count = smpi_process_count();
411   int i;
412
413   smpi_bench_destroy();
414   if (MPI_COMM_WORLD != MPI_COMM_UNINITIALIZED){
415       while (smpi_group_unuse(smpi_comm_group(MPI_COMM_WORLD)) > 0);
416       xbt_free(MPI_COMM_WORLD);
417       xbt_barrier_destroy(process_data[0]->finalization_barrier);
418   }else{
419       smpi_deployment_cleanup_instances();
420   }
421   MPI_COMM_WORLD = MPI_COMM_NULL;
422   for (i = 0; i < count; i++) {
423     if(process_data[i]->comm_self!=MPI_COMM_NULL){
424       smpi_group_unuse(smpi_comm_group(process_data[i]->comm_self));
425       smpi_comm_destroy(process_data[i]->comm_self);
426     }
427     xbt_os_timer_free(process_data[i]->timer);
428     simcall_rdv_destroy(process_data[i]->mailbox);
429     simcall_rdv_destroy(process_data[i]->mailbox_small);
430     xbt_free(process_data[i]);
431   }
432   xbt_free(process_data);
433   process_data = NULL;
434
435   xbt_free(index_to_process_data);
436   if(smpi_privatize_global_variables)
437     smpi_destroy_global_memory_segments();
438   smpi_free_static();
439 }
440
441 #ifndef WIN32
442 void __attribute__ ((weak)) user_main_()
443 {
444   xbt_die("Should not be in this smpi_simulated_main");
445   return;
446 }
447
448 int __attribute__ ((weak)) smpi_simulated_main_(int argc, char **argv)
449 {
450   smpi_process_init(&argc, &argv);
451   user_main_();
452   return 0;
453 }
454
455 int __attribute__ ((weak)) main(int argc, char **argv)
456 {
457   return smpi_main(smpi_simulated_main_, argc, argv);
458 }
459
460 #endif
461
462 static void smpi_init_logs(){
463
464   /* Connect log categories.  See xbt/log.c */
465   XBT_LOG_CONNECT(smpi);        /* Keep this line as soon as possible in this
466                                    function: xbt_log_appender_file.c depends on it
467                                    DO NOT connect this in XBT or so, or it will be
468                                    useless to xbt_log_appender_file.c */
469 #ifdef HAVE_TRACING
470   XBT_LOG_CONNECT(instr_smpi);
471 #endif
472   XBT_LOG_CONNECT(smpi_base);
473   XBT_LOG_CONNECT(smpi_bench);
474   XBT_LOG_CONNECT(smpi_coll);
475   XBT_LOG_CONNECT(smpi_colls);
476   XBT_LOG_CONNECT(smpi_comm);
477   XBT_LOG_CONNECT(smpi_dvfs);
478   XBT_LOG_CONNECT(smpi_group);
479   XBT_LOG_CONNECT(smpi_kernel);
480   XBT_LOG_CONNECT(smpi_mpi);
481   XBT_LOG_CONNECT(smpi_mpi_dt);
482   XBT_LOG_CONNECT(smpi_pmpi);
483   XBT_LOG_CONNECT(smpi_replay);
484   XBT_LOG_CONNECT(smpi_rma);
485
486 }
487
488
489 static void smpi_init_options(){
490   int gather_id = find_coll_description(mpi_coll_gather_description,
491                                           sg_cfg_get_string("smpi/gather"));
492     mpi_coll_gather_fun = (int (*)(void *, int, MPI_Datatype,
493                                    void *, int, MPI_Datatype, int, MPI_Comm))
494         mpi_coll_gather_description[gather_id].coll;
495
496     int allgather_id = find_coll_description(mpi_coll_allgather_description,
497                                              sg_cfg_get_string("smpi/allgather"));
498     mpi_coll_allgather_fun = (int (*)(void *, int, MPI_Datatype,
499                                       void *, int, MPI_Datatype, MPI_Comm))
500         mpi_coll_allgather_description[allgather_id].coll;
501
502     int allgatherv_id = find_coll_description(mpi_coll_allgatherv_description,
503                                               sg_cfg_get_string("smpi/allgatherv"));
504     mpi_coll_allgatherv_fun = (int (*)(void *, int, MPI_Datatype, void *, int *,
505                                        int *, MPI_Datatype, MPI_Comm))
506         mpi_coll_allgatherv_description[allgatherv_id].coll;
507
508     int allreduce_id = find_coll_description(mpi_coll_allreduce_description,
509                                              sg_cfg_get_string("smpi/allreduce"));
510     mpi_coll_allreduce_fun = (int (*)(void *sbuf, void *rbuf, int rcount,
511                                       MPI_Datatype dtype, MPI_Op op,
512                                       MPI_Comm comm))
513         mpi_coll_allreduce_description[allreduce_id].coll;
514
515     int alltoall_id = find_coll_description(mpi_coll_alltoall_description,
516                                             sg_cfg_get_string("smpi/alltoall"));
517     mpi_coll_alltoall_fun = (int (*)(void *, int, MPI_Datatype,
518                                      void *, int, MPI_Datatype, MPI_Comm))
519         mpi_coll_alltoall_description[alltoall_id].coll;
520
521     int alltoallv_id = find_coll_description(mpi_coll_alltoallv_description,
522                                              sg_cfg_get_string("smpi/alltoallv"));
523     mpi_coll_alltoallv_fun = (int (*)(void *, int *, int *, MPI_Datatype,
524                                       void *, int *, int *, MPI_Datatype,
525                                       MPI_Comm))
526         mpi_coll_alltoallv_description[alltoallv_id].coll;
527
528     int bcast_id = find_coll_description(mpi_coll_bcast_description,
529                                          sg_cfg_get_string("smpi/bcast"));
530     mpi_coll_bcast_fun = (int (*)(void *buf, int count, MPI_Datatype datatype,
531                                   int root, MPI_Comm com))
532         mpi_coll_bcast_description[bcast_id].coll;
533
534     int reduce_id = find_coll_description(mpi_coll_reduce_description,
535                                           sg_cfg_get_string("smpi/reduce"));
536     mpi_coll_reduce_fun = (int (*)(void *buf, void *rbuf, int count,
537                                    MPI_Datatype datatype, MPI_Op op,
538                                    int root, MPI_Comm comm))
539         mpi_coll_reduce_description[reduce_id].coll;
540
541     int reduce_scatter_id =
542         find_coll_description(mpi_coll_reduce_scatter_description,
543                               sg_cfg_get_string("smpi/reduce_scatter"));
544     mpi_coll_reduce_scatter_fun = (int (*)(void *sbuf, void *rbuf, int *rcounts,
545                                            MPI_Datatype dtype, MPI_Op op,
546                                            MPI_Comm comm))
547         mpi_coll_reduce_scatter_description[reduce_scatter_id].coll;
548
549     int scatter_id = find_coll_description(mpi_coll_scatter_description,
550                                            sg_cfg_get_string("smpi/scatter"));
551     mpi_coll_scatter_fun = (int (*)(void *sendbuf, int sendcount,
552                                     MPI_Datatype sendtype, void *recvbuf,
553                                     int recvcount, MPI_Datatype recvtype,
554                                     int root, MPI_Comm comm))
555         mpi_coll_scatter_description[scatter_id].coll;
556
557     int barrier_id = find_coll_description(mpi_coll_barrier_description,
558                                            sg_cfg_get_string("smpi/barrier"));
559     mpi_coll_barrier_fun = (int (*)(MPI_Comm comm))
560         mpi_coll_barrier_description[barrier_id].coll;
561
562     smpi_cpu_threshold = sg_cfg_get_double("smpi/cpu_threshold");
563     smpi_running_power = sg_cfg_get_double("smpi/running_power");
564     smpi_privatize_global_variables = sg_cfg_get_boolean("smpi/privatize_global_variables");
565     if (smpi_cpu_threshold < 0)
566       smpi_cpu_threshold = DBL_MAX;
567
568 }
569
570 int smpi_main(int (*realmain) (int argc, char *argv[]), int argc, char *argv[])
571 {
572   srand(SMPI_RAND_SEED);
573
574   if (getenv("SMPI_PRETEND_CC") != NULL) {
575     /* Hack to ensure that smpicc can pretend to be a simple
576      * compiler. Particularly handy to pass it to the configuration tools */
577     return 0;
578   }
579
580   smpi_init_logs();
581
582 #ifdef HAVE_TRACING
583   TRACE_global_init(&argc, argv);
584
585   TRACE_add_start_function(TRACE_smpi_alloc);
586   TRACE_add_end_function(TRACE_smpi_release);
587 #endif
588
589   SIMIX_global_init(&argc, argv);
590
591   // parse the platform file: get the host list
592   SIMIX_create_environment(argv[1]);
593   SIMIX_comm_set_copy_data_callback(&smpi_comm_copy_buffer_callback);
594   SIMIX_function_register_default(realmain);
595   SIMIX_launch_application(argv[2]);
596
597   smpi_init_options();
598
599   smpi_global_init();
600
601   smpi_check_options();
602
603   if(smpi_privatize_global_variables)
604     smpi_initialize_global_memory_segments();
605
606   /* Clean IO before the run */
607   fflush(stdout);
608   fflush(stderr);
609
610   if (MC_is_active())
611     MC_do_the_modelcheck_for_real();
612   else
613     SIMIX_run();
614
615   if (sg_cfg_get_boolean("smpi/display_timing"))
616     XBT_INFO("Simulation time: %g seconds.", SIMIX_get_clock());
617
618   smpi_global_destroy();
619
620 #ifdef HAVE_TRACING
621   TRACE_end();
622 #endif
623
624   return 0;
625 }
626
627 // This function can be called from extern file, to initialize logs, options, and processes of smpi
628 // without the need of smpirun
629 void SMPI_init(){
630   smpi_init_logs();
631   smpi_init_options();
632   smpi_global_init();
633   smpi_check_options();
634 #ifdef HAVE_TRACING
635   if (TRACE_is_enabled() && TRACE_is_configured()) {
636     TRACE_smpi_alloc();
637   }
638 #endif
639   if(smpi_privatize_global_variables)
640     smpi_initialize_global_memory_segments();
641 }
642
643 void SMPI_finalize(){
644   smpi_global_destroy();
645 }