rxvt-unicode/src/rxvtd.C

/*----------------------------------------------------------------------*
 * File:        rxvtd.C
 *----------------------------------------------------------------------*
 *
 * All portions of code are copyright by their respective author/s.
 * Copyright (c) 2003-2007 Marc Lehmann <schmorp@schmorp.de>
 *
 * 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, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *----------------------------------------------------------------------*/

#include "../config.h"
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>

#include <unistd.h>
#include <fcntl.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/socket.h>
#include <sys/un.h>

#if defined(ENABLE_FRILLS) && defined(_POSIX_MEMLOCK) && _POSIX_MEMLOCK > 0
# define ENABLE_MLOCK 1
#endif

#if ENABLE_MLOCK
# include <sys/mman.h>
#endif

#include <errno.h>

#include "rxvt.h"
#include "rxvtdaemon.h"
#include "libptytty.h"

struct server : rxvt_connection
{
  log_callback log_cb;
  getfd_callback getfd_cb;

  void read_cb (ev::io &w, int revents); ev::io read_ev;
  void log_msg (const char *msg);
  int getfd (int remote_fd);

  server (int fd)
  {
    read_ev.set <server, &server::read_cb> (this);
    log_cb.set  <server, &server::log_msg> (this);
    getfd_cb.set<server, &server::getfd>   (this);

    this->fd = fd;
    fcntl (fd, F_SETFD, FD_CLOEXEC);
    fcntl (fd, F_SETFL, 0);
    read_ev.start (fd, ev::READ);
  }

  void err (const char *format = 0, ...);
};

struct unix_listener
{
  int fd;

  void accept_cb (ev::io &w, int revents); ev::io accept_ev;

  unix_listener (int fd);
  static int open (const char *sockname);
};

unix_listener::unix_listener (int fd) : fd (fd)
{
  accept_ev.set<unix_listener, &unix_listener::accept_cb> (this);
  fcntl (fd, F_SETFD, FD_CLOEXEC);
  fcntl (fd, F_SETFL, O_NONBLOCK);
  accept_ev.start (fd, ev::READ);
}

