Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
a3438247245cff26957893b506e0866d891b96e7
[simgrid.git] / src / smpi / smpi_global.cpp
1 /* Copyright (c) 2007-2017. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #include "mc/mc.h"
7 #include "private.h"
8 #include "private.hpp"
9 #include "simgrid/s4u/Mailbox.hpp"
10 #include "smpi/smpi_shared_malloc.hpp"
11 #include "simgrid/sg_config.h"
12 #include "src/kernel/activity/SynchroComm.hpp"
13 #include "src/mc/mc_record.h"
14 #include "src/mc/mc_replay.h"
15 #include "src/msg/msg_private.h"
16 #include "src/simix/smx_private.h"
17 #include "surf/surf.h"
18 #include "xbt/replay.hpp"
19 #include <xbt/config.hpp>
20
21 #include <float.h> /* DBL_MAX */
22 #include <fstream>
23 #include <map>
24 #include <stdint.h>
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <string>
28 #include <vector>
29
30 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_kernel, smpi, "Logging specific to SMPI (kernel)");
31 #include <boost/tokenizer.hpp>
32 #include <boost/algorithm/string.hpp> /* trim_right / trim_left */
33
34 #if HAVE_PAPI
35 #include "papi.h"
36 const char* papi_default_config_name = "default";
37
38 struct papi_process_data {
39   papi_counter_t counter_data;
40   int event_set;
41 };
42
43 #endif
44 std::unordered_map<std::string, double> location2speedup;
45
46 simgrid::smpi::Process **process_data = nullptr;
47 int process_count = 0;
48 int smpi_universe_size = 0;
49 int* index_to_process_data = nullptr;
50 extern double smpi_total_benched_time;
51 xbt_os_timer_t global_timer;
52 MPI_Comm MPI_COMM_WORLD = MPI_COMM_UNINITIALIZED;
53 MPI_Errhandler *MPI_ERRORS_RETURN = nullptr;
54 MPI_Errhandler *MPI_ERRORS_ARE_FATAL = nullptr;
55 MPI_Errhandler *MPI_ERRHANDLER_NULL = nullptr;
56 static simgrid::config::Flag<double> smpi_wtime_sleep(
57   "smpi/wtime", "Minimum time to inject inside a call to MPI_Wtime", 0.0);
58 static simgrid::config::Flag<double> smpi_init_sleep(
59   "smpi/init", "Time to inject inside a call to MPI_Init", 0.0);
60
61 void (*smpi_comm_copy_data_callback) (smx_activity_t, void*, size_t) = &smpi_comm_copy_buffer_callback;
62
63
64
65 int smpi_process_count()
66 {
67   return process_count;
68 }
69
70 simgrid::smpi::Process* smpi_process()
71 {
72   simgrid::MsgActorExt* msgExt = static_cast<simgrid::MsgActorExt*>(SIMIX_process_self()->data);
73   return static_cast<simgrid::smpi::Process*>(msgExt->data);
74 }
75
76 simgrid::smpi::Process* smpi_process_remote(int index)
77 {
78   return process_data[index_to_process_data[index]];
79 }
80
81 MPI_Comm smpi_process_comm_self(){
82   return smpi_process()->comm_self();
83 }
84
85 void smpi_process_init(int *argc, char ***argv){
86   simgrid::smpi::Process::init(argc, argv);
87 }
88
89 int smpi_process_index(){
90   return smpi_process()->index();
91 }
92
93
94 int smpi_global_size()
95 {
96   char *value = getenv("SMPI_GLOBAL_SIZE");
97   xbt_assert(value,"Please set env var SMPI_GLOBAL_SIZE to the expected number of processes.");
98
99   return xbt_str_parse_int(value, "SMPI_GLOBAL_SIZE contains a non-numerical value: %s");
100 }
101
102 void smpi_comm_set_copy_data_callback(void (*callback) (smx_activity_t, void*, size_t))
103 {
104   smpi_comm_copy_data_callback = callback;
105 }
106
107 std::vector<std::pair<int, int>> merge_private_blocks(std::vector<std::pair<int, int>> src, std::vector<std::pair<int, int>> dst) {
108   std::vector<std::pair<int, int>> result;
109   int i_src=0, i_dst=0;
110   while(i_src < src.size() && i_dst < dst.size()) {
111     std::pair<int, int> block;
112     if(src[i_src].first < dst[i_dst].first) {
113       block = src[i_src];
114       i_src ++;
115     }
116     else {
117       block = dst[i_dst];
118       i_dst ++;
119     }
120     if(block.first <= result.back().second) { // overlapping with the last block inserted
121       result.back().second = std::max(result.back().second, block.second);
122     }
123     else { // not overlapping, we insert a new block
124       result.push_back(block);
125     }
126   }
127   for(; i_src < src.size(); i_src++) {
128     result.push_back(src[i_src]);
129   }
130   for(; i_dst < dst.size(); i_dst++) {
131     result.push_back(dst[i_dst]);
132   }
133   return result;
134 }
135
136 void smpi_comm_copy_buffer_callback(smx_activity_t synchro, void *buff, size_t buff_size)
137 {
138   simgrid::kernel::activity::Comm *comm = dynamic_cast<simgrid::kernel::activity::Comm*>(synchro);
139   int src_shared=0, dst_shared=0;
140   std::vector<std::pair<int, int>> src_private_blocks;
141   std::vector<std::pair<int, int>> dst_private_blocks;
142   XBT_DEBUG("Copy the data over");
143   if(src_shared=smpi_is_shared(buff, src_private_blocks))
144     XBT_DEBUG("Sender %p is shared. Let's ignore it.", buff);
145   if(dst_shared=smpi_is_shared((char*)comm->dst_buff, src_private_blocks))
146     XBT_DEBUG("Receiver %p is shared. Let's ignore it.", (char*)comm->dst_buff); 
147   if(!src_shared && !dst_shared){
148     void* tmpbuff=buff;
149     if((smpi_privatize_global_variables) && (static_cast<char*>(buff) >= smpi_start_data_exe)
150         && (static_cast<char*>(buff) < smpi_start_data_exe + smpi_size_data_exe )
151       ){
152          XBT_DEBUG("Privatization : We are copying from a zone inside global memory... Saving data to temp buffer !");
153
154          smpi_switch_data_segment(
155              (static_cast<simgrid::smpi::Process*>((static_cast<simgrid::MsgActorExt*>(comm->src_proc->data)->data))->index()));
156          tmpbuff = static_cast<void*>(xbt_malloc(buff_size));
157          memcpy(tmpbuff, buff, buff_size);
158     }
159
160     if((smpi_privatize_global_variables) && ((char*)comm->dst_buff >= smpi_start_data_exe)
161         && ((char*)comm->dst_buff < smpi_start_data_exe + smpi_size_data_exe )){
162          XBT_DEBUG("Privatization : We are copying to a zone inside global memory - Switch data segment");
163          smpi_switch_data_segment(
164              (static_cast<simgrid::smpi::Process*>((static_cast<simgrid::MsgActorExt*>(comm->dst_proc->data)->data))->index()));
165     }
166
167     XBT_DEBUG("Copying %zu bytes from %p to %p", buff_size, tmpbuff,comm->dst_buff);
168     memcpy(comm->dst_buff, tmpbuff, buff_size);
169
170     if (comm->detached) {
171       // if this is a detached send, the source buffer was duplicated by SMPI
172       // sender to make the original buffer available to the application ASAP
173       xbt_free(buff);
174       //It seems that the request is used after the call there this should be free somewhere else but where???
175       //xbt_free(comm->comm.src_data);// inside SMPI the request is kept inside the user data and should be free
176       comm->src_buff = nullptr;
177     }
178     if(tmpbuff!=buff)xbt_free(tmpbuff);
179   }
180
181 }
182
183 void smpi_comm_null_copy_buffer_callback(smx_activity_t comm, void *buff, size_t buff_size)
184 {
185   /* nothing done in this version */
186 }
187
188 static void smpi_check_options(){
189   //check correctness of MPI parameters
190
191    xbt_assert(xbt_cfg_get_int("smpi/async-small-thresh") <= xbt_cfg_get_int("smpi/send-is-detached-thresh"));
192
193    if (xbt_cfg_is_default_value("smpi/host-speed")) {
194      XBT_INFO("You did not set the power of the host running the simulation.  "
195               "The timings will certainly not be accurate.  "
196               "Use the option \"--cfg=smpi/host-speed:<flops>\" to set its value."
197               "Check http://simgrid.org/simgrid/latest/doc/options.html#options_smpi_bench for more information.");
198    }
199
200    xbt_assert(xbt_cfg_get_double("smpi/cpu-threshold") >=0,
201        "The 'smpi/cpu-threshold' option cannot have negative values [anymore]. If you want to discard "
202        "the simulation of any computation, please use 'smpi/simulate-computation:no' instead.");
203 }
204
205 int smpi_enabled() {
206   return process_data != nullptr;
207 }
208
209 void smpi_global_init()
210 {
211   int i;
212   MPI_Group group;
213   int smpirun=0;
214
215   if (!MC_is_active()) {
216     global_timer = xbt_os_timer_new();
217     xbt_os_walltimer_start(global_timer);
218   }
219
220   if (xbt_cfg_get_string("smpi/comp-adjustment-file")[0] != '\0') { 
221     std::string filename {xbt_cfg_get_string("smpi/comp-adjustment-file")};
222     std::ifstream fstream(filename);
223     if (!fstream.is_open()) {
224       xbt_die("Could not open file %s. Does it exist?", filename.c_str());
225     }
226
227     std::string line;
228     typedef boost::tokenizer< boost::escaped_list_separator<char>> Tokenizer;
229     std::getline(fstream, line); // Skip the header line
230     while (std::getline(fstream, line)) {
231       Tokenizer tok(line);
232       Tokenizer::iterator it  = tok.begin();
233       Tokenizer::iterator end = std::next(tok.begin());
234
235       std::string location = *it;
236       boost::trim(location);
237       location2speedup.insert(std::pair<std::string, double>(location, std::stod(*end)));
238     }
239   }
240
241 #if HAVE_PAPI
242   // This map holds for each computation unit (such as "default" or "process1" etc.)
243   // the configuration as given by the user (counter data as a pair of (counter_name, counter_counter))
244   // and the (computed) event_set.
245   std::map</* computation unit name */ std::string, papi_process_data> units2papi_setup;
246
247   if (xbt_cfg_get_string("smpi/papi-events")[0] != '\0') {
248     if (PAPI_library_init(PAPI_VER_CURRENT) != PAPI_VER_CURRENT)
249       XBT_ERROR("Could not initialize PAPI library; is it correctly installed and linked?"
250                 " Expected version is %i",
251                 PAPI_VER_CURRENT);
252
253     typedef boost::tokenizer<boost::char_separator<char>> Tokenizer;
254     boost::char_separator<char> separator_units(";");
255     std::string str = std::string(xbt_cfg_get_string("smpi/papi-events"));
256     Tokenizer tokens(str, separator_units);
257
258     // Iterate over all the computational units. This could be
259     // processes, hosts, threads, ranks... You name it. I'm not exactly
260     // sure what we will support eventually, so I'll leave it at the
261     // general term "units".
262     for (auto& unit_it : tokens) {
263       boost::char_separator<char> separator_events(":");
264       Tokenizer event_tokens(unit_it, separator_events);
265
266       int event_set = PAPI_NULL;
267       if (PAPI_create_eventset(&event_set) != PAPI_OK) {
268         // TODO: Should this let the whole simulation die?
269         XBT_CRITICAL("Could not create PAPI event set during init.");
270       }
271
272       // NOTE: We cannot use a map here, as we must obey the order of the counters
273       // This is important for PAPI: We need to map the values of counters back
274       // to the event_names (so, when PAPI_read() has finished)!
275       papi_counter_t counters2values;
276
277       // Iterate over all counters that were specified for this specific
278       // unit.
279       // Note that we need to remove the name of the unit
280       // (that could also be the "default" value), which always comes first.
281       // Hence, we start at ++(events.begin())!
282       for (Tokenizer::iterator events_it = ++(event_tokens.begin()); events_it != event_tokens.end(); events_it++) {
283
284         int event_code   = PAPI_NULL;
285         char* event_name = const_cast<char*>((*events_it).c_str());
286         if (PAPI_event_name_to_code(event_name, &event_code) == PAPI_OK) {
287           if (PAPI_add_event(event_set, event_code) != PAPI_OK) {
288             XBT_ERROR("Could not add PAPI event '%s'. Skipping.", event_name);
289             continue;
290           } else {
291             XBT_DEBUG("Successfully added PAPI event '%s' to the event set.", event_name);
292           }
293         } else {
294           XBT_CRITICAL("Could not find PAPI event '%s'. Skipping.", event_name);
295           continue;
296         }
297
298         counters2values.push_back(
299             // We cannot just pass *events_it, as this is of type const basic_string
300             std::make_pair<std::string, long long>(std::string(*events_it), 0));
301       }
302
303       std::string unit_name    = *(event_tokens.begin());
304       papi_process_data config = {.counter_data = std::move(counters2values), .event_set = event_set};
305
306       units2papi_setup.insert(std::make_pair(unit_name, std::move(config)));
307     }
308   }
309 #endif
310   if (process_count == 0){
311     process_count = SIMIX_process_count();
312     smpirun=1;
313   }
314   smpi_universe_size = process_count;
315   process_data       = new simgrid::smpi::Process*[process_count];
316   for (i = 0; i < process_count; i++) {
317     process_data[i]                       = new simgrid::smpi::Process(i);
318   }
319   //if the process was launched through smpirun script we generate a global mpi_comm_world
320   //if not, we let MPI_COMM_NULL, and the comm world will be private to each mpi instance
321   if(smpirun){
322     group = new  simgrid::smpi::Group(process_count);
323     MPI_COMM_WORLD = new  simgrid::smpi::Comm(group, nullptr);
324     MPI_Attr_put(MPI_COMM_WORLD, MPI_UNIVERSE_SIZE, reinterpret_cast<void *>(process_count));
325     msg_bar_t bar = MSG_barrier_init(process_count);
326
327     for (i = 0; i < process_count; i++) {
328       group->set_mapping(i, i);
329       process_data[i]->set_finalization_barrier(bar);
330     }
331   }
332 }
333
334 void smpi_global_destroy()
335 {
336   int count = smpi_process_count();
337
338   smpi_bench_destroy();
339   smpi_shared_destroy();
340   if (MPI_COMM_WORLD != MPI_COMM_UNINITIALIZED){
341       delete MPI_COMM_WORLD->group();
342       MSG_barrier_destroy(process_data[0]->finalization_barrier());
343   }else{
344       smpi_deployment_cleanup_instances();
345   }
346   for (int i = 0; i < count; i++) {
347     if(process_data[i]->comm_self()!=MPI_COMM_NULL){
348       simgrid::smpi::Comm::destroy(process_data[i]->comm_self());
349     }
350     if(process_data[i]->comm_intra()!=MPI_COMM_NULL){
351       simgrid::smpi::Comm::destroy(process_data[i]->comm_intra());
352     }
353     xbt_os_timer_free(process_data[i]->timer());
354     xbt_mutex_destroy(process_data[i]->mailboxes_mutex());
355     delete process_data[i];
356   }
357   delete[] process_data;
358   process_data = nullptr;
359
360   if (MPI_COMM_WORLD != MPI_COMM_UNINITIALIZED){
361     MPI_COMM_WORLD->cleanup_smp();
362     MPI_COMM_WORLD->cleanup_attr<simgrid::smpi::Comm>();
363     if(simgrid::smpi::Colls::smpi_coll_cleanup_callback!=nullptr)
364       simgrid::smpi::Colls::smpi_coll_cleanup_callback();
365     delete MPI_COMM_WORLD;
366   }
367
368   MPI_COMM_WORLD = MPI_COMM_NULL;
369
370   if (!MC_is_active()) {
371     xbt_os_timer_free(global_timer);
372   }
373
374   xbt_free(index_to_process_data);
375   if(smpi_privatize_global_variables)
376     smpi_destroy_global_memory_segments();
377   smpi_free_static();
378 }
379
380 extern "C" {
381
382 #ifndef WIN32
383
384 void __attribute__ ((weak)) user_main_()
385 {
386   xbt_die("Should not be in this smpi_simulated_main");
387 }
388
389 int __attribute__ ((weak)) smpi_simulated_main_(int argc, char **argv)
390 {
391   simgrid::smpi::Process::init(&argc, &argv);
392   user_main_();
393   return 0;
394 }
395
396 inline static int smpi_main_wrapper(int argc, char **argv){
397   int ret = smpi_simulated_main_(argc,argv);
398   if(ret !=0){
399     XBT_WARN("SMPI process did not return 0. Return value : %d", ret);
400     smpi_process()->set_return_value(ret);
401   }
402   return 0;
403 }
404
405 int __attribute__ ((weak)) main(int argc, char **argv)
406 {
407   return smpi_main(smpi_main_wrapper, argc, argv);
408 }
409
410 #endif
411
412 static void smpi_init_logs(){
413
414   /* Connect log categories.  See xbt/log.c */
415
416   XBT_LOG_CONNECT(smpi);  /* Keep this line as soon as possible in this function: xbt_log_appender_file.c depends on it
417                              DO NOT connect this in XBT or so, or it will be useless to xbt_log_appender_file.c */
418   XBT_LOG_CONNECT(instr_smpi);
419   XBT_LOG_CONNECT(smpi_bench);
420   XBT_LOG_CONNECT(smpi_coll);
421   XBT_LOG_CONNECT(smpi_colls);
422   XBT_LOG_CONNECT(smpi_comm);
423   XBT_LOG_CONNECT(smpi_datatype);
424   XBT_LOG_CONNECT(smpi_dvfs);
425   XBT_LOG_CONNECT(smpi_group);
426   XBT_LOG_CONNECT(smpi_kernel);
427   XBT_LOG_CONNECT(smpi_mpi);
428   XBT_LOG_CONNECT(smpi_memory);
429   XBT_LOG_CONNECT(smpi_op);
430   XBT_LOG_CONNECT(smpi_pmpi);
431   XBT_LOG_CONNECT(smpi_request);
432   XBT_LOG_CONNECT(smpi_replay);
433   XBT_LOG_CONNECT(smpi_rma);
434   XBT_LOG_CONNECT(smpi_shared);
435   XBT_LOG_CONNECT(smpi_utils);
436 }
437 }
438
439 static void smpi_init_options(){
440
441     simgrid::smpi::Colls::set_collectives();
442     simgrid::smpi::Colls::smpi_coll_cleanup_callback=nullptr;
443     smpi_cpu_threshold = xbt_cfg_get_double("smpi/cpu-threshold");
444     smpi_host_speed = xbt_cfg_get_double("smpi/host-speed");
445     smpi_privatize_global_variables = xbt_cfg_get_boolean("smpi/privatize-global-variables");
446     if (smpi_cpu_threshold < 0)
447       smpi_cpu_threshold = DBL_MAX;
448
449     char* val = xbt_cfg_get_string("smpi/shared-malloc");
450     if (!strcasecmp(val, "yes") || !strcmp(val, "1") || !strcasecmp(val, "on") || !strcasecmp(val, "global")) {
451       smpi_cfg_shared_malloc = shmalloc_global;
452     } else if (!strcasecmp(val, "local")) {
453       smpi_cfg_shared_malloc = shmalloc_local;
454     } else if (!strcasecmp(val, "no") || !strcmp(val, "0") || !strcasecmp(val, "off")) {
455       smpi_cfg_shared_malloc = shmalloc_none;
456     } else {
457       xbt_die("Invalid value '%s' for option smpi/shared-malloc. Possible values: 'on' or 'global', 'local', 'off'",
458               val);
459     }
460 }
461
462 int smpi_main(int (*realmain) (int argc, char *argv[]), int argc, char *argv[])
463 {
464   srand(SMPI_RAND_SEED);
465
466   if (getenv("SMPI_PRETEND_CC") != nullptr) {
467     /* Hack to ensure that smpicc can pretend to be a simple compiler. Particularly handy to pass it to the
468      * configuration tools */
469     return 0;
470   }
471   smpi_init_logs();
472
473   TRACE_global_init(&argc, argv);
474   TRACE_add_start_function(TRACE_smpi_alloc);
475   TRACE_add_end_function(TRACE_smpi_release);
476
477   SIMIX_global_init(&argc, argv);
478   MSG_init(&argc,argv);
479
480   SMPI_switch_data_segment = &smpi_switch_data_segment;
481
482   smpi_init_options();
483
484   // parse the platform file: get the host list
485   SIMIX_create_environment(argv[1]);
486   SIMIX_comm_set_copy_data_callback(smpi_comm_copy_data_callback);
487   SIMIX_function_register_default(realmain);
488   SIMIX_launch_application(argv[2]);
489
490   smpi_global_init();
491
492   smpi_check_options();
493
494   if(smpi_privatize_global_variables)
495     smpi_initialize_global_memory_segments();
496
497   /* Clean IO before the run */
498   fflush(stdout);
499   fflush(stderr);
500
501   if (MC_is_active()) {
502     MC_run();
503   } else {
504   
505     SIMIX_run();
506
507     xbt_os_walltimer_stop(global_timer);
508     if (xbt_cfg_get_boolean("smpi/display-timing")){
509       double global_time = xbt_os_timer_elapsed(global_timer);
510       XBT_INFO("Simulated time: %g seconds. \n\n"
511           "The simulation took %g seconds (after parsing and platform setup)\n"
512           "%g seconds were actual computation of the application",
513           SIMIX_get_clock(), global_time , smpi_total_benched_time);
514           
515       if (smpi_total_benched_time/global_time>=0.75)
516       XBT_INFO("More than 75%% of the time was spent inside the application code.\n"
517       "You may want to use sampling functions or trace replay to reduce this.");
518     }
519   }
520   int count = smpi_process_count();
521   int i, ret=0;
522   for (i = 0; i < count; i++) {
523     if(process_data[i]->return_value()!=0){
524       ret=process_data[i]->return_value();//return first non 0 value
525       break;
526     }
527   }
528   smpi_global_destroy();
529
530   TRACE_end();
531
532   return ret;
533 }
534
535 // This function can be called from extern file, to initialize logs, options, and processes of smpi
536 // without the need of smpirun
537 void SMPI_init(){
538   smpi_init_logs();
539   smpi_init_options();
540   smpi_global_init();
541   smpi_check_options();
542   if (TRACE_is_enabled() && TRACE_is_configured())
543     TRACE_smpi_alloc();
544   if(smpi_privatize_global_variables)
545     smpi_initialize_global_memory_segments();
546 }
547
548 void SMPI_finalize(){
549   smpi_global_destroy();
550 }
551
552 void smpi_mpi_init() {
553   if(smpi_init_sleep > 0) 
554     simcall_process_sleep(smpi_init_sleep);
555 }
556
557 double smpi_mpi_wtime(){
558   double time;
559   if (smpi_process()->initialized() != 0 && smpi_process()->finalized() == 0 && smpi_process()->sampling() == 0) {
560     smpi_bench_end();
561     time = SIMIX_get_clock();
562     // to avoid deadlocks if used as a break condition, such as
563     //     while (MPI_Wtime(...) < time_limit) {
564     //       ....
565     //     }
566     // because the time will not normally advance when only calls to MPI_Wtime
567     // are made -> deadlock (MPI_Wtime never reaches the time limit)
568     if(smpi_wtime_sleep > 0) 
569       simcall_process_sleep(smpi_wtime_sleep);
570     smpi_bench_begin();
571   } else {
572     time = SIMIX_get_clock();
573   }
574   return time;
575 }
576