doxygen: Remove some stale doxygen references.
[paraslash.git] / afs.c
1 /*
2 * Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file afs.c Paraslash's audio file selector. */
8
9 #include <netinet/in.h>
10 #include <sys/socket.h>
11 #include <regex.h>
12 #include <signal.h>
13 #include <fnmatch.h>
14 #include <osl.h>
15 #include <lopsub.h>
16 #include <arpa/inet.h>
17 #include <sys/un.h>
18 #include <netdb.h>
19 #include <lopsub.h>
20
21 #include "server.lsg.h"
22 #include "server_cmd.lsg.h"
23 #include "para.h"
24 #include "error.h"
25 #include "crypt.h"
26 #include "string.h"
27 #include "afh.h"
28 #include "afs.h"
29 #include "server.h"
30 #include "net.h"
31 #include "ipc.h"
32 #include "list.h"
33 #include "sched.h"
34 #include "fd.h"
35 #include "signal.h"
36 #include "mood.h"
37 #include "sideband.h"
38 #include "command.h"
39
40 /** The osl tables used by afs. \sa blob.c. */
41 enum afs_table_num {
42 /** Contains audio file information. See aft.c. */
43 TBLNUM_AUDIO_FILES,
44 /** The table for the paraslash attributes. See attribute.c. */
45 TBLNUM_ATTRIBUTES,
46 /**
47 * Paraslash's scoring system is based on Gaussian normal
48 * distributions, and the relevant data is stored in the rbtrees of an
49 * osl table containing only volatile columns. See score.c for
50 * details.
51 */
52 TBLNUM_SCORES,
53 /**
54 * A standard blob table containing the mood definitions. For details
55 * see mood.c.
56 */
57 TBLNUM_MOODS,
58 /** A blob table containing lyrics on a per-song basis. */
59 TBLNUM_LYRICS,
60 /** Another blob table for images (for example album cover art). */
61 TBLNUM_IMAGES,
62 /** Yet another blob table for storing standard playlists. */
63 TBLNUM_PLAYLIST,
64 /** How many tables are in use? */
65 NUM_AFS_TABLES
66 };
67
68 static struct afs_table afs_tables[NUM_AFS_TABLES] = {
69 [TBLNUM_AUDIO_FILES] = {.init = aft_init, .name = "audio_files"},
70 [TBLNUM_ATTRIBUTES] = {.init = attribute_init, .name = "attributes"},
71 [TBLNUM_SCORES] = {.init = score_init, .name = "scores"},
72 [TBLNUM_MOODS] = {.init = moods_init, .name = "moods"},
73 [TBLNUM_LYRICS] = {.init = lyrics_init, .name = "lyrics"},
74 [TBLNUM_IMAGES] = {.init = images_init, .name = "images"},
75 [TBLNUM_PLAYLIST] = {.init = playlists_init, .name = "playlists"},
76 };
77
78 struct command_task {
79 /** The file descriptor for the local socket. */
80 int fd;
81 /**
82 * Value sent by the command handlers to identify themselves as
83 * children of the running para_server.
84 */
85 uint32_t cookie;
86 /** The associated task structure. */
87 struct task *task;
88 };
89
90 extern int mmd_mutex;
91 extern struct misc_meta_data *mmd;
92
93 static int server_socket;
94 static struct command_task command_task_struct;
95 static struct signal_task *signal_task;
96
97 static enum play_mode current_play_mode;
98 static char *current_mop; /* mode or playlist specifier. NULL means dummy mood */
99
100 /**
101 * A random number used to "authenticate" the connection.
102 *
103 * para_server picks this number by random before it forks the afs process. The
104 * command handlers know this number as well and write it to the afs socket,
105 * together with the id of the shared memory area which contains the payload of
106 * the afs command. A local process has to know this number to abuse the afs
107 * service provided by the local socket.
108 */
109 extern uint32_t afs_socket_cookie;
110
111 /**
112 * Struct to let command handlers execute a callback in afs context.
113 *
114 * Commands that need to change the state of afs can't change the relevant data
115 * structures directly because commands are executed in a child process, i.e.
116 * they get their own virtual address space.
117 *
118 * This structure is used by \p send_callback_request() (executed from handler
119 * context) in order to let the afs process call the specified function. An
120 * instance of that structure is written to a shared memory area together with
121 * the arguments to the callback function. The identifier of the shared memory
122 * area is written to the command socket.
123 *
124 * The afs process accepts connections on the command socket and reads the
125 * shared memory id, attaches the corresponding area, calls the given handler to
126 * perform the desired action and to optionally compute a result.
127 *
128 * The result and a \p callback_result structure is then written to another
129 * shared memory area. The identifier for that area is written to the handler's
130 * command socket, so that the handler process can read the id, attach the
131 * shared memory area and use the result.
132 *
133 * \sa struct callback_result.
134 */
135 struct callback_query {
136 /** The function to be called. */
137 afs_callback *handler;
138 /** The number of bytes of the query */
139 size_t query_size;
140 };
141
142 /**
143 * Structure embedded in the result of a callback.
144 *
145 * If the callback produced a result, an instance of that structure is embedded
146 * into the shared memory area holding the result, mainly to let the command
147 * handler know the size of the result.
148 *
149 * \sa struct callback_query.
150 */
151 struct callback_result {
152 /** The number of bytes of the result. */
153 size_t result_size;
154 /** The band designator (loglevel for the result). */
155 uint8_t band;
156 };
157
158 static int dispatch_result(int result_shmid, callback_result_handler *handler,
159 void *private_result_data)
160 {
161 struct osl_object result;
162 void *result_shm;
163 /* must attach r/w as result.data might get encrypted in-place. */
164 int ret2, ret = shm_attach(result_shmid, ATTACH_RW, &result_shm);
165 struct callback_result *cr = result_shm;
166
167 if (ret < 0) {
168 PARA_ERROR_LOG("attach failed: %s\n", para_strerror(-ret));
169 return ret;
170 }
171 result.size = cr->result_size;
172 result.data = result_shm + sizeof(*cr);
173 assert(handler);
174 ret = handler(&result, cr->band, private_result_data);
175 ret2 = shm_detach(result_shm);
176 if (ret2 < 0) {
177 PARA_ERROR_LOG("detach failed: %s\n", para_strerror(-ret2));
178 if (ret >= 0)
179 ret = ret2;
180 }
181 return ret;
182 }
183
184 /**
185 * Ask the afs process to call a given function.
186 *
187 * \param f The function to be called.
188 * \param query Pointer to arbitrary data for the callback.
189 * \param result_handler Called for each shm area sent by the callback.
190 * \param private_result_data Passed verbatim to \a result_handler.
191 *
192 * This function creates a socket for communication with the afs process and a
193 * shared memory area (sma) to which the buffer pointed to by \a query is
194 * copied. It then notifies the afs process that the callback function \a f
195 * should be executed by sending the shared memory identifier (shmid) to the
196 * socket.
197 *
198 * If the callback produces a result, it sends any number of shared memory
199 * identifiers back via the socket. For each such identifier received, \a
200 * result_handler is called. The contents of the sma identified by the received
201 * shmid are passed to that function as an osl object. The private_result_data
202 * pointer is passed as the second argument to \a result_handler.
203 *
204 * \return Number of shared memory areas dispatched on success, negative on
205 * errors.
206 */
207 int send_callback_request(afs_callback *f, struct osl_object *query,
208 callback_result_handler *result_handler,
209 void *private_result_data)
210 {
211 struct callback_query *cq;
212 int ret, fd = -1, query_shmid, result_shmid;
213 void *query_shm;
214 char buf[sizeof(afs_socket_cookie) + sizeof(int)];
215 size_t query_shm_size = sizeof(*cq);
216 int dispatch_error = 0, num_dispatched = 0;
217
218 if (query)
219 query_shm_size += query->size;
220 ret = shm_new(query_shm_size);
221 if (ret < 0)
222 return ret;
223 query_shmid = ret;
224 ret = shm_attach(query_shmid, ATTACH_RW, &query_shm);
225 if (ret < 0)
226 goto out;
227 cq = query_shm;
228 cq->handler = f;
229 cq->query_size = query_shm_size - sizeof(*cq);
230
231 if (query)
232 memcpy(query_shm + sizeof(*cq), query->data, query->size);
233 ret = shm_detach(query_shm);
234 if (ret < 0)
235 goto out;
236
237 *(uint32_t *)buf = afs_socket_cookie;
238 *(int *)(buf + sizeof(afs_socket_cookie)) = query_shmid;
239
240 ret = connect_local_socket(OPT_STRING_VAL(AFS_SOCKET));
241 if (ret < 0)
242 goto out;
243 fd = ret;
244 ret = write_all(fd, buf, sizeof(buf));
245 if (ret < 0)
246 goto out;
247 /*
248 * Read all shmids from afs.
249 *
250 * Even if the dispatcher returns an error we _must_ continue to read
251 * shmids from fd so that we can destroy all shared memory areas that
252 * have been created for us by the afs process.
253 */
254 for (;;) {
255 ret = recv_bin_buffer(fd, buf, sizeof(int));
256 if (ret <= 0)
257 goto out;
258 assert(ret == sizeof(int));
259 ret = *(int *) buf;
260 assert(ret > 0);
261 result_shmid = ret;
262 ret = dispatch_result(result_shmid, result_handler,
263 private_result_data);
264 if (ret < 0 && dispatch_error >= 0)
265 dispatch_error = ret;
266 ret = shm_destroy(result_shmid);
267 if (ret < 0)
268 PARA_CRIT_LOG("destroy result failed: %s\n",
269 para_strerror(-ret));
270 num_dispatched++;
271 }
272 out:
273 if (shm_destroy(query_shmid) < 0)
274 PARA_CRIT_LOG("shm destroy error\n");
275 if (fd >= 0)
276 close(fd);
277 if (dispatch_error < 0)
278 return dispatch_error;
279 if (ret < 0)
280 return ret;
281 return num_dispatched;
282 }
283
284 /**
285 * Wrapper for send_callback_request() which passes a lopsub parse result.
286 *
287 * \param f The callback function.
288 * \param cmd Needed for (de-)serialization.
289 * \param lpr Must match cmd.
290 * \param private_result_data Passed to send_callback_request().
291 *
292 * This function serializes the parse result given by the lpr pointer into a
293 * buffer. The buffer is sent as the query to the afs process with the callback
294 * mechanism.
295 *
296 * \return The return value of the underlying call to send_callback_request().
297 */
298 int send_lls_callback_request(afs_callback *f,
299 const struct lls_command * const cmd,
300 struct lls_parse_result *lpr, void *private_result_data)
301 {
302 struct osl_object query;
303 char *buf = NULL;
304 int ret = lls_serialize_parse_result(lpr, cmd, &buf, &query.size);
305
306 assert(ret >= 0);
307 query.data = buf;
308 ret = send_callback_request(f, &query, afs_cb_result_handler,
309 private_result_data);
310 free(buf);
311 return ret;
312 }
313
314 static int action_if_pattern_matches(struct osl_row *row, void *data)
315 {
316 struct pattern_match_data *pmd = data;
317 struct osl_object name_obj;
318 const char *p, *name;
319 int i, ret;
320
321 ret = osl(osl_get_object(pmd->table, row, pmd->match_col_num,
322 &name_obj));
323 if (ret < 0)
324 return ret;
325 name = (char *)name_obj.data;
326 if ((!name || !*name) && (pmd->pm_flags & PM_SKIP_EMPTY_NAME))
327 return 1;
328 if (lls_num_inputs(pmd->lpr) == 0) {
329 if (pmd->pm_flags & PM_NO_PATTERN_MATCHES_EVERYTHING) {
330 pmd->num_matches++;
331 return pmd->action(pmd->table, row, name, pmd->data);
332 }
333 }
334 i = pmd->input_skip;
335 for (;;) {
336 if (i >= lls_num_inputs(pmd->lpr))
337 break;
338 p = lls_input(i, pmd->lpr);
339 ret = fnmatch(p, name, pmd->fnmatch_flags);
340 if (ret != FNM_NOMATCH) {
341 if (ret != 0)
342 return -E_FNMATCH;
343 ret = pmd->action(pmd->table, row, name, pmd->data);
344 if (ret >= 0)
345 pmd->num_matches++;
346 return ret;
347
348 }
349 i++;
350 }
351 return 1;
352 }
353
354 /**
355 * Execute the given function for each matching row.
356 *
357 * \param pmd Describes what to match and how.
358 *
359 * \return Standard.
360 */
361 int for_each_matching_row(struct pattern_match_data *pmd)
362 {
363 if (pmd->pm_flags & PM_REVERSE_LOOP)
364 return osl(osl_rbtree_loop_reverse(pmd->table, pmd->loop_col_num, pmd,
365 action_if_pattern_matches));
366 return osl(osl_rbtree_loop(pmd->table, pmd->loop_col_num, pmd,
367 action_if_pattern_matches));
368 }
369
370 /**
371 * Compare two osl objects of string type.
372 *
373 * \param obj1 Pointer to the first object.
374 * \param obj2 Pointer to the second object.
375 *
376 * In any case, only \p MIN(obj1->size, obj2->size) characters of each string
377 * are taken into account.
378 *
379 * \return It returns an integer less than, equal to, or greater than zero if
380 * \a obj1 is found, respectively, to be less than, to match, or be greater than
381 * obj2.
382 *
383 * \sa strcmp(3), strncmp(3), osl_compare_func.
384 */
385 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2)
386 {
387 const char *str1 = (const char *)obj1->data;
388 const char *str2 = (const char *)obj2->data;
389 return strncmp(str1, str2, PARA_MIN(obj1->size, obj2->size));
390 }
391
392 static int pass_afd(int fd, char *buf, size_t size)
393 {
394 struct msghdr msg = {.msg_iov = NULL};
395 struct cmsghdr *cmsg;
396 char control[255] __a_aligned(8);
397 int ret;
398 struct iovec iov;
399
400 iov.iov_base = buf;
401 iov.iov_len = size;
402
403 msg.msg_iov = &iov;
404 msg.msg_iovlen = 1;
405
406 msg.msg_control = control;
407 msg.msg_controllen = sizeof(control);
408
409 cmsg = CMSG_FIRSTHDR(&msg);
410 cmsg->cmsg_level = SOL_SOCKET;
411 cmsg->cmsg_type = SCM_RIGHTS;
412 cmsg->cmsg_len = CMSG_LEN(sizeof(int));
413 *(int *)CMSG_DATA(cmsg) = fd;
414
415 /* Sum of the length of all control messages in the buffer */
416 msg.msg_controllen = cmsg->cmsg_len;
417 PARA_DEBUG_LOG("passing %zu bytes and fd %d\n", size, fd);
418 ret = sendmsg(server_socket, &msg, 0);
419 if (ret < 0) {
420 ret = -ERRNO_TO_PARA_ERROR(errno);
421 return ret;
422 }
423 return 1;
424 }
425
426 /**
427 * Pass the fd of the next audio file to the server process.
428 *
429 * This stores all information for streaming the "best" audio file in a shared
430 * memory area. The id of that area and an open file descriptor for the next
431 * audio file are passed to the server process.
432 *
433 * \return Standard.
434 *
435 * \sa open_and_update_audio_file().
436 */
437 static int open_next_audio_file(void)
438 {
439 struct audio_file_data afd;
440 int ret, shmid;
441 char buf[8];
442
443 ret = open_and_update_audio_file(&afd);
444 if (ret < 0) {
445 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
446 goto no_admissible_files;
447 }
448 shmid = ret;
449 if (!write_ok(server_socket)) {
450 ret = -E_AFS_SOCKET;
451 goto destroy;
452 }
453 *(uint32_t *)buf = NEXT_AUDIO_FILE;
454 *(uint32_t *)(buf + 4) = (uint32_t)shmid;
455 ret = pass_afd(afd.fd, buf, 8);
456 close(afd.fd);
457 if (ret >= 0)
458 return ret;
459 destroy:
460 shm_destroy(shmid);
461 return ret;
462 no_admissible_files:
463 *(uint32_t *)buf = NO_ADMISSIBLE_FILES;
464 *(uint32_t *)(buf + 4) = (uint32_t)0;
465 return write_all(server_socket, buf, 8);
466 }
467
468 /* Never fails if arg == NULL */
469 static int activate_mood_or_playlist(const char *arg, int *num_admissible)
470 {
471 enum play_mode mode;
472 int ret;
473
474 if (!arg) {
475 ret = change_current_mood(NULL); /* always successful */
476 mode = PLAY_MODE_MOOD;
477 } else {
478 if (!strncmp(arg, "p/", 2)) {
479 ret = playlist_open(arg + 2);
480 mode = PLAY_MODE_PLAYLIST;
481 } else if (!strncmp(arg, "m/", 2)) {
482 ret = change_current_mood(arg + 2);
483 mode = PLAY_MODE_MOOD;
484 } else
485 return -E_AFS_SYNTAX;
486 if (ret < 0)
487 return ret;
488 }
489 if (num_admissible)
490 *num_admissible = ret;
491 current_play_mode = mode;
492 if (arg != current_mop) {
493 free(current_mop);
494 if (arg) {
495 current_mop = para_strdup(arg);
496 mutex_lock(mmd_mutex);
497 strncpy(mmd->afs_mode_string, arg,
498 sizeof(mmd->afs_mode_string));
499 mmd->afs_mode_string[sizeof(mmd->afs_mode_string) - 1] = '\0';
500 mutex_unlock(mmd_mutex);
501 } else {
502 mutex_lock(mmd_mutex);
503 strcpy(mmd->afs_mode_string, "dummy");
504 mutex_unlock(mmd_mutex);
505 current_mop = NULL;
506 }
507 }
508 return 1;
509 }
510
511 /**
512 * Result handler for sending data to the para_client process.
513 *
514 * \param result The data to be sent.
515 * \param band The band designator.
516 * \param private Pointer to the command context.
517 *
518 * \return The return value of the underlying call to \ref command.c::send_sb.
519 *
520 * \sa \ref callback_result_handler, \ref command.c::send_sb.
521 */
522 int afs_cb_result_handler(struct osl_object *result, uint8_t band,
523 void *private)
524 {
525 struct command_context *cc = private;
526
527 assert(cc);
528 switch (band) {
529 case SBD_OUTPUT:
530 case SBD_DEBUG_LOG:
531 case SBD_INFO_LOG:
532 case SBD_NOTICE_LOG:
533 case SBD_WARNING_LOG:
534 case SBD_ERROR_LOG:
535 case SBD_CRIT_LOG:
536 case SBD_EMERG_LOG:
537 assert(result->size > 0);
538 return send_sb(&cc->scc, result->data, result->size, band, true);
539 case SBD_AFS_CB_FAILURE:
540 return *(int *)(result->data);
541 default:
542 return -E_BAD_BAND;
543 }
544 }
545
546 static void flush_and_free_pb(struct para_buffer *pb)
547 {
548 int ret;
549 struct afs_max_size_handler_data *amshd = pb->private_data;
550
551 if (pb->buf && pb->size > 0) {
552 ret = pass_buffer_as_shm(amshd->fd, amshd->band, pb->buf,
553 pb->offset);
554 if (ret < 0)
555 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
556 }
557 free(pb->buf);
558 }
559
560 static int com_select_callback(struct afs_callback_arg *aca)
561 {
562 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(SELECT);
563 const char *arg;
564 int num_admissible, ret;
565
566 ret = lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr);
567 assert(ret >= 0);
568 arg = lls_input(0, aca->lpr);
569 ret = clear_score_table();
570 if (ret < 0) {
571 para_printf(&aca->pbout, "could not clear score table\n");
572 goto free_lpr;
573 }
574 if (current_play_mode == PLAY_MODE_MOOD)
575 close_current_mood();
576 else
577 playlist_close();
578 ret = activate_mood_or_playlist(arg, &num_admissible);
579 if (ret >= 0)
580 goto out;
581 /* ignore subsequent errors (but log them) */
582 para_printf(&aca->pbout, "could not activate %s\n", arg);
583 if (current_mop) {
584 int ret2;
585 para_printf(&aca->pbout, "switching back to %s\n", current_mop);
586 ret2 = activate_mood_or_playlist(current_mop, &num_admissible);
587 if (ret2 >= 0)
588 goto out;
589 para_printf(&aca->pbout, "could not reactivate %s: %s\n",
590 current_mop, para_strerror(-ret2));
591 }
592 para_printf(&aca->pbout, "activating dummy mood\n");
593 activate_mood_or_playlist(NULL, &num_admissible);
594 out:
595 para_printf(&aca->pbout, "activated %s (%d admissible files)\n",
596 current_mop? current_mop : "dummy mood", num_admissible);
597 free_lpr:
598 lls_free_parse_result(aca->lpr, cmd);
599 return ret;
600 }
601
602 static int com_select(struct command_context *cc, struct lls_parse_result *lpr)
603 {
604 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(SELECT);
605 char *errctx;
606 int ret = lls(lls_check_arg_count(lpr, 1, 1, &errctx));
607
608 if (ret < 0) {
609 send_errctx(cc, errctx);
610 return ret;
611 }
612 return send_lls_callback_request(com_select_callback, cmd, lpr, cc);
613 }
614 EXPORT_SERVER_CMD_HANDLER(select);
615
616 static void init_admissible_files(const char *arg)
617 {
618 if (activate_mood_or_playlist(arg, NULL) < 0)
619 activate_mood_or_playlist(NULL, NULL); /* always successful */
620 }
621
622 static int setup_command_socket_or_die(void)
623 {
624 int ret, socket_fd;
625 const char *socket_name = OPT_STRING_VAL(AFS_SOCKET);
626
627 unlink(socket_name);
628 ret = create_local_socket(socket_name);
629 if (ret < 0) {
630 PARA_EMERG_LOG("%s: %s\n", para_strerror(-ret), socket_name);
631 exit(EXIT_FAILURE);
632 }
633 socket_fd = ret;
634 PARA_INFO_LOG("listening on socket %s (fd %d)\n", socket_name,
635 socket_fd);
636 return socket_fd;
637 }
638
639 static void close_afs_tables(void)
640 {
641 int i;
642 PARA_NOTICE_LOG("closing afs_tables\n");
643 for (i = 0; i < NUM_AFS_TABLES; i++)
644 afs_tables[i].close();
645 }
646
647 static char *database_dir;
648
649 static void get_database_dir(void)
650 {
651 if (!database_dir) {
652 if (OPT_GIVEN(AFS_DATABASE_DIR))
653 database_dir = para_strdup(OPT_STRING_VAL(AFS_DATABASE_DIR));
654 else {
655 char *home = para_homedir();
656 database_dir = make_message(
657 "%s/.paraslash/afs_database-0.4", home);
658 free(home);
659 }
660 }
661 PARA_INFO_LOG("afs_database dir %s\n", database_dir);
662 }
663
664 static int make_database_dir(void)
665 {
666 int ret;
667
668 get_database_dir();
669 ret = para_mkdir(database_dir, 0777);
670 if (ret >= 0 || ret == -ERRNO_TO_PARA_ERROR(EEXIST))
671 return 1;
672 return ret;
673 }
674
675 static int open_afs_tables(void)
676 {
677 int i, ret;
678
679 get_database_dir();
680 PARA_NOTICE_LOG("opening %d osl tables in %s\n", NUM_AFS_TABLES,
681 database_dir);
682 for (i = 0; i < NUM_AFS_TABLES; i++) {
683 ret = afs_tables[i].open(database_dir);
684 if (ret >= 0)
685 continue;
686 PARA_ERROR_LOG("%s init: %s\n", afs_tables[i].name,
687 para_strerror(-ret));
688 break;
689 }
690 if (ret >= 0)
691 return ret;
692 while (i)
693 afs_tables[--i].close();
694 return ret;
695 }
696
697 static int afs_signal_post_select(struct sched *s, __a_unused void *context)
698 {
699 int signum, ret;
700
701 if (getppid() == 1) {
702 PARA_EMERG_LOG("para_server died\n");
703 goto shutdown;
704 }
705 signum = para_next_signal(&s->rfds);
706 if (signum == 0)
707 return 0;
708 if (signum == SIGHUP) {
709 close_afs_tables();
710 parse_config_or_die(1);
711 ret = open_afs_tables();
712 if (ret < 0)
713 return ret;
714 init_admissible_files(current_mop);
715 return 0;
716 }
717 PARA_EMERG_LOG("terminating on signal %d\n", signum);
718 shutdown:
719 task_notify_all(s, E_AFS_SIGNAL);
720 return -E_AFS_SIGNAL;
721 }
722
723 static void register_signal_task(struct sched *s)
724 {
725 para_sigaction(SIGPIPE, SIG_IGN);
726 signal_task = signal_init_or_die();
727 para_install_sighandler(SIGINT);
728 para_install_sighandler(SIGTERM);
729 para_install_sighandler(SIGHUP);
730
731 signal_task->task = task_register(&(struct task_info) {
732 .name = "signal",
733 .pre_select = signal_pre_select,
734 .post_select = afs_signal_post_select,
735 .context = signal_task,
736
737 }, s);
738 }
739
740 static struct list_head afs_client_list;
741
742 /** Describes one connected afs client. */
743 struct afs_client {
744 /** Position in the afs client list. */
745 struct list_head node;
746 /** The socket file descriptor for this client. */
747 int fd;
748 /** The time the client connected. */
749 struct timeval connect_time;
750 };
751
752 static void command_pre_select(struct sched *s, void *context)
753 {
754 struct command_task *ct = context;
755 struct afs_client *client;
756
757 para_fd_set(server_socket, &s->rfds, &s->max_fileno);
758 para_fd_set(ct->fd, &s->rfds, &s->max_fileno);
759 list_for_each_entry(client, &afs_client_list, node)
760 para_fd_set(client->fd, &s->rfds, &s->max_fileno);
761 }
762
763 /**
764 * Send data as shared memory to a file descriptor.
765 *
766 * \param fd File descriptor to send the shmid to.
767 * \param band The band designator for this data.
768 * \param buf The buffer holding the data to be sent.
769 * \param size The size of \a buf.
770 *
771 * This function creates a shared memory area large enough to hold
772 * the content given by \a buf and \a size and sends the identifier
773 * of this area to the file descriptor \a fd.
774 *
775 * It is called by the AFS max_size handler as well as directly by the AFS
776 * command callbacks to send command output to the command handlers.
777 *
778 * \return Zero if \a buf is \p NULL or \a size is zero. Negative on errors,
779 * and positive on success.
780 */
781 int pass_buffer_as_shm(int fd, uint8_t band, const char *buf, size_t size)
782 {
783 int ret, shmid;
784 void *shm;
785 struct callback_result *cr;
786
787 if (size == 0)
788 assert(band != SBD_OUTPUT);
789 ret = shm_new(size + sizeof(*cr));
790 if (ret < 0)
791 return ret;
792 shmid = ret;
793 ret = shm_attach(shmid, ATTACH_RW, &shm);
794 if (ret < 0)
795 goto err;
796 cr = shm;
797 cr->result_size = size;
798 cr->band = band;
799 if (size > 0)
800 memcpy(shm + sizeof(*cr), buf, size);
801 ret = shm_detach(shm);
802 if (ret < 0)
803 goto err;
804 ret = write_all(fd, (char *)&shmid, sizeof(int));
805 if (ret >= 0)
806 return ret;
807 err:
808 if (shm_destroy(shmid) < 0)
809 PARA_ERROR_LOG("destroy result failed\n");
810 return ret;
811 }
812
813 static int call_callback(int fd, int query_shmid)
814 {
815 void *query_shm;
816 struct callback_query *cq;
817 int ret, ret2;
818 struct afs_callback_arg aca = {.fd = fd};
819
820 ret = shm_attach(query_shmid, ATTACH_RW, &query_shm);
821 if (ret < 0)
822 return ret;
823 cq = query_shm;
824 aca.query.data = (char *)query_shm + sizeof(*cq);
825 aca.query.size = cq->query_size;
826 aca.pbout.max_size = shm_get_shmmax();
827 aca.pbout.max_size_handler = afs_max_size_handler;
828 aca.pbout.private_data = &(struct afs_max_size_handler_data) {
829 .fd = fd,
830 .band = SBD_OUTPUT
831 };
832 ret = cq->handler(&aca);
833 ret2 = shm_detach(query_shm);
834 if (ret2 < 0) {
835 if (ret < 0) /* ignore (but log) detach error */
836 PARA_ERROR_LOG("could not detach sma: %s\n",
837 para_strerror(-ret2));
838 else
839 ret = ret2;
840 }
841 flush_and_free_pb(&aca.pbout);
842 if (ret < 0) {
843 ret2 = pass_buffer_as_shm(fd, SBD_AFS_CB_FAILURE,
844 (const char *)&ret, sizeof(ret));
845 if (ret2 < 0)
846 PARA_ERROR_LOG("could not pass cb failure packet: %s\n",
847 para_strerror(-ret));
848 }
849 return ret;
850 }
851
852 static int execute_server_command(fd_set *rfds)
853 {
854 char buf[8];
855 size_t n;
856 int ret = read_nonblock(server_socket, buf, sizeof(buf) - 1, rfds, &n);
857
858 if (ret < 0 || n == 0)
859 return ret;
860 buf[n] = '\0';
861 if (strcmp(buf, "new"))
862 return -ERRNO_TO_PARA_ERROR(EINVAL);
863 return open_next_audio_file();
864 }
865
866 /* returns 0 if no data available, 1 else */
867 static int execute_afs_command(int fd, fd_set *rfds, uint32_t expected_cookie)
868 {
869 uint32_t cookie;
870 int query_shmid;
871 char buf[sizeof(cookie) + sizeof(query_shmid)];
872 size_t n;
873 int ret = read_nonblock(fd, buf, sizeof(buf), rfds, &n);
874
875 if (ret < 0)
876 goto err;
877 if (n == 0)
878 return 0;
879 if (n != sizeof(buf)) {
880 PARA_NOTICE_LOG("short read (%d bytes, expected %lu)\n",
881 ret, (long unsigned) sizeof(buf));
882 return 1;
883 }
884 cookie = *(uint32_t *)buf;
885 if (cookie != expected_cookie) {
886 PARA_NOTICE_LOG("received invalid cookie (got %u, expected %u)\n",
887 (unsigned)cookie, (unsigned)expected_cookie);
888 return 1;
889 }
890 query_shmid = *(int *)(buf + sizeof(cookie));
891 if (query_shmid < 0) {
892 PARA_WARNING_LOG("received invalid query shmid %d)\n",
893 query_shmid);
894 return 1;
895 }
896 ret = call_callback(fd, query_shmid);
897 if (ret >= 0)
898 return 1;
899 err:
900 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
901 return 1;
902 }
903
904 /** Shutdown connection if query has not arrived until this many seconds. */
905 #define AFS_CLIENT_TIMEOUT 3
906
907 static int command_post_select(struct sched *s, void *context)
908 {
909 struct command_task *ct = context;
910 struct sockaddr_un unix_addr;
911 struct afs_client *client, *tmp;
912 int fd, ret;
913
914 ret = task_get_notification(ct->task);
915 if (ret < 0)
916 return ret;
917 ret = execute_server_command(&s->rfds);
918 if (ret < 0) {
919 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
920 task_notify_all(s, -ret);
921 return ret;
922 }
923 /* Check the list of connected clients. */
924 list_for_each_entry_safe(client, tmp, &afs_client_list, node) {
925 ret = execute_afs_command(client->fd, &s->rfds, ct->cookie);
926 if (ret == 0) { /* prevent bogus connection flooding */
927 struct timeval diff;
928 tv_diff(now, &client->connect_time, &diff);
929 if (diff.tv_sec < AFS_CLIENT_TIMEOUT)
930 continue;
931 PARA_WARNING_LOG("connection timeout\n");
932 }
933 close(client->fd);
934 list_del(&client->node);
935 free(client);
936 }
937 /* Accept connections on the local socket. */
938 ret = para_accept(ct->fd, &s->rfds, &unix_addr, sizeof(unix_addr), &fd);
939 if (ret < 0)
940 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
941 if (ret <= 0)
942 return 0;
943 ret = mark_fd_nonblocking(fd);
944 if (ret < 0) {
945 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
946 close(fd);
947 return 0;
948 }
949 client = para_malloc(sizeof(*client));
950 client->fd = fd;
951 client->connect_time = *now;
952 para_list_add(&client->node, &afs_client_list);
953 return 0;
954 }
955
956 static void register_command_task(uint32_t cookie, struct sched *s)
957 {
958 struct command_task *ct = &command_task_struct;
959 ct->fd = setup_command_socket_or_die();
960 ct->cookie = cookie;
961
962 ct->task = task_register(&(struct task_info) {
963 .name = "afs command",
964 .pre_select = command_pre_select,
965 .post_select = command_post_select,
966 .context = ct,
967 }, s);
968 }
969
970 /**
971 * Initialize the audio file selector process.
972 *
973 * \param cookie The value used for "authentication".
974 * \param socket_fd File descriptor used for communication with the server.
975 */
976 __noreturn void afs_init(uint32_t cookie, int socket_fd)
977 {
978 static struct sched s;
979 int i, ret;
980
981 register_signal_task(&s);
982 INIT_LIST_HEAD(&afs_client_list);
983 for (i = 0; i < NUM_AFS_TABLES; i++)
984 afs_tables[i].init(&afs_tables[i]);
985 ret = open_afs_tables();
986 if (ret < 0)
987 goto out;
988 server_socket = socket_fd;
989 ret = mark_fd_nonblocking(server_socket);
990 if (ret < 0)
991 goto out_close;
992 PARA_INFO_LOG("server_socket: %d, afs_socket_cookie: %u\n",
993 server_socket, (unsigned) cookie);
994 init_admissible_files(OPT_STRING_VAL(AFS_INITIAL_MODE));
995 register_command_task(cookie, &s);
996 s.default_timeout.tv_sec = 0;
997 s.default_timeout.tv_usec = 999 * 1000;
998 ret = write(socket_fd, "\0", 1);
999 if (ret != 1) {
1000 if (ret == 0)
1001 errno = EINVAL;
1002 ret = -ERRNO_TO_PARA_ERROR(errno);
1003 goto out_close;
1004 }
1005 ret = schedule(&s);
1006 sched_shutdown(&s);
1007 out_close:
1008 close_afs_tables();
1009 out:
1010 if (ret < 0)
1011 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
1012 exit(EXIT_FAILURE);
1013 }
1014
1015 static int com_init_callback(struct afs_callback_arg *aca)
1016 {
1017 uint32_t table_mask = *(uint32_t *)aca->query.data;
1018 int i, ret;
1019
1020 close_afs_tables();
1021 for (i = 0; i < NUM_AFS_TABLES; i++) {
1022 struct afs_table *t = &afs_tables[i];
1023
1024 if (!(table_mask & (1 << i)))
1025 continue;
1026 if (!t->create)
1027 continue;
1028 ret = t->create(database_dir);
1029 if (ret < 0) {
1030 para_printf(&aca->pbout, "cannot create table %s\n",
1031 t->name);
1032 goto out;
1033 }
1034 para_printf(&aca->pbout, "successfully created %s table\n",
1035 t->name);
1036 }
1037 ret = open_afs_tables();
1038 if (ret < 0)
1039 para_printf(&aca->pbout, "cannot open afs tables\n");
1040 out:
1041 return ret;
1042 }
1043
1044 static int com_init(struct command_context *cc, struct lls_parse_result *lpr)
1045 {
1046 int i, j, ret;
1047 uint32_t table_mask = (1 << (NUM_AFS_TABLES + 1)) - 1;
1048 struct osl_object query = {.data = &table_mask,
1049 .size = sizeof(table_mask)};
1050 unsigned num_inputs = lls_num_inputs(lpr);
1051
1052 ret = make_database_dir();
1053 if (ret < 0)
1054 return ret;
1055 if (num_inputs > 0) {
1056 table_mask = 0;
1057 for (i = 0; i < num_inputs; i++) {
1058 for (j = 0; j < NUM_AFS_TABLES; j++) {
1059 struct afs_table *t = &afs_tables[j];
1060
1061 if (strcmp(lls_input(i, lpr), t->name))
1062 continue;
1063 table_mask |= (1 << j);
1064 break;
1065 }
1066 if (j == NUM_AFS_TABLES)
1067 return -E_BAD_TABLE_NAME;
1068 }
1069 }
1070 return send_callback_request(com_init_callback, &query,
1071 afs_cb_result_handler, cc);
1072 }
1073 EXPORT_SERVER_CMD_HANDLER(init);
1074
1075 static int com_check(struct command_context *cc, struct lls_parse_result *lpr)
1076 {
1077 const struct lls_opt_result *r_a = SERVER_CMD_OPT_RESULT(CHECK, AFT, lpr);
1078 const struct lls_opt_result *r_A = SERVER_CMD_OPT_RESULT(CHECK, ATTRIBUTE, lpr);
1079 const struct lls_opt_result *r_m = SERVER_CMD_OPT_RESULT(CHECK, MOOD, lpr);
1080 const struct lls_opt_result *r_p = SERVER_CMD_OPT_RESULT(CHECK, PLAYLIST, lpr);
1081 bool noopt = !lls_opt_given(r_a) && !lls_opt_given(r_A)
1082 && !lls_opt_given(r_m) && !lls_opt_given(r_p);
1083 int ret;
1084
1085 if (noopt || lls_opt_given(r_a)) {
1086 ret = send_callback_request(aft_check_callback, NULL,
1087 afs_cb_result_handler, cc);
1088 if (ret < 0)
1089 return ret;
1090 }
1091 if (noopt || lls_opt_given(r_A)) {
1092 ret = send_callback_request(attribute_check_callback, NULL,
1093 afs_cb_result_handler, cc);
1094 if (ret < 0)
1095 return ret;
1096 }
1097 if (noopt || lls_opt_given(r_p)) {
1098 ret = send_callback_request(playlist_check_callback,
1099 NULL, afs_cb_result_handler, cc);
1100 if (ret < 0)
1101 return ret;
1102 }
1103 if (noopt || lls_opt_given(r_m)) {
1104 ret = send_callback_request(mood_check_callback, NULL,
1105 afs_cb_result_handler, cc);
1106 if (ret < 0)
1107 return ret;
1108 }
1109 return 1;
1110 }
1111 EXPORT_SERVER_CMD_HANDLER(check);
1112
1113 /**
1114 * The afs event dispatcher.
1115 *
1116 * \param event Type of the event.
1117 * \param pb May be \p NULL.
1118 * \param data Type depends on \a event.
1119 *
1120 * This function calls each table event handler, passing \a pb and \a data
1121 * verbatim. It's up to the handlers to interpret the \a data pointer. If a
1122 * handler returns negative, the loop is aborted.
1123 *
1124 * \return The (negative) error code of the first handler that failed, or non-negative
1125 * if all handlers succeeded.
1126 */
1127 __must_check int afs_event(enum afs_events event, struct para_buffer *pb,
1128 void *data)
1129 {
1130 int i, ret;
1131
1132 for (i = 0; i < NUM_AFS_TABLES; i++) {
1133 struct afs_table *t = &afs_tables[i];
1134 if (!t->event_handler)
1135 continue;
1136 ret = t->event_handler(event, pb, data);
1137 if (ret < 0) {
1138 PARA_CRIT_LOG("table %s, event %u: %s\n", t->name,
1139 event, para_strerror(-ret));
1140 return ret;
1141 }
1142 }
1143 return 1;
1144 }
1145
1146 /**
1147 * Dummy event handler for the images table.
1148 *
1149 * \param event Unused.
1150 * \param pb Unused.
1151 * \param data Unused.
1152 *
1153 * \return The images table does not honor events, so this handler always
1154 * returns success.
1155 */
1156 __a_const int images_event_handler(__a_unused enum afs_events event,
1157 __a_unused struct para_buffer *pb, __a_unused void *data)
1158 {
1159 return 1;
1160 }
1161
1162 /**
1163 * Dummy event handler for the lyrics table.
1164 *
1165 * \param event Unused.
1166 * \param pb Unused.
1167 * \param data Unused.
1168 *
1169 * \return The lyrics table does not honor events, so this handler always
1170 * returns success.
1171 */
1172 __a_const int lyrics_event_handler(__a_unused enum afs_events event,
1173 __a_unused struct para_buffer *pb, __a_unused void *data)
1174 {
1175 return 1;
1176 }