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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
/*
* Copyright (c) 2004-2007 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2005 The University of Tennessee and The University
* of Tennessee Research Foundation. All rights
* reserved.
* Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
* University of Stuttgart. All rights reserved.
* Copyright (c) 2004-2005 The Regents of the University of California.
* All rights reserved.
* Copyright (c) 2012-2020 Cisco Systems, Inc. All rights reserved
* Copyright (c) 2015-2020 Intel, Inc. All rights reserved.
* Copyright (c) 2016-2017 Los Alamos National Security, LLC. All rights
* reserved.
* Copyright (c) 2017 IBM Corporation. All rights reserved.
* Copyright (c) 2021-2025 Nanook Consulting All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
#ifndef PMIX_CMD_LINE_H
#define PMIX_CMD_LINE_H
#include "src/include/pmix_config.h"
#ifdef HAVE_UNISTD_H
# include <unistd.h>
#endif
#include <ctype.h>
#include <stdio.h>
#include <string.h>
#include <getopt.h>
#include "src/class/pmix_list.h"
#include "src/class/pmix_object.h"
#include "src/util/pmix_argv.h"
BEGIN_C_DECLS
typedef struct {
pmix_list_item_t super;
char *key;
char **values;
} pmix_cli_item_t;
PMIX_CLASS_DECLARATION(pmix_cli_item_t);
typedef struct {
pmix_object_t super;
pmix_list_t instances; // comprised of pmix_cli_item_t's
char **tail; // remainder of argv
} pmix_cli_result_t;
PMIX_CLASS_DECLARATION(pmix_cli_result_t);
#define PMIX_CLI_RESULT_STATIC_INIT \
{ \
.super = PMIX_OBJ_STATIC_INIT(pmix_object_t), \
.instances = PMIX_LIST_STATIC_INIT, \
.tail = NULL \
}
/* define PMIX-named flags for argument required */
#define PMIX_ARG_REQD required_argument
#define PMIX_ARG_NONE no_argument
#define PMIX_ARG_OPTIONAL optional_argument
/* define PMIX-named flags for whether parsing
* CLI shall include deprecation warnings */
#define PMIX_CLI_SILENT true
#define PMIX_CLI_WARN false
/* define a long option that has no short option equivalent
*
* n = name of the option (see below for definitions)
* a = whether or not it requires an argument
*/
#define PMIX_OPTION_DEFINE(n, a) \
{ \
.name = (n), \
.has_arg = (a), \
.flag = NULL, \
.val = 0 \
}
/* define a long option that has a short option equivalent
*
* n = name of the option (see below for definitions)
* a = whether or not it requires an argument
* c = single character equivalent option
*/
#define PMIX_OPTION_SHORT_DEFINE(n, a, c) \
{ \
.name = (n), \
.has_arg = (a), \
.flag = NULL, \
.val = (c) \
}
#define PMIX_OPTION_END {0, 0, 0, 0}
// NAME STRING ARGUMENT
// Basic options
#define PMIX_CLI_HELP "help" // optional
#define PMIX_CLI_VERSION "version" // none
#define PMIX_CLI_VERBOSE "verbose" // number of instances => verbosity level
#define PMIX_CLI_PMIXMCA "pmixmca" // requires TWO
// Tool connection options
#define PMIX_CLI_SYS_SERVER_FIRST "system-server-first" // none
#define PMIX_CLI_SYSTEM_SERVER "system-server" // none
#define PMIX_CLI_SYS_SERVER_ONLY "system-server-only" // none
#define PMIX_CLI_DO_NOT_CONNECT "do-not-connect" // none
#define PMIX_CLI_WAIT_TO_CONNECT "wait-to-connect" // required
#define PMIX_CLI_NUM_CONNECT_RETRIES "num-connect-retries" // required
#define PMIX_CLI_PID "pid" // required
#define PMIX_CLI_NAMESPACE "namespace" // required
#define PMIX_CLI_NSPACE "nspace" // required
#define PMIX_CLI_URI "uri" // required
#define PMIX_CLI_TIMEOUT "timeout" // required
#define PMIX_CLI_TMPDIR "tmpdir" // required
#define PMIX_CLI_CONNECTION_ORDER "connect-order" // required
#define PMIX_CLI_SYS_CONTROLLER "system-controller" // none
// Allocation request options
#define PMIX_CLI_REQ_ID "request-id" // required
#define PMIX_CLI_QUEUE "queue" // required, short is 'q'
#define PMIX_CLI_RESOURCES "resources" // required
#define PMIX_CLI_NODES "nodes" // required, short is 'N'
#define PMIX_CLI_IMAGE "image" // required, short is 'i'
#define PMIX_CLI_EXCLUDE "exclude" // required, short is 'x'
#define PMIX_CLI_WAIT_ALL_NODES "wait-all-nodes" // none
#define PMIX_CLI_NODELIST "nodelist" // required, short is 'w'
#define PMIX_CLI_UID "uid" // required
#define PMIX_CLI_GID "gid" // required
#define PMIX_CLI_TIME "time" // required, short is 't'
#define PMIX_CLI_SIGNAL "signal" // required
#define PMIX_CLI_SHARE "share" // none
#define PMIX_CLI_EXTEND "extend" // none
#define PMIX_CLI_SHRINK "shrink" // none
#define PMIX_CLI_NO_SHELL "no-shell" // none
#define PMIX_CLI_BEGIN "begin" // required
#define PMIX_CLI_IMMEDIATE "immediate" // optional, short is 'I'
#define PMIX_CLI_DEPENDENCY "dependency" // required, short is 'd'
#define PMIX_CLI_DO_NOT_WAIT "do-not-wait" // none
// Job control options
#define PMIX_CLI_PAUSE "pause" // none
#define PMIX_CLI_RESUME "resume" // none
#define PMIX_CLI_CANCEL "cancel" // required
#define PMIX_CLI_KILL "kill" // none
#define PMIX_CLI_RESTART "restart" // required
#define PMIX_CLI_CHKPT "checkpoint" // required
#define PMIX_CLI_TARGETS "targets" // required
#define PMIX_CLI_TERMINATE "terminate" // none
#define PMIX_CLI_PSET_NAME "pset" // required
#define PMIX_CLI_FWD_ENVAR "x" // required
#define PMIX_CLI_PREPEND_ENVAR "prepend-env" // required
#define PMIX_CLI_APPEND_ENVAR "append-env" // required
#define PMIX_CLI_UNSET_ENVAR "unset-env" // required
typedef void (*pmix_cmd_line_store_fn_t)(const char *name, const char *option,
pmix_cli_result_t *results);
PMIX_EXPORT int pmix_cmd_line_parse(char **argv, char *shorts,
struct option myoptions[],
pmix_cmd_line_store_fn_t storefn,
pmix_cli_result_t *results,
char *helpfile);
static inline pmix_cli_item_t* pmix_cmd_line_get_param(pmix_cli_result_t *results,
const char *key)
{
pmix_cli_item_t *opt;
PMIX_LIST_FOREACH(opt, &results->instances, pmix_cli_item_t) {
if (0 == strcmp(opt->key, key)) {
return opt;
}
}
return NULL;
}
static inline bool pmix_cmd_line_is_taken(pmix_cli_result_t *results,
const char *key)
{
if (NULL == pmix_cmd_line_get_param(results, key)) {
return false;
}
return true;
}
static inline int pmix_cmd_line_get_ninsts(pmix_cli_result_t *results,
const char *key)
{
pmix_cli_item_t *opt;
opt = pmix_cmd_line_get_param(results, key);
if (NULL == opt) {
return 0;
}
return PMIx_Argv_count(opt->values);
}
static inline char* pmix_cmd_line_get_nth_instance(pmix_cli_result_t *results,
const char *key, int idx)
{
pmix_cli_item_t *opt;
int ninst;
opt = pmix_cmd_line_get_param(results, key);
if (NULL == opt) {
return NULL;
}
ninst = PMIx_Argv_count(opt->values);
if (ninst < idx) {
return NULL;
}
return opt->values[idx];
}
/* USAGE:
* param "a" is the input command line string
* param "b" is the defined CLI option
*/
static inline bool pmix_check_cli_option(char *a, char *b)
{
size_t len1, len2, len, n;
char **asplit, **bsplit;
int match;
/* if there exists a '-' in either argument,
* then we are dealing with a multi-word
* option. Parse those by checking each
* word segment individually for a match
* so the user doesn't have to spell it all
* out unless necessary. We consider it a
* valid match if all provided segments match
* that of the target option */
if (NULL != strchr(b, '-') ||
NULL != strchr(a, '-')) {
asplit = PMIx_Argv_split(a, '-');
bsplit = PMIx_Argv_split(b, '-');
if (PMIx_Argv_count(asplit) > PMIx_Argv_count(bsplit)) {
PMIx_Argv_free(asplit);
PMIx_Argv_free(bsplit);
return false;
}
match = 0;
for (n=0; NULL != asplit[n] && NULL != bsplit[n]; n++) {
len1 = strlen(asplit[n]);
len2 = strlen(bsplit[n]);
len = len1 < len2 ? len1 : len2;
if (0 == strncasecmp(asplit[n], bsplit[n], len)) {
++match;
} else {
PMIx_Argv_free(asplit);
PMIx_Argv_free(bsplit);
return false;
}
}
PMIx_Argv_free(asplit);
PMIx_Argv_free(bsplit);
if (match == PMIx_Argv_count(asplit)) {
/* all provided segments match */
return true;
}
return false;
}
/* if this is not a multi-word option, we just
* check the strings */
len1 = strlen(a);
len2 = strlen(b);
len = (len1 < len2) ? len1 : len2;
if (0 == strncasecmp(a, b, len)) {
return true;
}
return false;
}
#define PMIX_CHECK_CLI_OPTION(a, b) \
pmix_check_cli_option(a, b)
static inline unsigned int pmix_convert_string_to_time(const char *t)
{
char **tmp = PMIx_Argv_split(t, ':');
int sz = PMIx_Argv_count(tmp);
unsigned int tm;
/* work upwards from the bottom, where the
* bottom represents seconds, then minutes,
* then hours, and then days */
tm = strtoul(tmp[sz-1], NULL, 10);
if (0 <= (sz-2) && NULL != tmp[sz-2]) {
tm += 60 * strtoul(tmp[sz-2], NULL, 10);
}
if (0 <= (sz-3) && NULL != tmp[sz-3]) {
tm += 60 * 60 * strtoul(tmp[sz-3], NULL, 10);
}
if (0 <= (sz-4) && NULL != tmp[sz-4]) {
tm += 24 * 60 * 60 * strtoul(tmp[sz-4], NULL, 10);
}
PMIx_Argv_free(tmp);
return tm;
}
#define PMIX_CONVERT_TIME(s) \
pmix_convert_string_to_time(s)
#define PMIX_CLI_DEBUG_LIST(r) \
do { \
pmix_cli_item_t *_c; \
char *_tail; \
pmix_output(0, "\n[%s:%s:%d]", __FILE__, __func__, __LINE__); \
PMIX_LIST_FOREACH(_c, &(r)->instances, pmix_cli_item_t) { \
pmix_output(0, "KEY: %s", _c->key); \
if (NULL != _c->values) { \
for (int _n=0; NULL != _c->values[_n]; _n++) { \
pmix_output(0, " VAL[%d]: %s", _n, _c->values[_n]); \
} \
} \
} \
_tail = PMIx_Argv_join((r)->tail, ' '); \
pmix_output(0, "TAIL: %s", _tail); \
free(_tail); \
pmix_output(0, "\n"); \
} while(0)
#define PMIX_CLI_REMOVE_DEPRECATED(r, o) \
do { \
pmix_list_remove_item(&(r)->instances, &(o)->super); \
PMIX_RELEASE(o); \
} while(0)
END_C_DECLS
#endif /* PMIX_CMD_LINE_H */