1 /* Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
3 /** \file afs.c Paraslash's audio file selector. */
5 #include <netinet/in.h>
6 #include <sys/socket.h>
12 #include <arpa/inet.h>
17 #include "server.lsg.h"
18 #include "server_cmd.lsg.h"
36 /** The osl tables used by afs. \sa \ref blob.c. */
38 /** Contains audio file information. See \ref aft.c. */
40 /** The table for the paraslash attributes. See \ref attribute.c. */
43 * Paraslash's scoring system is based on Gaussian normal
44 * distributions, and the relevant data is stored in the rbtrees of an
45 * osl table containing only volatile columns. See \ref score.c for
50 * A standard blob table containing the mood definitions. For details
54 /** A blob table containing lyrics on a per-song basis. */
56 /** Another blob table for images (for example album cover art). */
58 /** Yet another blob table for storing standard playlists. */
60 /** How many tables are in use? */
64 static struct afs_table afs_tables[NUM_AFS_TABLES] = {
65 [TBLNUM_AUDIO_FILES] = {.init = aft_init, .name = "audio_files"},
66 [TBLNUM_ATTRIBUTES] = {.init = attribute_init, .name = "attributes"},
67 [TBLNUM_SCORES] = {.init = score_init, .name = "scores"},
68 [TBLNUM_MOODS] = {.init = moods_init, .name = "moods"},
69 [TBLNUM_LYRICS] = {.init = lyrics_init, .name = "lyrics"},
70 [TBLNUM_IMAGES] = {.init = images_init, .name = "images"},
71 [TBLNUM_PLAYLIST] = {.init = playlists_init, .name = "playlists"},
75 /** The file descriptor for the local socket. */
77 /** The associated task structure. */
82 extern struct misc_meta_data *mmd;
84 static int server_socket;
85 static struct command_task command_task_struct;
86 static struct signal_task *signal_task;
88 static enum play_mode current_play_mode;
89 static char *current_mop; /* mode or playlist specifier. NULL means dummy mood */
91 extern uint32_t afs_socket_cookie;
94 * Struct to let command handlers execute a callback in afs context.
96 * Commands that need to change the state of afs can't change the relevant data
97 * structures directly because commands are executed in a child process, i.e.
98 * they get their own virtual address space.
100 * This structure is used by \p send_callback_request() (executed from handler
101 * context) in order to let the afs process call the specified function. An
102 * instance of that structure is written to a shared memory area together with
103 * the arguments to the callback function. The identifier of the shared memory
104 * area is written to the command socket.
106 * The afs process accepts connections on the command socket and reads the
107 * shared memory id, attaches the corresponding area, calls the given handler to
108 * perform the desired action and to optionally compute a result.
110 * The result and a \p callback_result structure is then written to another
111 * shared memory area. The identifier for that area is written to the handler's
112 * command socket, so that the handler process can read the id, attach the
113 * shared memory area and use the result.
115 * \sa \ref struct callback_result.
117 struct callback_query {
118 /** The function to be called. */
119 afs_callback *handler;
120 /** The number of bytes of the query */
125 * Structure embedded in the result of a callback.
127 * If the callback produced a result, an instance of that structure is embedded
128 * into the shared memory area holding the result, mainly to let the command
129 * handler know the size of the result.
131 * \sa \ref struct callback_query.
133 struct callback_result {
134 /** The number of bytes of the result. */
136 /** The band designator (loglevel for the result). */
140 static int dispatch_result(int result_shmid, callback_result_handler *handler,
141 void *private_result_data)
143 struct osl_object result;
145 /* must attach r/w as result.data might get encrypted in-place. */
146 int ret2, ret = shm_attach(result_shmid, ATTACH_RW, &result_shm);
147 struct callback_result *cr = result_shm;
150 PARA_ERROR_LOG("attach failed: %s\n", para_strerror(-ret));
153 result.size = cr->result_size;
154 result.data = result_shm + sizeof(*cr);
156 ret = handler(&result, cr->band, private_result_data);
157 ret2 = shm_detach(result_shm);
159 PARA_ERROR_LOG("detach failed: %s\n", para_strerror(-ret2));
167 * Ask the afs process to call a given function.
169 * \param f The function to be called.
170 * \param query Pointer to arbitrary data for the callback.
171 * \param result_handler Called for each shm area sent by the callback.
172 * \param private_result_data Passed verbatim to \a result_handler.
174 * This function creates a socket for communication with the afs process and a
175 * shared memory area (sma) to which the buffer pointed to by \a query is
176 * copied. It then notifies the afs process that the callback function \a f
177 * should be executed by sending the shared memory identifier (shmid) to the
180 * If the callback produces a result, it sends any number of shared memory
181 * identifiers back via the socket. For each such identifier received, \a
182 * result_handler is called. The contents of the sma identified by the received
183 * shmid are passed to that function as an osl object. The private_result_data
184 * pointer is passed as the second argument to \a result_handler.
186 * \return Number of shared memory areas dispatched on success, negative on
189 int send_callback_request(afs_callback *f, struct osl_object *query,
190 callback_result_handler *result_handler,
191 void *private_result_data)
193 struct callback_query *cq;
194 int ret, fd = -1, query_shmid, result_shmid;
196 char buf[sizeof(afs_socket_cookie) + sizeof(int)];
197 size_t query_shm_size = sizeof(*cq);
198 int dispatch_error = 0, num_dispatched = 0;
201 query_shm_size += query->size;
202 ret = shm_new(query_shm_size);
206 ret = shm_attach(query_shmid, ATTACH_RW, &query_shm);
211 cq->query_size = query_shm_size - sizeof(*cq);
214 memcpy(query_shm + sizeof(*cq), query->data, query->size);
215 ret = shm_detach(query_shm);
219 *(uint32_t *)buf = afs_socket_cookie;
220 *(int *)(buf + sizeof(afs_socket_cookie)) = query_shmid;
222 ret = connect_local_socket(OPT_STRING_VAL(AFS_SOCKET));
226 ret = write_all(fd, buf, sizeof(buf));
230 * Read all shmids from afs.
232 * Even if the dispatcher returns an error we _must_ continue to read
233 * shmids from fd so that we can destroy all shared memory areas that
234 * have been created for us by the afs process.
237 ret = recv_bin_buffer(fd, buf, sizeof(int));
240 assert(ret == sizeof(int));
244 ret = dispatch_result(result_shmid, result_handler,
245 private_result_data);
246 if (ret < 0 && dispatch_error >= 0)
247 dispatch_error = ret;
248 ret = shm_destroy(result_shmid);
250 PARA_CRIT_LOG("destroy result failed: %s\n",
251 para_strerror(-ret));
255 if (shm_destroy(query_shmid) < 0)
256 PARA_CRIT_LOG("shm destroy error\n");
259 if (dispatch_error < 0)
260 return dispatch_error;
263 return num_dispatched;
267 * Wrapper for send_callback_request() which passes a lopsub parse result.
269 * \param f The callback function.
270 * \param cmd Needed for (de-)serialization.
271 * \param lpr Must match cmd.
272 * \param private_result_data Passed to send_callback_request().
274 * This function serializes the parse result given by the lpr pointer into a
275 * buffer. The buffer is sent as the query to the afs process with the callback
278 * \return The return value of the underlying call to send_callback_request().
280 int send_lls_callback_request(afs_callback *f,
281 const struct lls_command * const cmd,
282 struct lls_parse_result *lpr, void *private_result_data)
284 struct osl_object query;
286 int ret = lls_serialize_parse_result(lpr, cmd, &buf, &query.size);
290 ret = send_callback_request(f, &query, afs_cb_result_handler,
291 private_result_data);
296 static int action_if_pattern_matches(struct osl_row *row, void *data)
298 struct pattern_match_data *pmd = data;
299 struct osl_object name_obj;
300 const char *p, *name;
303 ret = osl(osl_get_object(pmd->table, row, pmd->match_col_num,
307 name = (char *)name_obj.data;
308 if ((!name || !*name) && (pmd->pm_flags & PM_SKIP_EMPTY_NAME))
310 if (lls_num_inputs(pmd->lpr) == 0) {
311 if (pmd->pm_flags & PM_NO_PATTERN_MATCHES_EVERYTHING) {
313 return pmd->action(pmd->table, row, name, pmd->data);
318 if (i >= lls_num_inputs(pmd->lpr))
320 p = lls_input(i, pmd->lpr);
321 ret = fnmatch(p, name, pmd->fnmatch_flags);
322 if (ret != FNM_NOMATCH) {
325 ret = pmd->action(pmd->table, row, name, pmd->data);
337 * Execute the given function for each matching row.
339 * \param pmd Describes what to match and how.
343 int for_each_matching_row(struct pattern_match_data *pmd)
345 if (pmd->pm_flags & PM_REVERSE_LOOP)
346 return osl(osl_rbtree_loop_reverse(pmd->table, pmd->loop_col_num, pmd,
347 action_if_pattern_matches));
348 return osl(osl_rbtree_loop(pmd->table, pmd->loop_col_num, pmd,
349 action_if_pattern_matches));
353 * Compare two osl objects of string type.
355 * \param obj1 Pointer to the first object.
356 * \param obj2 Pointer to the second object.
358 * In any case, only \p MIN(obj1->size, obj2->size) characters of each string
359 * are taken into account.
361 * \return It returns an integer less than, equal to, or greater than zero if
362 * \a obj1 is found, respectively, to be less than, to match, or be greater than
365 * \sa strcmp(3), strncmp(3).
367 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2)
369 const char *str1 = obj1->data;
370 const char *str2 = obj2->data;
371 return strncmp(str1, str2, PARA_MIN(obj1->size, obj2->size));
374 static int pass_afd(int fd, char *buf, size_t size)
376 struct msghdr msg = {.msg_iov = NULL};
377 struct cmsghdr *cmsg;
378 char control[255] __a_aligned(8);
388 msg.msg_control = control;
389 msg.msg_controllen = sizeof(control);
391 cmsg = CMSG_FIRSTHDR(&msg);
392 cmsg->cmsg_level = SOL_SOCKET;
393 cmsg->cmsg_type = SCM_RIGHTS;
394 cmsg->cmsg_len = CMSG_LEN(sizeof(int));
395 *(int *)CMSG_DATA(cmsg) = fd;
397 /* Sum of the length of all control messages in the buffer */
398 msg.msg_controllen = cmsg->cmsg_len;
399 PARA_DEBUG_LOG("passing %zu bytes and fd %d\n", size, fd);
400 ret = sendmsg(server_socket, &msg, 0);
402 ret = -ERRNO_TO_PARA_ERROR(errno);
409 * Pass the fd of the next audio file to the server process.
411 * This stores all information for streaming the "best" audio file in a shared
412 * memory area. The id of that area and an open file descriptor for the next
413 * audio file are passed to the server process.
417 * \sa \ref open_and_update_audio_file().
419 static int open_next_audio_file(void)
421 struct audio_file_data afd;
425 ret = open_and_update_audio_file(&afd);
427 if (ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
428 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
429 goto no_admissible_files;
432 if (!write_ok(server_socket)) {
436 *(uint32_t *)buf = NEXT_AUDIO_FILE;
437 *(uint32_t *)(buf + 4) = (uint32_t)shmid;
438 ret = pass_afd(afd.fd, buf, 8);
446 *(uint32_t *)buf = NO_ADMISSIBLE_FILES;
447 *(uint32_t *)(buf + 4) = (uint32_t)0;
448 return write_all(server_socket, buf, 8);
451 /* Never fails if arg == NULL */
452 static int activate_mood_or_playlist(const char *arg, int *num_admissible,
459 ret = change_current_mood(NULL, NULL); /* always successful */
460 mode = PLAY_MODE_MOOD;
462 if (!strncmp(arg, "p/", 2)) {
463 ret = playlist_open(arg + 2);
464 if (ret < 0 && errmsg)
465 *errmsg = make_message( "could not open %s",
467 mode = PLAY_MODE_PLAYLIST;
468 } else if (!strncmp(arg, "m/", 2)) {
469 ret = change_current_mood(arg + 2, errmsg);
470 mode = PLAY_MODE_MOOD;
473 *errmsg = make_message("%s: parse error", arg);
474 return -ERRNO_TO_PARA_ERROR(EINVAL);
480 *num_admissible = ret;
481 current_play_mode = mode;
482 if (arg != current_mop) {
485 current_mop = para_strdup(arg);
486 mutex_lock(mmd_mutex);
487 strncpy(mmd->afs_mode_string, arg,
488 sizeof(mmd->afs_mode_string));
489 mmd->afs_mode_string[sizeof(mmd->afs_mode_string) - 1] = '\0';
491 mutex_unlock(mmd_mutex);
493 mutex_lock(mmd_mutex);
494 strcpy(mmd->afs_mode_string, "dummy");
496 mutex_unlock(mmd_mutex);
504 * Result handler for sending data to the para_client process.
506 * \param result The data to be sent.
507 * \param band The band designator.
508 * \param private Pointer to the command context.
510 * \return The return value of the underlying call to \ref command.c::send_sb.
512 * \sa \ref callback_result_handler, \ref command.c::send_sb.
514 int afs_cb_result_handler(struct osl_object *result, uint8_t band,
517 struct command_context *cc = private;
525 case SBD_WARNING_LOG:
529 assert(result->size > 0);
530 return send_sb(&cc->scc, result->data, result->size, band, true);
531 case SBD_AFS_CB_FAILURE:
532 return *(int *)(result->data);
538 static void flush_and_free_pb(struct para_buffer *pb)
541 struct afs_max_size_handler_data *amshd = pb->private_data;
543 if (pb->buf && pb->size > 0) {
544 ret = pass_buffer_as_shm(amshd->fd, amshd->band, pb->buf,
547 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
552 static int com_select_callback(struct afs_callback_arg *aca)
554 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(SELECT);
556 int num_admissible, ret;
559 ret = lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr);
561 arg = lls_input(0, aca->lpr);
562 ret = clear_score_table();
564 para_printf(&aca->pbout, "could not clear score table\n");
567 if (current_play_mode == PLAY_MODE_MOOD)
568 close_current_mood();
571 ret = activate_mood_or_playlist(arg, &num_admissible, &errmsg);
574 /* ignore subsequent errors (but log them) */
575 para_printf(&aca->pbout, "%s\n", errmsg);
577 para_printf(&aca->pbout, "could not activate %s\n", arg);
578 if (current_mop && strcmp(current_mop, arg) != 0) {
580 para_printf(&aca->pbout, "switching back to %s\n", current_mop);
581 ret2 = activate_mood_or_playlist(current_mop, &num_admissible,
585 para_printf(&aca->pbout, "%s\n", errmsg);
587 para_printf(&aca->pbout, "could not reactivate %s: %s\n",
588 current_mop, para_strerror(-ret2));
590 para_printf(&aca->pbout, "activating dummy mood\n");
591 activate_mood_or_playlist(NULL, &num_admissible, NULL);
593 para_printf(&aca->pbout, "activated %s (%d admissible file%s)\n",
594 current_mop? current_mop : "dummy mood", num_admissible,
595 num_admissible == 1? "" : "s");
597 lls_free_parse_result(aca->lpr, cmd);
601 static int com_select(struct command_context *cc, struct lls_parse_result *lpr)
603 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(SELECT);
605 int ret = lls(lls_check_arg_count(lpr, 1, 1, &errctx));
608 send_errctx(cc, errctx);
611 return send_lls_callback_request(com_select_callback, cmd, lpr, cc);
613 EXPORT_SERVER_CMD_HANDLER(select);
615 static void init_admissible_files(const char *arg)
617 int ret = activate_mood_or_playlist(arg, NULL, NULL);
620 PARA_WARNING_LOG("could not activate %s: %s\n", arg,
621 para_strerror(-ret));
622 activate_mood_or_playlist(NULL, NULL, NULL);
626 static int setup_command_socket_or_die(void)
629 const char *socket_name = OPT_STRING_VAL(AFS_SOCKET);
632 ret = create_local_socket(socket_name);
634 PARA_EMERG_LOG("%s: %s\n", para_strerror(-ret), socket_name);
638 PARA_INFO_LOG("listening on socket %s (fd %d)\n", socket_name,
643 static char *database_dir;
645 static void close_afs_tables(void)
648 PARA_NOTICE_LOG("closing afs_tables\n");
649 for (i = 0; i < NUM_AFS_TABLES; i++)
650 afs_tables[i].close();
655 static void get_database_dir(void)
658 if (OPT_GIVEN(AFS_DATABASE_DIR))
659 database_dir = para_strdup(OPT_STRING_VAL(AFS_DATABASE_DIR));
661 char *home = para_homedir();
662 database_dir = make_message(
663 "%s/.paraslash/afs_database-0.4", home);
667 PARA_INFO_LOG("afs_database dir %s\n", database_dir);
670 static int make_database_dir(void)
675 ret = para_mkdir(database_dir, 0777);
676 if (ret >= 0 || ret == -ERRNO_TO_PARA_ERROR(EEXIST))
681 static int open_afs_tables(void)
686 PARA_NOTICE_LOG("opening %d osl tables in %s\n", NUM_AFS_TABLES,
688 for (i = 0; i < NUM_AFS_TABLES; i++) {
689 ret = afs_tables[i].open(database_dir);
692 PARA_ERROR_LOG("could not open %s\n", afs_tables[i].name);
698 afs_tables[--i].close();
702 static int afs_signal_post_select(struct sched *s, __a_unused void *context)
706 if (getppid() == 1) {
707 PARA_EMERG_LOG("para_server died\n");
710 signum = para_next_signal(&s->rfds);
713 if (signum == SIGHUP) {
715 parse_config_or_die(1);
716 ret = open_afs_tables();
719 init_admissible_files(current_mop);
722 PARA_EMERG_LOG("terminating on signal %d\n", signum);
724 task_notify_all(s, E_AFS_SIGNAL);
725 return -E_AFS_SIGNAL;
728 static void register_signal_task(struct sched *s)
730 para_sigaction(SIGPIPE, SIG_IGN);
731 signal_task = signal_init_or_die();
732 para_install_sighandler(SIGINT);
733 para_install_sighandler(SIGTERM);
734 para_install_sighandler(SIGHUP);
736 signal_task->task = task_register(&(struct task_info) {
738 .pre_select = signal_pre_select,
739 .post_select = afs_signal_post_select,
740 .context = signal_task,
745 static struct list_head afs_client_list;
747 /** Describes one connected afs client. */
749 /** Position in the afs client list. */
750 struct list_head node;
751 /** The socket file descriptor for this client. */
753 /** The time the client connected. */
754 struct timeval connect_time;
757 static void command_pre_select(struct sched *s, void *context)
759 struct command_task *ct = context;
760 struct afs_client *client;
762 para_fd_set(server_socket, &s->rfds, &s->max_fileno);
763 para_fd_set(ct->fd, &s->rfds, &s->max_fileno);
764 list_for_each_entry(client, &afs_client_list, node)
765 para_fd_set(client->fd, &s->rfds, &s->max_fileno);
769 * Send data as shared memory to a file descriptor.
771 * \param fd File descriptor to send the shmid to.
772 * \param band The band designator for this data.
773 * \param buf The buffer holding the data to be sent.
774 * \param size The size of \a buf.
776 * This function creates a shared memory area large enough to hold
777 * the content given by \a buf and \a size and sends the identifier
778 * of this area to the file descriptor \a fd.
780 * It is called by the AFS max_size handler as well as directly by the AFS
781 * command callbacks to send command output to the command handlers.
783 * \return Zero if \a buf is \p NULL or \a size is zero. Negative on errors,
784 * and positive on success.
786 int pass_buffer_as_shm(int fd, uint8_t band, const char *buf, size_t size)
790 struct callback_result *cr;
793 assert(band != SBD_OUTPUT);
794 ret = shm_new(size + sizeof(*cr));
798 ret = shm_attach(shmid, ATTACH_RW, &shm);
802 cr->result_size = size;
805 memcpy(shm + sizeof(*cr), buf, size);
806 ret = shm_detach(shm);
809 ret = write_all(fd, (char *)&shmid, sizeof(int));
813 if (shm_destroy(shmid) < 0)
814 PARA_ERROR_LOG("destroy result failed\n");
818 static int call_callback(int fd, int query_shmid)
821 struct callback_query *cq;
823 struct afs_callback_arg aca = {.fd = fd};
825 ret = shm_attach(query_shmid, ATTACH_RW, &query_shm);
829 aca.query.data = (char *)query_shm + sizeof(*cq);
830 aca.query.size = cq->query_size;
831 aca.pbout.max_size = shm_get_shmmax();
832 aca.pbout.max_size_handler = afs_max_size_handler;
833 aca.pbout.private_data = &(struct afs_max_size_handler_data) {
837 ret = cq->handler(&aca);
838 ret2 = shm_detach(query_shm);
840 if (ret < 0) /* ignore (but log) detach error */
841 PARA_ERROR_LOG("could not detach sma: %s\n",
842 para_strerror(-ret2));
846 flush_and_free_pb(&aca.pbout);
848 ret2 = pass_buffer_as_shm(fd, SBD_AFS_CB_FAILURE,
849 (const char *)&ret, sizeof(ret));
851 PARA_ERROR_LOG("could not pass cb failure packet: %s\n",
852 para_strerror(-ret));
857 static int execute_server_command(fd_set *rfds)
861 int ret = read_nonblock(server_socket, buf, sizeof(buf) - 1, rfds, &n);
863 if (ret < 0 || n == 0)
866 if (strcmp(buf, "new"))
867 return -ERRNO_TO_PARA_ERROR(EINVAL);
868 return open_next_audio_file();
871 /* returns 0 if no data available, 1 else */
872 static int execute_afs_command(int fd, fd_set *rfds)
876 char buf[sizeof(cookie) + sizeof(query_shmid)];
878 int ret = read_nonblock(fd, buf, sizeof(buf), rfds, &n);
884 if (n != sizeof(buf)) {
885 PARA_NOTICE_LOG("short read (%d bytes, expected %lu)\n",
886 ret, (long unsigned) sizeof(buf));
889 cookie = *(uint32_t *)buf;
890 if (cookie != afs_socket_cookie) {
891 PARA_NOTICE_LOG("received invalid cookie (got %u, expected %u)\n",
892 (unsigned)cookie, (unsigned)afs_socket_cookie);
895 query_shmid = *(int *)(buf + sizeof(cookie));
896 if (query_shmid < 0) {
897 PARA_WARNING_LOG("received invalid query shmid %d)\n",
901 ret = call_callback(fd, query_shmid);
905 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
909 /** Shutdown connection if query has not arrived until this many seconds. */
910 #define AFS_CLIENT_TIMEOUT 3
912 static int command_post_select(struct sched *s, void *context)
914 struct command_task *ct = context;
915 struct sockaddr_un unix_addr;
916 struct afs_client *client, *tmp;
919 ret = task_get_notification(ct->task);
922 ret = execute_server_command(&s->rfds);
924 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
925 task_notify_all(s, -ret);
928 /* Check the list of connected clients. */
929 list_for_each_entry_safe(client, tmp, &afs_client_list, node) {
930 ret = execute_afs_command(client->fd, &s->rfds);
931 if (ret == 0) { /* prevent bogus connection flooding */
933 tv_diff(now, &client->connect_time, &diff);
934 if (diff.tv_sec < AFS_CLIENT_TIMEOUT)
936 PARA_WARNING_LOG("connection timeout\n");
939 list_del(&client->node);
942 /* Accept connections on the local socket. */
943 ret = para_accept(ct->fd, &s->rfds, &unix_addr, sizeof(unix_addr), &fd);
945 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
948 ret = mark_fd_nonblocking(fd);
950 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
954 client = para_malloc(sizeof(*client));
956 client->connect_time = *now;
957 para_list_add(&client->node, &afs_client_list);
961 static void register_command_task(struct sched *s)
963 struct command_task *ct = &command_task_struct;
964 ct->fd = setup_command_socket_or_die();
966 ct->task = task_register(&(struct task_info) {
967 .name = "afs command",
968 .pre_select = command_pre_select,
969 .post_select = command_post_select,
975 * Initialize the audio file selector process.
977 * \param socket_fd File descriptor used for communication with the server.
979 __noreturn void afs_init(int socket_fd)
981 static struct sched s;
984 register_signal_task(&s);
985 INIT_LIST_HEAD(&afs_client_list);
986 for (i = 0; i < NUM_AFS_TABLES; i++)
987 afs_tables[i].init(&afs_tables[i]);
988 ret = open_afs_tables();
991 server_socket = socket_fd;
992 ret = mark_fd_nonblocking(server_socket);
995 PARA_INFO_LOG("server_socket: %d\n", server_socket);
996 init_admissible_files(OPT_STRING_VAL(AFS_INITIAL_MODE));
997 register_command_task(&s);
998 s.default_timeout.tv_sec = 0;
999 s.default_timeout.tv_usec = 999 * 1000;
1000 ret = write(socket_fd, "\0", 1);
1004 ret = -ERRNO_TO_PARA_ERROR(errno);
1009 close_current_mood();
1013 signal_shutdown(signal_task);
1014 free_status_items();
1018 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
1022 static int com_init_callback(struct afs_callback_arg *aca)
1024 uint32_t table_mask = *(uint32_t *)aca->query.data;
1029 for (i = 0; i < NUM_AFS_TABLES; i++) {
1030 struct afs_table *t = &afs_tables[i];
1032 if (!(table_mask & (1 << i)))
1036 ret = t->create(database_dir);
1038 para_printf(&aca->pbout, "cannot create table %s\n",
1042 para_printf(&aca->pbout, "successfully created %s table\n",
1045 ret = open_afs_tables();
1047 para_printf(&aca->pbout, "cannot open afs tables: %s\n",
1048 para_strerror(-ret));
1053 static int com_init(struct command_context *cc, struct lls_parse_result *lpr)
1056 uint32_t table_mask = (1 << (NUM_AFS_TABLES + 1)) - 1;
1057 struct osl_object query = {.data = &table_mask,
1058 .size = sizeof(table_mask)};
1059 unsigned num_inputs = lls_num_inputs(lpr);
1061 ret = make_database_dir();
1064 if (num_inputs > 0) {
1066 for (i = 0; i < num_inputs; i++) {
1067 for (j = 0; j < NUM_AFS_TABLES; j++) {
1068 struct afs_table *t = &afs_tables[j];
1070 if (strcmp(lls_input(i, lpr), t->name))
1072 table_mask |= (1 << j);
1075 if (j == NUM_AFS_TABLES)
1076 return -E_BAD_TABLE_NAME;
1079 return send_callback_request(com_init_callback, &query,
1080 afs_cb_result_handler, cc);
1082 EXPORT_SERVER_CMD_HANDLER(init);
1084 static int com_check(struct command_context *cc, struct lls_parse_result *lpr)
1086 const struct lls_opt_result *r_a = SERVER_CMD_OPT_RESULT(CHECK, AFT, lpr);
1087 const struct lls_opt_result *r_A = SERVER_CMD_OPT_RESULT(CHECK, ATTRIBUTE, lpr);
1088 const struct lls_opt_result *r_m = SERVER_CMD_OPT_RESULT(CHECK, MOOD, lpr);
1089 const struct lls_opt_result *r_p = SERVER_CMD_OPT_RESULT(CHECK, PLAYLIST, lpr);
1090 bool noopt = !lls_opt_given(r_a) && !lls_opt_given(r_A)
1091 && !lls_opt_given(r_m) && !lls_opt_given(r_p);
1094 if (noopt || lls_opt_given(r_a)) {
1095 ret = send_callback_request(aft_check_callback, NULL,
1096 afs_cb_result_handler, cc);
1100 if (noopt || lls_opt_given(r_A)) {
1101 ret = send_callback_request(attribute_check_callback, NULL,
1102 afs_cb_result_handler, cc);
1106 if (noopt || lls_opt_given(r_p)) {
1107 ret = send_callback_request(playlist_check_callback,
1108 NULL, afs_cb_result_handler, cc);
1112 if (noopt || lls_opt_given(r_m)) {
1113 ret = send_callback_request(mood_check_callback, NULL,
1114 afs_cb_result_handler, cc);
1120 EXPORT_SERVER_CMD_HANDLER(check);
1123 * The afs event dispatcher.
1125 * \param event Type of the event.
1126 * \param pb May be \p NULL.
1127 * \param data Type depends on \a event.
1129 * This function calls each table event handler, passing \a pb and \a data
1130 * verbatim. It's up to the handlers to interpret the \a data pointer. If a
1131 * handler returns negative, the loop is aborted.
1133 * \return The (negative) error code of the first handler that failed, or non-negative
1134 * if all handlers succeeded.
1136 __must_check int afs_event(enum afs_events event, struct para_buffer *pb,
1141 for (i = 0; i < NUM_AFS_TABLES; i++) {
1142 struct afs_table *t = &afs_tables[i];
1143 if (!t->event_handler)
1145 ret = t->event_handler(event, pb, data);
1147 PARA_CRIT_LOG("table %s, event %u: %s\n", t->name,
1148 event, para_strerror(-ret));
1156 * Dummy event handler for the images table.
1158 * \param event Unused.
1160 * \param data Unused.
1162 * \return The images table does not honor events, so this handler always
1165 __a_const int images_event_handler(__a_unused enum afs_events event,
1166 __a_unused struct para_buffer *pb, __a_unused void *data)
1172 * Dummy event handler for the lyrics table.
1174 * \param event Unused.
1176 * \param data Unused.
1178 * \return The lyrics table does not honor events, so this handler always
1181 __a_const int lyrics_event_handler(__a_unused enum afs_events event,
1182 __a_unused struct para_buffer *pb, __a_unused void *data)