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
|
/* buildcmd.[ch] -- build command lines from a stream of arguments
Copyright (C) 2005-2022 Free Software Foundation, Inc.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/*
* Written by James Youngman.
*/
#ifndef INC_BUILDCMD_H
# define INC_BUILDCMD_H 1
# include <stdbool.h>
struct buildcmd_state
{
/* Number of valid elements in `cmd_argv', including terminating NULL. */
size_t cmd_argc; /* 0 */
/* The list of args being built. */
char **cmd_argv; /* NULL */
/* Number of elements allocated for `cmd_argv'. */
size_t cmd_argv_alloc;
/* Storage for elements of `cmd_argv'. */
char *argbuf;
/* Number of chars being used in `cmd_argv'. */
size_t cmd_argv_chars;
/* Number of chars being used in `cmd_argv' for the initial args.. */
size_t cmd_initial_argv_chars;
/* User context information. */
void *usercontext;
/* to-do flag. */
int todo;
/* Directory in which to perform the exec. */
int dir_fd;
/* Summary of what we think the argv limits are. */
size_t largest_successful_arg_count;
size_t smallest_failed_arg_count;
};
struct buildcmd_control
{
/* If true, exit if lines_per_exec or args_per_exec is exceeded. */
int exit_if_size_exceeded; /* false */
/* POSIX limits on the argument length. */
size_t posix_arg_size_max;
size_t posix_arg_size_min;
/* The maximum number of characters that can be used per command line. */
size_t arg_max;
/* max_arg_count: the maximum number of arguments that can be used.
*
* Many systems include the size of the pointers in ARG_MAX.
* Linux on PPC fails if we just subtract 1 here.
*
* However, not all systems define ARG_MAX. Our bc_get_arg_max()
* function returns a useful value even if ARG_MAX is not defined.
* However, sometimes, max_arg_count is LONG_MAX!
*/
size_t max_arg_count;
/* The length of `replace_pat'. */
size_t rplen;
/* If nonzero, then instead of putting the args from stdin at
the end of the command argument list, they are each stuck into the
initial args, replacing each occurrence of the `replace_pat' in the
initial args. */
const char *replace_pat;
/* Number of initial arguments given on the command line. */
size_t initial_argc; /* 0 */
/* exec callback. */
int (*exec_callback)(struct buildcmd_control *, void *usercontext, int argc, char **argv);
/* If nonzero, the maximum number of nonblank lines from stdin to use
per command line. */
unsigned long lines_per_exec; /* 0 */
/* The maximum number of arguments to use per command line. */
size_t args_per_exec;
};
enum BC_INIT_STATUS
{
BC_INIT_OK = 0,
BC_INIT_ENV_TOO_BIG,
BC_INIT_CANNOT_ACCOMODATE_HEADROOM
};
extern size_t bc_size_of_environment (void);
extern void bc_do_insert (struct buildcmd_control *ctl,
struct buildcmd_state *state,
char *arg, size_t arglen,
const char *prefix, size_t pfxlen,
const char *linebuf, size_t lblen,
int initial_args);
extern void bc_do_exec (struct buildcmd_control *ctl,
struct buildcmd_state *state);
extern void bc_push_arg (struct buildcmd_control *ctl,
struct buildcmd_state *state,
const char *arg, size_t len,
const char *prefix, size_t pfxlen,
int initial_args);
extern void bc_init_state(const struct buildcmd_control *ctl,
struct buildcmd_state *state,
void *usercontext);
extern enum BC_INIT_STATUS bc_init_controlinfo(struct buildcmd_control *ctl,
size_t arglen_headroom);
extern size_t bc_get_arg_max(void);
extern void bc_use_sensible_arg_max(struct buildcmd_control *ctl);
extern void bc_clear_args(const struct buildcmd_control *ctl,
struct buildcmd_state *state);
bool bc_args_exceed_testing_limit(char **argv);
#endif
|
