{"id":19706077,"url":"https://github.com/llnl/mpip","last_synced_at":"2025-07-02T13:06:57.199Z","repository":{"id":46824737,"uuid":"56355311","full_name":"LLNL/mpiP","owner":"LLNL","description":"A light-weight MPI profiler.","archived":false,"fork":false,"pushed_at":"2024-07-24T16:59:55.000Z","size":1743,"stargazers_count":93,"open_issues_count":28,"forks_count":34,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-04-12T21:11:48.420Z","etag":null,"topics":["mpi"],"latest_commit_sha":null,"homepage":"http://llnl.github.io/mpiP","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LLNL.png","metadata":{"files":{"readme":"README.md","changelog":"ChangeLog","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-04-15T23:27:47.000Z","updated_at":"2025-04-10T20:15:48.000Z","dependencies_parsed_at":"2024-11-11T21:33:51.875Z","dependency_job_id":"71ebe0bf-154e-459d-88e8-b371b3ef0532","html_url":"https://github.com/LLNL/mpiP","commit_stats":{"total_commits":585,"total_committers":9,"mean_commits":65.0,"dds":0.07008547008547006,"last_synced_commit":"29faf3a32930044868807175db84b0c47934393c"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/LLNL/mpiP","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LLNL%2FmpiP","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LLNL%2FmpiP/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LLNL%2FmpiP/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LLNL%2FmpiP/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LLNL","download_url":"https://codeload.github.com/LLNL/mpiP/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LLNL%2FmpiP/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263145841,"owners_count":23420678,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mpi"],"created_at":"2024-11-11T21:33:41.269Z","updated_at":"2025-07-02T13:06:57.154Z","avatar_url":"https://github.com/LLNL.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mpiP 3.5\nA light-weight MPI profiler.\n\n## Introduction\nmpiP is a light-weight profiling library for MPI applications. Because it only collects statistical information about MPI functions, mpiP generates considerably less overhead and much less data than tracing tools. All the information captured by mpiP is task-local. It only uses communication during report generation, typically at the end of the experiment, to merge results from all of the tasks into one output file.\n\n## Downloading\nThe current version of mpiP can be accessed at [https://github.com/LLNL/mpiP/releases/latest](https://github.com/LLNL/mpiP/releases/latest).\n\n## New Features \u0026 Bug Fixes\nVersion 3.5 includes several new features, including\n\n- Multi-threaded support\n- Additional MPI-IO functions\n- Various updates including\n  - New configuration options and tests\n  - Updated test suite\n  - Updated build behavior\n\nPlease see the ChangeLog for additional changes.\n\n##  Configuring and Building mpiP\n### Dependencies\n- MPI installation\n- libunwind : for collecting stack traces.  \n- binutils : for address to source translation\n- glibc backtrace() can also be usef for stack tracing, but source line numbers may be inconsistent.\n\n### Configuration\nSeveral specific configuration flags can be using, as provided by ```./configure -h```.\nStandard configure flags, such as CC, can be used for specifying MPI compiler wrapper scripts.\n\n### Build Make Targets\n|Target|Effect|\n|---|---|\n|[default]| Build libmpiP.so|\n|all|Build shared library and all tests|\n|check|Use dejagnu to run and evaluate tests|\n\n## Using mpiP\nUsing mpiP is very simple. Because it gathers MPI information through the MPI profiling layer, mpiP is a link time library. That is, you don't have to recompile your application to use mpiP. Note that you might have to recompile to include the '-g' option. This is important if you want mpiP to decode the PC to a source code filename and line number automatically. mpiP will work without -g, but mileage may vary.\n\n### Instrumentation\n#### Link Time Instrumentation\nLink the mpiP library with an executable. The dependent libraries may need to be specified as well.  If the link command includes the MPI library, order the mpiP library before the MPI library, as in ``` -lmpiP -lmpi```.\n\n#### Run Time Instrumentation\nAn uninstrumented executable may able to be instrumented at run time by setting the LD_PRELOAD environment variable, as in ```export LD_PRELOAD=[path to mpiP]/libmpiP.so```.  Preloading libmpiP can possibly interfere with the launcher and may need to be specified on the launch command, such as ```srun -n 2 --export=LD_PRELOAD=[path to mpiP]/libmpiP.so [executable]```.\n\n### mpiP Run Time Flags\nThe behavior of mpiP can be set at run time through the use of the following flags.  Multiple flags can be delimited with spaces or commas.\n\n|Option|\tDescription|\tDefault|\n|---|---|---|\n|-c\t| Generate concise version of report, omitting callsite process-specific detail.||\n|-d\t|Suppress printing of callsite detail sections.||\n|-e|Print report data using floating-point format.  |\n|-f dir| Record output file in directory \\\u003cdir\u003e. |.|\n|-g|Enable mpiP debug mode.| disabled|\n|-k n |Sets callsite stack traceback depth to \u003cn\u003e.| 1|\n|-l|Use less memory to generate the report by using MPI collectives to generate callsite information on a callsite-by-callsite basis.  |\n|-n|Do not truncate full pathname of filename in callsites.  |\n|-o|Disable profiling at initialization. Application must enable profiling with MPI_Pcontrol().  |\n|-p|Point-to-point histogram reporting on message size and communicator used.|\n|-r|Generate the report by aggregating data at a single task. |default|\n|-s n|Set hash table size to \\\u003cn\u003e. |256|\n|-t x|Set print threshold for report, where \\\u003cx\u003e is the MPI percentage of time for each callsite. |0.0|\n|-v|Generates both concise and verbose report output.  |\n|-x exe |Specify the full path to the executable.  |\n|-y|Collective histogram reporting on message size and communicator used.|\n|-z|Suppress printing of the report at MPI_Finalize.  |\n\t\nFor example, to set the callsite stack walking depth to 2 and the report print threshold to 10%, you simply need to define the mpiP string in your environment, as in any of the following examples:\n\n```\n$ export MPIP=\"-t 10.0 -k 2\" (bash)\n\n$ export MPIP=-t10.0,-k2 (bash)\n\n$ setenv MPIP \"-t 10.0 -k 2\" (csh)\n```\n\nmpiP prints a message at initialization if it successfully finds the MPIP variable.\n\nFor more information on mpiP, please see the User Guide in the mpiP distribution.\n\n## License\nCopyright (c) 2006, The Regents of the University of California.\nProduced at the Lawrence Livermore National Laboratory\nWritten by Jeffery Vetter and Christopher Chambreau.\nUCRL-CODE-223450.\nAll rights reserved.\n \nThis file is part of mpiP.  For details, see http://llnl.github.io/mpiP.\n \nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are\nmet:\n \n* Redistributions of source code must retain the above copyright\nnotice, this list of conditions and the disclaimer below.\n\n* Redistributions in binary form must reproduce the above copyright\nnotice, this list of conditions and the disclaimer (as noted below) in\nthe documentation and/or other materials provided with the\ndistribution.\n\n* Neither the name of the UC/LLNL nor the names of its contributors\nmay be used to endorse or promote products derived from this software\nwithout specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\nLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\nA PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OF\nTHE UNIVERSITY OF CALIFORNIA, THE U.S. DEPARTMENT OF ENERGY OR\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\nEXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR\nPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\nLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\nSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n \n \nAdditional BSD Notice\n \n1. This notice is required to be provided under our contract with the\nU.S. Department of Energy (DOE).  This work was produced at the\nUniversity of California, Lawrence Livermore National Laboratory under\nContract No. W-7405-ENG-48 with the DOE.\n \n2. Neither the United States Government nor the University of\nCalifornia nor any of their employees, makes any warranty, express or\nimplied, or assumes any liability or responsibility for the accuracy,\ncompleteness, or usefulness of any information, apparatus, product, or\nprocess disclosed, or represents that its use would not infringe\nprivately-owned rights.\n \n3.  Also, reference herein to any specific commercial products,\nprocess, or services by trade name, trademark, manufacturer or\notherwise does not necessarily constitute or imply its endorsement,\nrecommendation, or favoring by the United States Government or the\nUniversity of California.  The views and opinions of authors expressed\nherein do not necessarily state or reflect those of the United States\nGovernment or the University of California, and shall not be used for\nadvertising or product endorsement purposes.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fllnl%2Fmpip","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fllnl%2Fmpip","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fllnl%2Fmpip/lists"}