int unix_listener::open (const char *sockname)
{
  sockaddr_un sa;

  if (strlen (sockname) >= sizeof(sa.sun_path))
    {
      fputs ("socket name too long, aborting.\n", stderr);
      exit (EXIT_FAILURE);
    }

  int fd;
  if ((fd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
    {
      perror ("unable to create listening socket");
      exit (EXIT_FAILURE);
    }

  sa.sun_family = AF_UNIX;
  strcpy (sa.sun_path, sockname);

  unlink (sockname);

  mode_t omask = umask (0077);

  if (bind (fd, (sockaddr *)&sa, sizeof (sa)))
    {
      perror ("unable to bind listening socket");
      exit (EXIT_FAILURE);
    }

  umask (omask);

  if (listen (fd, 5))
    {
      perror ("unable to listen on socket");
      exit (EXIT_FAILURE);
    }

  return fd;
}

void unix_listener::accept_cb (ev::io &w, int revents)
{
  int fd2 = accept (fd, 0, 0);

  if (fd2 >= 0)
    new server (fd2);
}

int server::getfd (int remote_fd)
{
  send ("GETFD");
  send (remote_fd);
  return ptytty::recv_fd (fd);
}

void server::log_msg (const char *msg)
{
  send ("MSG"), send (msg);
}

void server::err (const char *format, ...)
{
  if (format)
    {
      char err[1024];

      va_list ap;
      va_start (ap, format);
      vsnprintf (err, 1024, format, ap);
      va_end (ap);

      log_msg (err);
    }

  send ("END"), send (0);
  close (fd);
  delete this;
}

void server::read_cb (ev::io &w, int revents)
{
  auto_str tok;

  if (recv (tok))
    {
      if (!strcmp (tok, "NEW"))
        {
          stringvec *argv = new stringvec;
          stringvec *envv = new stringvec;

          for (;;)
            {
              if (!recv (tok))
                return err ();

              if (!strcmp (tok, "END"))
                break;
              else if (!strcmp (tok, "ENV") && recv (tok))
                envv->push_back (strdup (tok));
              else if (!strcmp (tok, "ARG") && recv (tok))
                argv->push_back (strdup (tok));
              else
                return err ("protocol error: unexpected NEW token.\n");
            }

          {
            rxvt_term *term = new rxvt_term;

            term->log_hook = &log_cb;
            term->getfd_hook = &getfd_cb;

            bool success = true;

            try
              {
                term->init (argv, envv);
              }
            catch (const class rxvt_failure_exception &e)
              {
                success = false;
              }

            term->log_hook = 0;

            chdir ("/"); // init might change to different working directory

            if (!success)
              term->destroy ();

            send ("END"); send (success ? 1 : 0);
          }
        }
      else if (!strcmp (tok, "QUIT"))
        _exit (0);
      else
        return err ("protocol error: request '%s' unsupported.\n", (char *)tok);
    }
  else
    return err ();
}

#ifdef ENABLE_FRILLS
enum {
  SD_LISTEN_FDS_START = 3,
};

// https://www.freedesktop.org/software/systemd/man/sd_listen_fds.html
// https://github.com/systemd/systemd/blob/main/src/libsystemd/sd-daemon/sd-daemon.c
static int get_listen_fds ()
{
  const char *listen_pid = getenv ("LISTEN_PID");
  if (!listen_pid)
    return 0;

  char *end;
  errno = 0;
  long pid = strtol (listen_pid, &end, 10);
  if (errno || end == listen_pid || *end)
    return -1;

  if (getpid () != pid)
    return 0;

  const char *listen_fds = getenv ("LISTEN_FDS");
  if (!listen_fds)
    return 0;

  errno = 0;
  long n = strtol (listen_fds, &end, 10);
  if (errno || end == listen_fds || *end)
    return -1;

  if (n <= 0 || n > INT_MAX - SD_LISTEN_FDS_START)
    return -1;

  unsetenv ("LISTEN_PID");
  unsetenv ("LISTEN_FDS");
  unsetenv ("LISTEN_FDNAMES");

  return n;
}
#endif

int
main (int argc, char *argv[])
{
  ptytty::init ();

  static char opt_fork, opt_opendisplay, opt_quiet;
#if ENABLE_PERL
  static char *opt_eval;
#endif
#if ENABLE_MLOCK
  static char opt_lock;
#endif

  for (int i = 1; i < argc; i++)
    {
      if (!strcmp (argv [i], "-f") || !strcmp (argv [i], "--fork"))
        opt_fork = 1;
      else if (!strcmp (argv [i], "-o") || !strcmp (argv [i], "--opendisplay"))
        opt_opendisplay = 1;
      else if (!strcmp (argv [i], "-q") || !strcmp (argv [i], "--quiet"))
        opt_quiet = 1;
#if ENABLE_MLOCK
      else if (!strcmp (argv [i], "-m") || !strcmp (argv [i], "--mlock"))
        opt_lock = 1;
#endif
#if ENABLE_PERL
      else if (!strcmp (argv [i], "-e") || !strcmp (argv [i], "--eval"))
        opt_eval = argv [++i];
#endif
      else
        {
          rxvt_log ("%s: unknown option '%s', aborting.\n", argv [0], argv [i]);
          return EXIT_FAILURE;
        }
    }

  rxvt_init ();

#if ENABLE_PERL
  if (opt_eval)
    {
      rxvt_perl.init ();
      rxvt_perl.eval (opt_eval);
    }
#endif

  // optionally open display and never release it.
  if (opt_opendisplay)
    if (const char *dpy = getenv ("DISPLAY"))
      displays.get (dpy ? dpy : ":0"); // move string logic into rxvt_display maybe?

  int fd;
#ifdef ENABLE_FRILLS
  int n = get_listen_fds ();
  if (n > 1)
    {
      fputs ("received multiple file descriptors, aborting.\n", stderr);
      exit (EXIT_FAILURE);
    }
  else if (n == 1)
    {
      fd = SD_LISTEN_FDS_START;
      if (!opt_quiet)
        {
          printf ("rxvt-unicode daemon listening on fd.\n");
          fflush (stdout);
        }
    }
  else
#endif
    {
      char *sockname = rxvt_connection::unix_sockname ();
      fd = unix_listener::open (sockname);
      if (!opt_quiet)
        {
          printf ("rxvt-unicode daemon listening on %s.\n", sockname);
          fflush (stdout);
        }
      free (sockname);
    }

  unix_listener l (fd);

  chdir ("/");

  pid_t pid = 0;
  if (opt_fork)
    {
      pid = fork ();
    }

#if ENABLE_MLOCK
  // Optionally perform an mlockall so this process does not get swapped out.
  if (opt_lock && !pid)
    if (mlockall (MCL_CURRENT | MCL_FUTURE) < 0)
      perror ("unable to lock into ram");
#endif

  if (opt_fork)
    {
      if (pid < 0)
        {
          rxvt_log ("unable to fork daemon, aborting.\n");
          return EXIT_FAILURE;
        }
      else if (pid > 0)
        _exit (EXIT_SUCCESS);

      ev_loop_fork (EV_DEFAULT_UC);
    }

  ev_run ();

  return EXIT_SUCCESS;
}

Revision:	1.64
Committed:	Thu Jun 17 00:08:35 2021 UTC (2 years, 11 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.63:	+4 -2 lines
Log Message:	editorial changes
#	User	Rev	Content
1	root	1.29	/----------------------------------------------------------------------
2	pcg	1.14	* File: rxvtd.C
3			----------------------------------------------------------------------
4			*
5			* All portions of code are copyright by their respective author/s.
6	root	1.56	* Copyright (c) 2003-2007 Marc Lehmann <schmorp@schmorp.de>
7	pcg	1.14	*
8			* This program is free software; you can redistribute it and/or modify
9			* it under the terms of the GNU General Public License as published by
10	root	1.61	* the Free Software Foundation; either version 3 of the License, or
11	pcg	1.14	* (at your option) any later version.
12			*
13			* This program is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU General Public License for more details.
17			*
18			* You should have received a copy of the GNU General Public License
19			* along with this program; if not, write to the Free Software
20			* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21			----------------------------------------------------------------------/
22
23	pcg	1.9	#include "../config.h"
24	sf-exg	1.59	#include <stdio.h>
25			#include <stdlib.h>
26			#include <stdarg.h>
27			#include <string.h>
28	pcg	1.1
29			#include <unistd.h>
30	pcg	1.12	#include <fcntl.h>
31	pcg	1.5	#include <sys/types.h>
32			#include <sys/stat.h>
33	pcg	1.1	#include <sys/socket.h>
34			#include <sys/un.h>
35
36	root	1.47	#if defined(ENABLE_FRILLS) && defined(_POSIX_MEMLOCK) && _POSIX_MEMLOCK > 0
37			# define ENABLE_MLOCK 1
38			#endif
39
40			#if ENABLE_MLOCK
41			# include <sys/mman.h>
42			#endif
43
44	sf-exg	1.59	#include <errno.h>
45	pcg	1.3
46	root	1.27	#include "rxvt.h"
47			#include "rxvtdaemon.h"
48			#include "libptytty.h"
49	pcg	1.3
50	root	1.64	struct server : rxvt_connection
51			{
52	pcg	1.10	log_callback log_cb;
53	root	1.22	getfd_callback getfd_cb;
54	pcg	1.10
55	root	1.34	void read_cb (ev::io &w, int revents); ev::io read_ev;
56	pcg	1.10	void log_msg (const char *msg);
57	root	1.22	int getfd (int remote_fd);
58	pcg	1.1
59			server (int fd)
60			{
61	root	1.41	read_ev.set <server, &server::read_cb> (this);
62			log_cb.set <server, &server::log_msg> (this);
63			getfd_cb.set<server, &server::getfd> (this);
64
65	root	1.37	this->fd = fd;
66	root	1.35	fcntl (fd, F_SETFD, FD_CLOEXEC);
67			fcntl (fd, F_SETFL, 0);
68	root	1.34	read_ev.start (fd, ev::READ);
69	pcg	1.1	}
70
71	pcg	1.3	void err (const char *format = 0, ...);
72	pcg	1.1	};
73
74	root	1.64	struct unix_listener
75			{
76	pcg	1.1	int fd;
77
78	root	1.34	void accept_cb (ev::io &w, int revents); ev::io accept_ev;
79	pcg	1.1
80	sf-exg	1.63	unix_listener (int fd);
81			static int open (const char *sockname);
82	pcg	1.1	};
83
84	sf-exg	1.63	unix_listener::unix_listener (int fd) : fd (fd)
85	pcg	1.1	{
86	root	1.41	accept_ev.set<unix_listener, &unix_listener::accept_cb> (this);
87	sf-exg	1.63	fcntl (fd, F_SETFD, FD_CLOEXEC);
88			fcntl (fd, F_SETFL, O_NONBLOCK);
89			accept_ev.start (fd, ev::READ);
90			}
91	root	1.41
92	sf-exg	1.63	int unix_listener::open (const char *sockname)
93			{
94	root	1.30	sockaddr_un sa;
95	ayin	1.33
96	root	1.31	if (strlen (sockname) >= sizeof(sa.sun_path))
97			{
98			fputs ("socket name too long, aborting.\n", stderr);
99			exit (EXIT_FAILURE);
100			}
101	root	1.30
102	sf-exg	1.63	int fd;
103	root	1.24	if ((fd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
104	pcg	1.1	{
105			perror ("unable to create listening socket");
106			exit (EXIT_FAILURE);
107			}
108
109			sa.sun_family = AF_UNIX;
110	pcg	1.5	strcpy (sa.sun_path, sockname);
111	pcg	1.1
112	sf-exg	1.55	unlink (sockname);
113	pcg	1.1
114	pcg	1.5	mode_t omask = umask (0077);
115
116	pcg	1.1	if (bind (fd, (sockaddr *)&sa, sizeof (sa)))
117			{
118			perror ("unable to bind listening socket");
119			exit (EXIT_FAILURE);
120			}
121
122	pcg	1.5	umask (omask);
123
124	pcg	1.1	if (listen (fd, 5))
125			{
126			perror ("unable to listen on socket");
127			exit (EXIT_FAILURE);
128			}
129
130	sf-exg	1.63	return fd;
131	pcg	1.1	}
132
133	root	1.34	void unix_listener::accept_cb (ev::io &w, int revents)
134	pcg	1.1	{
135			int fd2 = accept (fd, 0, 0);
136
137			if (fd2 >= 0)
138	root	1.35	new server (fd2);
139	pcg	1.1	}
140
141	root	1.22	int server::getfd (int remote_fd)
142			{
143			send ("GETFD");
144			send (remote_fd);
145	root	1.27	return ptytty::recv_fd (fd);
146	root	1.22	}
147
148	pcg	1.10	void server::log_msg (const char *msg)
149			{
150			send ("MSG"), send (msg);
151			}
152
153	pcg	1.3	void server::err (const char *format, ...)
154	pcg	1.1	{
155	pcg	1.3	if (format)
156			{
157			char err[1024];
158
159			va_list ap;
160			va_start (ap, format);
161			vsnprintf (err, 1024, format, ap);
162			va_end (ap);
163
164	root	1.32	log_msg (err);
165	pcg	1.3	}
166
167	root	1.32	send ("END"), send (0);
168	pcg	1.1	close (fd);
169			delete this;
170			}
171
172	root	1.34	void server::read_cb (ev::io &w, int revents)
173	pcg	1.1	{
174	pcg	1.2	auto_str tok;
175	pcg	1.1
176	pcg	1.2	if (recv (tok))
177	pcg	1.1	{
178	pcg	1.2	if (!strcmp (tok, "NEW"))
179	pcg	1.1	{
180	pcg	1.9	stringvec *argv = new stringvec;
181			stringvec *envv = new stringvec;
182	ayin	1.33
183	pcg	1.2	for (;;)
184			{
185			if (!recv (tok))
186			return err ();
187
188			if (!strcmp (tok, "END"))
189			break;
190	pcg	1.3	else if (!strcmp (tok, "ENV") && recv (tok))
191	root	1.26	envv->push_back (strdup (tok));
192	pcg	1.2	else if (!strcmp (tok, "ARG") && recv (tok))
193	root	1.26	argv->push_back (strdup (tok));
194	pcg	1.2	else
195	root	1.31	return err ("protocol error: unexpected NEW token.\n");
196	pcg	1.2	}
197
198	pcg	1.3	{
199	pcg	1.10	rxvt_term *term = new rxvt_term;
200	ayin	1.33
201	pcg	1.10	term->log_hook = &log_cb;
202	root	1.22	term->getfd_hook = &getfd_cb;
203	pcg	1.2
204	root	1.42	bool success = true;
205	ayin	1.33
206	pcg	1.10	try
207			{
208	root	1.42	term->init (argv, envv);
209	pcg	1.10	}
210			catch (const class rxvt_failure_exception &e)
211			{
212			success = false;
213			}
214
215	root	1.15	term->log_hook = 0;
216
217	root	1.46	chdir ("/"); // init might change to different working directory
218	pcg	1.10
219			if (!success)
220			term->destroy ();
221
222			send ("END"); send (success ? 1 : 0);
223	pcg	1.3	}
224	pcg	1.1	}
225	sf-exg	1.62	else if (!strcmp (tok, "QUIT"))
226			_exit (0);
227	pcg	1.1	else
228	root	1.31	return err ("protocol error: request '%s' unsupported.\n", (char *)tok);
229	pcg	1.1	}
230			else
231	pcg	1.2	return err ();
232	pcg	1.1	}
233
234	sf-exg	1.63	#ifdef ENABLE_FRILLS
235			enum {
236			SD_LISTEN_FDS_START = 3,
237			};
238
239			// https://www.freedesktop.org/software/systemd/man/sd_listen_fds.html
240			// https://github.com/systemd/systemd/blob/main/src/libsystemd/sd-daemon/sd-daemon.c
241			static int get_listen_fds ()
242			{
243			const char *listen_pid = getenv ("LISTEN_PID");
244			if (!listen_pid)
245			return 0;
246
247			char *end;
248			errno = 0;
249			long pid = strtol (listen_pid, &end, 10);
250			if (errno \|\| end == listen_pid \|\| *end)
251			return -1;
252
253			if (getpid () != pid)
254			return 0;
255
256			const char *listen_fds = getenv ("LISTEN_FDS");
257			if (!listen_fds)
258			return 0;
259
260			errno = 0;
261			long n = strtol (listen_fds, &end, 10);
262			if (errno \|\| end == listen_fds \|\| *end)
263			return -1;
264
265			if (n <= 0 \|\| n > INT_MAX - SD_LISTEN_FDS_START)
266			return -1;
267
268			unsetenv ("LISTEN_PID");
269			unsetenv ("LISTEN_FDS");
270			unsetenv ("LISTEN_FDNAMES");
271
272			return n;
273			}
274			#endif
275
276	sf-exg	1.49	int
277	root	1.58	main (int argc, char *argv[])
278	sf-exg	1.49	{
279	root	1.52	ptytty::init ();
280
281	sf-exg	1.54	static char opt_fork, opt_opendisplay, opt_quiet;
282	root	1.60	#if ENABLE_PERL
283			static char *opt_eval;
284			#endif
285	root	1.47	#if ENABLE_MLOCK
286	sf-exg	1.54	static char opt_lock;
287	root	1.47	#endif
288	root	1.21
289			for (int i = 1; i < argc; i++)
290			{
291			if (!strcmp (argv [i], "-f") \|\| !strcmp (argv [i], "--fork"))
292			opt_fork = 1;
293			else if (!strcmp (argv [i], "-o") \|\| !strcmp (argv [i], "--opendisplay"))
294			opt_opendisplay = 1;
295			else if (!strcmp (argv [i], "-q") \|\| !strcmp (argv [i], "--quiet"))
296			opt_quiet = 1;
297	root	1.47	#if ENABLE_MLOCK
298			else if (!strcmp (argv [i], "-m") \|\| !strcmp (argv [i], "--mlock"))
299			opt_lock = 1;
300			#endif
301	root	1.60	#if ENABLE_PERL
302			else if (!strcmp (argv [i], "-e") \|\| !strcmp (argv [i], "--eval"))
303			opt_eval = argv [++i];
304			#endif
305	root	1.21	else
306			{
307			rxvt_log ("%s: unknown option '%s', aborting.\n", argv [0], argv [i]);
308			return EXIT_FAILURE;
309			}
310			}
311	ayin	1.33
312	root	1.52	rxvt_init ();
313
314	root	1.60	#if ENABLE_PERL
315			if (opt_eval)
316			{
317			rxvt_perl.init ();
318			rxvt_perl.eval (opt_eval);
319			}
320			#endif
321
322	root	1.45	// optionally open display and never release it.
323	root	1.21	if (opt_opendisplay)
324	root	1.45	if (const char *dpy = getenv ("DISPLAY"))
325			displays.get (dpy ? dpy : ":0"); // move string logic into rxvt_display maybe?
326	root	1.21
327	sf-exg	1.63	int fd;
328			#ifdef ENABLE_FRILLS
329			int n = get_listen_fds ();
330			if (n > 1)
331			{
332			fputs ("received multiple file descriptors, aborting.\n", stderr);
333			exit (EXIT_FAILURE);
334			}
335			else if (n == 1)
336			{
337			fd = SD_LISTEN_FDS_START;
338			if (!opt_quiet)
339			{
340			printf ("rxvt-unicode daemon listening on fd.\n");
341			fflush (stdout);
342			}
343			}
344			else
345			#endif
346	root	1.21	{
347	sf-exg	1.63	char *sockname = rxvt_connection::unix_sockname ();
348			fd = unix_listener::open (sockname);
349			if (!opt_quiet)
350			{
351			printf ("rxvt-unicode daemon listening on %s.\n", sockname);
352			fflush (stdout);
353			}
354			free (sockname);
355	root	1.21	}
356
357	sf-exg	1.63	unix_listener l (fd);
358
359			chdir ("/");
360	pcg	1.5
361	root	1.47	pid_t pid = 0;
362	root	1.21	if (opt_fork)
363			{
364	root	1.47	pid = fork ();
365			}
366
367			#if ENABLE_MLOCK
368	root	1.48	// Optionally perform an mlockall so this process does not get swapped out.
369			if (opt_lock && !pid)
370			if (mlockall (MCL_CURRENT \| MCL_FUTURE) < 0)
371			perror ("unable to lock into ram");
372	root	1.47	#endif
373	root	1.21
374	root	1.47	if (opt_fork)
375			{
376	root	1.21	if (pid < 0)
377			{
378			rxvt_log ("unable to fork daemon, aborting.\n");
379			return EXIT_FAILURE;
380			}
381			else if (pid > 0)
382			_exit (EXIT_SUCCESS);
383	root	1.38
384	root	1.51	ev_loop_fork (EV_DEFAULT_UC);
385	root	1.21	}
386
387	root	1.50	ev_run ();
388	pcg	1.1
389			return EXIT_SUCCESS;
390			}
391	pcg	1.7