2 * Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file afs.c Paraslash's audio file selector. */
9 #include <netinet/in.h>
10 #include <sys/socket.h>
16 #include <arpa/inet.h>
21 #include "server.lsg.h"
22 #include "server_cmd.lsg.h"
40 /** The osl tables used by afs. \sa \ref blob.c. */
42 /** Contains audio file information. See \ref aft.c. */
44 /** The table for the paraslash attributes. See \ref attribute.c. */
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 \ref score.c for
54 * A standard blob table containing the mood definitions. For details
58 /** A blob table containing lyrics on a per-song basis. */
60 /** Another blob table for images (for example album cover art). */
62 /** Yet another blob table for storing standard playlists. */
64 /** How many tables are in use? */
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"},
79 /** The file descriptor for the local socket. */
82 * Value sent by the command handlers to identify themselves as
83 * children of the running para_server.
86 /** The associated task structure. */
91 extern struct misc_meta_data *mmd;
93 static int server_socket;
94 static struct command_task command_task_struct;
95 static struct signal_task *signal_task;
97 static enum play_mode current_play_mode;
98 static char *current_mop; /* mode or playlist specifier. NULL means dummy mood */
101 * A random number used to "authenticate" the connection.
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.
109 extern uint32_t afs_socket_cookie;
112 * Struct to let command handlers execute a callback in afs context.
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.
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.
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.
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.
133 * \sa \ref struct callback_result.
135 struct callback_query {
136 /** The function to be called. */
137 afs_callback *handler;
138 /** The number of bytes of the query */
143 * Structure embedded in the result of a callback.
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.
149 * \sa \ref struct callback_query.
151 struct callback_result {
152 /** The number of bytes of the result. */
154 /** The band designator (loglevel for the result). */
158 static int dispatch_result(int result_shmid, callback_result_handler *handler,
159 void *private_result_data)
161 struct osl_object result;
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;
168 PARA_ERROR_LOG("attach failed: %s\n", para_strerror(-ret));
171 result.size = cr->result_size;
172 result.data = result_shm + sizeof(*cr);
174 ret = handler(&result, cr->band, private_result_data);
175 ret2 = shm_detach(result_shm);
177 PARA_ERROR_LOG("detach failed: %s\n", para_strerror(-ret2));
185 * Ask the afs process to call a given function.
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.
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
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.
204 * \return Number of shared memory areas dispatched on success, negative on
207 int send_callback_request(afs_callback *f, struct osl_object *query,
208 callback_result_handler *result_handler,
209 void *private_result_data)
211 struct callback_query *cq;
212 int ret, fd = -1, query_shmid, result_shmid;
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;
219 query_shm_size += query->size;
220 ret = shm_new(query_shm_size);
224 ret = shm_attach(query_shmid, ATTACH_RW, &query_shm);
229 cq->query_size = query_shm_size - sizeof(*cq);
232 memcpy(query_shm + sizeof(*cq), query->data, query->size);
233 ret = shm_detach(query_shm);
237 *(uint32_t *)buf = afs_socket_cookie;
238 *(int *)(buf + sizeof(afs_socket_cookie)) = query_shmid;
240 ret = connect_local_socket(OPT_STRING_VAL(AFS_SOCKET));
244 ret = write_all(fd, buf, sizeof(buf));
248 * Read all shmids from afs.
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.
255 ret = recv_bin_buffer(fd, buf, sizeof(int));
258 assert(ret == sizeof(int));
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);
268 PARA_CRIT_LOG("destroy result failed: %s\n",
269 para_strerror(-ret));
273 if (shm_destroy(query_shmid) < 0)
274 PARA_CRIT_LOG("shm destroy error\n");
277 if (dispatch_error < 0)
278 return dispatch_error;
281 return num_dispatched;
285 * Wrapper for send_callback_request() which passes a lopsub parse result.
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().
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
296 * \return The return value of the underlying call to send_callback_request().
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)
302 struct osl_object query;
304 int ret = lls_serialize_parse_result(lpr, cmd, &buf, &query.size);
308 ret = send_callback_request(f, &query, afs_cb_result_handler,
309 private_result_data);
314 static int action_if_pattern_matches(struct osl_row *row, void *data)
316 struct pattern_match_data *pmd = data;
317 struct osl_object name_obj;
318 const char *p, *name;
321 ret = osl(osl_get_object(pmd->table, row, pmd->match_col_num,
325 name = (char *)name_obj.data;
326 if ((!name || !*name) && (pmd->pm_flags & PM_SKIP_EMPTY_NAME))
328 if (lls_num_inputs(pmd->lpr) == 0) {
329 if (pmd->pm_flags & PM_NO_PATTERN_MATCHES_EVERYTHING) {
331 return pmd->action(pmd->table, row, name, pmd->data);
336 if (i >= lls_num_inputs(pmd->lpr))
338 p = lls_input(i, pmd->lpr);
339 ret = fnmatch(p, name, pmd->fnmatch_flags);
340 if (ret != FNM_NOMATCH) {
343 ret = pmd->action(pmd->table, row, name, pmd->data);
355 * Execute the given function for each matching row.
357 * \param pmd Describes what to match and how.
361 int for_each_matching_row(struct pattern_match_data *pmd)
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));
371 * Compare two osl objects of string type.
373 * \param obj1 Pointer to the first object.
374 * \param obj2 Pointer to the second object.
376 * In any case, only \p MIN(obj1->size, obj2->size) characters of each string
377 * are taken into account.
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
383 * \sa strcmp(3), strncmp(3).
385 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2)
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));
392 static int pass_afd(int fd, char *buf, size_t size)
394 struct msghdr msg = {.msg_iov = NULL};
395 struct cmsghdr *cmsg;
396 char control[255] __a_aligned(8);
406 msg.msg_control = control;
407 msg.msg_controllen = sizeof(control);
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;
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);
420 ret = -ERRNO_TO_PARA_ERROR(errno);
427 * Pass the fd of the next audio file to the server process.
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.
435 * \sa \ref open_and_update_audio_file().
437 static int open_next_audio_file(void)
439 struct audio_file_data afd;
443 ret = open_and_update_audio_file(&afd);
445 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
446 goto no_admissible_files;
449 if (!write_ok(server_socket)) {
453 *(uint32_t *)buf = NEXT_AUDIO_FILE;
454 *(uint32_t *)(buf + 4) = (uint32_t)shmid;
455 ret = pass_afd(afd.fd, buf, 8);
463 *(uint32_t *)buf = NO_ADMISSIBLE_FILES;
464 *(uint32_t *)(buf + 4) = (uint32_t)0;
465 return write_all(server_socket, buf, 8);
468 /* Never fails if arg == NULL */
469 static int activate_mood_or_playlist(const char *arg, int *num_admissible)
475 ret = change_current_mood(NULL); /* always successful */
476 mode = PLAY_MODE_MOOD;
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;
485 return -ERRNO_TO_PARA_ERROR(EINVAL);
490 *num_admissible = ret;
491 current_play_mode = mode;
492 if (arg != current_mop) {
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';
501 mutex_unlock(mmd_mutex);
503 mutex_lock(mmd_mutex);
504 strcpy(mmd->afs_mode_string, "dummy");
506 mutex_unlock(mmd_mutex);
514 * Result handler for sending data to the para_client process.
516 * \param result The data to be sent.
517 * \param band The band designator.
518 * \param private Pointer to the command context.
520 * \return The return value of the underlying call to \ref command.c::send_sb.
522 * \sa \ref callback_result_handler, \ref command.c::send_sb.
524 int afs_cb_result_handler(struct osl_object *result, uint8_t band,
527 struct command_context *cc = private;
535 case SBD_WARNING_LOG:
539 assert(result->size > 0);
540 return send_sb(&cc->scc, result->data, result->size, band, true);
541 case SBD_AFS_CB_FAILURE:
542 return *(int *)(result->data);
548 static void flush_and_free_pb(struct para_buffer *pb)
551 struct afs_max_size_handler_data *amshd = pb->private_data;
553 if (pb->buf && pb->size > 0) {
554 ret = pass_buffer_as_shm(amshd->fd, amshd->band, pb->buf,
557 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
562 static int com_select_callback(struct afs_callback_arg *aca)
564 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(SELECT);
566 int num_admissible, ret;
568 ret = lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr);
570 arg = lls_input(0, aca->lpr);
571 ret = clear_score_table();
573 para_printf(&aca->pbout, "could not clear score table\n");
576 if (current_play_mode == PLAY_MODE_MOOD)
577 close_current_mood();
580 ret = activate_mood_or_playlist(arg, &num_admissible);
583 /* ignore subsequent errors (but log them) */
584 para_printf(&aca->pbout, "could not activate %s\n", arg);
585 if (current_mop && strcmp(current_mop, arg) != 0) {
587 para_printf(&aca->pbout, "switching back to %s\n", current_mop);
588 ret2 = activate_mood_or_playlist(current_mop, &num_admissible);
591 para_printf(&aca->pbout, "could not reactivate %s: %s\n",
592 current_mop, para_strerror(-ret2));
594 para_printf(&aca->pbout, "activating dummy mood\n");
595 activate_mood_or_playlist(NULL, &num_admissible);
597 para_printf(&aca->pbout, "activated %s (%d admissible files)\n",
598 current_mop? current_mop : "dummy mood", num_admissible);
600 lls_free_parse_result(aca->lpr, cmd);
604 static int com_select(struct command_context *cc, struct lls_parse_result *lpr)
606 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(SELECT);
608 int ret = lls(lls_check_arg_count(lpr, 1, 1, &errctx));
611 send_errctx(cc, errctx);
614 return send_lls_callback_request(com_select_callback, cmd, lpr, cc);
616 EXPORT_SERVER_CMD_HANDLER(select);
618 static void init_admissible_files(const char *arg)
620 int ret = activate_mood_or_playlist(arg, NULL);
623 PARA_WARNING_LOG("could not activate %s: %s\n", arg,
624 para_strerror(-ret));
625 activate_mood_or_playlist(NULL, NULL); /* always successful */
629 static int setup_command_socket_or_die(void)
632 const char *socket_name = OPT_STRING_VAL(AFS_SOCKET);
635 ret = create_local_socket(socket_name);
637 PARA_EMERG_LOG("%s: %s\n", para_strerror(-ret), socket_name);
641 PARA_INFO_LOG("listening on socket %s (fd %d)\n", socket_name,
646 static void close_afs_tables(void)
649 PARA_NOTICE_LOG("closing afs_tables\n");
650 for (i = 0; i < NUM_AFS_TABLES; i++)
651 afs_tables[i].close();
654 static char *database_dir;
656 static void get_database_dir(void)
659 if (OPT_GIVEN(AFS_DATABASE_DIR))
660 database_dir = para_strdup(OPT_STRING_VAL(AFS_DATABASE_DIR));
662 char *home = para_homedir();
663 database_dir = make_message(
664 "%s/.paraslash/afs_database-0.4", home);
668 PARA_INFO_LOG("afs_database dir %s\n", database_dir);
671 static int make_database_dir(void)
676 ret = para_mkdir(database_dir, 0777);
677 if (ret >= 0 || ret == -ERRNO_TO_PARA_ERROR(EEXIST))
682 static int open_afs_tables(void)
687 PARA_NOTICE_LOG("opening %d osl tables in %s\n", NUM_AFS_TABLES,
689 for (i = 0; i < NUM_AFS_TABLES; i++) {
690 ret = afs_tables[i].open(database_dir);
693 PARA_ERROR_LOG("%s init: %s\n", afs_tables[i].name,
694 para_strerror(-ret));
700 afs_tables[--i].close();
704 static int afs_signal_post_select(struct sched *s, __a_unused void *context)
708 if (getppid() == 1) {
709 PARA_EMERG_LOG("para_server died\n");
712 signum = para_next_signal(&s->rfds);
715 if (signum == SIGHUP) {
717 parse_config_or_die(1);
718 ret = open_afs_tables();
721 init_admissible_files(current_mop);
724 PARA_EMERG_LOG("terminating on signal %d\n", signum);
726 task_notify_all(s, E_AFS_SIGNAL);
727 return -E_AFS_SIGNAL;
730 static void register_signal_task(struct sched *s)
732 para_sigaction(SIGPIPE, SIG_IGN);
733 signal_task = signal_init_or_die();
734 para_install_sighandler(SIGINT);
735 para_install_sighandler(SIGTERM);
736 para_install_sighandler(SIGHUP);
738 signal_task->task = task_register(&(struct task_info) {
740 .pre_select = signal_pre_select,
741 .post_select = afs_signal_post_select,
742 .context = signal_task,
747 static struct list_head afs_client_list;
749 /** Describes one connected afs client. */
751 /** Position in the afs client list. */
752 struct list_head node;
753 /** The socket file descriptor for this client. */
755 /** The time the client connected. */
756 struct timeval connect_time;
759 static void command_pre_select(struct sched *s, void *context)
761 struct command_task *ct = context;
762 struct afs_client *client;
764 para_fd_set(server_socket, &s->rfds, &s->max_fileno);
765 para_fd_set(ct->fd, &s->rfds, &s->max_fileno);
766 list_for_each_entry(client, &afs_client_list, node)
767 para_fd_set(client->fd, &s->rfds, &s->max_fileno);
771 * Send data as shared memory to a file descriptor.
773 * \param fd File descriptor to send the shmid to.
774 * \param band The band designator for this data.
775 * \param buf The buffer holding the data to be sent.
776 * \param size The size of \a buf.
778 * This function creates a shared memory area large enough to hold
779 * the content given by \a buf and \a size and sends the identifier
780 * of this area to the file descriptor \a fd.
782 * It is called by the AFS max_size handler as well as directly by the AFS
783 * command callbacks to send command output to the command handlers.
785 * \return Zero if \a buf is \p NULL or \a size is zero. Negative on errors,
786 * and positive on success.
788 int pass_buffer_as_shm(int fd, uint8_t band, const char *buf, size_t size)
792 struct callback_result *cr;
795 assert(band != SBD_OUTPUT);
796 ret = shm_new(size + sizeof(*cr));
800 ret = shm_attach(shmid, ATTACH_RW, &shm);
804 cr->result_size = size;
807 memcpy(shm + sizeof(*cr), buf, size);
808 ret = shm_detach(shm);
811 ret = write_all(fd, (char *)&shmid, sizeof(int));
815 if (shm_destroy(shmid) < 0)
816 PARA_ERROR_LOG("destroy result failed\n");
820 static int call_callback(int fd, int query_shmid)
823 struct callback_query *cq;
825 struct afs_callback_arg aca = {.fd = fd};
827 ret = shm_attach(query_shmid, ATTACH_RW, &query_shm);
831 aca.query.data = (char *)query_shm + sizeof(*cq);
832 aca.query.size = cq->query_size;
833 aca.pbout.max_size = shm_get_shmmax();
834 aca.pbout.max_size_handler = afs_max_size_handler;
835 aca.pbout.private_data = &(struct afs_max_size_handler_data) {
839 ret = cq->handler(&aca);
840 ret2 = shm_detach(query_shm);
842 if (ret < 0) /* ignore (but log) detach error */
843 PARA_ERROR_LOG("could not detach sma: %s\n",
844 para_strerror(-ret2));
848 flush_and_free_pb(&aca.pbout);
850 ret2 = pass_buffer_as_shm(fd, SBD_AFS_CB_FAILURE,
851 (const char *)&ret, sizeof(ret));
853 PARA_ERROR_LOG("could not pass cb failure packet: %s\n",
854 para_strerror(-ret));
859 static int execute_server_command(fd_set *rfds)
863 int ret = read_nonblock(server_socket, buf, sizeof(buf) - 1, rfds, &n);
865 if (ret < 0 || n == 0)
868 if (strcmp(buf, "new"))
869 return -ERRNO_TO_PARA_ERROR(EINVAL);
870 return open_next_audio_file();
873 /* returns 0 if no data available, 1 else */
874 static int execute_afs_command(int fd, fd_set *rfds, uint32_t expected_cookie)
878 char buf[sizeof(cookie) + sizeof(query_shmid)];
880 int ret = read_nonblock(fd, buf, sizeof(buf), rfds, &n);
886 if (n != sizeof(buf)) {
887 PARA_NOTICE_LOG("short read (%d bytes, expected %lu)\n",
888 ret, (long unsigned) sizeof(buf));
891 cookie = *(uint32_t *)buf;
892 if (cookie != expected_cookie) {
893 PARA_NOTICE_LOG("received invalid cookie (got %u, expected %u)\n",
894 (unsigned)cookie, (unsigned)expected_cookie);
897 query_shmid = *(int *)(buf + sizeof(cookie));
898 if (query_shmid < 0) {
899 PARA_WARNING_LOG("received invalid query shmid %d)\n",
903 ret = call_callback(fd, query_shmid);
907 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
911 /** Shutdown connection if query has not arrived until this many seconds. */
912 #define AFS_CLIENT_TIMEOUT 3
914 static int command_post_select(struct sched *s, void *context)
916 struct command_task *ct = context;
917 struct sockaddr_un unix_addr;
918 struct afs_client *client, *tmp;
921 ret = task_get_notification(ct->task);
924 ret = execute_server_command(&s->rfds);
926 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
927 task_notify_all(s, -ret);
930 /* Check the list of connected clients. */
931 list_for_each_entry_safe(client, tmp, &afs_client_list, node) {
932 ret = execute_afs_command(client->fd, &s->rfds, ct->cookie);
933 if (ret == 0) { /* prevent bogus connection flooding */
935 tv_diff(now, &client->connect_time, &diff);
936 if (diff.tv_sec < AFS_CLIENT_TIMEOUT)
938 PARA_WARNING_LOG("connection timeout\n");
941 list_del(&client->node);
944 /* Accept connections on the local socket. */
945 ret = para_accept(ct->fd, &s->rfds, &unix_addr, sizeof(unix_addr), &fd);
947 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
950 ret = mark_fd_nonblocking(fd);
952 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
956 client = para_malloc(sizeof(*client));
958 client->connect_time = *now;
959 para_list_add(&client->node, &afs_client_list);
963 static void register_command_task(uint32_t cookie, struct sched *s)
965 struct command_task *ct = &command_task_struct;
966 ct->fd = setup_command_socket_or_die();
969 ct->task = task_register(&(struct task_info) {
970 .name = "afs command",
971 .pre_select = command_pre_select,
972 .post_select = command_post_select,
978 * Initialize the audio file selector process.
980 * \param cookie The value used for "authentication".
981 * \param socket_fd File descriptor used for communication with the server.
983 __noreturn void afs_init(uint32_t cookie, int socket_fd)
985 static struct sched s;
988 register_signal_task(&s);
989 INIT_LIST_HEAD(&afs_client_list);
990 for (i = 0; i < NUM_AFS_TABLES; i++)
991 afs_tables[i].init(&afs_tables[i]);
992 ret = open_afs_tables();
995 server_socket = socket_fd;
996 ret = mark_fd_nonblocking(server_socket);
999 PARA_INFO_LOG("server_socket: %d, afs_socket_cookie: %u\n",
1000 server_socket, (unsigned) cookie);
1001 init_admissible_files(OPT_STRING_VAL(AFS_INITIAL_MODE));
1002 register_command_task(cookie, &s);
1003 s.default_timeout.tv_sec = 0;
1004 s.default_timeout.tv_usec = 999 * 1000;
1005 ret = write(socket_fd, "\0", 1);
1009 ret = -ERRNO_TO_PARA_ERROR(errno);
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;
1028 for (i = 0; i < NUM_AFS_TABLES; i++) {
1029 struct afs_table *t = &afs_tables[i];
1031 if (!(table_mask & (1 << i)))
1035 ret = t->create(database_dir);
1037 para_printf(&aca->pbout, "cannot create table %s\n",
1041 para_printf(&aca->pbout, "successfully created %s table\n",
1044 ret = open_afs_tables();
1046 para_printf(&aca->pbout, "cannot open afs tables\n");
1051 static int com_init(struct command_context *cc, struct lls_parse_result *lpr)
1054 uint32_t table_mask = (1 << (NUM_AFS_TABLES + 1)) - 1;
1055 struct osl_object query = {.data = &table_mask,
1056 .size = sizeof(table_mask)};
1057 unsigned num_inputs = lls_num_inputs(lpr);
1059 ret = make_database_dir();
1062 if (num_inputs > 0) {
1064 for (i = 0; i < num_inputs; i++) {
1065 for (j = 0; j < NUM_AFS_TABLES; j++) {
1066 struct afs_table *t = &afs_tables[j];
1068 if (strcmp(lls_input(i, lpr), t->name))
1070 table_mask |= (1 << j);
1073 if (j == NUM_AFS_TABLES)
1074 return -E_BAD_TABLE_NAME;
1077 return send_callback_request(com_init_callback, &query,
1078 afs_cb_result_handler, cc);
1080 EXPORT_SERVER_CMD_HANDLER(init);
1082 static int com_check(struct command_context *cc, struct lls_parse_result *lpr)
1084 const struct lls_opt_result *r_a = SERVER_CMD_OPT_RESULT(CHECK, AFT, lpr);
1085 const struct lls_opt_result *r_A = SERVER_CMD_OPT_RESULT(CHECK, ATTRIBUTE, lpr);
1086 const struct lls_opt_result *r_m = SERVER_CMD_OPT_RESULT(CHECK, MOOD, lpr);
1087 const struct lls_opt_result *r_p = SERVER_CMD_OPT_RESULT(CHECK, PLAYLIST, lpr);
1088 bool noopt = !lls_opt_given(r_a) && !lls_opt_given(r_A)
1089 && !lls_opt_given(r_m) && !lls_opt_given(r_p);
1092 if (noopt || lls_opt_given(r_a)) {
1093 ret = send_callback_request(aft_check_callback, NULL,
1094 afs_cb_result_handler, cc);
1098 if (noopt || lls_opt_given(r_A)) {
1099 ret = send_callback_request(attribute_check_callback, NULL,
1100 afs_cb_result_handler, cc);
1104 if (noopt || lls_opt_given(r_p)) {
1105 ret = send_callback_request(playlist_check_callback,
1106 NULL, afs_cb_result_handler, cc);
1110 if (noopt || lls_opt_given(r_m)) {
1111 ret = send_callback_request(mood_check_callback, NULL,
1112 afs_cb_result_handler, cc);
1118 EXPORT_SERVER_CMD_HANDLER(check);
1121 * The afs event dispatcher.
1123 * \param event Type of the event.
1124 * \param pb May be \p NULL.
1125 * \param data Type depends on \a event.
1127 * This function calls each table event handler, passing \a pb and \a data
1128 * verbatim. It's up to the handlers to interpret the \a data pointer. If a
1129 * handler returns negative, the loop is aborted.
1131 * \return The (negative) error code of the first handler that failed, or non-negative
1132 * if all handlers succeeded.
1134 __must_check int afs_event(enum afs_events event, struct para_buffer *pb,
1139 for (i = 0; i < NUM_AFS_TABLES; i++) {
1140 struct afs_table *t = &afs_tables[i];
1141 if (!t->event_handler)
1143 ret = t->event_handler(event, pb, data);
1145 PARA_CRIT_LOG("table %s, event %u: %s\n", t->name,
1146 event, para_strerror(-ret));
1154 * Dummy event handler for the images table.
1156 * \param event Unused.
1158 * \param data Unused.
1160 * \return The images table does not honor events, so this handler always
1163 __a_const int images_event_handler(__a_unused enum afs_events event,
1164 __a_unused struct para_buffer *pb, __a_unused void *data)
1170 * Dummy event handler for the lyrics table.
1172 * \param event Unused.
1174 * \param data Unused.
1176 * \return The lyrics table does not honor events, so this handler always
1179 __a_const int lyrics_event_handler(__a_unused enum afs_events event,
1180 __a_unused struct para_buffer *pb, __a_unused void *data)