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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
<!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>17.2.1. PMIx_Abort — OpenPMIx 5.0.5 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="17.2.2. PMIx_Init" href="PMIx_Init.3.html" />
<link rel="prev" title="17.2. APIs (section 3)" href="index.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">
OpenPMIx
</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="../../getting-help.html">2. Getting help</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release-notes/index.html">3. Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../exceptions.html">4. Exceptions to the PMIx Standard</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../installing-pmix/index.html">5. Building and installing PMIx</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="../../release-notes.html">7. Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../history.html">8. History</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../versions.html">9. Version Numbers and Binary Compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../mca.html">10. The Modular Component Architecture (MCA)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../building-apps/index.html">11. Building PMIx applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/index.html">12. Developer’s guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">13. Contributing to OpenPMIx</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">14. License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../security.html">15. OpenPMIx Security Policy</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../news/index.html">16. News</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">17. OpenPMIx manual pages</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../man1/index.html">17.1. Commands (section 1)</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">17.2. APIs (section 3)</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">17.2.1. PMIx_Abort</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#synopsis">17.2.1.1. SYNOPSIS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#arguments">17.2.1.2. ARGUMENTS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#description">17.2.1.3. DESCRIPTION</a></li>
<li class="toctree-l4"><a class="reference internal" href="#return-value">17.2.1.4. RETURN VALUE</a></li>
<li class="toctree-l4"><a class="reference internal" href="#errors">17.2.1.5. ERRORS</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="PMIx_Init.3.html">17.2.2. PMIx_Init</a></li>
<li class="toctree-l3"><a class="reference internal" href="PMIx_Finalize.3.html">17.2.3. PMIx_Finalize</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../man5/index.html">17.3. Config file manual pages (section 5)</a></li>
</ul>
</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">OpenPMIx</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"><a href="../index.html"><span class="section-number">17. </span>OpenPMIx manual pages</a></li>
<li class="breadcrumb-item"><a href="index.html"><span class="section-number">17.2. </span>APIs (section 3)</a></li>
<li class="breadcrumb-item active"><span class="section-number">17.2.1. </span>PMIx_Abort</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/man/man3/PMIx_Abort.3.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="pmix-abort">
<span id="man3-pmix-abort"></span><h1><span class="section-number">17.2.1. </span>PMIx_Abort<a class="headerlink" href="#pmix-abort" title="Permalink to this heading"></a></h1>
<p>PMIx_Abort - Abort the specified processes</p>
<div class="section" id="synopsis">
<h2><span class="section-number">17.2.1.1. </span>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf"><pmix.h></span>
<span class="n">pmix_status_t</span><span class="w"> </span><span class="nf">PMIx_Abort</span><span class="p">(</span><span class="kt">int</span><span class="w"> </span><span class="n">status</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="n">msg</span><span class="p">[],</span>
<span class="w"> </span><span class="n">pmix_proc_t</span><span class="w"> </span><span class="n">procs</span><span class="p">[],</span><span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">nprocs</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="arguments">
<h2><span class="section-number">17.2.1.2. </span>ARGUMENTS<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">status</span></code>: Status value to be returned. A value of zero is
permitted by PMIx, but may not be returned by some resource
managers.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">msg</span></code>: A string message to be displayed.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">procs</span></code>: An array of <code class="docutils literal notranslate"><span class="pre">pmix_proc_t</span></code> structures defining the
processes to be aborted. A NULL for the proc array indicates that
all processes in the caller’s namespace are to be aborted. A
wildcard value for the rank in any structure indicates that all
processes in that namespace are to be aborted.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">nprocs</span></code>: Number of <code class="docutils literal notranslate"><span class="pre">pmix_proc_t</span></code> structures in the <code class="docutils literal notranslate"><span class="pre">procs</span></code>
array.</p></li>
</ul>
</div>
<div class="section" id="description">
<h2><span class="section-number">17.2.1.3. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>Request that the provided array of procs be aborted, returning the
provided status and printing the provided message. A NULL for the
<code class="docutils literal notranslate"><span class="pre">procs</span></code> array indicates that all processes in the caller’s namespace
are to be aborted.</p>
<p>The response to this request is somewhat dependent on the specific
resource manager and its configuration (e.g., some resource managers
will not abort the application if the provided status is zero unless
specifically configured to do so), and thus lies outside the control
of PMIx itself. However, the client will inform the RM of the request
that the application be aborted, regardless of the value of the
provided status.</p>
<p>Passing a NULL <code class="docutils literal notranslate"><span class="pre">msg</span></code> parameter is allowed. Note that race conditions
caused by multiple processes calling <code class="docutils literal notranslate"><span class="pre">PMIx_Abort</span></code> are left to the server
implementation to resolve with regard to which status is returned and
what messages (if any) are printed.</p>
</div>
<div class="section" id="return-value">
<h2><span class="section-number">17.2.1.4. </span>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this heading"></a></h2>
<p>Returns <code class="docutils literal notranslate"><span class="pre">PMIX_SUCCESS</span></code> on success. On error, a negative value
corresponding to a PMIx <code class="docutils literal notranslate"><span class="pre">errno</span></code> is returned.</p>
</div>
<div class="section" id="errors">
<h2><span class="section-number">17.2.1.5. </span>ERRORS<a class="headerlink" href="#errors" title="Permalink to this heading"></a></h2>
<p>PMIx errno values are defined in <code class="docutils literal notranslate"><span class="pre">pmix_common.h</span></code>.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p>PMIx_Commit(3),
<a class="reference internal" href="PMIx_Finalize.3.html#man3-pmix-finalize"><span class="std std-ref">PMIx_Finalize(3)</span></a>,
<a class="reference internal" href="PMIx_Init.3.html#man3-pmix-init"><span class="std std-ref">PMIx_Init(3)</span></a>,
PMIx_Initialized(3),
PMIx_Put(3),
pmiAddInstance(3),
pmiAddMetric(3)</p>
</div>
</div>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="17.2. APIs (section 3)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="PMIx_Init.3.html" class="btn btn-neutral float-right" title="17.2.2. PMIx_Init" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2014-2025, The OpenPMIx 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>
|
