summaryrefslogtreecommitdiff
path: root/missing/setproctitle.c
blob: 5b2dfa65cef4a68b3a9acfad537e7e91dcefd88d (plain)
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
/* Based on setproctitle.c from openssh-5.6p1 */
/* Based on conf.c from UCB sendmail 8.8.8 */

/*
 * Copyright 2003 Damien Miller
 * Copyright (c) 1983, 1995-1997 Eric P. Allman
 * Copyright (c) 1988, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include "ruby.h"
#include "ruby/util.h"
#define compat_init_setproctitle ruby_init_setproctitle
RUBY_FUNC_EXPORTED void ruby_init_setproctitle(int argc, char *argv[]);

#ifndef HAVE_SETPROCTITLE

#include <stdarg.h>
#include <stdlib.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#ifdef HAVE_SYS_PSTAT_H
#include <sys/pstat.h>
#endif
#include <string.h>

#if defined(__APPLE__)
# ifdef HAVE_CRT_EXTERNS_H
#  include <crt_externs.h>
#  undef environ
#  define environ (*_NSGetEnviron())
# else
#  include "crt_externs.h"
# endif
#endif

#define SPT_NONE	0	/* don't use it at all */
#define SPT_PSTAT	1	/* use pstat(PSTAT_SETCMD, ...) */
#define SPT_REUSEARGV	2	/* cover argv with title information */

#ifndef SPT_TYPE
# define SPT_TYPE	SPT_NONE
#endif

#ifndef SPT_PADCHAR
# define SPT_PADCHAR	'\0'
#endif

#if SPT_TYPE == SPT_REUSEARGV
static char *argv_start = NULL;
static size_t argv_env_len = 0;
static size_t argv_len = 0;
static char **argv1_addr = NULL;
#endif

#endif /* HAVE_SETPROCTITLE */

#if defined(SPT_TYPE) && SPT_TYPE == SPT_REUSEARGV
# define ALLOCATE_ENVIRON 1
#else
# define ALLOCATE_ENVIRON 0
#endif

#if ALLOCATE_ENVIRON
/* system_environ is the value of environ before we allocate a custom buffer.
 *
 * We use this to restore environ in ruby_free_proctitle.
 */
static char **system_environ = NULL;
/* orig_environ is the buffer we allocate for environ.
 *
 * We use this to free this buffer in ruby_free_proctitle. When we add new
 * environment variables using setenv, the system may change environ to a
 * different buffer and will not free the original buffer, so we need to hold
 * onto this so we can free it in ruby_free_proctitle.
 *
 * We must not free any of the contents because it may change if the system
 * updates existing environment variables.
 */
static char **orig_environ = NULL;
/* alloc_environ is a copy of orig_environ.
 *
 * We use this to free all the original string copies that were in orig_environ.
 * Since environ could be changed to point to strings allocated by the system
 * if environment variables are updated, so we need this to point to the
 * original strings.
 */
static char **alloc_environ = NULL;
#endif

void
compat_init_setproctitle(int argc, char *argv[])
{
#if ALLOCATE_ENVIRON
	extern char **environ;
	char *lastargv = NULL;
	char *lastenvp = NULL;
	char **envp = environ;
	int i;

	/*
	 * NB: This assumes that argv has already been copied out of the
	 * way. This is true for sshd, but may not be true for other
	 * programs. Beware.
	 */

	if (argc == 0 || argv[0] == NULL)
		return;

	/* Fail if we can't allocate room for the new environment */
	for (i = 0; envp[i] != NULL; i++);

	system_environ = environ;

	alloc_environ = xcalloc(i + 1, sizeof(*environ));
	orig_environ = environ = xcalloc(i + 1, sizeof(*environ));
	if (environ == NULL) {
		environ = envp;	/* put it back */
		return;
	}

	/*
	 * Find the last argv string or environment variable within
	 * our process memory area.
	 */
	for (i = 0; i < argc; i++) {
		if (lastargv == NULL || lastargv + 1 == argv[i])
			lastargv = argv[i] + strlen(argv[i]);
	}
	lastenvp = lastargv;
	for (i = 0; envp[i] != NULL; i++) {
		if (lastenvp + 1 == envp[i])
			lastenvp = envp[i] + strlen(envp[i]);
	}

	/* We keep argv[1], argv[2], etc. at this moment,
	   because the ps command of AIX refers to them. */
	argv1_addr = &argv[1];
	argv_start = argv[0];
	argv_len = lastargv - argv[0];
	argv_env_len = lastenvp - argv[0];

	for (i = 0; envp[i] != NULL; i++)
		alloc_environ[i] = environ[i] = ruby_strdup(envp[i]);
	alloc_environ[i] = environ[i] = NULL;
#endif /* SPT_REUSEARGV */
}

void
ruby_free_proctitle(void)
{
#if ALLOCATE_ENVIRON
	extern char **environ;

	if (!orig_environ) return; /* environ is allocated by OS */

	for (int i = 0; alloc_environ[i] != NULL; i++) {
		xfree(alloc_environ[i]);
	}
	xfree(alloc_environ);
	xfree(orig_environ);

	environ = system_environ;
#endif
}

#ifndef HAVE_SETPROCTITLE

void
setproctitle(const char *fmt, ...)
{
#if SPT_TYPE != SPT_NONE
	va_list ap;
	char ptitle[1024];
	size_t len;
	size_t argvlen;
#if SPT_TYPE == SPT_PSTAT
	union pstun pst;
#endif

#if SPT_TYPE == SPT_REUSEARGV
	if (argv_env_len <= 0)
		return;
#endif

	/* fmt must be non-NULL */
	va_start(ap, fmt);
	vsnprintf(ptitle, sizeof(ptitle), fmt, ap);
	va_end(ap);

#if SPT_TYPE == SPT_PSTAT
	pst.pst_command = ptitle;
	pstat(PSTAT_SETCMD, pst, strlen(ptitle), 0, 0);
#elif SPT_TYPE == SPT_REUSEARGV
	len = strlcpy(argv_start, ptitle, argv_env_len);
	argvlen = len > argv_len ? argv_env_len : argv_len;
	for(; len < argvlen; len++)
		argv_start[len] = SPT_PADCHAR;
	/* argv[1], argv[2], etc. are no longer valid. */
	*argv1_addr = NULL;
#endif

#endif /* SPT_NONE */
}

#endif /* HAVE_SETPROCTITLE */