2 * Copyright (C) 1997-2008 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 are
17 * - The main programs: \ref server.c, \ref audiod.c, \ref client.c,
18 * \ref audioc.c, \ref fsck.c,
19 * - Server: \ref server_command, \ref sender,
20 * - Audio file selector: \ref audio_format_handler, \ref mood, \ref afs_table,
21 * - Client: \ref receiver, \ref receiver_node, \ref filter, \ref filter_node.
24 * The gory details, listed by topic:
26 * - Audio format handlers: \ref mp3_afh.c, \ref ogg_afh.c, \ref aac_afh.c,
27 * - Decoders: \ref mp3dec.c, \ref oggdec.c, \ref aacdec.c,
28 * - Volume normalizer: \ref compress.c,
29 * - Output: \ref alsa_write.c, \ref osx_write.c,
30 * - http: \ref http_recv.c, \ref http_send.c,
31 * - ortp: \ref ortp_recv.c, \ref ortp_send.c,
32 * - dccp: \ref dccp_recv.c, \ref dccp_send.c,
33 * - Audio file selector: \ref afs.c, \ref aft.c, \ref mood.c,
34 * - Afs structures: \ref afs_table, \ref audio_file_data,
35 * \ref afs_info \ref afh_info,
36 * - Afs tables: \ref aft.c, \ref mood.c, \ref playlist.c,
37 * \ref attribute.c, \ref score.c,
38 * - The virtual streaming system: \ref vss.c, \ref chunk_queue.c.
42 * - Scheduling: \ref sched.c, \ref sched.h,
43 * - Networking: \ref net.c,
44 * - File descriptors: \ref fd.c,
45 * - Signals: \ref signal.c,
46 * - Daemons: \ref daemon.c,
47 * - Strings: \ref string.c, \ref string.h,
48 * - Time: \ref time.c,
49 * - Spawning processes: \ref exec.c,
50 * - Inter process communication: \ref ipc.c,
51 * - The object storage layer: \ref osl.c,
52 * - Blob tables: \ref blob.c,
53 * - The error subssystem: \ref error.h.
54 * - Access control for paraslash senders: \ref acl.c, \ref acl.h.
56 * Low-level data structures:
58 * - Doubly linked lists: \ref list.h,
59 * - Red-black trees: \ref rbtree.h, \ref rbtree.c,
60 * - Ring buffer: \ref ringbuffer.c, \ref ringbuffer.h,
61 * - Hashing: \ref hash.h, \ref sha1.h, \ref sha1.c,
62 * - Crypto: \ref crypt.c.
67 #include <sys/types.h>
72 #include "server.cmdline.h"
79 #include "close_on_fork.h"
88 #include "user_list.h"
90 /** define the array of error lists needed by para_server */
93 /** shut down non-authorized connections after that many seconds */
94 #define ALARM_TIMEOUT 10
97 * Pointer to shared memory area for communication between para_server
98 * and its children. Exported to vss.c. command.c and to afs.
100 struct misc_meta_data *mmd;
103 * the configuration of para_server
105 * It also contains the options for the audio file selector, audio format
106 * handler and all supported senders.
108 struct server_args_info conf;
110 /** the file containing user information (public key, permissions) */
111 char *user_list_file = NULL;
113 extern void dccp_send_init(struct sender *);
114 extern void http_send_init(struct sender *);
115 extern void ortp_send_init(struct sender *);
117 /** the list of supported senders */
118 struct sender senders[] = {
121 .init = http_send_init,
125 .init = dccp_send_init,
130 .init = ortp_send_init,
139 /* global variables for server-internal use */
140 static FILE *logfile;
141 static int mmd_mutex, mmd_shm_id;
142 static int signal_pipe;
145 * para_server's log function
147 * \param ll the log level
148 * \param fmt the format string describing the log message
150 void para_log(int ll, const char* fmt,...)
156 char str[MAXLINE] = "";
159 if (ll < conf.loglevel_arg)
161 outfd = logfile? logfile : stderr;
164 strftime(str, MAXLINE, "%b %d %H:%M:%S", tm);
165 fprintf(outfd, "%s ", str);
166 if (conf.loglevel_arg <= INFO)
167 fprintf(outfd, "%i: ", ll);
169 if (conf.loglevel_arg <= INFO)
170 fprintf(outfd, "(%d) ", (int)mypid);
172 vfprintf(outfd, fmt, argp);
177 * setup shared memory area and get mutex for locking
179 static void shm_init(void)
182 int ret = shm_new(sizeof(struct misc_meta_data));
187 ret = shm_attach(ret, ATTACH_RW, &shm);
199 mmd->num_commands = 0;
201 mmd->num_connects = 0;
202 mmd->active_connections = 0;
203 mmd->vss_status_flags = VSS_NEXT;
204 mmd->new_vss_status_flags = VSS_NEXT;
205 mmd->sender_cmd_data.cmd_num = -1;
208 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
213 * lock the shared memory area containing the mmd struct
215 * \sa semop(2), struct misc_meta_data.
219 mutex_lock(mmd_mutex);
223 * unlock the shared memory area containing the mmd struct
225 * \sa semop(2), struct misc_meta_data
228 void mmd_unlock(void)
230 mutex_unlock(mmd_mutex);
233 static void parse_config(int override)
235 char *home = para_homedir();
240 if (conf.config_file_given)
241 cf = para_strdup(conf.config_file_arg);
243 cf = make_message("%s/.paraslash/server.conf", home);
244 free(user_list_file);
245 if (!conf.user_list_given)
246 user_list_file = make_message("%s/.paraslash/server.users", home);
248 user_list_file = para_strdup(conf.user_list_arg);
249 ret = stat(cf, &statbuf);
250 if (ret && conf.config_file_given) {
252 PARA_EMERG_LOG("can not stat config file %s\n", cf);
256 int tmp = conf.daemon_given;
257 struct server_cmdline_parser_params params = {
258 .override = override,
263 server_cmdline_parser_config_file(cf, &conf, ¶ms);
264 conf.daemon_given = tmp;
266 if (conf.logfile_given)
267 logfile = open_log(conf.logfile_arg);
274 free(user_list_file);
275 user_list_file = NULL;
279 static void setup_signal_handling(void)
281 signal_pipe = para_signal_init(); /* always successful */
283 PARA_NOTICE_LOG("setting up signal handlers\n");
284 if (para_install_sighandler(SIGINT) < 0)
286 if (para_install_sighandler(SIGTERM) < 0)
288 if (para_install_sighandler(SIGHUP) < 0)
290 if (para_install_sighandler(SIGCHLD) < 0)
292 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
294 if (signal(SIGUSR1, SIG_IGN) == SIG_ERR)
296 add_close_on_fork_list(signal_pipe);
299 PARA_EMERG_LOG("could not install signal handlers\n");
303 static unsigned init_network(void)
305 int fd, ret = para_listen(AF_UNSPEC, IPPROTO_TCP, conf.port_arg);
310 ret = mark_fd_nonblocking(fd);
313 add_close_on_fork_list(fd); /* child doesn't need the listener */
316 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
320 static void init_random_seed(void)
323 int fd, ret = para_open("/dev/urandom", O_RDONLY, 0);
328 ret = read(fd, &seed, sizeof(seed));
330 ret = -ERRNO_TO_PARA_ERROR(errno);
333 if (ret != sizeof(seed)) {
334 ret = -ERRNO_TO_PARA_ERROR(EIO);
344 PARA_EMERG_LOG("can not seed pseudo random number generator: %s\n",
345 para_strerror(-ret));
349 uint32_t afs_socket_cookie;
351 static pid_t afs_pid;
353 static void init_afs(void)
355 int ret, afs_server_socket[2];
357 ret = socketpair(PF_UNIX, SOCK_DGRAM, 0, afs_server_socket);
360 afs_socket_cookie = para_random((uint32_t)-1);
364 if (!afs_pid) { /* child (afs) */
365 close(afs_server_socket[0]);
366 afs_init(afs_socket_cookie, afs_server_socket[1]);
368 close(afs_server_socket[1]);
369 afs_socket = afs_server_socket[0];
370 ret = mark_fd_nonblocking(afs_socket);
373 add_close_on_fork_list(afs_socket);
374 PARA_INFO_LOG("afs_socket: %d, afs_socket_cookie: %u\n", afs_socket,
375 (unsigned) afs_socket_cookie);
378 static unsigned server_init(int argc, char **argv)
380 /* connector's address information */
384 /* parse command line options */
385 server_cmdline_parser(argc, argv, &conf);
386 HANDLE_VERSION_FLAG("server", conf);
387 para_drop_privileges(conf.user_arg, conf.group_arg);
388 /* parse config file, open log and set defaults */
390 log_welcome("para_server", conf.loglevel_arg);
391 shm_init(); /* init mmd struct */
392 server_uptime(UPTIME_SET); /* reset server uptime */
393 init_user_list(user_list_file);
395 if (conf.daemon_given)
397 PARA_NOTICE_LOG("initializing audio format handlers\n");
399 PARA_NOTICE_LOG("initializing virtual streaming system\n");
400 mmd->server_pid = getpid();
401 setup_signal_handling();
402 PARA_NOTICE_LOG("initializing the audio file selector\n");
406 /* init network socket */
407 PARA_NOTICE_LOG("initializing tcp command socket\n");
408 sockfd = init_network();
409 PARA_NOTICE_LOG("server init complete\n");
414 * called when server gets SIGHUP or when client invokes hup command.
416 static void handle_sighup(void)
418 PARA_NOTICE_LOG("SIGHUP\n");
419 close_log(logfile); /* gets reopened if necessary by parse_config */
421 parse_config(1); /* reopens log */
422 init_user_list(user_list_file); /* reload user list */
424 kill(afs_pid, SIGHUP);
427 static void status_refresh(void)
429 static int prev_uptime = -1, prev_events = -1;
430 int uptime = server_uptime(UPTIME_GET), ret = 1;
432 if (prev_events != mmd->events)
434 if (mmd->new_vss_status_flags != mmd->vss_status_flags)
436 if (uptime / 60 != prev_uptime / 60)
440 prev_uptime = uptime;
441 prev_events = mmd->events;
442 mmd->vss_status_flags = mmd->new_vss_status_flags;
444 PARA_DEBUG_LOG("%d events, forcing status update\n",
451 * the main function of para_server
453 * \param argc usual argument count
454 * \param argv usual argument vector
456 * \return EXIT_SUCCESS or EXIT_FAILURE
459 int main(int argc, char *argv[])
461 /* listen on sock_fd, new connection on new_fd */
464 int i, max_fileno, ret;
467 struct timeval *timeout;
470 sockfd = server_init(argc, argv);
475 /* check socket and signal pipe in any case */
476 para_fd_set(sockfd, &rfds, &max_fileno);
477 para_fd_set(signal_pipe, &rfds, &max_fileno);
478 timeout = vss_preselect(&rfds, &wfds, &max_fileno);
480 for (i = 0; senders[i].name; i++) {
481 if (!senders[i].pre_select)
483 senders[i].pre_select(&max_fileno, &rfds, &wfds);
486 ret = para_select(max_fileno + 1, &rfds, &wfds, timeout);
488 vss_post_select(&rfds, &wfds);
491 for (i = 0; senders[i].name; i++) {
492 if (!senders[i].post_select)
494 senders[i].post_select(&rfds, &wfds);
498 if (FD_ISSET(signal_pipe, &rfds)) {
501 sig = para_next_signal();
508 ret = para_reap_child(&pid);
513 PARA_EMERG_LOG("fatal: afs died\n");
517 /* die on sigint/sigterm. Kill all children too. */
520 PARA_EMERG_LOG("terminating on signal %d\n", sig);
523 mutex_destroy(mmd_mutex);
525 shm_destroy(mmd_shm_id);
530 if (mmd->sender_cmd_data.cmd_num >= 0) {
531 int num = mmd->sender_cmd_data.cmd_num,
532 s = mmd->sender_cmd_data.sender_num;
534 if (senders[s].client_cmds[num])
535 senders[s].client_cmds[num](&mmd->sender_cmd_data);
536 mmd->sender_cmd_data.cmd_num = -1;
538 if (!FD_ISSET(sockfd, &rfds))
541 new_fd = para_accept(sockfd, NULL, 0);
544 peer_name = remote_name(new_fd);
545 PARA_INFO_LOG("got connection from %s, forking\n", peer_name);
547 mmd->active_connections++;
551 PARA_CRIT_LOG("fork failed\n");
556 /* parent keeps accepting connections */
559 alarm(ALARM_TIMEOUT);
561 para_signal_shutdown();
563 * put info on who we are serving into argv[0] to make
564 * client ip visible in top/ps
566 for (i = argc - 1; i >= 0; i--)
567 memset(argv[i], 0, strlen(argv[i]));
568 sprintf(argv[0], "para_server (serving %s)", peer_name);
569 return handle_connect(new_fd, peer_name);