2 * main.c : Main control function for svnserve
4 * ====================================================================
5 * Copyright (c) 2000-2007 CollabNet. All rights reserved.
7 * This software is licensed as described in the file COPYING, which
8 * you should have received as part of this distribution. The terms
9 * are also available at http://subversion.tigris.org/license-1.html.
10 * If newer versions of this license are posted there, you may use a
11 * newer version instead, at your option.
13 * This software consists of voluntary contributions made by many
14 * individuals. For exact contribution history, see the revision
15 * history and logs, available at http://subversion.tigris.org/.
16 * ====================================================================
21 #define APR_WANT_STRFUNC
23 #include <apr_general.h>
24 #include <apr_getopt.h>
25 #include <apr_network_io.h>
26 #include <apr_signal.h>
27 #include <apr_thread_proc.h>
28 #include <apr_portable.h>
32 #include "svn_cmdline.h"
33 #include "svn_types.h"
34 #include "svn_pools.h"
35 #include "svn_error.h"
36 #include "svn_ra_svn.h"
40 #include "svn_repos.h"
42 #include "svn_version.h"
45 #include "svn_private_config.h"
46 #include "winservice.h"
49 #include <unistd.h> /* For getpid() */
54 /* The strategy for handling incoming connections. Some of these may be
55 unavailable due to platform limitations. */
56 enum connection_handling_mode
{
57 connection_mode_fork
, /* Create a process per connection */
58 connection_mode_thread
, /* Create a thread per connection */
59 connection_mode_single
/* One connection at a time in this process */
62 /* The mode in which to run svnserve */
75 #define CONNECTION_DEFAULT connection_mode_fork
76 #define CONNECTION_HAVE_THREAD_OPTION
78 #else /* ! APR_HAS_THREADS */
80 #define CONNECTION_DEFAULT connection_mode_fork
82 #endif /* ! APR_HAS_THREADS */
83 #elif APR_HAS_THREADS /* and ! APR_HAS_FORK */
85 #define CONNECTION_DEFAULT connection_mode_thread
87 #else /* ! APR_HAS_THREADS and ! APR_HAS_FORK */
89 #define CONNECTION_DEFAULT connection_mode_single
95 static apr_os_sock_t winservice_svnserve_accept_socket
= INVALID_SOCKET
;
97 /* The SCM calls this function (on an arbitrary thread, not the main()
98 thread!) when it wants to stop the service.
100 For now, our strategy is to close the listener socket, in order to
101 unblock main() and cause it to exit its accept loop. We cannot use
102 apr_socket_close, because that function deletes the apr_socket_t
103 structure, as well as closing the socket handle. If we called
104 apr_socket_close here, then main() will also call apr_socket_close,
105 resulting in a double-free. This way, we just close the kernel
106 socket handle, which causes the accept() function call to fail,
107 which causes main() to clean up the socket. So, memory gets freed
110 This isn't pretty, but it's better than a lot of other options.
111 Currently, there is no "right" way to shut down svnserve.
113 We store the OS handle rather than a pointer to the apr_socket_t
114 structure in order to eliminate any possibility of illegal memory
116 void winservice_notify_stop(void)
118 if (winservice_svnserve_accept_socket
!= INVALID_SOCKET
)
119 closesocket(winservice_svnserve_accept_socket
);
124 /* Option codes and descriptions for svnserve.
126 * The entire list must be terminated with an entry of nulls.
128 * APR requires that options without abbreviations
129 * have codes greater than 255.
131 #define SVNSERVE_OPT_LISTEN_PORT 256
132 #define SVNSERVE_OPT_LISTEN_HOST 257
133 #define SVNSERVE_OPT_FOREGROUND 258
134 #define SVNSERVE_OPT_TUNNEL_USER 259
135 #define SVNSERVE_OPT_VERSION 260
136 #define SVNSERVE_OPT_PID_FILE 261
137 #define SVNSERVE_OPT_SERVICE 262
138 #define SVNSERVE_OPT_CONFIG_FILE 263
139 #define SVNSERVE_OPT_LOG_FILE 264
141 static const apr_getopt_option_t svnserve__options
[] =
143 {"daemon", 'd', 0, N_("daemon mode")},
144 {"inetd", 'i', 0, N_("inetd mode")},
145 {"tunnel", 't', 0, N_("tunnel mode")},
146 {"listen-once", 'X', 0, N_("listen-once mode (useful for debugging)")},
148 {"service", SVNSERVE_OPT_SERVICE
, 0,
149 N_("Windows service mode (Service Control Manager)")},
151 {"root", 'r', 1, N_("root of directory to serve")},
152 {"read-only", 'R', 0,
153 N_("force read only, overriding repository config file")},
154 {"config-file", SVNSERVE_OPT_CONFIG_FILE
, 1,
155 N_("read configuration from file ARG")},
156 {"listen-port", SVNSERVE_OPT_LISTEN_PORT
, 1,
160 "[mode: daemon, service, listen-once]")},
164 "[mode: daemon, listen-once]")},
166 {"listen-host", SVNSERVE_OPT_LISTEN_HOST
, 1,
168 N_("listen hostname or IP address\n"
170 "[mode: daemon, service, listen-once]")},
172 N_("listen hostname or IP address\n"
174 "[mode: daemon, listen-once]")},
176 #ifdef CONNECTION_HAVE_THREAD_OPTION
177 /* ### Making the assumption here that WIN32 never has fork and so
178 * ### this option never exists when --service exists. */
179 {"threads", 'T', 0, N_("use threads instead of fork "
182 {"foreground", SVNSERVE_OPT_FOREGROUND
, 0,
183 N_("run in foreground (useful for debugging)\n"
186 {"log-file", SVNSERVE_OPT_LOG_FILE
, 1,
187 N_("svnserve log file")},
188 {"pid-file", SVNSERVE_OPT_PID_FILE
, 1,
190 N_("write server process ID to file ARG\n"
192 "[mode: daemon, listen-once, service]")},
194 N_("write server process ID to file ARG\n"
196 "[mode: daemon, listen-once]")},
198 {"tunnel-user", SVNSERVE_OPT_TUNNEL_USER
, 1,
199 N_("tunnel username (default is current uid's name)\n"
202 {"help", 'h', 0, N_("display this help")},
203 {"version", SVNSERVE_OPT_VERSION
, 0,
204 N_("show program version information")},
209 static void usage(const char *progname
, apr_pool_t
*pool
)
212 progname
= "svnserve";
214 svn_error_clear(svn_cmdline_fprintf(stderr
, pool
,
215 _("Type '%s --help' for usage.\n"),
220 static void help(apr_pool_t
*pool
)
225 svn_error_clear(svn_cmdline_fputs(_("usage: svnserve [-d | -i | -t | -X "
226 "| --service] [options]\n"
231 svn_error_clear(svn_cmdline_fputs(_("usage: svnserve [-d | -i | -t | -X] "
237 for (i
= 0; svnserve__options
[i
].name
&& svnserve__options
[i
].optch
; i
++)
240 svn_opt_format_option(&optstr
, svnserve__options
+ i
, TRUE
, pool
);
241 svn_error_clear(svn_cmdline_fprintf(stdout
, pool
, " %s\n", optstr
));
243 svn_error_clear(svn_cmdline_fprintf(stdout
, pool
, "\n"));
247 static svn_error_t
* version(apr_pool_t
*pool
)
249 const char *fs_desc_start
250 = _("The following repository back-end (FS) modules are available:\n\n");
252 svn_stringbuf_t
*version_footer
;
254 version_footer
= svn_stringbuf_create(fs_desc_start
, pool
);
255 SVN_ERR(svn_fs_print_modules(version_footer
, pool
));
258 svn_stringbuf_appendcstr(version_footer
,
259 _("\nCyrus SASL authentication is available.\n"));
262 return svn_opt_print_help(NULL
, "svnserve", TRUE
, FALSE
, version_footer
->data
,
263 NULL
, NULL
, NULL
, NULL
, pool
);
268 static void sigchld_handler(int signo
)
270 /* Nothing to do; we just need to interrupt the accept(). */
274 /* In tunnel or inetd mode, we don't want hook scripts corrupting the
275 * data stream by sending data to stdout, so we need to redirect
276 * stdout somewhere else. Sending it to stderr is acceptable; sending
277 * it to /dev/null is another option, but apr doesn't provide a way to
278 * do that without also detaching from the controlling terminal.
280 static apr_status_t
redirect_stdout(void *arg
)
282 apr_pool_t
*pool
= arg
;
283 apr_file_t
*out_file
, *err_file
;
284 apr_status_t apr_err
;
286 if ((apr_err
= apr_file_open_stdout(&out_file
, pool
)))
288 if ((apr_err
= apr_file_open_stderr(&err_file
, pool
)))
290 return apr_file_dup2(out_file
, err_file
, pool
);
293 /* "Arguments" passed from the main thread to the connection thread */
294 struct serve_thread_t
{
295 svn_ra_svn_conn_t
*conn
;
296 serve_params_t
*params
;
301 static void * APR_THREAD_FUNC
serve_thread(apr_thread_t
*tid
, void *data
)
303 struct serve_thread_t
*d
= data
;
305 svn_error_clear(serve(d
->conn
, d
->params
, d
->pool
));
306 svn_pool_destroy(d
->pool
);
312 /* Write the PID of the current process as a decimal number, followed by a
313 newline to the file FILENAME, using POOL for temporary allocations. */
314 static svn_error_t
*write_pid_file(const char *filename
, apr_pool_t
*pool
)
317 const char *contents
= apr_psprintf(pool
, "%" APR_PID_T_FMT
"\n",
320 SVN_ERR(svn_io_file_open(&file
, filename
,
321 APR_WRITE
| APR_CREATE
| APR_TRUNCATE
,
322 APR_OS_DEFAULT
, pool
));
323 SVN_ERR(svn_io_file_write_full(file
, contents
, strlen(contents
), NULL
,
326 SVN_ERR(svn_io_file_close(file
, pool
));
331 /* Version compatibility check */
333 check_lib_versions(void)
335 static const svn_version_checklist_t checklist
[] =
337 { "svn_subr", svn_subr_version
},
338 { "svn_repos", svn_repos_version
},
339 { "svn_fs", svn_fs_version
},
340 { "svn_delta", svn_delta_version
},
341 { "svn_ra_svn", svn_ra_svn_version
},
345 SVN_VERSION_DEFINE(my_version
);
346 return svn_ver_check_list(&my_version
, checklist
);
350 int main(int argc
, const char *argv
[])
352 enum run_mode run_mode
= run_mode_unspecified
;
353 svn_boolean_t foreground
= FALSE
;
354 apr_socket_t
*sock
, *usock
;
355 apr_file_t
*in_file
, *out_file
;
358 apr_pool_t
*connection_pool
;
362 serve_params_t params
;
365 svn_ra_svn_conn_t
*conn
;
368 apr_threadattr_t
*tattr
;
371 struct serve_thread_t
*thread_data
;
373 enum connection_handling_mode handling_mode
= CONNECTION_DEFAULT
;
374 apr_uint16_t port
= SVN_RA_SVN_PORT
;
375 const char *host
= NULL
;
376 int family
= APR_INET
;
377 int mode_opt_count
= 0;
378 const char *config_filename
= NULL
;
379 const char *pid_filename
= NULL
;
380 const char *log_filename
= NULL
;
381 svn_node_kind_t kind
;
383 /* Initialize the app. */
384 if (svn_cmdline_init("svnserve", stderr
) != EXIT_SUCCESS
)
387 /* Create our top-level pool. */
388 pool
= svn_pool_create(NULL
);
391 SVN_INT_ERR(cyrus_init(pool
));
394 /* Check library versions */
395 err
= check_lib_versions();
397 return svn_cmdline_handle_exit_error(err
, pool
, "svnserve: ");
399 /* Initialize the FS library. */
400 err
= svn_fs_initialize(pool
);
402 return svn_cmdline_handle_exit_error(err
, pool
, "svnserve: ");
404 err
= svn_cmdline__getopt_init(&os
, argc
, argv
, pool
);
406 return svn_cmdline_handle_exit_error(err
, pool
, "svnserve: ");
409 params
.tunnel
= FALSE
;
410 params
.tunnel_user
= NULL
;
411 params
.read_only
= FALSE
;
414 params
.authzdb
= NULL
;
415 params
.log_file
= NULL
;
419 status
= apr_getopt_long(os
, svnserve__options
, &opt
, &arg
);
420 if (APR_STATUS_IS_EOF(status
))
422 if (status
!= APR_SUCCESS
)
423 usage(argv
[0], pool
);
430 case SVNSERVE_OPT_VERSION
:
431 SVN_INT_ERR(version(pool
));
436 if (run_mode
!= run_mode_daemon
)
438 run_mode
= run_mode_daemon
;
443 case SVNSERVE_OPT_FOREGROUND
:
448 if (run_mode
!= run_mode_inetd
)
450 run_mode
= run_mode_inetd
;
455 case SVNSERVE_OPT_LISTEN_PORT
:
459 case SVNSERVE_OPT_LISTEN_HOST
:
464 if (run_mode
!= run_mode_tunnel
)
466 run_mode
= run_mode_tunnel
;
471 case SVNSERVE_OPT_TUNNEL_USER
:
472 params
.tunnel_user
= arg
;
476 if (run_mode
!= run_mode_listen_once
)
478 run_mode
= run_mode_listen_once
;
484 SVN_INT_ERR(svn_utf_cstring_to_utf8(¶ms
.root
, arg
, pool
));
486 err
= svn_io_check_resolved_path(params
.root
, &kind
, pool
);
488 return svn_cmdline_handle_exit_error(err
, pool
, "svnserve: ");
489 if (kind
!= svn_node_dir
)
494 _("svnserve: Root path '%s' does not exist "
495 "or is not a directory.\n"), params
.root
));
499 params
.root
= svn_path_internal_style(params
.root
, pool
);
500 SVN_INT_ERR(svn_path_get_absolute(¶ms
.root
, params
.root
, pool
));
504 params
.read_only
= TRUE
;
508 handling_mode
= connection_mode_thread
;
512 case SVNSERVE_OPT_SERVICE
:
513 if (run_mode
!= run_mode_service
)
515 run_mode
= run_mode_service
;
521 case SVNSERVE_OPT_CONFIG_FILE
:
522 SVN_INT_ERR(svn_utf_cstring_to_utf8(&config_filename
, arg
, pool
));
523 config_filename
= svn_path_internal_style(config_filename
, pool
);
524 SVN_INT_ERR(svn_path_get_absolute(&config_filename
, config_filename
,
528 case SVNSERVE_OPT_PID_FILE
:
529 SVN_INT_ERR(svn_utf_cstring_to_utf8(&pid_filename
, arg
, pool
));
530 pid_filename
= svn_path_internal_style(pid_filename
, pool
);
531 SVN_INT_ERR(svn_path_get_absolute(&pid_filename
, pid_filename
,
535 case SVNSERVE_OPT_LOG_FILE
:
536 SVN_INT_ERR(svn_utf_cstring_to_utf8(&log_filename
, arg
, pool
));
537 log_filename
= svn_path_internal_style(log_filename
, pool
);
538 SVN_INT_ERR(svn_path_get_absolute(&log_filename
, log_filename
,
545 usage(argv
[0], pool
);
547 if (mode_opt_count
!= 1)
549 svn_error_clear(svn_cmdline_fputs
551 (_("You must specify exactly one of -d, -i, -t, "
552 "--service or -X.\n"),
554 (_("You must specify exactly one of -d, -i, -t or -X.\n"),
557 usage(argv
[0], pool
);
560 /* If a configuration file is specified, load it and any referenced
561 * password and authorization files. */
563 SVN_INT_ERR(load_configs(¶ms
.cfg
, ¶ms
.pwdb
, ¶ms
.authzdb
,
564 config_filename
, TRUE
,
565 svn_path_dirname(config_filename
, pool
),
569 SVN_INT_ERR(svn_io_file_open(¶ms
.log_file
, log_filename
,
570 APR_WRITE
| APR_CREATE
| APR_APPEND
,
571 APR_OS_DEFAULT
, pool
));
573 if (params
.tunnel_user
&& run_mode
!= run_mode_tunnel
)
578 _("Option --tunnel-user is only valid in tunnel mode.\n")));
582 if (run_mode
== run_mode_inetd
|| run_mode
== run_mode_tunnel
)
584 params
.tunnel
= (run_mode
== run_mode_tunnel
);
585 apr_pool_cleanup_register(pool
, pool
, apr_pool_cleanup_null
,
587 status
= apr_file_open_stdin(&in_file
, pool
);
590 err
= svn_error_wrap_apr(status
, _("Can't open stdin"));
591 return svn_cmdline_handle_exit_error(err
, pool
, "svnserve: ");
594 status
= apr_file_open_stdout(&out_file
, pool
);
597 err
= svn_error_wrap_apr(status
, _("Can't open stdout"));
598 return svn_cmdline_handle_exit_error(err
, pool
, "svnserve: ");
601 conn
= svn_ra_svn_create_conn(NULL
, in_file
, out_file
, pool
);
602 svn_error_clear(serve(conn
, ¶ms
, pool
));
607 /* If svnserve needs to run as a Win32 service, then we need to
608 coordinate with the Service Control Manager (SCM) before
609 continuing. This function call registers the svnserve.exe
610 process with the SCM, waits for the "start" command from the SCM
611 (which will come very quickly), and confirms that those steps
614 After this call succeeds, the service is free to run. At some
615 point in the future, the SCM will send a message to the service,
616 requesting that it stop. This is translated into a call to
617 winservice_notify_stop(). The service is then responsible for
620 We need to do this before actually starting the service logic
621 (opening files, sockets, etc.) because the SCM wants you to
622 connect *first*, then do your service-specific logic. If the
623 service process takes too long to connect to the SCM, then the
624 SCM will decide that the service is busted, and will give up on
627 if (run_mode
== run_mode_service
)
629 err
= winservice_start();
632 svn_handle_error2(err
, stderr
, FALSE
, "svnserve: ");
634 /* This is the most common error. It means the user started
635 svnserve from a shell, and specified the --service
636 argument. svnserve cannot be started, as a service, in
637 this way. The --service argument is valid only valid if
638 svnserve is started by the SCM. */
640 APR_FROM_OS_ERROR(ERROR_FAILED_SERVICE_CONTROLLER_CONNECT
))
642 svn_error_clear(svn_cmdline_fprintf(stderr
, pool
,
643 _("svnserve: The --service flag is only valid if the"
644 " process is started by the Service Control Manager.\n")));
647 svn_error_clear(err
);
651 /* The service is now in the "starting" state. Before the SCM will
652 consider the service "started", this thread must call the
653 winservice_running() function. */
657 /* Make sure we have IPV6 support first before giving apr_sockaddr_info_get
658 APR_UNSPEC, because it may give us back an IPV6 address even if we can't
659 create IPV6 sockets. */
662 #ifdef MAX_SECS_TO_LINGER
663 /* ### old APR interface */
664 status
= apr_socket_create(&sock
, APR_INET6
, SOCK_STREAM
, pool
);
666 status
= apr_socket_create(&sock
, APR_INET6
, SOCK_STREAM
, APR_PROTO_TCP
,
671 apr_socket_close(sock
);
676 status
= apr_sockaddr_info_get(&sa
, host
, family
, port
, 0, pool
);
679 err
= svn_error_wrap_apr(status
, _("Can't get address info"));
680 return svn_cmdline_handle_exit_error(err
, pool
, "svnserve: ");
684 #ifdef MAX_SECS_TO_LINGER
685 /* ### old APR interface */
686 status
= apr_socket_create(&sock
, sa
->family
, SOCK_STREAM
, pool
);
688 status
= apr_socket_create(&sock
, sa
->family
, SOCK_STREAM
, APR_PROTO_TCP
,
693 err
= svn_error_wrap_apr(status
, _("Can't create server socket"));
694 return svn_cmdline_handle_exit_error(err
, pool
, "svnserve: ");
697 /* Prevents "socket in use" errors when server is killed and quickly
699 apr_socket_opt_set(sock
, APR_SO_REUSEADDR
, 1);
701 status
= apr_socket_bind(sock
, sa
);
704 err
= svn_error_wrap_apr(status
, _("Can't bind server socket"));
705 return svn_cmdline_handle_exit_error(err
, pool
, "svnserve: ");
708 apr_socket_listen(sock
, 7);
711 if (run_mode
!= run_mode_listen_once
&& !foreground
)
712 apr_proc_detach(APR_PROC_DETACH_DAEMONIZE
);
714 apr_signal(SIGCHLD
, sigchld_handler
);
718 /* Disable SIGPIPE generation for the platforms that have it. */
719 apr_signal(SIGPIPE
, SIG_IGN
);
723 /* Disable SIGXFSZ generation for the platforms that have it, otherwise
724 * working with large files when compiled against an APR that doesn't have
725 * large file support will crash the program, which is uncool. */
726 apr_signal(SIGXFSZ
, SIG_IGN
);
730 SVN_INT_ERR(write_pid_file(pid_filename
, pool
));
733 status
= apr_os_sock_get(&winservice_svnserve_accept_socket
, sock
);
735 winservice_svnserve_accept_socket
= INVALID_SOCKET
;
737 /* At this point, the service is "running". Notify the SCM. */
738 if (run_mode
== run_mode_service
)
739 winservice_running();
745 if (winservice_is_stopping())
746 return ERROR_SUCCESS
;
749 /* Non-standard pool handling. The main thread never blocks to join
750 the connection threads so it cannot clean up after each one. So
751 separate pools, that can be cleared at thread exit, are used */
752 connection_pool
= svn_pool_create(NULL
);
754 status
= apr_socket_accept(&usock
, sock
, connection_pool
);
755 if (handling_mode
== connection_mode_fork
)
757 /* Collect any zombie child processes. */
758 while (apr_proc_wait_all_procs(&proc
, NULL
, NULL
, APR_NOWAIT
,
759 connection_pool
) == APR_CHILD_DONE
)
762 if (APR_STATUS_IS_EINTR(status
))
764 svn_pool_destroy(connection_pool
);
769 err
= svn_error_wrap_apr
770 (status
, _("Can't accept client connection"));
771 return svn_cmdline_handle_exit_error(err
, pool
, "svnserve: ");
774 conn
= svn_ra_svn_create_conn(usock
, NULL
, NULL
, connection_pool
);
776 if (run_mode
== run_mode_listen_once
)
778 err
= serve(conn
, ¶ms
, connection_pool
);
780 if (err
&& err
->apr_err
!= SVN_ERR_RA_SVN_CONNECTION_CLOSED
)
781 svn_handle_error2(err
, stdout
, FALSE
, "svnserve: ");
782 svn_error_clear(err
);
784 apr_socket_close(usock
);
785 apr_socket_close(sock
);
789 switch (handling_mode
)
791 case connection_mode_fork
:
793 status
= apr_proc_fork(&proc
, connection_pool
);
794 if (status
== APR_INCHILD
)
796 apr_socket_close(sock
);
797 svn_error_clear(serve(conn
, ¶ms
, connection_pool
));
798 apr_socket_close(usock
);
801 else if (status
== APR_INPARENT
)
803 apr_socket_close(usock
);
807 /* Log an error, when we support logging. */
808 apr_socket_close(usock
);
810 svn_pool_destroy(connection_pool
);
814 case connection_mode_thread
:
815 /* Create a detached thread for each connection. That's not a
816 particularly sophisticated strategy for a threaded server, it's
817 little different from forking one process per connection. */
819 status
= apr_threadattr_create(&tattr
, connection_pool
);
822 err
= svn_error_wrap_apr(status
, _("Can't create threadattr"));
823 svn_handle_error2(err
, stderr
, FALSE
, "svnserve: ");
824 svn_error_clear(err
);
827 status
= apr_threadattr_detach_set(tattr
, 1);
830 err
= svn_error_wrap_apr(status
, _("Can't set detached state"));
831 svn_handle_error2(err
, stderr
, FALSE
, "svnserve: ");
832 svn_error_clear(err
);
835 thread_data
= apr_palloc(connection_pool
, sizeof(*thread_data
));
836 thread_data
->conn
= conn
;
837 thread_data
->params
= ¶ms
;
838 thread_data
->pool
= connection_pool
;
839 status
= apr_thread_create(&tid
, tattr
, serve_thread
, thread_data
,
843 err
= svn_error_wrap_apr(status
, _("Can't create thread"));
844 svn_handle_error2(err
, stderr
, FALSE
, "svnserve: ");
845 svn_error_clear(err
);
851 case connection_mode_single
:
852 /* Serve one connection at a time. */
853 svn_error_clear(serve(conn
, ¶ms
, connection_pool
));
854 svn_pool_destroy(connection_pool
);