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
/*
* Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2013 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) 2007 Cisco Systems, Inc. All rights reserved.
* Copyright (c) 2018 Amazon.com, Inc. or its affiliates. All Rights reserved.
* Copyright (c) 2015-2020 Intel, Inc. All rights reserved.
* Copyright (c) 2021-2022 Nanook Consulting. All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
/*
* Buffer safe printf functions for portability to archaic platforms.
*/
#include "src/include/pmix_config.h"
#include "src/util/pmix_output.h"
#include "src/util/pmix_printf.h"
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#ifndef HAVE_VASPRINTF
/*
* Make a good guess about how long a printf-style varargs formatted
* string will be once all the % escapes are filled in. We don't
* handle every % escape here, but we handle enough, and then add a
* fudge factor in at the end.
*/
static int guess_strlen(const char *fmt, va_list ap)
{
#if HAVE_VSNPRINTF
char dummy[1];
/* vsnprintf() returns the number of bytes that would have been
copied if the provided buffer were infinite. */
return 1 + vsnprintf(dummy, sizeof(dummy), fmt, ap);
#else
char *sarg, carg;
double darg;
float farg;
size_t i;
int iarg;
int len;
long larg;
/* Start off with a fudge factor of 128 to handle the % escapes that
we aren't calculating here */
len = (int) strlen(fmt) + 128;
for (i = 0; i < strlen(fmt); ++i) {
if ('%' == fmt[i] && i + 1 < strlen(fmt) && '%' != fmt[i + 1]) {
++i;
switch (fmt[i]) {
case 'c':
carg = va_arg(ap, int);
len += 1; /* let's suppose it's a printable char */
(void)
carg; /* prevent compiler from complaining about set but not used variables */
break;
case 's':
sarg = va_arg(ap, char *);
/* If there's an arg, get the strlen, otherwise we'll
* use (null) */
if (NULL != sarg) {
len += (int) strlen(sarg);
} else {
#if PMIX_ENABLE_DEBUG
pmix_output(0, "PMIX DEBUG WARNING: Got a NULL argument to pmix_vasprintf!\n");
#endif
len += 5;
}
break;
case 'd':
case 'i':
iarg = va_arg(ap, int);
/* Alloc for minus sign */
if (iarg < 0)
++len;
/* Now get the log10 */
do {
++len;
iarg /= 10;
} while (0 != iarg);
break;
case 'x':
case 'X':
iarg = va_arg(ap, int);
/* Now get the log16 */
do {
++len;
iarg /= 16;
} while (0 != iarg);
break;
case 'f':
farg = (float) va_arg(ap, int);
/* Alloc for minus sign */
if (farg < 0) {
++len;
farg = -farg;
}
/* Alloc for 3 decimal places + '.' */
len += 4;
/* Now get the log10 */
do {
++len;
farg /= 10.0;
} while (0 != farg);
break;
case 'g':
darg = va_arg(ap, int);
/* Alloc for minus sign */
if (darg < 0) {
++len;
darg = -darg;
}
/* Alloc for 3 decimal places + '.' */
len += 4;
/* Now get the log10 */
do {
++len;
darg /= 10.0;
} while (0 != darg);
break;
case 'l':
/* Get %ld %lx %lX %lf */
if (i + 1 < strlen(fmt)) {
++i;
switch (fmt[i]) {
case 'x':
case 'X':
larg = va_arg(ap, int);
/* Now get the log16 */
do {
++len;
larg /= 16;
} while (0 != larg);
break;
case 'f':
darg = va_arg(ap, int);
/* Alloc for minus sign */
if (darg < 0) {
++len;
darg = -darg;
}
/* Alloc for 3 decimal places + '.' */
len += 4;
/* Now get the log10 */
do {
++len;
darg /= 10.0;
} while (0 != darg);
break;
case 'd':
default:
larg = va_arg(ap, int);
/* Now get the log10 */
do {
++len;
larg /= 10;
} while (0 != larg);
break;
}
}
default:
break;
}
}
}
return len;
#endif
}
#endif /* #ifndef HAVE_VASPRINTF */
int pmix_asprintf(char **ptr, const char *fmt, ...)
{
int length;
va_list ap;
va_start(ap, fmt);
/* pmix_vasprintf guarantees that *ptr is set to NULL on error */
length = pmix_vasprintf(ptr, fmt, ap);
va_end(ap);
return length;
}
int pmix_vasprintf(char **ptr, const char *fmt, va_list ap)
{
#ifdef HAVE_VASPRINTF
int length;
length = vasprintf(ptr, fmt, ap);
if (length < 0) {
*ptr = NULL;
}
return length;
#else
int length;
va_list ap2;
/* va_list might have pointer to internal state and using
it twice is a bad idea. So make a copy for the second
use. Copy order taken from Autoconf docs. */
#if PMIX_HAVE_VA_COPY
va_copy(ap2, ap);
#elif PMIX_HAVE_UNDERSCORE_VA_COPY
__va_copy(ap2, ap);
#else
memcpy(&ap2, &ap, sizeof(va_list));
#endif
/* guess the size */
length = guess_strlen(fmt, ap);
/* allocate a buffer */
*ptr = (char *) malloc((size_t) length + 1);
if (NULL == *ptr) {
errno = ENOMEM;
va_end(ap2);
return -1;
}
/* fill the buffer */
length = vsprintf(*ptr, fmt, ap2);
#if PMIX_HAVE_VA_COPY || PMIX_HAVE_UNDERSCORE_VA_COPY
va_end(ap2);
#endif /* PMIX_HAVE_VA_COPY || PMIX_HAVE_UNDERSCORE_VA_COPY */
/* realloc */
*ptr = (char *) realloc(*ptr, (size_t) length + 1);
if (NULL == *ptr) {
errno = ENOMEM;
return -1;
}
return length;
#endif
}
int pmix_snprintf(char *str, size_t size, const char *fmt, ...)
{
int length;
va_list ap;
va_start(ap, fmt);
length = pmix_vsnprintf(str, size, fmt, ap);
va_end(ap);
return length;
}
int pmix_vsnprintf(char *str, size_t size, const char *fmt, va_list ap)
{
int length;
char *buf;
length = pmix_vasprintf(&buf, fmt, ap);
if (length < 0) {
return length;
}
/* return the length when given a null buffer (C99) */
if (str) {
if ((size_t) length < size) {
strcpy(str, buf);
} else {
memcpy(str, buf, size - 1);
str[size] = '\0';
}
}
/* free allocated buffer */
free(buf);
return length;
}
#ifdef TEST
int main(int argc, char *argv[])
{
char a[10];
char b[173];
char *s;
int length;
puts("test for NULL buffer in snprintf:");
length = pmix_snprintf(NULL, 0, "this is a string %d", 1004);
printf("length = %d\n", length);
puts("test of snprintf to an undersize buffer:");
length = pmix_snprintf(a, sizeof(a), "this is a string %d", 1004);
printf("string = %s\n", a);
printf("length = %d\n", length);
printf("strlen = %d\n", (int) strlen(a));
puts("test of snprintf to an oversize buffer:");
length = pmix_snprintf(b, sizeof(b), "this is a string %d", 1004);
printf("string = %s\n", b);
printf("length = %d\n", length);
printf("strlen = %d\n", (int) strlen(b));
puts("test of asprintf:");
length = pmix_asprintf(&s, "this is a string %d", 1004);
printf("string = %s\n", s);
printf("length = %d\n", length);
printf("strlen = %d\n", (int) strlen(s));
free(s);
return 0;
}
#endif