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", 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
;
267 if (!conf
.logfile_given
&& conf
.daemon_given
) {
269 PARA_EMERG_LOG("%s", "daemon, but no log file\n");
272 if (conf
.logfile_given
)
273 logfile
= open_log(conf
.logfile_arg
);
280 free(user_list_file
);
281 user_list_file
= NULL
;
285 static void setup_signal_handling(void)
287 signal_pipe
= para_signal_init(); /* always successful */
289 PARA_NOTICE_LOG("setting up signal handlers\n");
290 if (para_install_sighandler(SIGINT
) < 0)
292 if (para_install_sighandler(SIGTERM
) < 0)
294 if (para_install_sighandler(SIGHUP
) < 0)
296 if (para_install_sighandler(SIGCHLD
) < 0)
298 if (signal(SIGPIPE
, SIG_IGN
) == SIG_ERR
)
300 if (signal(SIGUSR1
, SIG_IGN
) == SIG_ERR
)
302 add_close_on_fork_list(signal_pipe
);
305 PARA_EMERG_LOG("could not install signal handlers\n");
309 static unsigned init_network(void)
311 int fd
, ret
= para_listen(AF_UNSPEC
, IPPROTO_TCP
, conf
.port_arg
);
316 ret
= mark_fd_nonblocking(fd
);
319 add_close_on_fork_list(fd
); /* child doesn't need the listener */
322 PARA_EMERG_LOG("%s\n", para_strerror(-ret
));
326 static void init_random_seed(void)
330 size_t len
= sizeof(unsigned int);
332 fd
= open("/dev/urandom", O_RDONLY
);
336 if (read(fd
, &seed
, len
) != len
)
345 PARA_EMERG_LOG("can not seed pseudo random generator (ret = %d)\n",
350 uint32_t afs_socket_cookie
;
352 static pid_t afs_pid
;
354 static void init_afs(void)
356 int ret
, afs_server_socket
[2];
358 ret
= socketpair(PF_UNIX
, SOCK_DGRAM
, 0, afs_server_socket
);
361 afs_socket_cookie
= para_random((uint32_t)-1);
365 if (!afs_pid
) { /* child (afs) */
366 close(afs_server_socket
[0]);
367 afs_init(afs_socket_cookie
, afs_server_socket
[1]);
369 close(afs_server_socket
[1]);
370 afs_socket
= afs_server_socket
[0];
371 ret
= mark_fd_nonblocking(afs_socket
);
374 add_close_on_fork_list(afs_socket
);
375 PARA_INFO_LOG("afs_socket: %d, afs_socket_cookie: %u\n", afs_socket
,
376 (unsigned) afs_socket_cookie
);
380 static unsigned server_init(int argc
, char **argv
)
382 /* connector's address information */
386 /* parse command line options */
387 server_cmdline_parser(argc
, argv
, &conf
);
388 HANDLE_VERSION_FLAG("server", conf
);
389 para_drop_privileges(conf
.user_arg
, conf
.group_arg
);
390 /* parse config file, open log and set defaults */
392 log_welcome("para_server", conf
.loglevel_arg
);
393 shm_init(); /* init mmd struct */
394 server_uptime(UPTIME_SET
); /* reset server uptime */
395 init_user_list(user_list_file
);
397 if (conf
.daemon_given
)
399 PARA_NOTICE_LOG("initializing audio format handlers\n");
401 PARA_NOTICE_LOG("initializing virtual streaming system\n");
402 mmd
->server_pid
= getpid();
403 setup_signal_handling();
404 PARA_NOTICE_LOG("initializing the audio file selector\n");
408 /* init network socket */
409 PARA_NOTICE_LOG("initializing tcp command socket\n");
410 sockfd
= init_network();
411 PARA_NOTICE_LOG("server init complete\n");
416 * called when server gets SIGHUP or when client invokes hup command.
418 static void handle_sighup(void)
420 PARA_NOTICE_LOG("%s", "SIGHUP\n");
421 close_log(logfile
); /* gets reopened if necessary by parse_config */
423 parse_config(1); /* reopens log */
424 init_user_list(user_list_file
); /* reload user list */
426 kill(afs_pid
, SIGHUP
);
429 static void status_refresh(void)
431 static int prev_uptime
= -1, prev_events
= -1;
432 int uptime
= server_uptime(UPTIME_GET
), ret
= 1;
434 if (prev_events
!= mmd
->events
)
436 if (mmd
->new_vss_status_flags
!= mmd
->vss_status_flags
)
438 if (uptime
/ 60 != prev_uptime
/ 60)
442 prev_uptime
= uptime
;
443 prev_events
= mmd
->events
;
444 mmd
->vss_status_flags
= mmd
->new_vss_status_flags
;
446 PARA_DEBUG_LOG("%d events, forcing status update\n",
453 * the main function of para_server
455 * \param argc usual argument count
456 * \param argv usual argument vector
458 * \return EXIT_SUCCESS or EXIT_FAILURE
461 int main(int argc
, char *argv
[])
463 /* listen on sock_fd, new connection on new_fd */
466 int i
, max_fileno
, ret
;
469 struct timeval
*timeout
;
472 sockfd
= server_init(argc
, argv
);
477 /* check socket and signal pipe in any case */
478 para_fd_set(sockfd
, &rfds
, &max_fileno
);
479 para_fd_set(signal_pipe
, &rfds
, &max_fileno
);
480 timeout
= vss_preselect(&rfds
, &wfds
, &max_fileno
);
482 for (i
= 0; senders
[i
].name
; i
++) {
483 if (senders
[i
].status
!= SENDER_ON
)
485 if (!senders
[i
].pre_select
)
487 senders
[i
].pre_select(&max_fileno
, &rfds
, &wfds
);
490 ret
= para_select(max_fileno
+ 1, &rfds
, &wfds
, timeout
);
492 vss_post_select(&rfds
, &wfds
);
495 for (i
= 0; senders
[i
].name
; i
++) {
496 if (senders
[i
].status
!= SENDER_ON
)
498 if (!senders
[i
].post_select
)
500 senders
[i
].post_select(&rfds
, &wfds
);
504 if (FD_ISSET(signal_pipe
, &rfds
)) {
507 sig
= para_next_signal();
514 ret
= para_reap_child(&pid
);
519 PARA_EMERG_LOG("fatal: afs died\n");
523 /* die on sigint/sigterm. Kill all children too. */
526 PARA_EMERG_LOG("terminating on signal %d\n", sig
);
529 mutex_destroy(mmd_mutex
);
531 shm_destroy(mmd_shm_id
);
536 if (mmd
->sender_cmd_data
.cmd_num
>= 0) {
537 int num
= mmd
->sender_cmd_data
.cmd_num
,
538 s
= mmd
->sender_cmd_data
.sender_num
;
540 if (senders
[s
].client_cmds
[num
])
541 senders
[s
].client_cmds
[num
](&mmd
->sender_cmd_data
);
542 mmd
->sender_cmd_data
.cmd_num
= -1;
544 if (!FD_ISSET(sockfd
, &rfds
))
547 new_fd
= para_accept(sockfd
, NULL
, 0);
550 peer_name
= remote_name(new_fd
);
551 PARA_INFO_LOG("got connection from %s, forking\n", peer_name
);
553 mmd
->active_connections
++;
557 PARA_CRIT_LOG("%s", "fork failed\n");
562 /* parent keeps accepting connections */
565 alarm(ALARM_TIMEOUT
);
567 para_signal_shutdown();
569 * put info on who we are serving into argv[0] to make
570 * client ip visible in top/ps
572 for (i
= argc
- 1; i
>= 0; i
--)
573 memset(argv
[i
], 0, strlen(argv
[i
]));
574 sprintf(argv
[0], "para_server (serving %s)", peer_name
);
575 return handle_connect(new_fd
, peer_name
);