Merge pull request #4 from Durganshu/develop

Debugging fixes and improved stability

Author: stepanvanecek

README.md

@@ -151,11 +151,19 @@ The default installation of `mitos` will be configured for Intel based Precise E
 
 ## Saving the virtual address
 
-The source code of the executable must save the virtual addess offset when the executable starts runnnig. This can be done by including the [virtual_address_writer.h](src/virtual_address_writer.h) and calling the function [save_virtual_address_offset("virt_address.txt")](src/virtual_address_writer.h#L18).
+The source code of the executable must save the virtual addess offset when the executable starts runnnig. This can be done by including the [virtual_address_writer.h](src/virtual_address_writer.h) and calling the function [save_virtual_address_offset("/tmp/mitos_virt_address.txt")](src/virtual_address_writer.h#L18).
 
 See [matmul.cpp](examples/matmul.cpp) for reference.
 
-This saves the virtual address offset to `/tmp/virt_address.txt`. Dyninst will access this file and attribute the source code information when the samples are saved.
+This saves the virtual address offset to `/tmp/mitos_virt_address.txt`. Dyninst will access this file and attribute the source code information when the samples are saved.
+
+When running the application with `mitosrun`, another location can also be specified. When doing this, use `-l` option with the `mitosrun` to specify the location of the file.
+
+For instance, if the application saves virtual address by calling `save_virtual_address_offset("/myPath/mitos_virt_address.txt")`, `mitosrun` can be run as:
+
+```shell
+./mitosrun -l /myPath/mitos_virt_address.txt ./myApplication
+```
 
 # Authors
 

examples/api_test.cpp

@@ -65,7 +65,7 @@ void matmul(int N, double *a, double *b, double *c)
 
 int main(int argc, char **argv)
 {
-    save_virtual_address_offset("virt_address.txt");
+    save_virtual_address_offset("/tmp/mitos_virt_address.txt");
     int N = (argc == 2) ? atoi(argv[1]) : 1024;
 
     double *a,*b,*c;
@@ -82,7 +82,7 @@ int main(int argc, char **argv)
     matmul(N,a,b,c);
     Mitos_end_sampler();
     std::set<std::string> src_files;
-    Mitos_add_offsets("", &mout);
+    Mitos_add_offsets("/tmp/mitos_virt_address.txt", &mout);
     if(Mitos_openFile(argv[0], &mout))
     {
         std::cerr << "Error opening binary file!" << std::endl;

examples/matmul.cpp

@@ -52,7 +52,7 @@ void matmul(int N, double *a, double *b, double *c)
 int main(int argc, char **argv)
 {
     int N = (argc == 2) ? atoi(argv[1]) : 1024;
-    save_virtual_address_offset("virt_address.txt");
+    save_virtual_address_offset("/tmp/mitos_virt_address.txt");
     double *a,*b,*c;
     init_matrices(N,&a,&b,&c);
     matmul(N,a,b,c);

examples/omp_example.cpp

@@ -19,7 +19,7 @@ void do_something_single_thread() {
 }
 
 int main() {
-    save_virtual_address_offset("virt_address.txt");
+    save_virtual_address_offset("/tmp/mitos_virt_address.txt");
     do_something_single_thread();
     #pragma omp parallel default(none) num_threads(8)
     {

src/CMakeLists.txt

@@ -14,12 +14,12 @@ add_library(mitoshooks SHARED ${MITOSHOOKS_SRC_FILES} ${MITOS_SRC_FILES})
 
 # Binaries
 add_executable(mitosrun mitosrun.cpp)
-add_executable(demo_post_process demo.cpp)
+add_executable(mitos_post_process mitos_post_process.cpp)
 
 # Linkage
 target_link_libraries(mitos mitoshooks numa hwloc ${CMAKE_THREAD_LIBS_INIT} stdc++fs)
 target_link_libraries(mitosrun mitos)
-target_link_libraries(demo_post_process mitos common)
+target_link_libraries(mitos_post_process mitos common)
 target_link_libraries(mitoshooks dl)
 
 if(MPI_FOUND)
@@ -37,7 +37,7 @@ install(FILES ${MITOS_HDR_PUBLIC}
 install(TARGETS mitosrun
         EXPORT mitos-targets
         DESTINATION bin)
-install(TARGETS demo_post_process
+install(TARGETS mitos_post_process
         EXPORT mitos-targets
         DESTINATION bin) 
 install(TARGETS mitos

src/Mitos.h

@@ -138,8 +138,6 @@ struct mitos_output
     char *dname_srcdir;
     char *dname_hwdatadir;
 
-    std::string dname_srcdir_orig;
-
     char *fname_raw;
     char *fname_processed;
 

src/demo.cpp renamed to src/mitos_post_process.cpp

@@ -62,7 +62,7 @@ long ts_output = 0;
 
 void sample_handler(perf_event_sample *sample, void *args)
 {
-    LOG_MEDIUM("mitoshooks.cpp: sample_handler(), MPI handler sample: cpu= " << sample->cpu << " tid= "  << sample->tid);
+    LOG_HIGH("mitoshooks.cpp: sample_handler(), MPI handler sample: cpu= " << sample->cpu << " tid= "  << sample->tid);
     Mitos_write_sample(sample, &mout);
 }
 
@@ -77,12 +77,14 @@ int MPI_Init(int *argc, char ***argv)
     MPI_Bcast(&ts_output, 1, MPI_LONG, 0, MPI_COMM_WORLD);
     // send timestamp from rank 0 to all others to synchronize folder prefix
 
-    char rank_prefix[48];
-    sprintf(rank_prefix, "%ld_rank_%d_", ts_output, mpi_rank);
+    char rank_prefix[54];
+    sprintf(rank_prefix, "mitos_%ld_rank_%d_", ts_output, mpi_rank);
 
-    virt_address = new char[strlen(rank_prefix) + 1];
-    strcpy(virt_address, rank_prefix);
-    save_virtual_address_offset(std::string(rank_prefix) + std::string("virt_address.txt"));
+    virt_address = new char[(strlen(rank_prefix) + strlen("/tmp/") + strlen("virt_address.txt") + 1)];
+    strcpy(virt_address, "/tmp/");
+    strcat(virt_address, rank_prefix);
+    strcat(virt_address, "virt_address.txt");
+    save_virtual_address_offset(std::string(virt_address));
     // Take user inputs
     int sampling_period = DEFAULT_PERIOD;
     int latency_threshold = DEFAULT_THRESH;
@@ -112,8 +114,8 @@ int MPI_Init_thread(int *argc, char ***argv, int required, int *provided)
     int mpi_rank;
     MPI_Comm_rank(MPI_COMM_WORLD, &mpi_rank);
 
-    char rank_prefix[32];
-    sprintf(rank_prefix, "rank_%d", mpi_rank);
+    char rank_prefix[38];
+    sprintf(rank_prefix, "mitos_rank_%d", mpi_rank);
 
     // Take user inputs
     int sampling_period = DEFAULT_PERIOD;
@@ -143,11 +145,11 @@ int MPI_Finalize()
     Mitos_add_offsets(virt_address, &mout);
     // merge files
     if (mpi_rank == 0) {
-        int ret_val = Mitos_merge_files(std::to_string(ts_output) + "_rank_", std::to_string(ts_output) + "_rank_0");
+        int ret_val = Mitos_merge_files(std::string("mitos_") + std::to_string(ts_output) + "_rank_", std::string("mitos_") + std::to_string(ts_output) + "_rank_0");
         Mitos_openFile("/proc/self/exe", &mout);
         std::set<std::string> src_files;
         mitos_output result_mout;
-        std::string result_dir = std::to_string(ts_output) + "_rank_result";
+        std::string result_dir = "mitos_" + std::to_string(ts_output) + "_rank_result";
         Mitos_set_result_mout(&result_mout, result_dir.c_str());    
         Mitos_post_process("/proc/self/exe", &result_mout, src_files);
         Mitos_copy_sources(result_dir, src_files);
@@ -164,7 +166,7 @@ int MPI_Finalize()
 
 void sample_handler_omp(perf_event_sample *sample, void *args)
 {
-    LOG_MEDIUM("mitoshooks.cpp: sample_handler_omp(), MPI handler sample: cpu= " << sample->cpu << " tid= "  << sample->tid);
+    LOG_HIGH("mitoshooks.cpp: sample_handler_omp(), MPI handler sample: cpu= " << sample->cpu << " tid= "  << sample->tid);
     Mitos_write_sample(sample, &mout);
 }
 
@@ -203,23 +205,25 @@ static void on_ompt_callback_thread_begin(ompt_thread_t thread_type,
     LOG_MEDIUM("mitoshooks.cpp: on_ompt_callback_thread_begin(), Start Thread OMP:= " << getpid()
          << " tid= "  << tid << " omp_tid= "  << tid_omp << " cpu_id= "  << cpu_num);
 #endif
-    char rank_prefix[48];
-    sprintf(rank_prefix, "%ld_openmp_distr_mon_%d_", ts_output_prefix_omp, tid);
+    char rank_prefix[54];
+    sprintf(rank_prefix, "mitos_%ld_openmp_distr_mon_%d_", ts_output_prefix_omp, tid);
     Mitos_create_output(&mout, rank_prefix);
 #if CURRENT_VERBOSITY >= VERBOSE_MEDIUM
    pid_t curpid = getpid();
    LOG_MEDIUM("mitoshooks.cpp: on_ompt_callback_thread_begin(), Curpid:= " << curpid);
 #endif
-    virt_address = new char[strlen(rank_prefix) + 1];
-    strcpy(virt_address, rank_prefix);
-    save_virtual_address_offset(std::string(rank_prefix) + std::string("virt_address.txt"));
+    virt_address = new char[(strlen(rank_prefix) + strlen("/tmp/") + strlen("virt_address.txt") + 1)];
+    strcpy(virt_address, "/tmp/");
+    strcat(virt_address, rank_prefix);
+    strcat(virt_address, "virt_address.txt");
+    save_virtual_address_offset(std::string(virt_address));
     // Take user inputs
     int sampling_period = DEFAULT_PERIOD;
     int latency_threshold = DEFAULT_THRESH;
     Mitos_get_environment_variables(sampling_period, latency_threshold);
 
     Mitos_pre_process(&mout);
-    Mitos_set_pid(getpid());
+    Mitos_set_pid(tid);
 
     Mitos_set_handler_fn(&sample_handler_omp,NULL);
     Mitos_set_sample_latency_threshold(latency_threshold);
@@ -269,7 +273,7 @@ void ompt_finalize(ompt_data_t *tool_data) {
            omp_get_wtime() - *(double *) (tool_data->ptr));
 
     printf("End Sampler...\n");
-    Mitos_merge_files(std::to_string(ts_output_prefix_omp) + "_openmp_distr_mon", std::to_string(ts_output_prefix_omp) + "_openmp_distr_mon_" + std::to_string(tid_omp_first));
+    Mitos_merge_files("mitos_" + std::to_string(ts_output_prefix_omp) + "_openmp_distr_mon", "mitos_" + std::to_string(ts_output_prefix_omp) + "_openmp_distr_mon_" + std::to_string(tid_omp_first));
     {
         auto bin_name = [](pid_t pid) -> std::string {    
             char buffer[1024];
@@ -291,7 +295,7 @@ void ompt_finalize(ompt_data_t *tool_data) {
         };   
         std::cout << "\n*******************************************************************\n\n";
         std::cout << "Samples collected and written as raw data. Run the following command for post-processing the samples: \n ";
-        std::cout << "./demo_post_process " <<bin_name(getpid()) << " " + std::to_string(ts_output_prefix_omp) + "_openmp_distr_monresult\n";                    
+        std::cout << "./mitos_post_process " <<bin_name(getpid()) << " mitos_" + std::to_string(ts_output_prefix_omp) + "_openmp_distr_monresult\n";                    
         std::cout << "\n*******************************************************************\n\n";    
     }
 

src/mitoshooks.cpp

@@ -98,22 +98,6 @@ int Mitos_create_output(mitos_output *mout, const char *prefix_name)
         return 1;
     }
 
-    //copy over source code to mitos output folder
-    if (!mout->dname_srcdir_orig.empty())
-    {
-        if(!fs::exists(mout->dname_srcdir_orig))
-        {
-            std::cerr << "Mitos: Source code path " << mout->dname_srcdir_orig << "does not exist!\n";
-            return 1;
-        }
-        std::error_code ec;
-        fs::copy(mout->dname_srcdir_orig, mout->dname_srcdir, ec);
-        if(ec)
-        {
-            std::cerr << "Mitos: Source code path " << mout->dname_srcdir_orig << "was not copied. Error " << ec.value() << ".\n";
-            return 1;
-        }
-    }
 
     mout->ok = true;
 
@@ -140,14 +124,14 @@ int Mitos_pre_process(mitos_output *mout)
         return 1;
     }
 
-    std::string fname_lshw = std::string(mout->dname_hwdatadir) + "/lshw.xml";
-    std::string lshw_cmd = "lshw -c memory -xml > " + fname_lshw;
-    err = system(lshw_cmd.c_str());
-    if(err)
-    {
-        std::cerr << "Mitos: Failed to create hardware topology file!\n";
-        return 1;
-    }
+    // std::string fname_lshw = std::string(mout->dname_hwdatadir) + "/lshw.xml";
+    // std::string lshw_cmd = "lshw -c memory -xml > " + fname_lshw;
+    // err = system(lshw_cmd.c_str());
+    // if(err)
+    // {
+    //     std::cerr << "Mitos: Failed to create hardware topology file!\n";
+    //     return 1;
+    // }
 
     return 0;
 }
@@ -326,7 +310,7 @@ int Mitos_write_sample(perf_event_sample *sample, mitos_output *mout)
 int Mitos_add_offsets(const char * virt_address, mitos_output *mout){
 
     // Read the virtual address
-    std::string loc = std::string("/tmp/") + std::string(virt_address) + std::string("virt_address.txt");
+    std::string loc = virt_address;
     std::ifstream foffset(loc);
     long long offsetAddr = 0;
     std::string str_offset;
@@ -441,6 +425,7 @@ std::ofstream fproc(mout->fname_processed);
         return 1;
     }
     return 0;
+#endif // USE_DYNINST
 }
 
 int Mitos_post_process(const char *bin_name, mitos_output *mout, std::set<std::string>& src_files)
@@ -466,7 +451,7 @@ int Mitos_post_process(const char *bin_name, mitos_output *mout, std::set<std::s
     Dyninst::Offset ip;
     std::string line, ip_str;
     int tmp_line = 0;
-    LOG_MEDIUM("mitosoutput.cpp: Mitos_post_process(), reading raw samples...");
+    LOG_HIGH("mitosoutput.cpp: Mitos_post_process(), reading raw samples...");
 
     while(std::getline(fraw, line).good())
     {
@@ -493,14 +478,6 @@ int Mitos_post_process(const char *bin_name, mitos_output *mout, std::set<std::s
         if(sym_success)
         {
             source = (string)stats[0]->getFile();
-            if (!mout->dname_srcdir_orig.empty())
-            {
-                std::size_t pos = source.find(mout->dname_srcdir_orig);
-                if(pos == 0){
-                    source = source.substr(mout->dname_srcdir_orig.length() + (mout->dname_srcdir_orig.back() == '/' ? 0 : 1)); //to remove slash if there is none in the string
-                }
-
-            }
             line_num << stats[0]->getLine();
         }
         if(!source.empty()){
@@ -549,8 +526,6 @@ int Mitos_post_process(const char *bin_name, mitos_output *mout, std::set<std::s
         return 1;
     }
 
-#endif // USE_DYNINST
-
     return 0;
 }
 

src/mitosoutput.cpp

@@ -20,7 +20,7 @@ uint64_t thresh;
 mitos_output mout;
 std::vector<perf_event_sample> samples;
 pid_t child_pid;
-
+static std::string address_file;
 /* Helper function for writing samples.*/
 void dump_samples()
 {
@@ -54,7 +54,7 @@ void usage(char **argv)
     std::cerr << "        -b sample buffer size (default 4096)" << std::endl;
     std::cerr << "        -p sample period (default 4000)" << std::endl;
     std::cerr << "        -t sample latency threshold (default 10)" << std::endl;
-    std::cerr << "        -s top folder of source code to copy" << std::endl;
+    std::cerr << "        -l location of virtual address file (default /tmp/mitos_virt_address.txt)" << std::endl;
     std::cerr << "    <cmd>: command to sample on (required)" << std::endl;
     std::cerr << "    [args]: command arguments" << std::endl;
 }
@@ -65,7 +65,7 @@ void set_defaults()
     bufsz = DEFAULT_BUFSZ;
     period = DEFAULT_PERIOD;
     thresh = DEFAULT_THRESH;
-    mout.dname_srcdir_orig = "";
+    address_file = "/tmp/mitos_virt_address.txt";
 }
 
 /* Parses command line arguments.*/
@@ -74,7 +74,7 @@ int parse_args(int argc, char **argv)
     set_defaults();
 
     int c;
-    while((c=getopt(argc, argv, "b:p:t:s:")) != -1)
+    while((c=getopt(argc, argv, "b:p:t:l:")) != -1)
     {
         switch(c)
         {
@@ -87,9 +87,9 @@ int parse_args(int argc, char **argv)
             case 't':
                 thresh = atoi(optarg);
                 break;
-            case 's':
-                mout.dname_srcdir_orig = optarg;
-                break;
+            case 'l':
+                address_file = optarg;
+                break;    
             case '?':
                 usage(argv);
                 return 1;
@@ -198,7 +198,7 @@ int main(int argc, char **argv)
         std::cout << "Command completed! Processing samples..." <<  "\n";
         std::cout << "Bin Name" << argv[cmdarg] <<  "\n";
         std::set<std::string> src_files;
-        Mitos_add_offsets("", &mout);
+        Mitos_add_offsets(address_file.c_str(), &mout);
         if(Mitos_openFile(argv[cmdarg], &mout))
         {
             std::cerr << "Error opening binary file!" << std::endl;
@@ -208,6 +208,7 @@ int main(int argc, char **argv)
             std::cerr << "Error post processing!" << std::endl;
             return 1;
         }
+        Mitos_copy_sources(mout.dname_topdir, src_files);   
         std::cout << "Done!\n";
     }