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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
|
/*
* Copyright (C) 2020 Linux Studio Plugins Project <https://lsp-plug.in/>
* (C) 2020 Vladimir Sadovnikov <sadko4u@gmail.com>
*
* This file is part of lsp-runtime-lib
* Created on: 24 июл. 2019 г.
*
* lsp-runtime-lib is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* lsp-runtime-lib 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with lsp-runtime-lib. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef LSP_PLUG_IN_IPC_PROCESS_H_
#define LSP_PLUG_IN_IPC_PROCESS_H_
#include <lsp-plug.in/runtime/version.h>
#include <lsp-plug.in/runtime/LSPString.h>
#include <lsp-plug.in/common/types.h>
#include <lsp-plug.in/common/status.h>
#include <lsp-plug.in/io/IInStream.h>
#include <lsp-plug.in/io/IOutStream.h>
#include <lsp-plug.in/lltl/parray.h>
#include <unistd.h>
namespace lsp
{
namespace ipc
{
/**
* Class for running processes
*/
class Process
{
public:
enum pstatus_t {
PSTATUS_CREATED,
PSTATUS_RUNNING,
PSTATUS_EXITED,
PSTATUS_ERROR,
PSTATUS_RUNNING_ERROR
};
private:
Process & operator = (const Process &);
typedef struct envvar_t {
LSPString name;
LSPString value;
} envvar_t;
#ifdef PLATFORM_WINDOWS
typedef void *HANDLE;
#endif /* PLATFORM_WINDOWS */
private:
LSPString sCommand;
lltl::parray<LSPString> vArgs;
lltl::parray<envvar_t> vEnv;
pstatus_t nStatus;
int nExitCode;
#ifdef PLATFORM_WINDOWS
uint32_t nPID;
HANDLE hProcess;
HANDLE hStdIn;
HANDLE hStdOut;
HANDLE hStdErr;
#else
pid_t nPID;
int hStdIn;
int hStdOut;
int hStdErr;
#endif /* PLATFORM_WINDOWS */
io::IOutStream *pStdIn;
io::IInStream *pStdOut;
io::IInStream *pStdErr;
protected:
static void destroy_args(lltl::parray<LSPString> *args);
static void destroy_env(lltl::parray<envvar_t> *env);
void close_handles();
#ifdef PLATFORM_WINDOWS
static status_t append_arg_escaped(LSPString *dst, const LSPString *value);
status_t build_argv(LSPString *dst);
status_t build_envp(LSPString *dst);
#else
status_t build_argv(lltl::parray<char> *dst);
status_t build_envp(lltl::parray<char> *dst);
status_t spawn_process(const char *cmd, char * const *argv, char * const *envp);
status_t vfork_process(const char *cmd, char * const *argv, char * const *envp);
status_t fork_process(const char *cmd, char * const *argv, char * const *envp);
void execve_process(const char *cmd, char * const *argv, char * const *envp, bool soft_exit);
#endif /* PLATFORM_WINDOWS */
public:
explicit Process();
~Process();
public:
/**
* Set command for execution
* @param cmd command to execute
* @return status of operation
*/
status_t set_command(const LSPString *cmd);
/**
* Set command for execution
* @param cmd command to execute in UTF-8 encoding
* @return status of operation
*/
status_t set_command(const char *cmd);
public:
/**
* Get overall number of additional command-line arguments
* @return number of additional command-line arguments
*/
size_t args() const;
/**
* Add argument at the end of command line
* @param value argument value
* @return status of operation
*/
status_t add_arg(const LSPString *value);
/**
* Add argument at the end of command line
* @param value argument value in UTF-8 encoding
* @return status of operation
*/
status_t add_arg(const char *value);
/**
* Set value of argument at the specified place
* @param value argument value
* @return status of operation
*/
status_t set_arg(size_t index, const LSPString *value);
/**
* Set value of argument at the specified place
* @param value argument value in UTF-8 encoding
* @return status of operation
*/
status_t set_arg(size_t index, const char *value);
/**
* Get value of argument at the specified place
* @param value pointer to store argument value
* @return status of operation
*/
status_t get_arg(size_t index, LSPString *value);
/**
* Get value of argument at the specified place
* @param value pointer to store argument value
* @return status of operation
*/
status_t get_arg(size_t index, char **value);
/**
* Remove the argument at the specified place
* @param value pointer to store value of removed argument
* @return status of operation
*/
status_t remove_arg(size_t index, LSPString *value = NULL);
/**
* Remove the argument at the specified place
* @param value pointer to store value of removed argument.
* The pointer should be free()'d after use
* @return status of operation
*/
status_t remove_arg(size_t index, char **value = NULL);
/**
* Insert argument at the specified position
* @param value argument value
* @return status of operation
*/
status_t insert_arg(size_t index, const LSPString *value);
/**
* Insert argument at the specified position
* @param value argument value in UTF-8 encoding
* @return status of operation
*/
status_t insert_arg(size_t index, const char *value);
/**
* Clear arguments;
* @return status of operation
*/
status_t clear_args();
public:
/**
* Return number of environment variables
* @return number of environment variables
*/
size_t envs() const;
/**
* Set value of the specific environment variable
* @param key the name of environment variable
* @param value the value of environment variable
* @return status of operation
*/
status_t set_env(const LSPString *key, const LSPString *value);
/**
* Set value of the specific environment variable
* @param key the name of environment variable in UTF-8 encoding
* @param value the value of environment variable in UTF-8 encoding
* @return status of operation
*/
status_t set_env(const char *key, const char *value);
/**
* Remove the specific environment variable
* @param key the name of environment variable
* @param pointer to store value of the removed environment variable
* @return status of operation
*/
status_t remove_env(const LSPString *key, LSPString *value = NULL);
/**
* Remove the specific environment variable
* @param key the name of environment variable
* @param pointer to store value of the removed environment variable
* @return status of operation
*/
status_t remove_env(const char *key, LSPString *value = NULL);
/**
* Remove the specific environment variable
* @param key the name of environment variable in UTF-8 encoding
* @param pointer to store value of the removed environment variable in UTF-8 encoding.
* The obtained pointer should be free()'d after use
* @return status of operation
*/
status_t remove_env(const char *key, char **value = NULL);
/**
* Obtain the value of the specific environment variable
* @param key the name of environment variable
* @param pointer to store value of the environment variable
* @return status of operation
*/
status_t get_env(const LSPString *key, LSPString *value = NULL);
/**
* Obtain the value of the specific environment variable
* @param key the name of environment variable
* @param pointer to store value of the environment variable
* @return status of operation
*/
status_t get_env(const char *key, LSPString *value = NULL);
/**
* Obtain the value of the specific environment variable
* @param key the name of environment variable in UTF-8 encoding
* @param pointer to store value of the environment variable in UTF-8 encoding.
* The obtained pointer should be free()'d after use
* @return status of operation
*/
status_t get_env(const char *key, char **value = NULL);
/**
* Obtain the key and value of environment variable by index
* @param idx the environment variable index
* @param key environment variable key
* @param value environment variable value
* @return status of operation
*/
status_t read_env(size_t idx, LSPString *key = NULL, LSPString *value = NULL);
/**
* Obtain the value of the specific environment variable
* @param idx the environment variable index
* @param key the name of environment variable in UTF-8 encoding
* The obtained pointer should be free()'d after use
* @param pointer to store value of the environment variable in UTF-8 encoding.
* The obtained pointer should be free()'d after use
* @return status of operation
*/
status_t read_env(size_t idx, char **key = NULL, char **value = NULL);
/**
* Clear all environment variables
* @return status of operation
*/
status_t clear_env();
public:
/**
* Return redirected standard input stream of the process.
* The redirection is allowed before successful launch() has been issued.
*
* @return pointer to standard input stream
*/
io::IOutStream *get_stdin();
/**
* Return redirected standard output stream of the process.
* The redirection is allowed before successful launch() has been issued.
*
* @return pointer to standard output stream
*/
io::IInStream *get_stdout();
/**
* Return redirected standard error stream of the process.
* The redirection is allowed before successful launch() has been issued.
*
* @return pointer to standard error stream
*/
io::IInStream *get_stderr();
/**
* Get process status
* @return process status
*/
size_t status();
/**
* Copy environment variables of the current process
* @return status of operation
*/
status_t copy_env();
/**
* Launch the process
* @return status of operation
*/
status_t launch();
/**
* Chech that the object is not in error state
* @return true if object is in not error state
*/
bool valid();
/**
* Check that process is in running state
* @return true if process is in running state
*/
bool running();
/**
* Check that process has exited
* @return true if process has exited
*/
bool exited();
/**
* Get unique process identifier
* @return process identifier
*/
ssize_t process_id() const;
/**
* Wait for the process termination
* @param millis number of milliseconds to wait, negative value means infinite wait
* @return status of operation
*/
status_t wait(wssize_t millis = -1);
/**
* Get process exit status
* @param code pointer to save exit status
* @return status of operation
*/
status_t exit_code(int *code);
};
} /* namespace ipc */
} /* namespace lsp */
#endif /* LSP_PLUG_IN_IPC_PROCESS_H_ */
|
