1*5c51f124SMoriah Waterland /*
2*5c51f124SMoriah Waterland * CDDL HEADER START
3*5c51f124SMoriah Waterland *
4*5c51f124SMoriah Waterland * The contents of this file are subject to the terms of the
5*5c51f124SMoriah Waterland * Common Development and Distribution License (the "License").
6*5c51f124SMoriah Waterland * You may not use this file except in compliance with the License.
7*5c51f124SMoriah Waterland *
8*5c51f124SMoriah Waterland * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9*5c51f124SMoriah Waterland * or http://www.opensolaris.org/os/licensing.
10*5c51f124SMoriah Waterland * See the License for the specific language governing permissions
11*5c51f124SMoriah Waterland * and limitations under the License.
12*5c51f124SMoriah Waterland *
13*5c51f124SMoriah Waterland * When distributing Covered Code, include this CDDL HEADER in each
14*5c51f124SMoriah Waterland * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15*5c51f124SMoriah Waterland * If applicable, add the following below this CDDL HEADER, with the
16*5c51f124SMoriah Waterland * fields enclosed by brackets "[]" replaced with your own identifying
17*5c51f124SMoriah Waterland * information: Portions Copyright [yyyy] [name of copyright owner]
18*5c51f124SMoriah Waterland *
19*5c51f124SMoriah Waterland * CDDL HEADER END
20*5c51f124SMoriah Waterland */
21*5c51f124SMoriah Waterland /*
22*5c51f124SMoriah Waterland * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
23*5c51f124SMoriah Waterland * Use is subject to license terms.
24*5c51f124SMoriah Waterland */
25*5c51f124SMoriah Waterland
26*5c51f124SMoriah Waterland
27*5c51f124SMoriah Waterland
28*5c51f124SMoriah Waterland /*
29*5c51f124SMoriah Waterland * Module: zones_args.c
30*5c51f124SMoriah Waterland * Group: libinstzones
31*5c51f124SMoriah Waterland * Description: Private functions used by zones library functions to manipulate
32*5c51f124SMoriah Waterland * argument lists
33*5c51f124SMoriah Waterland *
34*5c51f124SMoriah Waterland * Public Methods:
35*5c51f124SMoriah Waterland *
36*5c51f124SMoriah Waterland * _z_add_arg - add new argument to argument array for use in exec() calls
37*5c51f124SMoriah Waterland * _z_free_args - free all storage contained in an argument array previously
38*5c51f124SMoriah Waterland * _z_get_argc - return (int) argc count from argument array
39*5c51f124SMoriah Waterland * _z_get_argv - return (char **)argv pointer from argument array
40*5c51f124SMoriah Waterland * _z_new_args - create a new argument array for use in exec() calls
41*5c51f124SMoriah Waterland */
42*5c51f124SMoriah Waterland
43*5c51f124SMoriah Waterland /*
44*5c51f124SMoriah Waterland * System includes
45*5c51f124SMoriah Waterland */
46*5c51f124SMoriah Waterland
47*5c51f124SMoriah Waterland #include <stdio.h>
48*5c51f124SMoriah Waterland #include <stdlib.h>
49*5c51f124SMoriah Waterland #include <unistd.h>
50*5c51f124SMoriah Waterland #include <fcntl.h>
51*5c51f124SMoriah Waterland #include <ctype.h>
52*5c51f124SMoriah Waterland #include <sys/types.h>
53*5c51f124SMoriah Waterland #include <sys/param.h>
54*5c51f124SMoriah Waterland #include <string.h>
55*5c51f124SMoriah Waterland #include <strings.h>
56*5c51f124SMoriah Waterland #include <stdarg.h>
57*5c51f124SMoriah Waterland #include <limits.h>
58*5c51f124SMoriah Waterland #include <errno.h>
59*5c51f124SMoriah Waterland #include <stropts.h>
60*5c51f124SMoriah Waterland #include <libintl.h>
61*5c51f124SMoriah Waterland #include <locale.h>
62*5c51f124SMoriah Waterland #include <assert.h>
63*5c51f124SMoriah Waterland
64*5c51f124SMoriah Waterland /*
65*5c51f124SMoriah Waterland * local includes
66*5c51f124SMoriah Waterland */
67*5c51f124SMoriah Waterland
68*5c51f124SMoriah Waterland #include "instzones_lib.h"
69*5c51f124SMoriah Waterland #include "zones_strings.h"
70*5c51f124SMoriah Waterland
71*5c51f124SMoriah Waterland /*
72*5c51f124SMoriah Waterland * Private structures
73*5c51f124SMoriah Waterland */
74*5c51f124SMoriah Waterland
75*5c51f124SMoriah Waterland /*
76*5c51f124SMoriah Waterland * Library Function Prototypes
77*5c51f124SMoriah Waterland */
78*5c51f124SMoriah Waterland
79*5c51f124SMoriah Waterland /*
80*5c51f124SMoriah Waterland * Local Function Prototypes
81*5c51f124SMoriah Waterland */
82*5c51f124SMoriah Waterland
83*5c51f124SMoriah Waterland /*
84*5c51f124SMoriah Waterland * Global internal (private) declarations
85*5c51f124SMoriah Waterland */
86*5c51f124SMoriah Waterland
87*5c51f124SMoriah Waterland /*
88*5c51f124SMoriah Waterland * *****************************************************************************
89*5c51f124SMoriah Waterland * global external (public) functions
90*5c51f124SMoriah Waterland * *****************************************************************************
91*5c51f124SMoriah Waterland */
92*5c51f124SMoriah Waterland
93*5c51f124SMoriah Waterland /*
94*5c51f124SMoriah Waterland * Name: _z_add_arg
95*5c51f124SMoriah Waterland * Description: add new argument to argument array for use in exec() calls
96*5c51f124SMoriah Waterland * Arguments: a_args - [RO, *RW] - (argArray_t *)
97*5c51f124SMoriah Waterland * Pointer to argument array (previously allocated via
98*5c51f124SMoriah Waterland * a call to _z_new_args) to add the argument to
99*5c51f124SMoriah Waterland * a_format - [RO, *RO] - (char *)
100*5c51f124SMoriah Waterland * Pointer to "printf(3C)" style format argument
101*5c51f124SMoriah Waterland * ... - [RO, *RO] - (varies)
102*5c51f124SMoriah Waterland * Arguments as appropriate for format argument specified
103*5c51f124SMoriah Waterland * Returns: boolean_t
104*5c51f124SMoriah Waterland * B_TRUE - success
105*5c51f124SMoriah Waterland * B_FALSE - failure
106*5c51f124SMoriah Waterland * Examples:
107*5c51f124SMoriah Waterland * - to add an argument that specifies a file descriptor:
108*5c51f124SMoriah Waterland * int fd;
109*5c51f124SMoriah Waterland * _z_add_arg(aa, "/proc/self/fd/%d", fd);
110*5c51f124SMoriah Waterland * - to add a flag or other known text:
111*5c51f124SMoriah Waterland * _z_add_arg(aa, "-s")
112*5c51f124SMoriah Waterland * - to add random text:
113*5c51f124SMoriah Waterland * char *random_text;
114*5c51f124SMoriah Waterland * _z_add_arg(aa, "%s", random_text);
115*5c51f124SMoriah Waterland */
116*5c51f124SMoriah Waterland
117*5c51f124SMoriah Waterland /*PRINTFLIKE2*/
118*5c51f124SMoriah Waterland boolean_t
_z_add_arg(argArray_t * a_args,char * a_format,...)119*5c51f124SMoriah Waterland _z_add_arg(argArray_t *a_args, char *a_format, ...)
120*5c51f124SMoriah Waterland {
121*5c51f124SMoriah Waterland char *rstr = NULL;
122*5c51f124SMoriah Waterland char bfr[MAX_CANON];
123*5c51f124SMoriah Waterland size_t vres = 0;
124*5c51f124SMoriah Waterland va_list ap;
125*5c51f124SMoriah Waterland
126*5c51f124SMoriah Waterland /* entry assertions */
127*5c51f124SMoriah Waterland
128*5c51f124SMoriah Waterland assert(a_args != NULL);
129*5c51f124SMoriah Waterland assert(a_format != NULL);
130*5c51f124SMoriah Waterland assert(*a_format != '\0');
131*5c51f124SMoriah Waterland
132*5c51f124SMoriah Waterland /*
133*5c51f124SMoriah Waterland * double argument array if array is full
134*5c51f124SMoriah Waterland */
135*5c51f124SMoriah Waterland
136*5c51f124SMoriah Waterland if (a_args->_aaNumArgs >= a_args->_aaMaxArgs) {
137*5c51f124SMoriah Waterland int newMax;
138*5c51f124SMoriah Waterland char **newArgs;
139*5c51f124SMoriah Waterland
140*5c51f124SMoriah Waterland newMax = a_args->_aaMaxArgs * 2;
141*5c51f124SMoriah Waterland newArgs = (char **)_z_realloc(a_args->_aaArgs,
142*5c51f124SMoriah Waterland (newMax+1) * sizeof (char *));
143*5c51f124SMoriah Waterland a_args->_aaArgs = newArgs;
144*5c51f124SMoriah Waterland a_args->_aaMaxArgs = newMax;
145*5c51f124SMoriah Waterland }
146*5c51f124SMoriah Waterland
147*5c51f124SMoriah Waterland /*
148*5c51f124SMoriah Waterland * determine size of argument to add to list
149*5c51f124SMoriah Waterland */
150*5c51f124SMoriah Waterland
151*5c51f124SMoriah Waterland va_start(ap, a_format);
152*5c51f124SMoriah Waterland vres = vsnprintf(bfr, sizeof (bfr), a_format, ap);
153*5c51f124SMoriah Waterland va_end(ap);
154*5c51f124SMoriah Waterland
155*5c51f124SMoriah Waterland /*
156*5c51f124SMoriah Waterland * use the expanded argument if it will fit in the built in buffer,
157*5c51f124SMoriah Waterland * otherwise, allocate space to hold the argument
158*5c51f124SMoriah Waterland */
159*5c51f124SMoriah Waterland
160*5c51f124SMoriah Waterland if (vres < sizeof (bfr)) {
161*5c51f124SMoriah Waterland /* duplicate text already generated in buffer */
162*5c51f124SMoriah Waterland rstr = _z_strdup(bfr);
163*5c51f124SMoriah Waterland } else {
164*5c51f124SMoriah Waterland /* allocate new space for argument to add */
165*5c51f124SMoriah Waterland
166*5c51f124SMoriah Waterland rstr = (char *)_z_malloc(vres+2);
167*5c51f124SMoriah Waterland
168*5c51f124SMoriah Waterland /* generate argument to add */
169*5c51f124SMoriah Waterland
170*5c51f124SMoriah Waterland va_start(ap, a_format);
171*5c51f124SMoriah Waterland vres = vsnprintf(rstr, vres+1, a_format, ap);
172*5c51f124SMoriah Waterland va_end(ap);
173*5c51f124SMoriah Waterland }
174*5c51f124SMoriah Waterland
175*5c51f124SMoriah Waterland /* add argument to the end of the argument array */
176*5c51f124SMoriah Waterland
177*5c51f124SMoriah Waterland a_args->_aaArgs[a_args->_aaNumArgs++] = rstr;
178*5c51f124SMoriah Waterland a_args->_aaArgs[a_args->_aaNumArgs] = NULL;
179*5c51f124SMoriah Waterland
180*5c51f124SMoriah Waterland /* successful - return */
181*5c51f124SMoriah Waterland
182*5c51f124SMoriah Waterland return (B_TRUE);
183*5c51f124SMoriah Waterland }
184*5c51f124SMoriah Waterland
185*5c51f124SMoriah Waterland /*
186*5c51f124SMoriah Waterland * Name: _z_free_args
187*5c51f124SMoriah Waterland * Description: free all storage contained in an argument array previously
188*5c51f124SMoriah Waterland * allocated by a call to _z_new_args
189*5c51f124SMoriah Waterland * Arguments: a_args - [RO, *RW] - (argArray_t *)
190*5c51f124SMoriah Waterland * Pointer to argument array (previously allocated via
191*5c51f124SMoriah Waterland * a call to _z_new_args) to free
192*5c51f124SMoriah Waterland * Returns: void
193*5c51f124SMoriah Waterland * NOTE: preserves errno (usually called right after e_execCmd*())
194*5c51f124SMoriah Waterland */
195*5c51f124SMoriah Waterland
196*5c51f124SMoriah Waterland void
_z_free_args(argArray_t * a_args)197*5c51f124SMoriah Waterland _z_free_args(argArray_t *a_args)
198*5c51f124SMoriah Waterland {
199*5c51f124SMoriah Waterland int i;
200*5c51f124SMoriah Waterland int lerrno = errno;
201*5c51f124SMoriah Waterland
202*5c51f124SMoriah Waterland /* entry assertions */
203*5c51f124SMoriah Waterland
204*5c51f124SMoriah Waterland assert(a_args != NULL);
205*5c51f124SMoriah Waterland assert(a_args->_aaArgs != NULL);
206*5c51f124SMoriah Waterland
207*5c51f124SMoriah Waterland /* free all arguments in the argument array */
208*5c51f124SMoriah Waterland
209*5c51f124SMoriah Waterland for (i = (a_args->_aaNumArgs-1); i >= 0; i--) {
210*5c51f124SMoriah Waterland assert(a_args->_aaArgs[i] != NULL);
211*5c51f124SMoriah Waterland (void) free(a_args->_aaArgs[i]);
212*5c51f124SMoriah Waterland }
213*5c51f124SMoriah Waterland
214*5c51f124SMoriah Waterland /* free argument array */
215*5c51f124SMoriah Waterland
216*5c51f124SMoriah Waterland (void) free(a_args->_aaArgs);
217*5c51f124SMoriah Waterland
218*5c51f124SMoriah Waterland /* free argument array structure */
219*5c51f124SMoriah Waterland
220*5c51f124SMoriah Waterland (void) free(a_args);
221*5c51f124SMoriah Waterland
222*5c51f124SMoriah Waterland /* restore errno */
223*5c51f124SMoriah Waterland
224*5c51f124SMoriah Waterland errno = lerrno;
225*5c51f124SMoriah Waterland }
226*5c51f124SMoriah Waterland
227*5c51f124SMoriah Waterland /*
228*5c51f124SMoriah Waterland * Name: _z_get_argc
229*5c51f124SMoriah Waterland * Description: return (int) argc count from argument array
230*5c51f124SMoriah Waterland * Arguments: a_args - [RO, *RW] - (argArray_t *)
231*5c51f124SMoriah Waterland * Pointer to argument array (previously allocated via
232*5c51f124SMoriah Waterland * a call to _z_new_args) to return argc count for
233*5c51f124SMoriah Waterland * Returns: int
234*5c51f124SMoriah Waterland * Count of the number of arguments in the argument array
235*5c51f124SMoriah Waterland * suitable for use in an exec*() call
236*5c51f124SMoriah Waterland */
237*5c51f124SMoriah Waterland
238*5c51f124SMoriah Waterland int
_z_get_argc(argArray_t * a_args)239*5c51f124SMoriah Waterland _z_get_argc(argArray_t *a_args)
240*5c51f124SMoriah Waterland {
241*5c51f124SMoriah Waterland return (a_args->_aaNumArgs);
242*5c51f124SMoriah Waterland }
243*5c51f124SMoriah Waterland
244*5c51f124SMoriah Waterland /*
245*5c51f124SMoriah Waterland * Name: _z_get_argv
246*5c51f124SMoriah Waterland * Description: return (char **)argv pointer from argument array
247*5c51f124SMoriah Waterland * Arguments: a_args - [RO, *RW] - (argArray_t *)
248*5c51f124SMoriah Waterland * Pointer to argument array (previously allocated via
249*5c51f124SMoriah Waterland * a call to _z_new_args) to return argv pointer for
250*5c51f124SMoriah Waterland * Returns: char **
251*5c51f124SMoriah Waterland * Pointer to (char **)argv pointer suitable for use
252*5c51f124SMoriah Waterland * in an exec*() call
253*5c51f124SMoriah Waterland * NOTE: the actual character array is always terminated with a NULL
254*5c51f124SMoriah Waterland */
255*5c51f124SMoriah Waterland
256*5c51f124SMoriah Waterland char **
_z_get_argv(argArray_t * a_args)257*5c51f124SMoriah Waterland _z_get_argv(argArray_t *a_args)
258*5c51f124SMoriah Waterland {
259*5c51f124SMoriah Waterland return (a_args->_aaArgs);
260*5c51f124SMoriah Waterland }
261*5c51f124SMoriah Waterland
262*5c51f124SMoriah Waterland /*
263*5c51f124SMoriah Waterland * Name: _z_new_args
264*5c51f124SMoriah Waterland * Description: create a new argument array for use in exec() calls
265*5c51f124SMoriah Waterland * Arguments: initialCount - [RO, *RO] - (int)
266*5c51f124SMoriah Waterland * Initial number of elements to populate the
267*5c51f124SMoriah Waterland * argument array with - use best guess
268*5c51f124SMoriah Waterland * Returns: argArray_t *
269*5c51f124SMoriah Waterland * Pointer to argument array that can be used in other
270*5c51f124SMoriah Waterland * functions that accept it as an argument
271*5c51f124SMoriah Waterland * == (argArray_t *)NULL - error
272*5c51f124SMoriah Waterland * NOTE: you must call _z_free_args() when the returned argument array is
273*5c51f124SMoriah Waterland * no longer needed so that all storage used can be freed up.
274*5c51f124SMoriah Waterland */
275*5c51f124SMoriah Waterland
276*5c51f124SMoriah Waterland argArray_t *
_z_new_args(int initialCount)277*5c51f124SMoriah Waterland _z_new_args(int initialCount)
278*5c51f124SMoriah Waterland {
279*5c51f124SMoriah Waterland argArray_t *aa;
280*5c51f124SMoriah Waterland
281*5c51f124SMoriah Waterland /* entry assertions */
282*5c51f124SMoriah Waterland
283*5c51f124SMoriah Waterland assert(initialCount >= 0);
284*5c51f124SMoriah Waterland
285*5c51f124SMoriah Waterland /* if no guess on size, then assume 1 */
286*5c51f124SMoriah Waterland
287*5c51f124SMoriah Waterland if (initialCount == 0) {
288*5c51f124SMoriah Waterland initialCount = 1;
289*5c51f124SMoriah Waterland }
290*5c51f124SMoriah Waterland
291*5c51f124SMoriah Waterland /* allocate new argument array structure */
292*5c51f124SMoriah Waterland
293*5c51f124SMoriah Waterland aa = (argArray_t *)_z_calloc(sizeof (argArray_t));
294*5c51f124SMoriah Waterland
295*5c51f124SMoriah Waterland /* allocate initial argument array */
296*5c51f124SMoriah Waterland
297*5c51f124SMoriah Waterland aa->_aaArgs = (char **)_z_calloc((initialCount+1) * sizeof (char *));
298*5c51f124SMoriah Waterland
299*5c51f124SMoriah Waterland /* initialize argument indexes */
300*5c51f124SMoriah Waterland
301*5c51f124SMoriah Waterland aa->_aaNumArgs = 0;
302*5c51f124SMoriah Waterland aa->_aaMaxArgs = initialCount;
303*5c51f124SMoriah Waterland
304*5c51f124SMoriah Waterland /* successful - return pointer to argument array created */
305*5c51f124SMoriah Waterland
306*5c51f124SMoriah Waterland return (aa);
307*5c51f124SMoriah Waterland }
308