2 * Copyright (C) 2007-2009 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. */
11 #include "server.cmdline.h"
18 #include <dirent.h> /* readdir() */
28 /** The osl tables used by afs. \sa blob.c. */
30 /** Contains audio file information. See aft.c. */
32 /** The table for the paraslash attributes. See attribute.c. */
35 * Paraslash's scoring system is based on Gaussian normal
36 * distributions, and the relevant data is stored in the rbtrees of an
37 * osl table containing only volatile columns. See score.c for
42 * A standard blob table containing the mood definitions. For details
46 /** A blob table containing lyrics on a per-song basis. */
48 /** Another blob table for images (for example album cover art). */
50 /** Yet another blob table for storing standard playlists. */
52 /** How many tables are in use? */
56 static struct afs_table afs_tables
[NUM_AFS_TABLES
] = {
57 [TBLNUM_AUDIO_FILES
] = {.init
= aft_init
},
58 [TBLNUM_ATTRIBUTES
] = {.init
= attribute_init
},
59 [TBLNUM_SCORES
] = {.init
= score_init
},
60 [TBLNUM_MOODS
] = {.init
= moods_init
},
61 [TBLNUM_LYRICS
] = {.init
= lyrics_init
},
62 [TBLNUM_IMAGES
] = {.init
= images_init
},
63 [TBLNUM_PLAYLIST
] = {.init
= playlists_init
},
67 /** The file descriptor for the local socket. */
70 * Value sent by the command handlers to identify themselves as
71 * children of the running para_server.
74 /** The associated task structure. */
79 extern struct misc_meta_data
*mmd
;
81 static int server_socket
;
82 static struct command_task command_task_struct
;
83 static struct signal_task signal_task_struct
;
85 static enum play_mode current_play_mode
;
86 static char *current_mop
; /* mode or playlist specifier. NULL means dummy mooe */
90 * A random number used to "authenticate" the connection.
92 * para_server picks this number by random before forking the afs process. The
93 * command handlers write this number together with the id of the shared memory
94 * area containing the query. This way, a malicious local user has to know this
95 * number to be able to cause the afs process to crash by sending fake queries.
97 extern uint32_t afs_socket_cookie
;
100 * Struct to let command handlers execute a callback in afs context.
102 * Commands that need to change the state of afs can't change the relevant data
103 * structures directly because commands are executed in a child process, i.e.
104 * they get their own virtual address space.
106 * This structure is used by \p send_callback_request() (executed from handler
107 * context) in order to let the afs process call the specified function. An
108 * instance of that structure is written to a shared memory area together with
109 * the arguments to the callback function. The identifier of the shared memory
110 * area is written to the command socket.
112 * The afs process accepts connections on the command socket and reads the
113 * shared memory id, attaches the corresponing area, calls the given handler to
114 * perform the desired action and to optionally compute a result.
116 * The result and a \p callback_result structure is then written to another
117 * shared memory area. The identifier for that area is written to the handler's
118 * command socket, so that the handler process can read the id, attach the
119 * shared memory area and use the result.
121 * \sa struct callback_result.
123 struct callback_query
{
124 /** The function to be called. */
125 callback_function
*handler
;
126 /** The number of bytes of the query */
131 * Structure embedded in the result of a callback.
133 * If the callback produced a result, an instance of that structure is embeeded
134 * into the shared memory area holding the result, mainly to let the command
135 * handler know the size of the result.
137 * \sa struct callback_query.
139 struct callback_result
{
140 /** The number of bytes of the result. */
144 static int dispatch_result(int result_shmid
, callback_result_handler
*handler
,
145 void *private_result_data
)
147 struct osl_object result
;
149 int ret2
, ret
= shm_attach(result_shmid
, ATTACH_RO
, &result_shm
);
150 struct callback_result
*cr
= result_shm
;
153 PARA_ERROR_LOG("attach failed: %s\n", para_strerror(-ret
));
156 result
.size
= cr
->result_size
;
157 result
.data
= result_shm
+ sizeof(*cr
);
160 ret
= handler(&result
, private_result_data
);
162 PARA_NOTICE_LOG("result handler error: %s\n",
163 para_strerror(-ret
));
165 ret2
= shm_detach(result_shm
);
167 PARA_ERROR_LOG("detach failed: %s\n", para_strerror(-ret2
));
175 * Ask the afs process to call a given function.
177 * \param f The function to be called.
178 * \param query Pointer to arbitrary data for the callback.
179 * \param result_handler Called for each shm area sent by the callback.
180 * \param private_result_data Passed verbatim to \a result_handler.
182 * This function creates a socket for communication with the afs process and a
183 * shared memory area (sma) to which the buffer pointed to by \a query is
184 * copied. It then notifies the afs process that the callback function \a f
185 * should be executed by sending the shared memory identifier (shmid) to the
188 * If the callback produces a result, it sends any number of shared memory
189 * identifiers back via the socket. For each such identifier received, \a
190 * result_handler is called. The contents of the sma identified by the received
191 * shmid are passed to that function as an osl object. The private_result_data
192 * pointer is passed as the second argument to \a result_handler.
196 * \sa send_option_arg_callback_request(), send_standard_callback_request().
198 int send_callback_request(callback_function
*f
, struct osl_object
*query
,
199 callback_result_handler
*result_handler
,
200 void *private_result_data
)
202 struct callback_query
*cq
;
203 int ret
, fd
= -1, query_shmid
, result_shmid
;
205 char buf
[sizeof(afs_socket_cookie
) + sizeof(int)];
206 size_t query_shm_size
= sizeof(*cq
);
207 int dispatch_error
= 0;
210 query_shm_size
+= query
->size
;
211 ret
= shm_new(query_shm_size
);
215 ret
= shm_attach(query_shmid
, ATTACH_RW
, &query_shm
);
220 cq
->query_size
= query_shm_size
- sizeof(*cq
);
223 memcpy(query_shm
+ sizeof(*cq
), query
->data
, query
->size
);
224 ret
= shm_detach(query_shm
);
228 *(uint32_t *) buf
= afs_socket_cookie
;
229 *(int *) (buf
+ sizeof(afs_socket_cookie
)) = query_shmid
;
231 ret
= create_remote_socket(conf
.afs_socket_arg
);
235 ret
= send_bin_buffer(fd
, buf
, sizeof(buf
));
239 * Read all shmids from afs.
241 * Even if the dispatcher returns an error we _must_ continue to read
242 * shmids from fd so that we can destroy all shared memory areas that
243 * have been created for us by the afs process.
246 ret
= recv_bin_buffer(fd
, buf
, sizeof(int));
249 assert(ret
== sizeof(int));
253 if (!dispatch_error
) {
254 ret
= dispatch_result(result_shmid
, result_handler
,
255 private_result_data
);
259 ret
= shm_destroy(result_shmid
);
261 PARA_CRIT_LOG("destroy result failed: %s\n",
262 para_strerror(-ret
));
265 if (shm_destroy(query_shmid
) < 0)
266 PARA_CRIT_LOG("shm destroy error\n");
269 // PARA_DEBUG_LOG("callback_ret: %d\n", ret);
274 * Send a callback request passing an options structure and an argument vector.
276 * \param options pointer to an arbitrary data structure.
277 * \param argc Argument count.
278 * \param argv Standard argument vector.
279 * \param f The callback function.
280 * \param result_handler See \ref send_callback_request.
281 * \param private_result_data See \ref send_callback_request.
283 * Some commands have a couple of options that are parsed in child context for
284 * syntactic correctness and are stored in a special options structure for that
285 * command. This function allows to pass such a structure together with a list
286 * of further arguments (often a list of audio files) to the parent process.
288 * \sa send_standard_callback_request(), send_callback_request().
290 int send_option_arg_callback_request(struct osl_object
*options
,
291 int argc
, char * const * const argv
, callback_function
*f
,
292 callback_result_handler
*result_handler
,
293 void *private_result_data
)
297 struct osl_object query
= {.size
= options
? options
->size
: 0};
299 for (i
= 0; i
< argc
; i
++)
300 query
.size
+= strlen(argv
[i
]) + 1;
301 query
.data
= para_malloc(query
.size
);
304 memcpy(query
.data
, options
->data
, options
->size
);
307 for (i
= 0; i
< argc
; i
++) {
308 strcpy(p
, argv
[i
]); /* OK */
309 p
+= strlen(argv
[i
]) + 1;
311 ret
= send_callback_request(f
, &query
, result_handler
,
312 private_result_data
);
318 * Send a callback request with an argument vector only.
320 * \param argc The same meaning as in send_option_arg_callback_request().
321 * \param argv The same meaning as in send_option_arg_callback_request().
322 * \param f The same meaning as in send_option_arg_callback_request().
323 * \param result_handler See \ref send_callback_request.
324 * \param private_result_data See \ref send_callback_request.
326 * This is similar to send_option_arg_callback_request(), but no options buffer
327 * is passed to the parent process.
329 * \return The return value of the underlying call to
330 * send_option_arg_callback_request().
332 int send_standard_callback_request(int argc
, char * const * const argv
,
333 callback_function
*f
, callback_result_handler
*result_handler
,
334 void *private_result_data
)
336 return send_option_arg_callback_request(NULL
, argc
, argv
, f
, result_handler
,
337 private_result_data
);
340 static int action_if_pattern_matches(struct osl_row
*row
, void *data
)
342 struct pattern_match_data
*pmd
= data
;
343 struct osl_object name_obj
;
344 const char *p
, *name
;
345 int ret
= osl_get_object(pmd
->table
, row
, pmd
->match_col_num
, &name_obj
);
346 const char *pattern_txt
= (const char *)pmd
->patterns
.data
;
350 name
= (char *)name_obj
.data
;
351 if ((!name
|| !*name
) && (pmd
->pm_flags
& PM_SKIP_EMPTY_NAME
))
353 if (!pmd
->patterns
.size
&& (pmd
->pm_flags
& PM_NO_PATTERN_MATCHES_EVERYTHING
))
354 return pmd
->action(pmd
->table
, row
, name
, pmd
->data
);
355 for (p
= pattern_txt
; p
< pattern_txt
+ pmd
->patterns
.size
;
356 p
+= strlen(p
) + 1) {
357 ret
= fnmatch(p
, name
, pmd
->fnmatch_flags
);
358 if (ret
== FNM_NOMATCH
)
362 return pmd
->action(pmd
->table
, row
, name
, pmd
->data
);
368 * Execute the given function for each matching row.
370 * \param pmd Describes what to match and how.
372 * \return The return value of the underlying call to osl_rbtree_loop()
373 * or osl_rbtree_loop_reverse().
375 int for_each_matching_row(struct pattern_match_data
*pmd
)
377 if (pmd
->pm_flags
& PM_REVERSE_LOOP
)
378 return osl_rbtree_loop_reverse(pmd
->table
, pmd
->loop_col_num
, pmd
,
379 action_if_pattern_matches
);
380 return osl_rbtree_loop(pmd
->table
, pmd
->loop_col_num
, pmd
,
381 action_if_pattern_matches
);
385 * Compare two osl objects of string type.
387 * \param obj1 Pointer to the first object.
388 * \param obj2 Pointer to the second object.
390 * In any case, only \p MIN(obj1->size, obj2->size) characters of each string
391 * are taken into account.
393 * \return It returns an integer less than, equal to, or greater than zero if
394 * \a obj1 is found, respectively, to be less than, to match, or be greater than
397 * \sa strcmp(3), strncmp(3), osl_compare_func.
399 int string_compare(const struct osl_object
*obj1
, const struct osl_object
*obj2
)
401 const char *str1
= (const char *)obj1
->data
;
402 const char *str2
= (const char *)obj2
->data
;
403 return strncmp(str1
, str2
, PARA_MIN(obj1
->size
, obj2
->size
));
407 * write input from fd to dynamically allocated buffer,
408 * but maximal max_size byte.
410 static int fd2buf(int fd
, unsigned max_size
, struct osl_object
*obj
)
412 const size_t chunk_size
= 1024;
413 size_t size
= 2048, received
= 0;
415 char *buf
= para_malloc(size
);
418 ret
= recv_bin_buffer(fd
, buf
+ received
, chunk_size
);
422 if (received
+ chunk_size
>= size
) {
424 ret
= -E_INPUT_TOO_LARGE
;
427 buf
= para_realloc(buf
, size
);
431 obj
->size
= received
;
438 * Read data from a file descriptor, and send it to the afs process.
440 * \param fd File descriptor to read data from.
441 * \param arg_obj Pointer to the arguments to \a f.
442 * \param f The callback function.
443 * \param max_len Don't read more than that many bytes from stdin.
444 * \param result_handler See \ref send_callback_request.
445 * \param private_result_data See \ref send_callback_request.
447 * This function is used by commands that wish to let para_server store
448 * arbitrary data specified by the user (for instance the add_blob family of
449 * commands). First, at most \a max_len bytes are read from \a fd, the result
450 * is concatenated with the buffer given by \a arg_obj, and the combined buffer
451 * is made available to the afs process via the callback method. See \ref
452 * send_callback_request for details.
454 * \return Negative on errors, the return value of the underlying call to
455 * send_callback_request() otherwise.
457 int stdin_command(int fd
, struct osl_object
*arg_obj
, callback_function
*f
,
458 unsigned max_len
, callback_result_handler
*result_handler
,
459 void *private_result_data
)
461 struct osl_object query
, stdin_obj
;
464 ret
= send_buffer(fd
, AWAITING_DATA_MSG
);
467 ret
= fd2buf(fd
, max_len
, &stdin_obj
);
470 query
.size
= arg_obj
->size
+ stdin_obj
.size
;
471 query
.data
= para_malloc(query
.size
);
472 memcpy(query
.data
, arg_obj
->data
, arg_obj
->size
);
473 memcpy((char *)query
.data
+ arg_obj
->size
, stdin_obj
.data
, stdin_obj
.size
);
474 free(stdin_obj
.data
);
475 ret
= send_callback_request(f
, &query
, result_handler
, private_result_data
);
480 static int pass_afd(int fd
, char *buf
, size_t size
)
482 struct msghdr msg
= {.msg_iov
= NULL
};
483 struct cmsghdr
*cmsg
;
494 msg
.msg_control
= control
;
495 msg
.msg_controllen
= sizeof(control
);
497 cmsg
= CMSG_FIRSTHDR(&msg
);
498 cmsg
->cmsg_level
= SOL_SOCKET
;
499 cmsg
->cmsg_type
= SCM_RIGHTS
;
500 cmsg
->cmsg_len
= CMSG_LEN(sizeof(int));
501 *(int *)CMSG_DATA(cmsg
) = fd
;
503 /* Sum of the length of all control messages in the buffer */
504 msg
.msg_controllen
= cmsg
->cmsg_len
;
505 PARA_DEBUG_LOG("passing %zu bytes and fd %d\n", size
, fd
);
506 ret
= sendmsg(server_socket
, &msg
, 0);
508 ret
= -ERRNO_TO_PARA_ERROR(errno
);
515 * Open the audio file with highest score.
517 * This stores all information for streaming the "best" audio file in a shared
518 * memory area. The id of that area and an open file descriptor for the next
519 * audio file are passed to the server process.
523 * \sa open_and_update_audio_file().
525 static int open_next_audio_file(void)
527 struct osl_row
*aft_row
;
528 struct audio_file_data afd
;
533 PARA_NOTICE_LOG("getting next audio file\n");
534 ret
= score_get_best(&aft_row
, &score
);
536 PARA_ERROR_LOG("%s\n", para_strerror(-ret
));
537 goto no_admissible_files
;
539 ret
= open_and_update_audio_file(aft_row
, score
, &afd
);
541 PARA_ERROR_LOG("%s\n", para_strerror(-ret
));
542 ret
= score_delete(aft_row
);
544 PARA_ERROR_LOG("%s\n", para_strerror(-ret
));
545 goto no_admissible_files
;
550 if (!write_ok(server_socket
)) {
554 *(uint32_t *)buf
= NEXT_AUDIO_FILE
;
555 *(uint32_t *)(buf
+ 4) = (uint32_t)shmid
;
556 ret
= pass_afd(afd
.fd
, buf
, 8);
564 *(uint32_t *)buf
= NO_ADMISSIBLE_FILES
;
565 *(uint32_t *)(buf
+ 4) = (uint32_t)0;
566 return send_bin_buffer(server_socket
, buf
, 8);
569 /* Never fails if arg == NULL */
570 static int activate_mood_or_playlist(char *arg
, int *num_admissible
)
576 ret
= change_current_mood(NULL
); /* always successful */
577 mode
= PLAY_MODE_MOOD
;
579 if (!strncmp(arg
, "p/", 2)) {
580 ret
= playlist_open(arg
+ 2);
581 mode
= PLAY_MODE_PLAYLIST
;
582 } else if (!strncmp(arg
, "m/", 2)) {
583 ret
= change_current_mood(arg
+ 2);
584 mode
= PLAY_MODE_MOOD
;
586 return -E_AFS_SYNTAX
;
591 *num_admissible
= ret
;
592 current_play_mode
= mode
;
593 if (arg
!= current_mop
) {
596 current_mop
= para_strdup(arg
);
597 mutex_lock(mmd_mutex
);
598 strncpy(mmd
->afs_mode_string
, arg
,
599 sizeof(mmd
->afs_mode_string
));
600 mmd
->afs_mode_string
[sizeof(mmd
->afs_mode_string
) - 1] = '\0';
601 mutex_unlock(mmd_mutex
);
603 mutex_lock(mmd_mutex
);
604 strcpy(mmd
->afs_mode_string
, "dummy");
605 mutex_unlock(mmd_mutex
);
612 static void com_select_callback(int fd
, const struct osl_object
*query
)
614 struct para_buffer pb
= {
617 .max_size_handler
= pass_buffer_as_shm
619 char *arg
= query
->data
;
620 int num_admissible
, ret
, ret2
;
622 ret
= clear_score_table();
624 ret2
= para_printf(&pb
, "%s\n", para_strerror(-ret
));
627 if (current_play_mode
== PLAY_MODE_MOOD
)
628 close_current_mood();
631 ret
= activate_mood_or_playlist(arg
, &num_admissible
);
633 ret2
= para_printf(&pb
, "%s\nswitching back to %s\n",
634 para_strerror(-ret
), current_mop
?
635 current_mop
: "dummy");
636 ret
= activate_mood_or_playlist(current_mop
, &num_admissible
);
639 ret2
= para_printf(&pb
, "failed, switching to dummy\n");
640 activate_mood_or_playlist(NULL
, &num_admissible
);
643 ret2
= para_printf(&pb
, "activated %s (%d admissible files)\n", current_mop
?
644 current_mop
: "dummy mood", num_admissible
);
646 if (ret2
>= 0 && pb
.offset
)
647 pass_buffer_as_shm(pb
.buf
, pb
.offset
, &fd
);
652 * Result handler for sending data to the para_client process.
654 * \param result The data to be sent.
655 * \param fd_ptr Pointer to the file descriptor.
657 * \return The return value of the underlying call to send_bin_buffer().
659 * \sa \ref callback_result_handler.
661 int send_result(struct osl_object
*result
, void *fd_ptr
)
663 int fd
= *(int *)fd_ptr
;
666 return send_bin_buffer(fd
, result
->data
, result
->size
);
669 int com_select(int fd
, int argc
, char * const * const argv
)
671 struct osl_object query
;
674 return -E_AFS_SYNTAX
;
675 query
.data
= argv
[1];
676 query
.size
= strlen(argv
[1]) + 1;
677 return send_callback_request(com_select_callback
, &query
,
681 static void init_admissible_files(char *arg
)
683 if (activate_mood_or_playlist(arg
, NULL
) < 0)
684 activate_mood_or_playlist(NULL
, NULL
); /* always successful */
687 static int setup_command_socket_or_die(void)
690 char *socket_name
= conf
.afs_socket_arg
;
691 struct sockaddr_un unix_addr
;
694 ret
= create_local_socket(socket_name
, &unix_addr
,
695 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IWOTH
);
697 PARA_EMERG_LOG("%s: %s\n", para_strerror(-ret
), socket_name
);
701 if (listen(socket_fd
, 5) < 0) {
702 PARA_EMERG_LOG("can not listen on socket\n");
705 ret
= mark_fd_nonblocking(socket_fd
);
710 PARA_INFO_LOG("listening on socket %s (fd %d)\n", socket_name
,
715 static void close_afs_tables(void)
718 PARA_NOTICE_LOG("closing afs_tables\n");
719 for (i
= 0; i
< NUM_AFS_TABLES
; i
++)
720 afs_tables
[i
].close();
723 static char *database_dir
;
725 static void get_database_dir(void)
728 if (conf
.afs_database_dir_given
)
729 database_dir
= para_strdup(conf
.afs_database_dir_arg
);
731 char *home
= para_homedir();
732 database_dir
= make_message(
733 "%s/.paraslash/afs_database", home
);
737 PARA_INFO_LOG("afs_database dir %s\n", database_dir
);
740 static int make_database_dir(void)
745 ret
= para_mkdir(database_dir
, 0777);
746 if (ret
>= 0 || is_errno(-ret
, EEXIST
))
751 static int open_afs_tables(void)
756 PARA_NOTICE_LOG("opening %u osl tables in %s\n", NUM_AFS_TABLES
,
758 for (i
= 0; i
< NUM_AFS_TABLES
; i
++) {
759 ret
= afs_tables
[i
].open(database_dir
);
762 PARA_ERROR_LOG("%s init: %s\n", afs_tables
[i
].name
,
763 para_strerror(-ret
));
769 afs_tables
[--i
].close();
773 static void signal_pre_select(struct sched
*s
, struct task
*t
)
775 struct signal_task
*st
= container_of(t
, struct signal_task
, task
);
776 para_fd_set(st
->fd
, &s
->rfds
, &s
->max_fileno
);
779 static void signal_post_select(struct sched
*s
, struct task
*t
)
781 struct signal_task
*st
= container_of(t
, struct signal_task
, task
);
782 if (getppid() == 1) {
783 PARA_EMERG_LOG("para_server died\n");
786 if (!FD_ISSET(st
->fd
, &s
->rfds
))
788 st
->signum
= para_next_signal();
789 if (st
->signum
== SIGHUP
) {
791 parse_config_or_die(1);
792 t
->error
= open_afs_tables();
795 init_admissible_files(current_mop
);
798 PARA_EMERG_LOG("terminating on signal %d\n", st
->signum
);
801 t
->error
= -E_AFS_SIGNAL
;
804 static void register_signal_task(void)
806 struct signal_task
*st
= &signal_task_struct
;
808 if (signal(SIGPIPE
, SIG_IGN
) == SIG_ERR
) {
809 PARA_EMERG_LOG("failed to ignore SIGPIPE\n");
812 if (signal(SIGUSR1
, SIG_IGN
) == SIG_ERR
) {
813 PARA_EMERG_LOG("failed to ignore SIGUSR1\n");
816 st
->fd
= para_signal_init();
817 PARA_INFO_LOG("signal pipe: fd %d\n", st
->fd
);
818 para_install_sighandler(SIGINT
);
819 para_install_sighandler(SIGTERM
);
820 para_install_sighandler(SIGHUP
);
822 st
->task
.pre_select
= signal_pre_select
;
823 st
->task
.post_select
= signal_post_select
;
824 sprintf(st
->task
.status
, "signal task");
825 register_task(&st
->task
);
828 static struct list_head afs_client_list
;
830 /** Describes on connected afs client. */
832 /** Position in the afs client list. */
833 struct list_head node
;
834 /** The socket file descriptor for this client. */
836 /** The time the client connected. */
837 struct timeval connect_time
;
840 static void command_pre_select(struct sched
*s
, struct task
*t
)
842 struct command_task
*ct
= container_of(t
, struct command_task
, task
);
843 struct afs_client
*client
;
845 para_fd_set(server_socket
, &s
->rfds
, &s
->max_fileno
);
846 para_fd_set(ct
->fd
, &s
->rfds
, &s
->max_fileno
);
847 list_for_each_entry(client
, &afs_client_list
, node
)
848 para_fd_set(client
->fd
, &s
->rfds
, &s
->max_fileno
);
852 * Send data as shared memory to a file descriptor.
854 * \param buf The buffer holding the data to be sent.
855 * \param size The size of \a buf.
856 * \param fd_ptr A pointer to the file descriptor.
858 * This function is used as the \a max_size handler in a \ref para_buffer
859 * structure. If used this way, it is called by \ref para_printf() whenever
860 * the buffer passed to para_printf() is about to exceed its maximal size.
862 * This function creates a shared memory area large enough to hold
863 * the content given by \a buf and \a size and sends the identifier
864 * of this area to the file descriptor given by \a fd_ptr.
866 * \return Zero if \a buf is \p NULL or \a size is zero. Negative on errors,
867 * and positive on success.
869 int pass_buffer_as_shm(char *buf
, size_t size
, void *fd_ptr
)
871 int ret
, shmid
, fd
= *(int *)fd_ptr
;
873 struct callback_result
*cr
;
877 ret
= shm_new(size
+ sizeof(struct callback_result
));
881 ret
= shm_attach(shmid
, ATTACH_RW
, &shm
);
885 cr
->result_size
= size
;
886 memcpy(shm
+ sizeof(*cr
), buf
, size
);
887 ret
= shm_detach(shm
);
890 ret
= send_bin_buffer(fd
, (char *)&shmid
, sizeof(int));
894 if (shm_destroy(shmid
) < 0)
895 PARA_ERROR_LOG("destroy result failed\n");
900 * On errors, negative value is written to fd.
901 * On success: If query produced a result, the result_shmid is written to fd.
902 * Otherwise, zero is written.
904 static int call_callback(int fd
, int query_shmid
)
907 struct callback_query
*cq
;
908 struct osl_object query
;
911 ret
= shm_attach(query_shmid
, ATTACH_RW
, &query_shm
);
915 query
.data
= (char *)query_shm
+ sizeof(*cq
);
916 query
.size
= cq
->query_size
;
917 cq
->handler(fd
, &query
);
918 return shm_detach(query_shm
);
921 static int execute_server_command(void)
924 int ret
= recv_bin_buffer(server_socket
, buf
, sizeof(buf
) - 1);
928 ret
= -ERRNO_TO_PARA_ERROR(ECONNRESET
);
932 PARA_DEBUG_LOG("received: %s\n", buf
);
934 if (strcmp(buf
, "new"))
936 ret
= open_next_audio_file();
941 static void execute_afs_command(int fd
, uint32_t expected_cookie
)
945 char buf
[sizeof(cookie
) + sizeof(query_shmid
)];
946 int ret
= recv_bin_buffer(fd
, buf
, sizeof(buf
));
950 if (ret
!= sizeof(buf
)) {
951 PARA_NOTICE_LOG("short read (%d bytes, expected %lu)\n",
952 ret
, (long unsigned) sizeof(buf
));
955 cookie
= *(uint32_t *)buf
;
956 if (cookie
!= expected_cookie
) {
957 PARA_NOTICE_LOG("received invalid cookie(got %u, expected %u)\n",
958 (unsigned)cookie
, (unsigned)expected_cookie
);
961 query_shmid
= *(int *)(buf
+ sizeof(cookie
));
962 if (query_shmid
< 0) {
963 PARA_WARNING_LOG("received invalid query shmid %d)\n",
967 ret
= call_callback(fd
, query_shmid
);
971 PARA_NOTICE_LOG("%s\n", para_strerror(-ret
));
974 /** Shutdown connection if query has not arrived until this many seconds. */
975 #define AFS_CLIENT_TIMEOUT 3
977 static void command_post_select(struct sched
*s
, struct task
*t
)
979 struct command_task
*ct
= container_of(t
, struct command_task
, task
);
980 struct sockaddr_un unix_addr
;
981 struct afs_client
*client
, *tmp
;
984 if (FD_ISSET(server_socket
, &s
->rfds
)) {
985 ret
= execute_server_command();
987 PARA_EMERG_LOG("%s\n", para_strerror(-ret
));
993 /* Check the list of connected clients. */
994 list_for_each_entry_safe(client
, tmp
, &afs_client_list
, node
) {
995 if (FD_ISSET(client
->fd
, &s
->rfds
))
996 execute_afs_command(client
->fd
, ct
->cookie
);
997 else { /* prevent bogus connection flooding */
999 tv_diff(now
, &client
->connect_time
, &diff
);
1000 if (diff
.tv_sec
< AFS_CLIENT_TIMEOUT
)
1002 PARA_WARNING_LOG("connection timeout\n");
1005 list_del(&client
->node
);
1008 /* Accept connections on the local socket. */
1009 if (!FD_ISSET(ct
->fd
, &s
->rfds
))
1011 ret
= para_accept(ct
->fd
, &unix_addr
, sizeof(unix_addr
));
1013 PARA_NOTICE_LOG("%s\n", para_strerror(-ret
));
1017 ret
= mark_fd_nonblocking(fd
);
1019 PARA_NOTICE_LOG("%s\n", para_strerror(-ret
));
1023 client
= para_malloc(sizeof(*client
));
1025 client
->connect_time
= *now
;
1026 para_list_add(&client
->node
, &afs_client_list
);
1029 static void register_command_task(uint32_t cookie
)
1031 struct command_task
*ct
= &command_task_struct
;
1032 ct
->fd
= setup_command_socket_or_die();
1033 ct
->cookie
= cookie
;
1035 ct
->task
.pre_select
= command_pre_select
;
1036 ct
->task
.post_select
= command_post_select
;
1037 sprintf(ct
->task
.status
, "command task");
1038 register_task(&ct
->task
);
1042 * Initialize the audio file selector process.
1044 * \param cookie The value used for "authentication".
1045 * \param socket_fd File descriptor used for communication with the server.
1047 __noreturn
void afs_init(uint32_t cookie
, int socket_fd
)
1049 static struct sched s
;
1052 register_signal_task();
1053 INIT_LIST_HEAD(&afs_client_list
);
1054 for (i
= 0; i
< NUM_AFS_TABLES
; i
++)
1055 afs_tables
[i
].init(&afs_tables
[i
]);
1056 ret
= open_afs_tables();
1059 server_socket
= socket_fd
;
1060 ret
= mark_fd_nonblocking(server_socket
);
1063 PARA_INFO_LOG("server_socket: %d, afs_socket_cookie: %u\n",
1064 server_socket
, (unsigned) cookie
);
1065 init_admissible_files(conf
.afs_initial_mode_arg
);
1066 register_command_task(cookie
);
1067 s
.default_timeout
.tv_sec
= 0;
1068 s
.default_timeout
.tv_usec
= 999 * 1000;
1074 PARA_EMERG_LOG("%s\n", para_strerror(-ret
));
1078 static void create_tables_callback(int fd
, const struct osl_object
*query
)
1080 uint32_t table_mask
= *(uint32_t *)query
->data
;
1085 for (i
= 0; i
< NUM_AFS_TABLES
; i
++) {
1086 struct afs_table
*t
= &afs_tables
[i
];
1088 if (!(table_mask
& (1 << i
)))
1092 ret
= t
->create(database_dir
);
1096 ret
= open_afs_tables();
1099 buf
= make_message("successfully created afs table(s)\n");
1101 buf
= make_message("%s\n", para_strerror(-ret
));
1102 pass_buffer_as_shm(buf
, strlen(buf
), &fd
);
1106 int com_init(int fd
, int argc
, char * const * const argv
)
1109 uint32_t table_mask
= (1 << (NUM_AFS_TABLES
+ 1)) - 1;
1110 struct osl_object query
= {.data
= &table_mask
,
1111 .size
= sizeof(table_mask
)};
1113 ret
= make_database_dir();
1118 for (i
= 1; i
< argc
; i
++) {
1119 for (j
= 0; j
< NUM_AFS_TABLES
; j
++) {
1120 struct afs_table
*t
= &afs_tables
[j
];
1122 if (strcmp(argv
[i
], t
->name
))
1124 table_mask
|= (1 << j
);
1127 if (j
== NUM_AFS_TABLES
)
1128 return -E_BAD_TABLE_NAME
;
1131 ret
= send_callback_request(create_tables_callback
, &query
, &send_result
, &fd
);
1133 return send_va_buffer(fd
, "%s\n", para_strerror(-ret
));
1138 * Flags for the check command.
1142 enum com_check_flags
{
1143 /** Check the audio file table. */
1145 /** Check the mood table. */
1147 /** Check the playlist table. */
1151 int com_check(int fd
, int argc
, char * const * const argv
)
1156 for (i
= 1; i
< argc
; i
++) {
1157 const char *arg
= argv
[i
];
1160 if (!strcmp(arg
, "--")) {
1164 if (!strcmp(arg
, "-a")) {
1168 if (!strcmp(arg
, "-p")) {
1169 flags
|= CHECK_PLAYLISTS
;
1172 if (!strcmp(arg
, "-m")) {
1173 flags
|= CHECK_MOODS
;
1176 return -E_AFS_SYNTAX
;
1179 return -E_AFS_SYNTAX
;
1182 if (flags
& CHECK_AFT
) {
1183 ret
= send_callback_request(aft_check_callback
, NULL
, send_result
, &fd
);
1187 if (flags
& CHECK_PLAYLISTS
) {
1188 ret
= send_callback_request(playlist_check_callback
, NULL
, send_result
, &fd
);
1192 if (flags
& CHECK_MOODS
) {
1193 ret
= send_callback_request(mood_check_callback
, NULL
, send_result
, &fd
);
1201 * The afs event dispatcher.
1203 * \param event Type of the event.
1204 * \param pb May be \p NULL.
1205 * \param data Type depends on \a event.
1207 * This function calls the table handlers of all tables and passes \a pb and \a
1208 * data verbatim. It's up to the handlers to interpret the \a data pointer.
1210 void afs_event(enum afs_events event
, struct para_buffer
*pb
,
1215 for (i
= 0; i
< NUM_AFS_TABLES
; i
++) {
1216 struct afs_table
*t
= &afs_tables
[i
];
1217 if (!t
->event_handler
)
1219 ret
= t
->event_handler(event
, pb
, data
);
1221 PARA_CRIT_LOG("table %s, event %d: %s\n", t
->name
,
1222 event
, para_strerror(-ret
));
1226 int images_event_handler(__a_unused
enum afs_events event
,
1227 __a_unused
struct para_buffer
*pb
, __a_unused
void *data
)
1232 int lyrics_event_handler(__a_unused
enum afs_events event
,
1233 __a_unused
struct para_buffer
*pb
, __a_unused
void *data
)