2 * Copyright (C) 2007-2012 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file afs.c Paraslash's audio file selector. */
14 #include "server.cmdline.h"
32 /** The osl tables used by afs. \sa blob.c. */
34 /** Contains audio file information. See aft.c. */
36 /** The table for the paraslash attributes. See attribute.c. */
39 * Paraslash's scoring system is based on Gaussian normal
40 * distributions, and the relevant data is stored in the rbtrees of an
41 * osl table containing only volatile columns. See score.c for
46 * A standard blob table containing the mood definitions. For details
50 /** A blob table containing lyrics on a per-song basis. */
52 /** Another blob table for images (for example album cover art). */
54 /** Yet another blob table for storing standard playlists. */
56 /** How many tables are in use? */
60 static struct afs_table afs_tables
[NUM_AFS_TABLES
] = {
61 [TBLNUM_AUDIO_FILES
] = {.init
= aft_init
, .name
= "audio_files"},
62 [TBLNUM_ATTRIBUTES
] = {.init
= attribute_init
, .name
= "attributes"},
63 [TBLNUM_SCORES
] = {.init
= score_init
, .name
= "scores"},
64 [TBLNUM_MOODS
] = {.init
= moods_init
, .name
= "moods"},
65 [TBLNUM_LYRICS
] = {.init
= lyrics_init
, .name
= "lyrics"},
66 [TBLNUM_IMAGES
] = {.init
= images_init
, .name
= "images"},
67 [TBLNUM_PLAYLIST
] = {.init
= playlists_init
, .name
= "playlists"},
71 /** The file descriptor for the local socket. */
74 * Value sent by the command handlers to identify themselves as
75 * children of the running para_server.
78 /** The associated task structure. */
83 extern struct misc_meta_data
*mmd
;
85 static int server_socket
;
86 static struct command_task command_task_struct
;
87 static struct signal_task signal_task_struct
;
89 static enum play_mode current_play_mode
;
90 static char *current_mop
; /* mode or playlist specifier. NULL means dummy mooe */
93 * A random number used to "authenticate" the connection.
95 * para_server picks this number by random before forking the afs process. The
96 * command handlers write this number together with the id of the shared memory
97 * area containing the query. This way, a malicious local user has to know this
98 * number to be able to cause the afs process to crash by sending fake queries.
100 extern uint32_t afs_socket_cookie
;
103 * Struct to let command handlers execute a callback in afs context.
105 * Commands that need to change the state of afs can't change the relevant data
106 * structures directly because commands are executed in a child process, i.e.
107 * they get their own virtual address space.
109 * This structure is used by \p send_callback_request() (executed from handler
110 * context) in order to let the afs process call the specified function. An
111 * instance of that structure is written to a shared memory area together with
112 * the arguments to the callback function. The identifier of the shared memory
113 * area is written to the command socket.
115 * The afs process accepts connections on the command socket and reads the
116 * shared memory id, attaches the corresponing area, calls the given handler to
117 * perform the desired action and to optionally compute a result.
119 * The result and a \p callback_result structure is then written to another
120 * shared memory area. The identifier for that area is written to the handler's
121 * command socket, so that the handler process can read the id, attach the
122 * shared memory area and use the result.
124 * \sa struct callback_result.
126 struct callback_query
{
127 /** The function to be called. */
128 callback_function
*handler
;
129 /** The number of bytes of the query */
134 * Structure embedded in the result of a callback.
136 * If the callback produced a result, an instance of that structure is embeeded
137 * into the shared memory area holding the result, mainly to let the command
138 * handler know the size of the result.
140 * \sa struct callback_query.
142 struct callback_result
{
143 /** The number of bytes of the result. */
145 /** The band designator (loglevel for the result). */
149 static int dispatch_result(int result_shmid
, callback_result_handler
*handler
,
150 void *private_result_data
)
152 struct osl_object result
;
154 /* must attach r/w as result.data might get encrypted in-place. */
155 int ret2
, ret
= shm_attach(result_shmid
, ATTACH_RW
, &result_shm
);
156 struct callback_result
*cr
= result_shm
;
159 PARA_ERROR_LOG("attach failed: %s\n", para_strerror(-ret
));
162 result
.size
= cr
->result_size
;
163 result
.data
= result_shm
+ sizeof(*cr
);
166 ret
= handler(&result
, cr
->band
, private_result_data
);
168 PARA_NOTICE_LOG("result handler error: %s\n",
169 para_strerror(-ret
));
171 ret2
= shm_detach(result_shm
);
173 PARA_ERROR_LOG("detach failed: %s\n", para_strerror(-ret2
));
181 * Ask the afs process to call a given function.
183 * \param f The function to be called.
184 * \param query Pointer to arbitrary data for the callback.
185 * \param result_handler Called for each shm area sent by the callback.
186 * \param private_result_data Passed verbatim to \a result_handler.
188 * This function creates a socket for communication with the afs process and a
189 * shared memory area (sma) to which the buffer pointed to by \a query is
190 * copied. It then notifies the afs process that the callback function \a f
191 * should be executed by sending the shared memory identifier (shmid) to the
194 * If the callback produces a result, it sends any number of shared memory
195 * identifiers back via the socket. For each such identifier received, \a
196 * result_handler is called. The contents of the sma identified by the received
197 * shmid are passed to that function as an osl object. The private_result_data
198 * pointer is passed as the second argument to \a result_handler.
200 * \return Number of shared memory areas dispatched on success, negative on errors.
202 * \sa send_option_arg_callback_request(), send_standard_callback_request().
204 int send_callback_request(callback_function
*f
, struct osl_object
*query
,
205 callback_result_handler
*result_handler
,
206 void *private_result_data
)
208 struct callback_query
*cq
;
209 int ret
, fd
= -1, query_shmid
, result_shmid
;
211 char buf
[sizeof(afs_socket_cookie
) + sizeof(int)];
212 size_t query_shm_size
= sizeof(*cq
);
213 int dispatch_error
= 0, num_dispatched
= 0;
216 query_shm_size
+= query
->size
;
217 ret
= shm_new(query_shm_size
);
221 ret
= shm_attach(query_shmid
, ATTACH_RW
, &query_shm
);
226 cq
->query_size
= query_shm_size
- sizeof(*cq
);
229 memcpy(query_shm
+ sizeof(*cq
), query
->data
, query
->size
);
230 ret
= shm_detach(query_shm
);
234 *(uint32_t *) buf
= afs_socket_cookie
;
235 *(int *) (buf
+ sizeof(afs_socket_cookie
)) = query_shmid
;
237 ret
= connect_local_socket(conf
.afs_socket_arg
);
241 ret
= write_all(fd
, buf
, sizeof(buf
));
245 * Read all shmids from afs.
247 * Even if the dispatcher returns an error we _must_ continue to read
248 * shmids from fd so that we can destroy all shared memory areas that
249 * have been created for us by the afs process.
252 ret
= recv_bin_buffer(fd
, buf
, sizeof(int));
255 assert(ret
== sizeof(int));
259 if (!dispatch_error
) {
260 ret
= dispatch_result(result_shmid
, result_handler
,
261 private_result_data
);
265 ret
= shm_destroy(result_shmid
);
267 PARA_CRIT_LOG("destroy result failed: %s\n",
268 para_strerror(-ret
));
272 if (shm_destroy(query_shmid
) < 0)
273 PARA_CRIT_LOG("shm destroy error\n");
276 // PARA_DEBUG_LOG("callback_ret: %d\n", ret);
277 return ret
< 0? ret
: num_dispatched
;
281 * Send a callback request passing an options structure and an argument vector.
283 * \param options pointer to an arbitrary data structure.
284 * \param argc Argument count.
285 * \param argv Standard argument vector.
286 * \param f The callback function.
287 * \param result_handler See \ref send_callback_request.
288 * \param private_result_data See \ref send_callback_request.
290 * Some commands have a couple of options that are parsed in child context for
291 * syntactic correctness and are stored in a special options structure for that
292 * command. This function allows to pass such a structure together with a list
293 * of further arguments (often a list of audio files) to the parent process.
295 * \return The return value of the underlying call to \ref
296 * send_callback_request().
298 * \sa send_standard_callback_request(), send_callback_request().
300 int send_option_arg_callback_request(struct osl_object
*options
,
301 int argc
, char * const * const argv
, callback_function
*f
,
302 callback_result_handler
*result_handler
,
303 void *private_result_data
)
307 struct osl_object query
= {.size
= options
? options
->size
: 0};
309 for (i
= 0; i
< argc
; i
++)
310 query
.size
+= strlen(argv
[i
]) + 1;
311 query
.data
= para_malloc(query
.size
);
314 memcpy(query
.data
, options
->data
, options
->size
);
317 for (i
= 0; i
< argc
; i
++) {
318 strcpy(p
, argv
[i
]); /* OK */
319 p
+= strlen(argv
[i
]) + 1;
321 ret
= send_callback_request(f
, &query
, result_handler
,
322 private_result_data
);
328 * Send a callback request with an argument vector only.
330 * \param argc The same meaning as in send_option_arg_callback_request().
331 * \param argv The same meaning as in send_option_arg_callback_request().
332 * \param f The same meaning as in send_option_arg_callback_request().
333 * \param result_handler See \ref send_callback_request.
334 * \param private_result_data See \ref send_callback_request.
336 * This is similar to send_option_arg_callback_request(), but no options buffer
337 * is passed to the parent process.
339 * \return The return value of the underlying call to
340 * send_option_arg_callback_request().
342 int send_standard_callback_request(int argc
, char * const * const argv
,
343 callback_function
*f
, callback_result_handler
*result_handler
,
344 void *private_result_data
)
346 return send_option_arg_callback_request(NULL
, argc
, argv
, f
, result_handler
,
347 private_result_data
);
350 static int action_if_pattern_matches(struct osl_row
*row
, void *data
)
352 struct pattern_match_data
*pmd
= data
;
353 struct osl_object name_obj
;
354 const char *p
, *name
;
355 int ret
= osl(osl_get_object(pmd
->table
, row
, pmd
->match_col_num
, &name_obj
));
356 const char *pattern_txt
= (const char *)pmd
->patterns
.data
;
360 name
= (char *)name_obj
.data
;
361 if ((!name
|| !*name
) && (pmd
->pm_flags
& PM_SKIP_EMPTY_NAME
))
363 if (!pmd
->patterns
.size
&& (pmd
->pm_flags
& PM_NO_PATTERN_MATCHES_EVERYTHING
))
364 return pmd
->action(pmd
->table
, row
, name
, pmd
->data
);
365 for (p
= pattern_txt
; p
< pattern_txt
+ pmd
->patterns
.size
;
366 p
+= strlen(p
) + 1) {
367 ret
= fnmatch(p
, name
, pmd
->fnmatch_flags
);
368 if (ret
== FNM_NOMATCH
)
372 ret
= pmd
->action(pmd
->table
, row
, name
, pmd
->data
);
381 * Execute the given function for each matching row.
383 * \param pmd Describes what to match and how.
387 int for_each_matching_row(struct pattern_match_data
*pmd
)
389 if (pmd
->pm_flags
& PM_REVERSE_LOOP
)
390 return osl(osl_rbtree_loop_reverse(pmd
->table
, pmd
->loop_col_num
, pmd
,
391 action_if_pattern_matches
));
392 return osl(osl_rbtree_loop(pmd
->table
, pmd
->loop_col_num
, pmd
,
393 action_if_pattern_matches
));
397 * Compare two osl objects of string type.
399 * \param obj1 Pointer to the first object.
400 * \param obj2 Pointer to the second object.
402 * In any case, only \p MIN(obj1->size, obj2->size) characters of each string
403 * are taken into account.
405 * \return It returns an integer less than, equal to, or greater than zero if
406 * \a obj1 is found, respectively, to be less than, to match, or be greater than
409 * \sa strcmp(3), strncmp(3), osl_compare_func.
411 int string_compare(const struct osl_object
*obj1
, const struct osl_object
*obj2
)
413 const char *str1
= (const char *)obj1
->data
;
414 const char *str2
= (const char *)obj2
->data
;
415 return strncmp(str1
, str2
, PARA_MIN(obj1
->size
, obj2
->size
));
418 static int pass_afd(int fd
, char *buf
, size_t size
)
420 struct msghdr msg
= {.msg_iov
= NULL
};
421 struct cmsghdr
*cmsg
;
432 msg
.msg_control
= control
;
433 msg
.msg_controllen
= sizeof(control
);
435 cmsg
= CMSG_FIRSTHDR(&msg
);
436 cmsg
->cmsg_level
= SOL_SOCKET
;
437 cmsg
->cmsg_type
= SCM_RIGHTS
;
438 cmsg
->cmsg_len
= CMSG_LEN(sizeof(int));
439 *(int *)CMSG_DATA(cmsg
) = fd
;
441 /* Sum of the length of all control messages in the buffer */
442 msg
.msg_controllen
= cmsg
->cmsg_len
;
443 PARA_DEBUG_LOG("passing %zu bytes and fd %d\n", size
, fd
);
444 ret
= sendmsg(server_socket
, &msg
, 0);
446 ret
= -ERRNO_TO_PARA_ERROR(errno
);
453 * Open the audio file with highest score.
455 * This stores all information for streaming the "best" audio file in a shared
456 * memory area. The id of that area and an open file descriptor for the next
457 * audio file are passed to the server process.
461 * \sa open_and_update_audio_file().
463 static int open_next_audio_file(void)
465 struct osl_row
*aft_row
;
466 struct audio_file_data afd
;
471 PARA_NOTICE_LOG("getting next audio file\n");
472 ret
= score_get_best(&aft_row
, &score
);
474 PARA_ERROR_LOG("%s\n", para_strerror(-ret
));
475 goto no_admissible_files
;
477 ret
= open_and_update_audio_file(aft_row
, score
, &afd
);
479 ret
= score_delete(aft_row
);
481 PARA_ERROR_LOG("%s\n", para_strerror(-ret
));
482 goto no_admissible_files
;
487 if (!write_ok(server_socket
)) {
491 *(uint32_t *)buf
= NEXT_AUDIO_FILE
;
492 *(uint32_t *)(buf
+ 4) = (uint32_t)shmid
;
493 ret
= pass_afd(afd
.fd
, buf
, 8);
501 *(uint32_t *)buf
= NO_ADMISSIBLE_FILES
;
502 *(uint32_t *)(buf
+ 4) = (uint32_t)0;
503 return write_all(server_socket
, buf
, 8);
506 /* Never fails if arg == NULL */
507 static int activate_mood_or_playlist(char *arg
, int *num_admissible
)
513 ret
= change_current_mood(NULL
); /* always successful */
514 mode
= PLAY_MODE_MOOD
;
516 if (!strncmp(arg
, "p/", 2)) {
517 ret
= playlist_open(arg
+ 2);
518 mode
= PLAY_MODE_PLAYLIST
;
519 } else if (!strncmp(arg
, "m/", 2)) {
520 ret
= change_current_mood(arg
+ 2);
521 mode
= PLAY_MODE_MOOD
;
523 return -E_AFS_SYNTAX
;
528 *num_admissible
= ret
;
529 current_play_mode
= mode
;
530 if (arg
!= current_mop
) {
533 current_mop
= para_strdup(arg
);
534 mutex_lock(mmd_mutex
);
535 strncpy(mmd
->afs_mode_string
, arg
,
536 sizeof(mmd
->afs_mode_string
));
537 mmd
->afs_mode_string
[sizeof(mmd
->afs_mode_string
) - 1] = '\0';
538 mutex_unlock(mmd_mutex
);
540 mutex_lock(mmd_mutex
);
541 strcpy(mmd
->afs_mode_string
, "dummy");
542 mutex_unlock(mmd_mutex
);
549 static void com_select_callback(int fd
, const struct osl_object
*query
)
551 struct para_buffer pb
= {
552 .max_size
= shm_get_shmmax(),
553 .private_data
= &(struct afs_max_size_handler_data
) {
557 .max_size_handler
= afs_max_size_handler
,
559 char *arg
= query
->data
;
560 int num_admissible
, ret
, ret2
;
562 ret
= clear_score_table();
564 ret2
= para_printf(&pb
, "%s\n", para_strerror(-ret
));
567 if (current_play_mode
== PLAY_MODE_MOOD
)
568 close_current_mood();
571 ret
= activate_mood_or_playlist(arg
, &num_admissible
);
573 ret2
= para_printf(&pb
, "%s\nswitching back to %s\n",
574 para_strerror(-ret
), current_mop
?
575 current_mop
: "dummy");
576 ret
= activate_mood_or_playlist(current_mop
, &num_admissible
);
579 ret2
= para_printf(&pb
, "failed, switching to dummy\n");
580 activate_mood_or_playlist(NULL
, &num_admissible
);
583 ret2
= para_printf(&pb
, "activated %s (%d admissible files)\n", current_mop
?
584 current_mop
: "dummy mood", num_admissible
);
586 if (ret2
>= 0 && pb
.offset
)
587 pass_buffer_as_shm(fd
, SBD_OUTPUT
, pb
.buf
, pb
.offset
);
592 * Result handler for sending data to the para_client process.
594 * \param result The data to be sent.
595 * \param band The band designator.
596 * \param private Pointer to the command context.
598 * \return The return value of the underlying call to \ref command.c::send_sb.
600 * \sa \ref callback_result_handler, \ref command.c::send_sb.
602 int afs_cb_result_handler(struct osl_object
*result
, uint8_t band
,
605 struct command_context
*cc
= private;
609 if (cc
->use_sideband
)
610 return send_sb(&cc
->scc
, result
->data
, result
->size
, band
,
612 return sc_send_bin_buffer(&cc
->scc
, result
->data
, result
->size
);
615 int com_select(struct command_context
*cc
)
617 struct osl_object query
;
620 return -E_AFS_SYNTAX
;
621 query
.data
= cc
->argv
[1];
622 query
.size
= strlen(cc
->argv
[1]) + 1;
623 return send_callback_request(com_select_callback
, &query
,
624 &afs_cb_result_handler
, cc
);
627 static void init_admissible_files(char *arg
)
629 if (activate_mood_or_playlist(arg
, NULL
) < 0)
630 activate_mood_or_playlist(NULL
, NULL
); /* always successful */
633 static int setup_command_socket_or_die(void)
636 char *socket_name
= conf
.afs_socket_arg
;
637 struct sockaddr_un unix_addr
;
640 ret
= create_local_socket(socket_name
, &unix_addr
,
641 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IWOTH
);
643 PARA_EMERG_LOG("%s: %s\n", para_strerror(-ret
), socket_name
);
647 if (listen(socket_fd
, 5) < 0) {
648 PARA_EMERG_LOG("can not listen on socket\n");
651 ret
= mark_fd_nonblocking(socket_fd
);
656 PARA_INFO_LOG("listening on socket %s (fd %d)\n", socket_name
,
661 static void close_afs_tables(void)
664 PARA_NOTICE_LOG("closing afs_tables\n");
665 for (i
= 0; i
< NUM_AFS_TABLES
; i
++)
666 afs_tables
[i
].close();
669 static char *database_dir
;
671 static void get_database_dir(void)
674 if (conf
.afs_database_dir_given
)
675 database_dir
= para_strdup(conf
.afs_database_dir_arg
);
677 char *home
= para_homedir();
678 database_dir
= make_message(
679 "%s/.paraslash/afs_database-0.4", home
);
683 PARA_INFO_LOG("afs_database dir %s\n", database_dir
);
686 static int make_database_dir(void)
691 ret
= para_mkdir(database_dir
, 0777);
692 if (ret
>= 0 || is_errno(-ret
, EEXIST
))
697 static int open_afs_tables(void)
702 PARA_NOTICE_LOG("opening %u osl tables in %s\n", NUM_AFS_TABLES
,
704 for (i
= 0; i
< NUM_AFS_TABLES
; i
++) {
705 ret
= afs_tables
[i
].open(database_dir
);
708 PARA_ERROR_LOG("%s init: %s\n", afs_tables
[i
].name
,
709 para_strerror(-ret
));
715 afs_tables
[--i
].close();
719 static void signal_pre_select(struct sched
*s
, struct task
*t
)
721 struct signal_task
*st
= container_of(t
, struct signal_task
, task
);
722 para_fd_set(st
->fd
, &s
->rfds
, &s
->max_fileno
);
725 static void afs_signal_post_select(struct sched
*s
, struct task
*t
)
729 if (getppid() == 1) {
730 PARA_EMERG_LOG("para_server died\n");
733 signum
= para_next_signal(&s
->rfds
);
736 if (signum
== SIGHUP
) {
738 parse_config_or_die(1);
739 t
->error
= open_afs_tables();
742 init_admissible_files(current_mop
);
745 PARA_EMERG_LOG("terminating on signal %d\n", signum
);
747 task_notify_all(s
, E_AFS_SIGNAL
);
748 t
->error
= -E_AFS_SIGNAL
;
751 static void register_signal_task(struct sched
*s
)
753 struct signal_task
*st
= &signal_task_struct
;
755 para_sigaction(SIGPIPE
, SIG_IGN
);
756 st
->fd
= para_signal_init();
757 PARA_INFO_LOG("signal pipe: fd %d\n", st
->fd
);
758 para_install_sighandler(SIGINT
);
759 para_install_sighandler(SIGTERM
);
760 para_install_sighandler(SIGHUP
);
762 st
->task
.pre_select
= signal_pre_select
;
763 st
->task
.post_select
= afs_signal_post_select
;
764 sprintf(st
->task
.status
, "signal task");
765 register_task(s
, &st
->task
);
768 static struct list_head afs_client_list
;
770 /** Describes on connected afs client. */
772 /** Position in the afs client list. */
773 struct list_head node
;
774 /** The socket file descriptor for this client. */
776 /** The time the client connected. */
777 struct timeval connect_time
;
780 static void command_pre_select(struct sched
*s
, struct task
*t
)
782 struct command_task
*ct
= container_of(t
, struct command_task
, task
);
783 struct afs_client
*client
;
785 para_fd_set(server_socket
, &s
->rfds
, &s
->max_fileno
);
786 para_fd_set(ct
->fd
, &s
->rfds
, &s
->max_fileno
);
787 list_for_each_entry(client
, &afs_client_list
, node
)
788 para_fd_set(client
->fd
, &s
->rfds
, &s
->max_fileno
);
792 * Send data as shared memory to a file descriptor.
794 * \param fd File descriptor to send the shmid to.
795 * \param band The band designator for this data.
796 * \param buf The buffer holding the data to be sent.
797 * \param size The size of \a buf.
799 * This function creates a shared memory area large enough to hold
800 * the content given by \a buf and \a size and sends the identifier
801 * of this area to the file descriptor \a fd.
803 * It is called by the AFS max_size handler as well as directly by the AFS
804 * command callbacks to send command output to the command handlers.
806 * \return Zero if \a buf is \p NULL or \a size is zero. Negative on errors,
807 * and positive on success.
809 int pass_buffer_as_shm(int fd
, uint8_t band
, char *buf
, size_t size
)
813 struct callback_result
*cr
;
817 ret
= shm_new(size
+ sizeof(*cr
));
821 ret
= shm_attach(shmid
, ATTACH_RW
, &shm
);
825 cr
->result_size
= size
;
827 memcpy(shm
+ sizeof(*cr
), buf
, size
);
828 ret
= shm_detach(shm
);
831 ret
= write_all(fd
, (char *)&shmid
, sizeof(int));
835 if (shm_destroy(shmid
) < 0)
836 PARA_ERROR_LOG("destroy result failed\n");
841 * On errors, negative value is written to fd.
842 * On success: If query produced a result, the result_shmid is written to fd.
843 * Otherwise, zero is written.
845 static int call_callback(int fd
, int query_shmid
)
848 struct callback_query
*cq
;
849 struct osl_object query
;
852 ret
= shm_attach(query_shmid
, ATTACH_RW
, &query_shm
);
856 query
.data
= (char *)query_shm
+ sizeof(*cq
);
857 query
.size
= cq
->query_size
;
858 cq
->handler(fd
, &query
);
859 return shm_detach(query_shm
);
862 static int execute_server_command(fd_set
*rfds
)
866 int ret
= read_nonblock(server_socket
, buf
, sizeof(buf
) - 1, rfds
, &n
);
868 if (ret
< 0 || n
== 0)
871 if (strcmp(buf
, "new"))
873 return open_next_audio_file();
876 /* returns 0 if no data available, 1 else */
877 static int execute_afs_command(int fd
, fd_set
*rfds
, uint32_t expected_cookie
)
881 char buf
[sizeof(cookie
) + sizeof(query_shmid
)];
883 int ret
= read_nonblock(fd
, buf
, sizeof(buf
), rfds
, &n
);
889 if (n
!= sizeof(buf
)) {
890 PARA_NOTICE_LOG("short read (%d bytes, expected %lu)\n",
891 ret
, (long unsigned) sizeof(buf
));
894 cookie
= *(uint32_t *)buf
;
895 if (cookie
!= expected_cookie
) {
896 PARA_NOTICE_LOG("received invalid cookie (got %u, expected %u)\n",
897 (unsigned)cookie
, (unsigned)expected_cookie
);
900 query_shmid
= *(int *)(buf
+ sizeof(cookie
));
901 if (query_shmid
< 0) {
902 PARA_WARNING_LOG("received invalid query shmid %d)\n",
906 ret
= call_callback(fd
, query_shmid
);
910 PARA_NOTICE_LOG("%s\n", para_strerror(-ret
));
914 /** Shutdown connection if query has not arrived until this many seconds. */
915 #define AFS_CLIENT_TIMEOUT 3
917 static void command_post_select(struct sched
*s
, struct task
*t
)
919 struct command_task
*ct
= container_of(t
, struct command_task
, task
);
920 struct sockaddr_un unix_addr
;
921 struct afs_client
*client
, *tmp
;
924 ret
= task_get_notification(t
);
929 ret
= execute_server_command(&s
->rfds
);
931 PARA_EMERG_LOG("%s\n", para_strerror(-ret
));
932 task_notify_all(s
, -ret
);
936 /* Check the list of connected clients. */
937 list_for_each_entry_safe(client
, tmp
, &afs_client_list
, node
) {
938 ret
= execute_afs_command(client
->fd
, &s
->rfds
, ct
->cookie
);
939 if (ret
== 0) { /* prevent bogus connection flooding */
941 tv_diff(now
, &client
->connect_time
, &diff
);
942 if (diff
.tv_sec
< AFS_CLIENT_TIMEOUT
)
944 PARA_WARNING_LOG("connection timeout\n");
947 list_del(&client
->node
);
950 /* Accept connections on the local socket. */
951 ret
= para_accept(ct
->fd
, &s
->rfds
, &unix_addr
, sizeof(unix_addr
), &fd
);
953 PARA_NOTICE_LOG("%s\n", para_strerror(-ret
));
956 ret
= mark_fd_nonblocking(fd
);
958 PARA_NOTICE_LOG("%s\n", para_strerror(-ret
));
962 client
= para_malloc(sizeof(*client
));
964 client
->connect_time
= *now
;
965 para_list_add(&client
->node
, &afs_client_list
);
968 static void register_command_task(uint32_t cookie
, struct sched
*s
)
970 struct command_task
*ct
= &command_task_struct
;
971 ct
->fd
= setup_command_socket_or_die();
974 ct
->task
.pre_select
= command_pre_select
;
975 ct
->task
.post_select
= command_post_select
;
976 sprintf(ct
->task
.status
, "afs command task");
977 register_task(s
, &ct
->task
);
981 * Initialize the audio file selector process.
983 * \param cookie The value used for "authentication".
984 * \param socket_fd File descriptor used for communication with the server.
986 __noreturn
void afs_init(uint32_t cookie
, int socket_fd
)
988 static struct sched s
;
991 register_signal_task(&s
);
992 INIT_LIST_HEAD(&afs_client_list
);
993 for (i
= 0; i
< NUM_AFS_TABLES
; i
++)
994 afs_tables
[i
].init(&afs_tables
[i
]);
995 ret
= open_afs_tables();
998 server_socket
= socket_fd
;
999 ret
= mark_fd_nonblocking(server_socket
);
1002 PARA_INFO_LOG("server_socket: %d, afs_socket_cookie: %u\n",
1003 server_socket
, (unsigned) cookie
);
1004 init_admissible_files(conf
.afs_initial_mode_arg
);
1005 register_command_task(cookie
, &s
);
1006 s
.default_timeout
.tv_sec
= 0;
1007 s
.default_timeout
.tv_usec
= 999 * 1000;
1013 PARA_EMERG_LOG("%s\n", para_strerror(-ret
));
1017 static void create_tables_callback(int fd
, const struct osl_object
*query
)
1019 uint32_t table_mask
= *(uint32_t *)query
->data
;
1021 struct para_buffer pb
= {.buf
= NULL
};
1024 for (i
= 0; i
< NUM_AFS_TABLES
; i
++) {
1025 struct afs_table
*t
= &afs_tables
[i
];
1027 if (!(table_mask
& (1 << i
)))
1031 ret
= t
->create(database_dir
);
1034 para_printf(&pb
, "successfully created %s table\n", t
->name
);
1036 ret
= open_afs_tables();
1039 para_printf(&pb
, "%s\n", para_strerror(-ret
));
1041 pass_buffer_as_shm(fd
, SBD_OUTPUT
, pb
.buf
, pb
.offset
);
1045 int com_init(struct command_context
*cc
)
1048 uint32_t table_mask
= (1 << (NUM_AFS_TABLES
+ 1)) - 1;
1049 struct osl_object query
= {.data
= &table_mask
,
1050 .size
= sizeof(table_mask
)};
1052 ret
= make_database_dir();
1055 if (cc
->argc
!= 1) {
1057 for (i
= 1; i
< cc
->argc
; i
++) {
1058 for (j
= 0; j
< NUM_AFS_TABLES
; j
++) {
1059 struct afs_table
*t
= &afs_tables
[j
];
1061 if (strcmp(cc
->argv
[i
], t
->name
))
1063 table_mask
|= (1 << j
);
1066 if (j
== NUM_AFS_TABLES
)
1067 return -E_BAD_TABLE_NAME
;
1070 ret
= send_callback_request(create_tables_callback
, &query
,
1071 afs_cb_result_handler
, cc
);
1072 if (ret
< 0 && !cc
->use_sideband
)
1073 /* ignore return value */
1074 sc_send_va_buffer(&cc
->scc
, "%s\n", para_strerror(-ret
));
1079 * Flags for the check command.
1083 enum com_check_flags
{
1084 /** Check the audio file table. */
1086 /** Check the mood table. */
1088 /** Check the playlist table. */
1092 int com_check(struct command_context
*cc
)
1097 for (i
= 1; i
< cc
->argc
; i
++) {
1098 const char *arg
= cc
->argv
[i
];
1101 if (!strcmp(arg
, "--")) {
1105 if (!strcmp(arg
, "-a")) {
1109 if (!strcmp(arg
, "-p")) {
1110 flags
|= CHECK_PLAYLISTS
;
1113 if (!strcmp(arg
, "-m")) {
1114 flags
|= CHECK_MOODS
;
1117 return -E_AFS_SYNTAX
;
1120 return -E_AFS_SYNTAX
;
1123 if (flags
& CHECK_AFT
) {
1124 ret
= send_callback_request(aft_check_callback
, NULL
,
1125 afs_cb_result_handler
, cc
);
1129 if (flags
& CHECK_PLAYLISTS
) {
1130 ret
= send_callback_request(playlist_check_callback
,
1131 NULL
, afs_cb_result_handler
, cc
);
1135 if (flags
& CHECK_MOODS
) {
1136 ret
= send_callback_request(mood_check_callback
, NULL
,
1137 afs_cb_result_handler
, cc
);
1145 * The afs event dispatcher.
1147 * \param event Type of the event.
1148 * \param pb May be \p NULL.
1149 * \param data Type depends on \a event.
1151 * This function calls the table handlers of all tables and passes \a pb and \a
1152 * data verbatim. It's up to the handlers to interpret the \a data pointer.
1154 void afs_event(enum afs_events event
, struct para_buffer
*pb
,
1159 for (i
= 0; i
< NUM_AFS_TABLES
; i
++) {
1160 struct afs_table
*t
= &afs_tables
[i
];
1161 if (!t
->event_handler
)
1163 ret
= t
->event_handler(event
, pb
, data
);
1165 PARA_CRIT_LOG("table %s, event %d: %s\n", t
->name
,
1166 event
, para_strerror(-ret
));
1171 * Dummy event handler for the images table.
1173 * \param event Unused.
1175 * \param data Unused.
1177 * \return The images table does not honor events, so this handler always
1180 __a_const
int images_event_handler(__a_unused
enum afs_events event
,
1181 __a_unused
struct para_buffer
*pb
, __a_unused
void *data
)
1187 * Dummy event handler for the lyrics table.
1189 * \param event Unused.
1191 * \param data Unused.
1193 * \return The lyrics table does not honor events, so this handler always
1196 __a_const
int lyrics_event_handler(__a_unused
enum afs_events event
,
1197 __a_unused
struct para_buffer
*pb
, __a_unused
void *data
)