1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>10. Session directory — PMIx Reference Run Time Environment 3.0.8 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="11. Developer’s guide" href="developers/index.html" />
<link rel="prev" title="9. Notifications" href="notifications.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
PMIx Reference Run Time Environment
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">1. Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">2. Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-help.html">3. Getting help</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">4. Installing PRRTE</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">5. PRRTE DVM Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="how-things-work/index.html">6. How Things Work</a></li>
<li class="toctree-l1"><a class="reference internal" href="hosts/index.html">7. Host specification</a></li>
<li class="toctree-l1"><a class="reference internal" href="placement/index.html">8. Process placement</a></li>
<li class="toctree-l1"><a class="reference internal" href="notifications.html">9. Notifications</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">10. Session directory</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#directory-location">10.1. Directory location</a></li>
<li class="toctree-l2"><a class="reference internal" href="#directory-name">10.2. Directory name</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tools">10.3. Tools</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="developers/index.html">11. Developer’s guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">12. Contributing to PRRTE</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">13. License</a></li>
<li class="toctree-l1"><a class="reference internal" href="man/index.html">14. PRRTE manual pages</a></li>
<li class="toctree-l1"><a class="reference internal" href="versions.html">15. Software Version Numbers</a></li>
<li class="toctree-l1"><a class="reference internal" href="news/index.html">16. News</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">PMIx Reference Run Time Environment</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active"><span class="section-number">10. </span>Session directory</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/session-directory.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<style>
.wy-table-responsive table td,.wy-table-responsive table th{white-space:normal}
</style><div class="section" id="session-directory">
<h1><span class="section-number">10. </span>Session directory<a class="headerlink" href="#session-directory" title="Permalink to this heading"></a></h1>
<p>PRRTE establishes a “session directory” on the filesystem to serve as
a top-level location for temporary files used by both the local PRRTE
daemon and its child processes.</p>
<p>This is done to enable quick and easy cleanup in the event that PRRTE
is unable to fully cleanup after itself.</p>
<p>More detail on session directories is provided in the How Things Work
<a class="reference internal" href="how-things-work/session_dirs.html#session-dir-detail-label"><span class="std std-ref">session directory</span></a> section.</p>
<div class="section" id="directory-location">
<h2><span class="section-number">10.1. </span>Directory location<a class="headerlink" href="#directory-location" title="Permalink to this heading"></a></h2>
<p>PRRTE decides where to located the root of the session directory by
examining the following (in precedence order):</p>
<ol class="arabic">
<li><p>If the value of the <code class="docutils literal notranslate"><span class="pre">prte_top_session_dir</span></code> MCA parameter is not
empty, use that (it defaults to empty).</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>MCA parameters can be set via environment variables, on
the command line, or in a parameter file.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If necessary, the value of the top session directory on
the local node where the launcher (e.g., <code class="docutils literal notranslate"><span class="pre">prun</span></code>, <code class="docutils literal notranslate"><span class="pre">prterun</span></code>,
or <code class="docutils literal notranslate"><span class="pre">mpirun</span></code>) is executing can be set separately from
the value to be used on compute nodes via the
<code class="docutils literal notranslate"><span class="pre">prte_local_tmpdir_base</span></code> and <code class="docutils literal notranslate"><span class="pre">prte_remote_tmpdir_base</span></code>
parameters.</p>
</div>
</li>
<li><p>If the environment variable <code class="docutils literal notranslate"><span class="pre">TMPDIR</span></code> is not empty, use that.</p></li>
<li><p>If the environment variable <code class="docutils literal notranslate"><span class="pre">TEMP</span></code> is not empty, use that.</p></li>
<li><p>If the environment variable <code class="docutils literal notranslate"><span class="pre">TMP</span></code> is not empty, use that.</p></li>
<li><p>Use <code class="docutils literal notranslate"><span class="pre">/tmp</span></code></p></li>
</ol>
</div>
<div class="section" id="directory-name">
<h2><span class="section-number">10.2. </span>Directory name<a class="headerlink" href="#directory-name" title="Permalink to this heading"></a></h2>
<p>By default, the session directory name is set to</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">tool</span><span class="o">>.<</span><span class="n">nodename</span><span class="o">>.<</span><span class="n">pid</span><span class="o">>.<</span><span class="n">uid</span><span class="o">></span>
</pre></div>
</div>
<p>where <cite>tool</cite> is the argv[0] of the process setting up the
session directory. In most cases, this will be either <cite>prte</cite>,
<cite>prterun</cite>, or <cite>prted</cite> - though special tools such as <cite>psched</cite>
may also create a session directory tree.</p>
<p>The session directory name includes the PID
of the daemon process to allow a user to have multiple
instances of a tool concurrently executing on a node.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Each tool will generate its own session directory tree. This
is done to avoid cleanup race conditions where one tool might
cleanup the session directory, and thereby remove the contact
information for a tool that is continuing to execute.</p>
</div>
</div>
<div class="section" id="tools">
<h2><span class="section-number">10.3. </span>Tools<a class="headerlink" href="#tools" title="Permalink to this heading"></a></h2>
<p>In the case of tools, the rendezvous files containing connection
information for a target server are located in the session directory
tree. Thus, it may be necessary to point the tool at the location
where those files can be found if that location is other than the
expected default.</p>
</div>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="notifications.html" class="btn btn-neutral float-left" title="9. Notifications" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="developers/index.html" class="btn btn-neutral float-right" title="11. Developer’s guide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2003-2025, The PRRTE Community.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|
