2 * Copyright (C) 1997-2009 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file server.c Paraslash's main server. */
11 * \mainpage Paraslash API Reference
13 * Starting points for getting an overview:
16 * - The main programs: \ref server.c, \ref audiod.c, \ref client.c,
17 * \ref audioc.c, \ref afh.c
18 * - Server: \ref server_command, \ref sender,
19 * - Audio file selector: \ref audio_format_handler, \ref mood, \ref afs_table,
20 * - Client: \ref receiver, \ref receiver_node, \ref filter, \ref filter_node.
23 * The gory details, listed by topic:
25 * - Audio format handlers: \ref send_common.c \ref mp3_afh.c, \ref ogg_afh.c, \ref aac_afh.c,
26 * - Decoders: \ref mp3dec_filter.c, \ref oggdec_filter.c, \ref aacdec_filter.c,
27 * - Volume normalizer: \ref compress_filter.c,
28 * - Output: \ref alsa_write.c, \ref osx_write.c,
29 * - http: \ref http_recv.c, \ref http_send.c,
30 * - udp: \ref udp_recv.c, \ref udp_send.c,
31 * - dccp: \ref dccp_recv.c, \ref dccp_send.c,
32 * - Audio file selector: \ref afs.c, \ref aft.c, \ref mood.c,
33 * - Afs structures: \ref afs_table, \ref audio_file_data,
34 * \ref afs_info \ref afh_info,
35 * - Afs tables: \ref aft.c, \ref mood.c, \ref playlist.c,
36 * \ref attribute.c, \ref score.c,
37 * - The virtual streaming system: \ref vss.c, \ref chunk_queue.c.
41 * - Scheduling: \ref sched.c, \ref sched.h,
42 * - Networking: \ref net.c,
43 * - File descriptors: \ref fd.c,
44 * - Signals: \ref signal.c,
45 * - Daemons: \ref daemon.c,
46 * - Strings: \ref string.c, \ref string.h,
47 * - Time: \ref time.c,
48 * - Spawning processes: \ref exec.c,
49 * - Inter process communication: \ref ipc.c,
50 * - Blob tables: \ref blob.c,
51 * - The error subssystem: \ref error.h.
52 * - Access control for paraslash senders: \ref acl.c, \ref acl.h.
54 * Low-level data structures:
56 * - Doubly linked lists: \ref list.h,
57 * - Ring buffer: \ref ringbuffer.c, \ref ringbuffer.h,
58 * - Hashing: \ref hash.h, \ref sha1.h, \ref sha1.c,
59 * - Crypto: \ref crypt.c.
60 * - Forward error correction: \ref fec.c
66 #include <openssl/rc4.h>
72 #include "server.cmdline.h"
79 #include "close_on_fork.h"
88 #include "user_list.h"
91 /** Define the array of error lists needed by para_server. */
94 /** Shut down non-authorized connections after that many seconds. */
95 #define ALARM_TIMEOUT 10
98 * Pointer to shared memory area for communication between para_server
99 * and its children. Exported to vss.c. command.c and to afs.
101 struct misc_meta_data
*mmd
;
104 * The configuration of para_server
106 * It also contains the options for the audio file selector, audio format
107 * handler and all supported senders.
109 struct server_args_info conf
;
111 /** A random value used in child context for authentication. */
112 uint32_t afs_socket_cookie
;
114 /** The mutex protecting the shared memory area containing the mmd struct. */
117 /** The file containing user information (public key, permissions). */
118 static char *user_list_file
= NULL
;
121 /** The task responsible for server command handling. */
122 struct server_command_task
{
123 /** TCP port on which para_server listens for connections. */
125 /** Copied from para_server's main function. */
127 /** Argument vector passed to para_server's main function. */
129 /** The command task structure for scheduling. */
133 static int want_colors(void)
135 if (conf
.color_arg
== color_arg_no
)
137 if (conf
.color_arg
== color_arg_yes
)
139 if (conf
.logfile_given
)
141 return isatty(STDERR_FILENO
);
144 static void init_colors_or_die(void)
150 daemon_set_flag(DF_COLOR_LOG
);
151 daemon_set_default_log_colors();
152 for (i
= 0; i
< conf
.log_color_given
; i
++) {
153 ret
= daemon_set_log_color(conf
.log_color_arg
[i
]);
160 * setup shared memory area and get mutex for locking
162 static void init_ipc_or_die(void)
165 int shmid
, ret
= shm_new(sizeof(struct misc_meta_data
));
170 ret
= shm_attach(shmid
, ATTACH_RW
, &shm
);
182 mmd
->num_commands
= 0;
184 mmd
->num_connects
= 0;
185 mmd
->active_connections
= 0;
186 mmd
->vss_status_flags
= VSS_NEXT
;
187 mmd
->new_vss_status_flags
= VSS_NEXT
;
190 PARA_EMERG_LOG("%s\n", para_strerror(-ret
));
195 * (Re-)read the server configuration files.
197 * \param override Passed to gengetopt to activate the override feature.
199 * This function also re-opens the logfile and sets the global \a
200 * user_list_file variable.
202 void parse_config_or_die(int override
)
204 char *home
= para_homedir();
209 if (conf
.config_file_given
)
210 cf
= para_strdup(conf
.config_file_arg
);
212 cf
= make_message("%s/.paraslash/server.conf", home
);
213 free(user_list_file
);
214 if (!conf
.user_list_given
)
215 user_list_file
= make_message("%s/.paraslash/server.users", home
);
217 user_list_file
= para_strdup(conf
.user_list_arg
);
218 ret
= file_exists(cf
);
219 if (conf
.config_file_given
&& !ret
) {
221 PARA_EMERG_LOG("can not read config file %s\n", cf
);
225 int tmp
= conf
.daemon_given
;
226 struct server_cmdline_parser_params params
= {
227 .override
= override
,
230 .check_ambiguity
= 0,
231 .print_errors
= !conf
.daemon_given
233 server_cmdline_parser_config_file(cf
, &conf
, ¶ms
);
234 conf
.daemon_given
= tmp
;
236 if (conf
.logfile_given
) {
237 daemon_set_logfile(conf
.logfile_arg
);
238 daemon_open_log_or_die();
240 daemon_set_loglevel(conf
.loglevel_arg
);
241 init_colors_or_die();
242 daemon_set_flag(DF_LOG_PID
);
243 daemon_set_flag(DF_LOG_LL
);
244 daemon_set_flag(DF_LOG_TIME
);
251 free(user_list_file
);
252 user_list_file
= NULL
;
256 static void signal_pre_select(struct sched
*s
, struct task
*t
)
258 struct signal_task
*st
= container_of(t
, struct signal_task
, task
);
259 para_fd_set(st
->fd
, &s
->rfds
, &s
->max_fileno
);
263 * called when server gets SIGHUP or when client invokes hup command.
265 static void handle_sighup(void)
267 PARA_NOTICE_LOG("SIGHUP\n");
268 parse_config_or_die(1); /* reopens log */
269 init_user_list(user_list_file
); /* reload user list */
271 kill(mmd
->afs_pid
, SIGHUP
);
274 static void signal_post_select(struct sched
*s
, struct task
*t
)
276 struct signal_task
*st
= container_of(t
, struct signal_task
, task
);
278 if (!FD_ISSET(st
->fd
, &s
->rfds
))
281 st
->signum
= para_next_signal();
282 switch (st
->signum
) {
289 int ret
= para_reap_child(&pid
);
292 if (pid
!= mmd
->afs_pid
)
294 PARA_EMERG_LOG("fatal: afs died\n");
299 /* die on sigint/sigterm. Kill all children too. */
302 PARA_EMERG_LOG("terminating on signal %d\n", st
->signum
);
305 * We must wait for afs because afs catches SIGINT/SIGTERM.
306 * Before reacting to the signal, afs might want to use the
307 * shared memory area and the mmd mutex. If we destroy this
308 * mutex too early and afs tries to lock the shared memory
309 * area, the call to mutex_lock() will fail and terminate the
310 * afs process. This leads to dirty osl tables.
312 * There's no such problem with the other children of the
313 * server process (the command handlers) as these reset their
314 * SIGINT/SIGTERM handlers to the default action, i.e. these
315 * processes get killed immediately by the above kill().
317 PARA_INFO_LOG("waiting for afs (pid %d) to die\n",
319 waitpid(mmd
->afs_pid
, NULL
, 0);
321 free(mmd
->afd
.afhi
.chunk_table
);
323 mutex_destroy(mmd_mutex
);
329 static void init_signal_task(void)
331 static struct signal_task signal_task_struct
,
332 *st
= &signal_task_struct
;
334 st
->task
.pre_select
= signal_pre_select
;
335 st
->task
.post_select
= signal_post_select
;
336 sprintf(st
->task
.status
, "signal task");
338 PARA_NOTICE_LOG("setting up signal handling\n");
339 st
->fd
= para_signal_init(); /* always successful */
340 para_install_sighandler(SIGINT
);
341 para_install_sighandler(SIGTERM
);
342 para_install_sighandler(SIGHUP
);
343 para_install_sighandler(SIGCHLD
);
344 para_sigaction(SIGPIPE
, SIG_IGN
);
345 add_close_on_fork_list(st
->fd
);
346 register_task(&st
->task
);
349 static void command_pre_select(struct sched
*s
, struct task
*t
)
351 struct server_command_task
*sct
= container_of(t
, struct server_command_task
, task
);
352 para_fd_set(sct
->listen_fd
, &s
->rfds
, &s
->max_fileno
);
355 static void command_post_select(struct sched
*s
, struct task
*t
)
357 struct server_command_task
*sct
= container_of(t
, struct server_command_task
, task
);
362 uint32_t *chunk_table
;
364 if (!FD_ISSET(sct
->listen_fd
, &s
->rfds
))
366 ret
= para_accept(sct
->listen_fd
, NULL
, 0);
370 peer_name
= remote_name(new_fd
);
371 PARA_INFO_LOG("got connection from %s, forking\n", peer_name
);
373 mmd
->active_connections
++;
375 * The chunk table is a pointer located in the mmd struct that points
376 * to dynamically allocated memory, i.e. it must be freed by the parent
377 * and the child. However, as the mmd struct is in a shared memory
378 * area, there's no guarantee that after the fork this pointer is still
379 * valid in child context. As it is not used in the child anyway, we
380 * save it to a local variable before the fork and free the memory via
381 * that copy in the child directly after the fork.
383 chunk_table
= mmd
->afd
.afhi
.chunk_table
;
386 ret
= -ERRNO_TO_PARA_ERROR(errno
);
391 /* parent keeps accepting connections */
394 /* mmd might already have changed at this point */
396 alarm(ALARM_TIMEOUT
);
398 para_signal_shutdown();
400 * put info on who we are serving into argv[0] to make
401 * client ip visible in top/ps
403 for (i
= sct
->argc
- 1; i
>= 0; i
--)
404 memset(sct
->argv
[i
], 0, strlen(sct
->argv
[i
]));
405 sprintf(sct
->argv
[0], "para_server (serving %s)", peer_name
);
406 return handle_connect(new_fd
, peer_name
);
409 PARA_CRIT_LOG("%s\n", para_strerror(-ret
));
412 static void init_server_command_task(int argc
, char **argv
)
415 static struct server_command_task server_command_task_struct
,
416 *sct
= &server_command_task_struct
;
418 PARA_NOTICE_LOG("initializing tcp command socket\n");
419 sct
->task
.pre_select
= command_pre_select
;
420 sct
->task
.post_select
= command_post_select
;
423 ret
= para_listen(AF_UNSPEC
, IPPROTO_TCP
, conf
.port_arg
);
426 sct
->listen_fd
= ret
;
427 ret
= mark_fd_nonblocking(sct
->listen_fd
);
430 add_close_on_fork_list(sct
->listen_fd
); /* child doesn't need the listener */
431 register_task(&sct
->task
);
434 PARA_EMERG_LOG("%s\n", para_strerror(-ret
));
438 static int init_afs(void)
440 int ret
, afs_server_socket
[2];
442 ret
= socketpair(PF_UNIX
, SOCK_DGRAM
, 0, afs_server_socket
);
445 get_random_bytes_or_die((unsigned char *)&afs_socket_cookie
,
446 sizeof(afs_socket_cookie
));
447 mmd
->afs_pid
= fork();
448 if (mmd
->afs_pid
< 0)
450 if (!mmd
->afs_pid
) { /* child (afs) */
451 close(afs_server_socket
[0]);
452 afs_init(afs_socket_cookie
, afs_server_socket
[1]);
454 close(afs_server_socket
[1]);
455 ret
= mark_fd_nonblocking(afs_server_socket
[0]);
458 add_close_on_fork_list(afs_server_socket
[0]);
459 PARA_INFO_LOG("afs_socket: %d, afs_socket_cookie: %u\n",
460 afs_server_socket
[0], (unsigned) afs_socket_cookie
);
461 return afs_server_socket
[0];
464 __noreturn
static void tmp_sigchld_handler(__a_unused
int s
)
466 PARA_EMERG_LOG("caught early SIGCHLD\n");
470 static void server_init(int argc
, char **argv
)
472 struct server_cmdline_parser_params params
= {
476 .check_ambiguity
= 0,
482 init_random_seed_or_die();
483 /* parse command line options */
484 server_cmdline_parser_ext(argc
, argv
, &conf
, ¶ms
);
485 HANDLE_VERSION_FLAG("server", conf
);
486 drop_privileges_or_die(conf
.user_arg
, conf
.group_arg
);
487 /* parse config file, open log and set defaults */
488 parse_config_or_die(0);
489 log_welcome("para_server");
490 init_ipc_or_die(); /* init mmd struct and mmd->lock */
491 /* make sure, the global now pointer is uptodate */
492 gettimeofday(now
, NULL
);
493 server_uptime(UPTIME_SET
); /* reset server uptime */
494 init_user_list(user_list_file
);
496 if (conf
.daemon_given
)
498 PARA_NOTICE_LOG("initializing audio format handlers\n");
502 * Although afs uses its own signal handling we must ignore SIGUSR1
503 * _before_ the afs child process gets born by init_afs() below. It's
504 * racy to do this in the child because the parent might send SIGUSR1
505 * before the child gets a chance to ignore this signal -- only the
508 para_sigaction(SIGUSR1
, SIG_IGN
);
510 * We have to install a SIGCHLD handler before the afs process is being
511 * forked off. Otherwise, para_server does not notice if afs dies before
512 * the SIGCHLD handler has been installed by init_signal_task() below.
514 para_sigaction(SIGCHLD
, tmp_sigchld_handler
);
515 PARA_NOTICE_LOG("initializing the audio file selector\n");
516 afs_socket
= init_afs();
518 PARA_NOTICE_LOG("initializing virtual streaming system\n");
519 init_vss_task(afs_socket
);
520 init_server_command_task(argc
, argv
);
521 PARA_NOTICE_LOG("server init complete\n");
524 static void status_refresh(void)
526 static int prev_uptime
= -1, prev_events
= -1;
527 int uptime
= server_uptime(UPTIME_GET
), ret
= 1;
529 if (prev_events
!= mmd
->events
)
531 if (mmd
->new_vss_status_flags
!= mmd
->vss_status_flags
)
533 if (uptime
/ 60 != prev_uptime
/ 60)
539 prev_uptime
= uptime
;
540 prev_events
= mmd
->events
;
541 mmd
->vss_status_flags
= mmd
->new_vss_status_flags
;
543 PARA_DEBUG_LOG("%d events, forcing status update\n",
549 static int server_select(int max_fileno
, fd_set
*readfds
, fd_set
*writefds
,
550 struct timeval
*timeout_tv
)
555 mutex_unlock(mmd_mutex
);
556 ret
= para_select(max_fileno
+ 1, readfds
, writefds
, timeout_tv
);
557 mutex_lock(mmd_mutex
);
562 * The main function of para_server.
564 * \param argc Usual argument count.
565 * \param argv Usual argument vector.
567 * \return EXIT_SUCCESS or EXIT_FAILURE.
569 int main(int argc
, char *argv
[])
572 static struct sched s
= {
577 .select_function
= server_select
579 server_init(argc
, argv
);
580 mutex_lock(mmd_mutex
);
583 PARA_EMERG_LOG("%s\n", para_strerror(-ret
));