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
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
|
/*
** Zabbix
** Copyright (C) 2001-2014 Zabbix SIA
**
** 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 2 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, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
#include "common.h"
#include "threads.h"
#include "log.h"
/* the size of temporary buffer used to read from output stream */
#define PIPE_BUFFER_SIZE 4096
#ifdef _WINDOWS
/******************************************************************************
* *
* Function: zbx_get_timediff_ms *
* *
* Purpose: considers a difference between times in milliseconds *
* *
* Parameters: time1 - [IN] first time point *
* time2 - [IN] second time point *
* *
* Return value: difference between times in milliseconds *
* *
* Author: Alexander Vladishev *
* *
******************************************************************************/
static int zbx_get_timediff_ms(struct _timeb *time1, struct _timeb *time2)
{
int ms;
ms = (int)(time2->time - time1->time) * 1000;
ms += time2->millitm - time1->millitm;
if (0 > ms)
ms = 0;
return ms;
}
/******************************************************************************
* *
* Function: zbx_read_from_pipe *
* *
* Purpose: read data from pipe *
* *
* Parameters: hRead - [IN] a handle to the device *
* buf - [IN/OUT] a pointer to the buffer *
* buf_size - [IN] buffer size *
* timeout_ms - [IN] timeout in milliseconds *
* *
* Return value: SUCCEED or TIMEOUT_ERROR if timeout reached *
* *
* Author: Alexander Vladishev *
* *
******************************************************************************/
static int zbx_read_from_pipe(HANDLE hRead, char **buf, size_t *buf_size, size_t *offset, int timeout_ms)
{
DWORD in_buf_size, read_bytes;
struct _timeb start_time, current_time;
char tmp_buf[PIPE_BUFFER_SIZE];
_ftime(&start_time);
while (0 != PeekNamedPipe(hRead, NULL, 0, NULL, &in_buf_size, NULL) &&
MAX_EXECUTE_OUTPUT_LEN > *offset + in_buf_size)
{
if (0 != in_buf_size)
{
if (0 == ReadFile(hRead, tmp_buf, sizeof(tmp_buf) - 1, &read_bytes, NULL))
{
zabbix_log(LOG_LEVEL_ERR, "cannot read command output: %s",
strerror_from_system(GetLastError()));
return FAIL;
}
else
{
tmp_buf[read_bytes] = '\0';
zbx_strcpy_alloc(buf, buf_size, offset, tmp_buf);
}
in_buf_size = 0;
continue;
}
_ftime(¤t_time);
if (zbx_get_timediff_ms(&start_time, ¤t_time) >= timeout_ms)
return TIMEOUT_ERROR;
Sleep(20); /* milliseconds */
}
if (MAX_EXECUTE_OUTPUT_LEN <= *offset + in_buf_size)
{
zabbix_log(LOG_LEVEL_ERR, "command output exceeded limit of %d KB",
MAX_EXECUTE_OUTPUT_LEN / ZBX_KIBIBYTE);
return FAIL;
}
return SUCCEED;
}
#else /* not _WINDOWS */
/******************************************************************************
* *
* Function: zbx_popen *
* *
* Purpose: this function opens a process by creating a pipe, forking, *
* and invoking the shell *
* *
* Parameters: pid - [OUT] child process PID *
* command - [IN] a pointer to a null-terminated string *
* containing a shell command line *
* *
* Return value: on success, reading file descriptor is returned. On error, *
* -1 is returned, and errno is set appropriately *
* *
* Author: Alexander Vladishev *
* *
******************************************************************************/
static int zbx_popen(pid_t *pid, const char *command)
{
const char *__function_name = "zbx_popen";
int fd[2];
zabbix_log(LOG_LEVEL_DEBUG, "In %s() command:'%s'", __function_name, command);
if (-1 == pipe(fd))
return -1;
if (-1 == (*pid = zbx_fork()))
{
close(fd[0]);
close(fd[1]);
return -1;
}
if (0 != *pid) /* parent process */
{
close(fd[1]);
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%d", __function_name, fd[0]);
return fd[0];
}
/* child process */
close(fd[0]);
dup2(fd[1], STDOUT_FILENO);
dup2(fd[1], STDERR_FILENO);
close(fd[1]);
/* set the child as the process group leader, otherwise orphans may be left after timeout */
if (-1 == setpgid(0, 0))
{
zabbix_log(LOG_LEVEL_ERR, "%s(): failed to create a process group: %s",
__function_name, zbx_strerror(errno));
exit(EXIT_SUCCESS);
}
zabbix_log(LOG_LEVEL_DEBUG, "%s(): executing script", __function_name);
execl("/bin/sh", "sh", "-c", command, NULL);
/* execl() returns only when an error occurs */
zabbix_log(LOG_LEVEL_WARNING, "execl() failed for [%s]: %s", command, zbx_strerror(errno));
exit(EXIT_SUCCESS);
}
/******************************************************************************
* *
* Function: zbx_waitpid *
* *
* Purpose: this function waits for process to change state *
* *
* Parameters: pid - [IN] child process PID *
* *
* Return value: on success, PID is returned. On error, *
* -1 is returned, and errno is set appropriately *
* *
* Author: Alexander Vladishev *
* *
******************************************************************************/
static int zbx_waitpid(pid_t pid)
{
const char *__function_name = "zbx_waitpid";
int rc, status;
zabbix_log(LOG_LEVEL_DEBUG, "In %s()", __function_name);
do
{
#ifdef WCONTINUED
static int wcontinued = WCONTINUED;
retry:
if (-1 == (rc = waitpid(pid, &status, WUNTRACED | wcontinued)))
{
if (EINVAL == errno && 0 != wcontinued)
{
wcontinued = 0;
goto retry;
}
#else
if (-1 == (rc = waitpid(pid, &status, WUNTRACED)))
{
#endif
zabbix_log(LOG_LEVEL_DEBUG, "%s() waitpid failure: %s", __function_name, zbx_strerror(errno));
goto exit;
}
if (WIFEXITED(status))
zabbix_log(LOG_LEVEL_DEBUG, "%s() exited, status:%d", __function_name, WEXITSTATUS(status));
else if (WIFSIGNALED(status))
zabbix_log(LOG_LEVEL_DEBUG, "%s() killed by signal %d", __function_name, WTERMSIG(status));
else if (WIFSTOPPED(status))
zabbix_log(LOG_LEVEL_DEBUG, "%s() stopped by signal %d", __function_name, WSTOPSIG(status));
#ifdef WIFCONTINUED
else if (WIFCONTINUED(status))
zabbix_log(LOG_LEVEL_DEBUG, "%s() continued", __function_name);
#endif
}
while (!WIFEXITED(status) && !WIFSIGNALED(status));
exit:
zabbix_log(LOG_LEVEL_DEBUG, "End of %s():%d", __function_name, rc);
return rc;
}
#endif /* _WINDOWS */
/******************************************************************************
* *
* Function: zbx_execute *
* *
* Purpose: this function executes a script and returns result from stdout *
* *
* Parameters: command - [IN] command for execution *
* buffer - [OUT] buffer for output, if NULL - ignored *
* error - [OUT] error string if function fails *
* max_error_len - [IN] length of error buffer *
* *
* Return value: SUCCEED if processed successfully, TIMEOUT_ERROR if *
* timeout occurred or FAIL otherwise *
* *
* Author: Alexander Vladishev *
* *
******************************************************************************/
int zbx_execute(const char *command, char **buffer, char *error, size_t max_error_len, int timeout)
{
size_t buf_size = PIPE_BUFFER_SIZE, offset = 0;
int ret = FAIL;
#ifdef _WINDOWS
STARTUPINFO si;
PROCESS_INFORMATION pi;
SECURITY_ATTRIBUTES sa;
HANDLE job = NULL, hWrite = NULL, hRead = NULL;
char *cmd = NULL;
wchar_t *wcmd = NULL;
struct _timeb start_time, current_time;
#else
pid_t pid;
int fd;
#endif
*error = '\0';
if (NULL != buffer)
{
*buffer = zbx_realloc(*buffer, buf_size);
**buffer = '\0';
}
#ifdef _WINDOWS
/* set the bInheritHandle flag so pipe handles are inherited */
sa.nLength = sizeof(SECURITY_ATTRIBUTES);
sa.bInheritHandle = TRUE;
sa.lpSecurityDescriptor = NULL;
/* create a pipe for the child process's STDOUT */
if (0 == CreatePipe(&hRead, &hWrite, &sa, 0))
{
zbx_snprintf(error, max_error_len, "unable to create a pipe: %s", strerror_from_system(GetLastError()));
goto close;
}
/* create a new job where the script will be executed */
if (0 == (job = CreateJobObject(&sa, NULL)))
{
zbx_snprintf(error, max_error_len, "unable to create a job: %s", strerror_from_system(GetLastError()));
goto close;
}
/* fill in process startup info structure */
memset(&si, 0, sizeof(STARTUPINFO));
si.cb = sizeof(STARTUPINFO);
si.dwFlags = STARTF_USESTDHANDLES;
si.hStdInput = GetStdHandle(STD_INPUT_HANDLE);
si.hStdOutput = hWrite;
si.hStdError = hWrite;
/* use cmd command to support scripts */
cmd = zbx_dsprintf(cmd, "cmd /C \"%s\"", command);
wcmd = zbx_utf8_to_unicode(cmd);
/* create the new process */
if (0 == CreateProcess(NULL, wcmd, NULL, NULL, TRUE, CREATE_SUSPENDED, NULL, NULL, &si, &pi))
{
zbx_snprintf(error, max_error_len, "unable to create process [%s]: %s",
cmd, strerror_from_system(GetLastError()));
goto close;
}
CloseHandle(hWrite);
hWrite = NULL;
/* assign the new process to the created job */
if (0 == AssignProcessToJobObject(job, pi.hProcess))
{
zbx_snprintf(error, max_error_len, "unable to assign process [%s] to a job: %s",
cmd, strerror_from_system(GetLastError()));
if (0 == TerminateProcess(pi.hProcess, 0))
{
zabbix_log(LOG_LEVEL_ERR, "failed to terminate [%s]: %s",
cmd, strerror_from_system(GetLastError()));
}
}
else if (-1 == ResumeThread(pi.hThread))
{
zbx_snprintf(error, max_error_len, "unable to assign process [%s] to a job: %s",
cmd, strerror_from_system(GetLastError()));
}
else
ret = SUCCEED;
if (FAIL == ret)
goto close;
_ftime(&start_time);
timeout *= 1000;
if (NULL != buffer)
ret = zbx_read_from_pipe(hRead, buffer, &buf_size, &offset, timeout);
if (TIMEOUT_ERROR != ret)
{
_ftime(¤t_time);
if (0 < (timeout -= zbx_get_timediff_ms(&start_time, ¤t_time)) &&
WAIT_TIMEOUT == WaitForSingleObject(pi.hProcess, timeout))
{
ret = TIMEOUT_ERROR;
}
}
CloseHandle(pi.hProcess);
CloseHandle(pi.hThread);
close:
if (NULL != job)
{
/* terminate the child process and it's childs */
if (0 == TerminateJobObject(job, 0))
zabbix_log(LOG_LEVEL_ERR, "failed to terminate job [%s]: %s", cmd, strerror_from_system(GetLastError()));
CloseHandle(job);
}
if (NULL != hWrite)
CloseHandle(hWrite);
if (NULL != hRead)
CloseHandle(hRead);
zbx_free(cmd);
zbx_free(wcmd);
#else /* not _WINDOWS */
alarm(timeout);
if (-1 != (fd = zbx_popen(&pid, command)))
{
int rc = 0;
char tmp_buf[PIPE_BUFFER_SIZE];
if (NULL != buffer)
{
while (0 < (rc = read(fd, tmp_buf, sizeof(tmp_buf) - 1)) &&
MAX_EXECUTE_OUTPUT_LEN > offset + rc)
{
tmp_buf[rc] = '\0';
zbx_strcpy_alloc(buffer, &buf_size, &offset, tmp_buf);
}
}
close(fd);
if (-1 == rc || -1 == zbx_waitpid(pid))
{
if (EINTR == errno)
ret = TIMEOUT_ERROR;
else
zbx_snprintf(error, max_error_len, "zbx_waitpid() failed: %s", zbx_strerror(errno));
/* kill the whole process group, pid must be the leader */
if (-1 == kill(-pid, SIGTERM))
zabbix_log(LOG_LEVEL_ERR, "failed to kill [%s]: %s", command, zbx_strerror(errno));
zbx_waitpid(pid);
}
else if (MAX_EXECUTE_OUTPUT_LEN <= offset + rc)
{
zabbix_log(LOG_LEVEL_ERR, "command output exceeded limit of %d KB",
MAX_EXECUTE_OUTPUT_LEN / ZBX_KIBIBYTE);
}
else
ret = SUCCEED;
}
else
zbx_strlcpy(error, zbx_strerror(errno), max_error_len);
alarm(0);
#endif /* _WINDOWS */
if (TIMEOUT_ERROR == ret)
zbx_strlcpy(error, "Timeout while executing a shell script.", max_error_len);
else if ('\0' != *error)
zabbix_log(LOG_LEVEL_WARNING, "%s", error);
if (SUCCEED != ret && NULL != buffer)
zbx_free(*buffer);
return ret;
}
/******************************************************************************
* *
* Function: zbx_execute_nowait *
* *
* Purpose: this function executes a script in the background and *
* suppresses the std output *
* *
* Parameters: command - [IN] command for execution *
* *
* Author: Rudolfs Kreicbergs *
* *
******************************************************************************/
int zbx_execute_nowait(const char *command)
{
#ifdef _WINDOWS
const char *__function_name = "zbx_execute_nowait";
char *full_command;
STARTUPINFO si;
PROCESS_INFORMATION pi;
wchar_t *wcommand;
full_command = zbx_dsprintf(NULL, "cmd /C \"%s\"", command);
wcommand = zbx_utf8_to_unicode(full_command);
/* fill in process startup info structure */
memset(&si, 0, sizeof(si));
si.cb = sizeof(si);
GetStartupInfo(&si);
zabbix_log(LOG_LEVEL_DEBUG, "%s(): executing [%s]", __function_name, full_command);
if (0 == CreateProcess(
NULL, /* no module name (use command line) */
wcommand, /* name of app to launch */
NULL, /* default process security attributes */
NULL, /* default thread security attributes */
FALSE, /* do not inherit handles from the parent */
0, /* normal priority */
NULL, /* use the same environment as the parent */
NULL, /* launch in the current directory */
&si, /* startup information */
&pi)) /* process information stored upon return */
{
zabbix_log(LOG_LEVEL_WARNING, "failed to create process for [%s]: %s",
full_command, strerror_from_system(GetLastError()));
return FAIL;
}
CloseHandle(pi.hProcess);
CloseHandle(pi.hThread);
zbx_free(wcommand);
zbx_free(full_command);
return SUCCEED;
#else /* not _WINDOWS */
pid_t pid;
/* use a double fork for running the command in background */
if (-1 == (pid = zbx_fork()))
{
zabbix_log(LOG_LEVEL_WARNING, "first fork() failed for executing [%s]: %s",
command, zbx_strerror(errno));
return FAIL;
}
else if (0 != pid)
{
waitpid(pid, NULL, 0);
return SUCCEED;
}
/* This is the child process. Now create a grand child process which */
/* will be replaced by execl() with the actual command to be executed. */
pid = zbx_fork();
switch (pid)
{
case -1:
zabbix_log(LOG_LEVEL_WARNING, "second fork() failed for executing [%s]: %s",
command, zbx_strerror(errno));
break;
case 0:
/* this is the grand child process */
/* suppress the output of the executed script, otherwise */
/* the output might get written to a logfile or elsewhere */
redirect_std(NULL);
/* replace the process with actual command to be executed */
execl("/bin/sh", "sh", "-c", command, NULL);
/* execl() returns only when an error occurs */
zabbix_log(LOG_LEVEL_WARNING, "execl() failed for [%s]: %s", command, zbx_strerror(errno));
break;
default:
/* this is the child process, exit to complete the double fork */
waitpid(pid, NULL, WNOHANG);
break;
}
/* always exit, parent has already returned */
exit(EXIT_SUCCESS);
#endif
}
|