/*
- * Copyright (C) 1997-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2007 Andre Noll <maan@systemlinux.org>
*
* Licensed under the GPL v2. For licencing details see COPYING.
*/
#include "signal.h"
#include "fd.h"
-extern uint32_t afs_socket_cookie;
-
-/**
- * Compare two osl objects of string type.
- *
- * \param obj1 Pointer to the first object.
- * \param obj2 Pointer to the second object.
- *
- * In any case, only \p MIN(obj1->size, obj2->size) characters of each string
- * are taken into account.
- *
- * \return It returns an integer less than, equal to, or greater than zero if
- * \a obj1 is found, respectively, to be less than, to match, or be greater than
- * obj2.
- *
- * \sa strcmp(3), strncmp(3), osl_compare_func.
- */
-int string_compare(const struct osl_object *obj1, const struct osl_object *obj2)
-{
- const char *str1 = (const char *)obj1->data;
- const char *str2 = (const char *)obj2->data;
- return strncmp(str1, str2, PARA_MIN(obj1->size, obj2->size));
-}
-
-/** The osl tables used by afs. \sa blob.c */
+/** The osl tables used by afs. \sa blob.c. */
enum afs_table_num {
/** Contains audio file information. See aft.c. */
TBLNUM_AUDIO_FILES,
struct task task;
};
-
/**
- * A wrapper for strtol(3).
- *
- * \param str The string to be converted to a long integer.
- * \param result The converted value is stored here.
- *
- * \return Positive on success, -E_ATOL on errors.
+ * A random number used to "authenticate" the connection.
*
- * \sa strtol(3), atoi(3).
+ * para_server picks this number by random before forking the afs process. The
+ * command handlers write this number together with the id of the shared memory
+ * area containing the query. This way, a malicious local user has to know this
+ * number to be able to cause the afs process to crash by sending fake queries.
*/
-int para_atol(const char *str, long *result)
-{
- char *endptr;
- long val;
- int ret, base = 10;
-
- errno = 0; /* To distinguish success/failure after call */
- val = strtol(str, &endptr, base);
- ret = -E_ATOL;
- if (errno == ERANGE && (val == LONG_MAX || val == LONG_MIN))
- goto out; /* overflow */
- if (errno != 0 && val == 0)
- goto out; /* other error */
- if (endptr == str)
- goto out; /* No digits were found */
- if (*endptr != '\0')
- goto out; /* Further characters after number */
- *result = val;
- ret = 1;
-out:
- return ret;
-}
+extern uint32_t afs_socket_cookie;
/**
- * Struct to let para_server call a function specified from child context.
+ * Struct to let command handlers execute a callback in afs context.
+ *
+ * Commands that need to change the state of afs can't change the relevant data
+ * structures directly because commands are executed in a child process, i.e.
+ * they get their own virtual address space.
+ *
+ * This structure is used by \p send_callback_request() (executed from handler
+ * context) in order to let the afs process call the specified function. An
+ * instance of that structure is written to a shared memory area together with
+ * the arguments to the callback function. The identifier of the shared memory
+ * area is written to the command socket.
*
- * Commands that need to change the state of para_server can't
- * change the relevant data structures directly because commands
- * are executed in a child process, i.e. they get their own
- * virtual address space. This structure must be used to let
- * para_server (i.e. the parent process) call a function specified
- * by the child (the command handler).
+ * The afs process accepts connections on the command socket and reads the
+ * shared memory id, attaches the corresponing area, calls the given handler to
+ * perform the desired action and to optionally compute a result.
*
- * \sa fork(2), ipc.c.
+ * The result and a \p callback_result structure is then written to another
+ * shared memory area. The identifier for that area is written to the handler's
+ * command socket, so that the handler process can read the id, attach the
+ * shared memory area and use the result.
+ *
+ * \sa struct callback_result.
*/
-struct callback_data {
- /** The function to be called. */
- callback_function *handler;
- /** The sma for the parameters of the callback function. */
- int query_shmid;
- /** The size of the query sma. */
- size_t query_size;
- /** If the callback produced a result, it is stored in this sma. */
- int result_shmid;
- /** The size of the result sma. */
- size_t result_size;
- /** The return value of the callback function. */
- int callback_ret;
- /** The return value of the callback() procedure. */
- int sma_ret;
-};
-
struct callback_query {
/** The function to be called. */
callback_function *handler;
size_t query_size;
};
+/**
+ * Structure embedded in the result of a callback.
+ *
+ * If the callback produced a result, an instance of that structure is embeeded
+ * into the shared memory area holding the result, mainly to let the command
+ * handler know the size of the result.
+ *
+ * \sa struct callback_query.
+ */
struct callback_result {
/** The number of bytes of the result. */
size_t result_size;
};
-static struct callback_data *shm_callback_data;
-static int callback_mutex;
-static int child_mutex;
-static int result_mutex;
-
/**
* Ask the parent process to call a given function.
*
if (connect(fd, (struct sockaddr *)&unix_addr, sizeof(unix_addr)) < 0) /* FIXME: Use para_connect() */
goto out;
ret = send_bin_buffer(fd, buf, sizeof(buf));
- PARA_NOTICE_LOG("bin buffer ret: %d\n", ret);
if (ret < 0)
goto out;
ret = recv_bin_buffer(fd, buf, sizeof(buf));
- PARA_NOTICE_LOG("ret: %d\n", ret);
if (ret < 0)
goto out;
if (ret != sizeof(int)) {
goto out;
}
ret = *(int *) buf;
- PARA_NOTICE_LOG("result_shmid: %d\n", ret);
if (ret <= 0)
goto out;
result_shmid = ret;
PARA_ERROR_LOG("%s\n", "shm destroy error");
if (fd >= 0)
close(fd);
- PARA_DEBUG_LOG("callback_ret: %d\n", ret);
+// PARA_DEBUG_LOG("callback_ret: %d\n", ret);
return ret;
}
* \sa send_standard_callback_request(), send_callback_request().
*/
int send_option_arg_callback_request(struct osl_object *options,
- int argc, const char **argv, callback_function *f,
+ int argc, char * const * const argv, callback_function *f,
struct osl_object *result)
{
char *p;
* \return The return value of the underlying call to
* send_option_arg_callback_request().
*/
-int send_standard_callback_request(int argc, const char **argv,
+int send_standard_callback_request(int argc, char * const * const argv,
callback_function *f, struct osl_object *result)
{
return send_option_arg_callback_request(NULL, argc, argv, f, result);
}
+/**
+ * Compare two osl objects of string type.
+ *
+ * \param obj1 Pointer to the first object.
+ * \param obj2 Pointer to the second object.
+ *
+ * In any case, only \p MIN(obj1->size, obj2->size) characters of each string
+ * are taken into account.
+ *
+ * \return It returns an integer less than, equal to, or greater than zero if
+ * \a obj1 is found, respectively, to be less than, to match, or be greater than
+ * obj2.
+ *
+ * \sa strcmp(3), strncmp(3), osl_compare_func.
+ */
+int string_compare(const struct osl_object *obj1, const struct osl_object *obj2)
+{
+ const char *str1 = (const char *)obj1->data;
+ const char *str2 = (const char *)obj2->data;
+ return strncmp(str1, str2, PARA_MIN(obj1->size, obj2->size));
+}
+
+/**
+ * A wrapper for strtol(3).
+ *
+ * \param str The string to be converted to a long integer.
+ * \param result The converted value is stored here.
+ *
+ * \return Positive on success, -E_ATOL on errors.
+ *
+ * \sa strtol(3), atoi(3).
+ */
+int para_atol(const char *str, long *result)
+{
+ char *endptr;
+ long val;
+ int ret, base = 10;
+
+ errno = 0; /* To distinguish success/failure after call */
+ val = strtol(str, &endptr, base);
+ ret = -E_ATOL;
+ if (errno == ERANGE && (val == LONG_MAX || val == LONG_MIN))
+ goto out; /* overflow */
+ if (errno != 0 && val == 0)
+ goto out; /* other error */
+ if (endptr == str)
+ goto out; /* No digits were found */
+ if (*endptr != '\0')
+ goto out; /* Further characters after number */
+ *result = val;
+ ret = 1;
+out:
+ return ret;
+}
+
+
/*
* write input from fd to dynamically allocated char array,
* but maximal max_size byte. Return size.
unlink(socket_name);
ret = create_local_socket(socket_name, &unix_addr,
S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IWOTH);
- if (ret < 0)
+ if (ret < 0) {
+ PARA_EMERG_LOG("%s: %s\n", PARA_STRERROR(-ret), socket_name);
exit(EXIT_FAILURE);
+ }
if (listen(ret , 5) < 0) {
PARA_EMERG_LOG("%s", "can not listen on socket\n");
exit(EXIT_FAILURE);
}
static int server_socket;
+static struct command_task command_task_struct;
+static struct signal_task signal_task_struct;
-void loop(void)
+static void unregister_tasks(void)
{
- for (;;)
- sleep(1);
+ unregister_task(&command_task_struct.task);
+ unregister_task(&signal_task_struct.task);
}
-static void afs_shutdown(enum osl_close_flags flags)
+static void close_afs_tables(enum osl_close_flags flags)
{
- PARA_NOTICE_LOG("cleaning up\n");
+ PARA_NOTICE_LOG("closing afs_tables\n");
score_shutdown(flags);
attribute_shutdown(flags);
mood_close();
t->ret = 1;
if (st->signum == SIGUSR1)
return; /* ignore SIGUSR1 */
- afs_shutdown(OSL_MARK_CLEAN);
t->ret = -E_SIGNAL_CAUGHT;
+ unregister_tasks();
}
static void register_signal_task(void)
{
- static struct signal_task signal_task_struct;
struct signal_task *st = &signal_task_struct;
st->fd = para_signal_init();
PARA_INFO_LOG("signal pipe: fd %d\n", st->fd);
t->ret = recv_bin_buffer(fd, buf, sizeof(buf));
if (t->ret < 0) {
PARA_NOTICE_LOG("%s (%d)\n", PARA_STRERROR(-t->ret), t->ret);
- t->ret = 1;
goto out;
}
if (t->ret != sizeof(buf)) {
- PARA_NOTICE_LOG("short read (%d bytes, expected %d)\n",
- t->ret, sizeof(buf));
- t->ret = 1;
+ PARA_NOTICE_LOG("short read (%d bytes, expected %lu)\n",
+ t->ret, (long unsigned) sizeof(buf));
goto out;
}
cookie = *(uint32_t *)buf;
if (cookie != ct->cookie) {
PARA_NOTICE_LOG("received invalid cookie(got %u, expected %u)\n",
(unsigned)cookie, (unsigned)ct->cookie);
- t->ret = 1;
goto out;
}
query_shmid = *(int *)(buf + sizeof(cookie));
if (query_shmid < 0) {
PARA_WARNING_LOG("received invalid query shmid %d)\n",
query_shmid);
- t->ret = 1;
- goto out;
- }
- t->ret = call_callback(fd, query_shmid);
- if (t->ret < 0) {
- PARA_NOTICE_LOG("%s\n", PARA_STRERROR(-t->ret));
- t->ret = 1;
goto out;
}
+ /* Ignore return value: Errors might be ok here. */
+ call_callback(fd, query_shmid);
out:
+ t->ret = 1;
close(fd);
}
static void register_command_task(uint32_t cookie)
{
- static struct command_task command_task_struct;
struct command_task *ct = &command_task_struct;
ct->fd = setup_command_socket_or_die();
ct->cookie = cookie;
register_command_task(cookie);
}
-__noreturn int afs_init(uint32_t cookie, int socket_fd)
+static char *database_dir;
+
+static int make_database_dir(void)
{
int ret;
-// void *shm_area;
- enum play_mode current_play_mode;
- struct sched s;
- server_socket = socket_fd;
- PARA_INFO_LOG("server_socket: %d, afs_socket_cookie: %u\n",
- server_socket, (unsigned) cookie);
+ if (!database_dir) {
+ if (conf.afs_database_dir_given)
+ database_dir = para_strdup(conf.afs_database_dir_arg);
+ else {
+ char *home = para_homedir();
+ database_dir = make_message(
+ "%s/.paraslash/afs_database", home);
+ free(home);
+ }
+ }
+ PARA_INFO_LOG("afs_database dir %s\n", database_dir);
+ ret = para_mkdir(database_dir, 0777);
+ if (ret >= 0 || ret == -E_EXIST)
+ return 1;
+ free(database_dir);
+ database_dir = NULL;
+ return ret;
+}
- ret = attribute_init(&afs_tables[TBLNUM_ATTRIBUTES]);
+static int open_afs_tables(void)
+{
+ int ret = make_database_dir();
+
+ if (ret < 0)
+ return ret;
+ ret = attribute_init(&afs_tables[TBLNUM_ATTRIBUTES], database_dir);
if (ret < 0)
- goto attribute_init_error;
- ret = moods_init(&afs_tables[TBLNUM_MOODS]);
+ return ret;
+ ret = moods_init(&afs_tables[TBLNUM_MOODS], database_dir);
if (ret < 0)
goto moods_init_error;
- ret = playlists_init(&afs_tables[TBLNUM_PLAYLIST]);
+ ret = playlists_init(&afs_tables[TBLNUM_PLAYLIST], database_dir);
if (ret < 0)
goto playlists_init_error;
- ret = lyrics_init(&afs_tables[TBLNUM_LYRICS]);
+ ret = lyrics_init(&afs_tables[TBLNUM_LYRICS], database_dir);
if (ret < 0)
goto lyrics_init_error;
- ret = images_init(&afs_tables[TBLNUM_IMAGES]);
+ ret = images_init(&afs_tables[TBLNUM_IMAGES], database_dir);
if (ret < 0)
goto images_init_error;
- ret = score_init(&afs_tables[TBLNUM_SCORES]);
+ ret = score_init(&afs_tables[TBLNUM_SCORES], database_dir);
if (ret < 0)
goto score_init_error;
- ret = aft_init(&afs_tables[TBLNUM_AUDIO_FILES]);
+ ret = aft_init(&afs_tables[TBLNUM_AUDIO_FILES], database_dir);
if (ret < 0)
goto aft_init_error;
+ return 1;
- current_play_mode = init_admissible_files();
- register_tasks(cookie);
- s.default_timeout.tv_sec = 0;
- s.default_timeout.tv_usec = 99 * 1000;
- sched(&s);
-
-#if 0
- ret = shm_new(sizeof(struct callback_data));
- if (ret < 0)
- return ret;
- shmid = ret;
- ret = shm_attach(shmid, ATTACH_RW, &shm_area);
- if (ret < 0)
- return ret;
- shm_callback_data = shm_area;
- ret = mutex_new();
- if (ret < 0)
- return ret;
- callback_mutex = ret;
- ret = mutex_new();
- if (ret < 0)
- return ret;
- child_mutex = ret;
- ret = mutex_new();
- if (ret < 0)
- return ret;
- result_mutex = ret;
- mutex_lock(result_mutex);
-#endif
aft_init_error:
score_shutdown(OSL_MARK_CLEAN);
score_init_error:
moods_shutdown(OSL_MARK_CLEAN);
moods_init_error:
attribute_shutdown(OSL_MARK_CLEAN);
-attribute_init_error:
+ return ret;
+}
+
+__noreturn int afs_init(uint32_t cookie, int socket_fd)
+{
+ enum play_mode current_play_mode;
+ struct sched s;
+ int ret = open_afs_tables();
+
+ if (ret < 0) {
+ PARA_EMERG_LOG("%s\n", PARA_STRERROR(-ret));
+ exit(EXIT_FAILURE);
+ }
+ server_socket = socket_fd;
+ PARA_INFO_LOG("server_socket: %d, afs_socket_cookie: %u\n",
+ server_socket, (unsigned) cookie);
+ current_play_mode = init_admissible_files();
+ register_tasks(cookie);
+ s.default_timeout.tv_sec = 0;
+ s.default_timeout.tv_usec = 99 * 1000;
+ ret = sched(&s);
+ if (ret < 0)
+ PARA_EMERG_LOG("%s\n", PARA_STRERROR(-ret));
+ close_afs_tables(OSL_MARK_CLEAN);
exit(EXIT_FAILURE);
}
-static int create_all_tables(void)
+static int create_tables_callback(const struct osl_object *query,
+ __a_unused struct osl_object *result)
{
+ uint32_t table_mask = *(uint32_t *)query->data;
int i, ret;
+ close_afs_tables(OSL_MARK_CLEAN);
for (i = 0; i < NUM_AFS_TABLES; i++) {
struct table_info *ti = afs_tables + i;
if (ti->flags & TBLFLAG_SKIP_CREATE)
continue;
+ if (!(table_mask & (1 << i)))
+ continue;
ret = osl_create_table(ti->desc);
if (ret < 0)
return ret;
}
- return 1;
+ ret = open_afs_tables();
+ return ret < 0? ret: 0;
}
-/* TODO load tables after init */
-int com_init(__a_unused int fd, int argc, const char **argv)
+int com_init(int fd, int argc, char * const * const argv)
{
int i, j, ret;
- if (argc == 1)
- return create_all_tables();
- for (i = 1; i < argc; i++) {
- for (j = 0; j < NUM_AFS_TABLES; j++) {
- struct table_info *ti = afs_tables + j;
-
- if (ti->flags & TBLFLAG_SKIP_CREATE)
- continue;
- if (strcmp(argv[i], ti->desc->name))
- continue;
- PARA_NOTICE_LOG("creating table %s\n", argv[i]);
- ret = osl_create_table(ti->desc);
- if (ret < 0)
- return ret;
- break;
+ uint32_t table_mask = (1 << (NUM_AFS_TABLES + 1)) - 1;
+ struct osl_object query = {.data = &table_mask,
+ .size = sizeof(table_mask)};
+
+ if (argc != 1) {
+ table_mask = 0;
+ for (i = 1; i < argc; i++) {
+ for (j = 0; j < NUM_AFS_TABLES; j++) {
+ struct table_info *ti = afs_tables + j;
+
+ if (ti->flags & TBLFLAG_SKIP_CREATE)
+ continue;
+ if (strcmp(argv[i], ti->desc->name))
+ continue;
+ table_mask |= (1 << j);
+ break;
+ }
+ if (j == NUM_AFS_TABLES)
+ return -E_BAD_TABLE_NAME;
}
- if (j == NUM_AFS_TABLES)
- return -E_BAD_TABLE_NAME;
}
- return 1;
+ ret = send_callback_request(create_tables_callback, &query, NULL);
+ if (ret < 0)
+ return ret;
+ return send_va_buffer(fd, "successfully created afs table(s)\n");
}