2 * Copyright (C) 2007-2012 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file blob.c Macros and functions for blob handling. */
20 #include "portable_io.h"
25 * Compare two osl objects pointing to unsigned integers of 32 bit size.
27 * \param obj1 Pointer to the first integer.
28 * \param obj2 Pointer to the second integer.
30 * \return The values required for an osl compare function.
32 * \sa osl_compare_func, osl_hash_compare().
34 static int uint32_compare(const struct osl_object *obj1, const struct osl_object *obj2)
36 uint32_t d1 = read_u32((const char *)obj1->data);
37 uint32_t d2 = read_u32((const char *)obj2->data);
46 static struct osl_column_description blob_cols[] = {
48 .storage_type = OSL_MAPPED_STORAGE,
49 .storage_flags = OSL_RBTREE | OSL_UNIQUE | OSL_FIXED_SIZE,
52 .compare_function = uint32_compare
55 .storage_type = OSL_MAPPED_STORAGE,
56 .storage_flags = OSL_RBTREE | OSL_UNIQUE,
58 .compare_function = string_compare
61 .storage_type = OSL_DISK_STORAGE,
67 /** Define an osl table description for a blob table. */
68 #define DEFINE_BLOB_TABLE_DESC(table_name) \
69 struct osl_table_description table_name ## _table_desc = { \
70 .name = #table_name, \
71 .num_columns = NUM_BLOB_COLUMNS, \
72 .flags = OSL_LARGE_TABLE, \
73 .column_descriptions = blob_cols \
76 /** Define a pointer to an osl blob table with a canonical name. */
77 #define DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table;
80 /** Define a blob table. */
81 #define INIT_BLOB_TABLE(table_name) \
82 DEFINE_BLOB_TABLE_DESC(table_name); \
83 DEFINE_BLOB_TABLE_PTR(table_name);
85 /* doxygen isn't smart enough to recognize these */
86 /** \cond blob_table */
87 INIT_BLOB_TABLE(lyrics);
88 INIT_BLOB_TABLE(images);
89 INIT_BLOB_TABLE(moods);
90 INIT_BLOB_TABLE(playlists);
91 /** \endcond blob_table */
93 /** Flags that may be passed to the \p ls functions of each blob type. */
95 /** List both id and name. */
96 BLOB_LS_FLAG_LONG = 1,
97 /** Reverse sort order. */
98 BLOB_LS_FLAG_REVERSE = 2,
99 /** Sort by id instead of name. */
100 BLOB_LS_FLAG_SORT_BY_ID = 4,
103 /** Structure passed to the \p print_blob function. */
104 struct lsblob_action_data {
105 /** The flags given at the command line. */
107 /** Message buffer. */
108 struct para_buffer pb;
111 static int print_blob(struct osl_table *table, struct osl_row *row,
112 const char *name, void *data)
114 struct lsblob_action_data *lbad = data;
115 struct osl_object obj;
119 if (!(lbad->flags & BLOB_LS_FLAG_LONG))
120 return para_printf(&lbad->pb, "%s\n", name);
121 ret = osl(osl_get_object(table, row, BLOBCOL_ID, &obj));
123 para_printf(&lbad->pb, "%s: %s\n", name, para_strerror(-ret));
126 id = *(uint32_t *)obj.data;
127 return para_printf(&lbad->pb, "%u\t%s\n", id, name);
130 static void com_lsblob_callback(struct osl_table *table,
131 int fd, const struct osl_object *query)
133 struct lsblob_action_data lbad = {
134 .flags = *(uint32_t *)query->data,
136 .max_size = shm_get_shmmax(),
137 .private_data = &(struct afs_max_size_handler_data) {
140 .max_size_handler = afs_max_size_handler,
143 struct pattern_match_data pmd = {
145 .patterns = {.data = (char *)query->data + sizeof(uint32_t),
146 .size = query->size - sizeof(uint32_t)},
147 .pm_flags = PM_NO_PATTERN_MATCHES_EVERYTHING | PM_SKIP_EMPTY_NAME,
148 .match_col_num = BLOBCOL_NAME,
150 .action = print_blob,
154 if (lbad.flags & BLOB_LS_FLAG_REVERSE)
155 pmd.pm_flags |= PM_REVERSE_LOOP;
156 if (!(lbad.flags & BLOB_LS_FLAG_SORT_BY_ID))
157 pmd.loop_col_num = BLOBCOL_NAME;
159 pmd.loop_col_num = BLOBCOL_ID;
160 ret = for_each_matching_row(&pmd);
162 para_printf(&lbad.pb, "%s\n", para_strerror(-ret));
163 else if (pmd.num_matches == 0 && pmd.patterns.size > 0)
164 para_printf(&lbad.pb, "no matches\n");
166 pass_buffer_as_shm(fd, lbad.pb.buf, lbad.pb.offset);
170 static int com_lsblob(callback_function *f, struct command_context *cc)
173 struct osl_object options = {.data = &flags, .size = sizeof(flags)};
176 for (i = 1; i < cc->argc; i++) {
177 const char *arg = cc->argv[i];
180 if (!strcmp(arg, "--")) {
184 if (!strcmp(arg, "-l")) {
185 flags |= BLOB_LS_FLAG_LONG;
188 if (!strcmp(arg, "-i")) {
189 flags |= BLOB_LS_FLAG_SORT_BY_ID;
192 if (!strcmp(arg, "-r")) {
193 flags |= BLOB_LS_FLAG_REVERSE;
199 // return -E_BLOB_SYNTAX;
200 return send_option_arg_callback_request(&options, cc->argc - i,
201 cc->argv + i, f, afs_cb_result_handler, cc);
204 static int cat_blob(struct osl_table *table, struct osl_row *row,
205 __a_unused const char *name, void *data)
207 int ret = 0, ret2, fd = *(int *)data;
208 struct osl_object obj;
210 ret = osl(osl_open_disk_object(table, row, BLOBCOL_DEF, &obj));
212 return (ret == osl(-E_OSL_EMPTY))? 0 : ret;
213 assert(obj.size > 0);
214 ret = pass_buffer_as_shm(fd, obj.data, obj.size);
215 ret2 = osl(osl_close_disk_object(&obj));
216 return (ret < 0)? ret : ret2;
219 static void com_catblob_callback(struct osl_table *table, int fd,
220 const struct osl_object *query)
222 struct pattern_match_data pmd = {
225 .loop_col_num = BLOBCOL_NAME,
226 .match_col_num = BLOBCOL_NAME,
227 .pm_flags = PM_SKIP_EMPTY_NAME,
231 for_each_matching_row(&pmd);
232 if (pmd.num_matches == 0) {
233 char err_msg[] = "no matches\n";
234 pass_buffer_as_shm(fd, err_msg, sizeof(err_msg));
238 static int com_catblob(callback_function *f, struct command_context *cc)
241 return -E_BLOB_SYNTAX;
242 return send_standard_callback_request(cc->argc - 1, cc->argv + 1, f,
243 afs_cb_result_handler, cc);
246 /** Used for removing rows from a blob table. */
248 /** Message buffer. */
249 struct para_buffer pb;
252 static int remove_blob(struct osl_table *table, struct osl_row *row,
253 const char *name, void *data)
255 struct rmblob_data *rmbd = data;
256 int ret = osl(osl_del_row(table, row));
258 para_printf(&rmbd->pb, "%s: %s\n", name, para_strerror(-ret));
264 static void com_rmblob_callback(struct osl_table *table, int fd,
265 const struct osl_object *query)
268 struct rmblob_data rmbd = {
270 .max_size = shm_get_shmmax(),
271 .private_data = &(struct afs_max_size_handler_data) {
274 .max_size_handler = afs_max_size_handler,
277 struct pattern_match_data pmd = {
280 .loop_col_num = BLOBCOL_NAME,
281 .match_col_num = BLOBCOL_NAME,
282 .pm_flags = PM_SKIP_EMPTY_NAME,
284 .action = remove_blob
286 ret = for_each_matching_row(&pmd);
288 ret2 = para_printf(&rmbd.pb, "%s\n", para_strerror(-ret));
292 if (pmd.num_matches == 0)
293 ret2 = para_printf(&rmbd.pb, "no matches, nothing removed\n");
295 ret2 = para_printf(&rmbd.pb, "removed %d blobs\n", pmd.num_matches);
296 afs_event(BLOB_RENAME, NULL, table);
299 if (ret2 >= 0 && rmbd.pb.offset)
300 pass_buffer_as_shm(fd, rmbd.pb.buf, rmbd.pb.offset);
304 static int com_rmblob(callback_function *f, struct command_context *cc)
307 return -E_MOOD_SYNTAX;
308 return send_option_arg_callback_request(NULL, cc->argc - 1, cc->argv + 1, f,
309 afs_cb_result_handler, cc);
312 static void com_addblob_callback(struct osl_table *table, __a_unused int fd,
313 const struct osl_object *query)
315 struct osl_object objs[NUM_BLOB_COLUMNS];
316 char *name = query->data;
317 size_t name_len = strlen(name) + 1;
322 ret = osl(osl_get_num_rows(table, &num_rows));
325 if (!num_rows) { /* this is the first entry ever added */
326 /* insert dummy row containing the id */
327 id = 2; /* this entry will be entry #1, so 2 is the next */
328 objs[BLOBCOL_ID].data = &id;
329 objs[BLOBCOL_ID].size = sizeof(id);
330 objs[BLOBCOL_NAME].data = "";
331 objs[BLOBCOL_NAME].size = 1;
332 objs[BLOBCOL_DEF].data = "";
333 objs[BLOBCOL_DEF].size = 1;
334 ret = osl(osl_add_row(table, objs));
338 /* check if name already exists */
340 struct osl_object obj = {.data = name, .size = name_len};
341 ret = osl(osl_get_row(table, BLOBCOL_NAME, &obj, &row));
342 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
344 if (ret >= 0) { /* we already have a blob with this name */
345 obj.data = name + name_len;
346 obj.size = query->size - name_len;
347 ret = osl(osl_update_object(table, row, BLOBCOL_DEF, &obj));
350 /* new blob, get id of the dummy row and increment it */
353 ret = osl(osl_get_row(table, BLOBCOL_NAME, &obj, &row));
356 ret = osl(osl_get_object(table, row, BLOBCOL_ID, &obj));
359 id = *(uint32_t *)obj.data + 1;
361 ret = osl(osl_update_object(table, row, BLOBCOL_ID, &obj));
366 objs[BLOBCOL_ID].data = &id;
367 objs[BLOBCOL_ID].size = sizeof(id);
368 objs[BLOBCOL_NAME].data = name;
369 objs[BLOBCOL_NAME].size = name_len;
370 objs[BLOBCOL_DEF].data = name + name_len;
371 objs[BLOBCOL_DEF].size = query->size - name_len;
372 ret = osl(osl_add_row(table, objs));
375 afs_event(BLOB_ADD, NULL, table);
378 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
382 * write input from fd to dynamically allocated buffer,
383 * but maximal max_size byte.
385 static int fd2buf(struct stream_cipher_context *scc, unsigned max_size, struct osl_object *obj)
387 const size_t chunk_size = 1024;
388 size_t size = 2048, received = 0;
390 char *buf = para_malloc(size);
393 ret = sc_recv_bin_buffer(scc, buf + received, chunk_size);
397 if (received + chunk_size >= size) {
399 ret = -E_INPUT_TOO_LARGE;
402 buf = para_realloc(buf, size);
406 obj->size = received;
413 * Read data from a file descriptor, and send it to the afs process.
415 * \param scc crypt context containing the file descriptor to read data from.
416 * \param arg_obj Pointer to the arguments to \a f.
417 * \param f The callback function.
418 * \param max_len Don't read more than that many bytes from stdin.
419 * \param result_handler See \ref send_callback_request.
420 * \param private_result_data See \ref send_callback_request.
422 * This function is used by commands that wish to let para_server store
423 * arbitrary data specified by the user (for instance the add_blob family of
424 * commands). First, at most \a max_len bytes are read and decrypted from the
425 * file descriptor given by \a scc. The result is concatenated with the buffer
426 * given by \a arg_obj, and the combined buffer is made available to the afs
427 * process via the callback method. See \ref send_callback_request for details.
429 * \return Negative on errors, the return value of the underlying call to
430 * send_callback_request() otherwise.
432 static int stdin_command(struct command_context *cc, struct osl_object *arg_obj,
433 callback_function *f, unsigned max_len,
434 callback_result_handler *result_handler,
435 void *private_result_data)
437 struct osl_object query, stdin_obj;
440 ret = sc_send_buffer(&cc->scc, AWAITING_DATA_MSG);
443 ret = fd2buf(&cc->scc, max_len, &stdin_obj);
446 query.size = arg_obj->size + stdin_obj.size;
447 query.data = para_malloc(query.size);
448 memcpy(query.data, arg_obj->data, arg_obj->size);
449 memcpy((char *)query.data + arg_obj->size, stdin_obj.data, stdin_obj.size);
450 free(stdin_obj.data);
451 ret = send_callback_request(f, &query, result_handler, private_result_data);
456 static int com_addblob(callback_function *f, struct command_context *cc)
458 struct osl_object arg_obj;
461 return -E_BLOB_SYNTAX;
462 if (!*cc->argv[1]) /* empty name is reserved for the dummy row */
463 return -E_BLOB_SYNTAX;
464 arg_obj.size = strlen(cc->argv[1]) + 1;
465 arg_obj.data = (char *)cc->argv[1];
466 return stdin_command(cc, &arg_obj, f, 10 * 1024 * 1024, NULL, NULL);
469 /* FIXME: Print output to client, not to log file */
470 static void com_mvblob_callback(struct osl_table *table, __a_unused int fd,
471 const struct osl_object *query)
473 char *src = (char *) query->data;
474 struct osl_object obj = {.data = src, .size = strlen(src) + 1};
475 char *dest = src + obj.size;
477 int ret = osl(osl_get_row(table, BLOBCOL_NAME, &obj, &row));
482 obj.size = strlen(dest) + 1;
483 ret = osl(osl_update_object(table, row, BLOBCOL_NAME, &obj));
486 afs_event(BLOB_RENAME, NULL, table);
489 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
492 static int com_mvblob(callback_function *f, struct command_context *cc)
495 return -E_MOOD_SYNTAX;
496 return send_option_arg_callback_request(NULL, cc->argc - 1,
497 cc->argv + 1, f, NULL, NULL);
500 #define DEFINE_BLOB_COMMAND(cmd_name, table_name, cmd_prefix) \
501 static void com_ ## cmd_name ## cmd_prefix ## _callback(int fd, const struct osl_object *query) \
503 return com_ ## cmd_name ## blob_callback(table_name ## _table, fd, query); \
505 int com_ ## cmd_name ## cmd_prefix(struct command_context *cc) \
507 return com_ ## cmd_name ## blob(com_ ## cmd_name ## cmd_prefix ## _callback, cc); \
510 static int blob_get_name_by_id(struct osl_table *table, uint32_t id,
514 struct osl_object obj = {.data = &id, .size = sizeof(id)};
520 ret = osl(osl_get_row(table, BLOBCOL_ID, &obj, &row));
523 ret = osl(osl_get_object(table, row, BLOBCOL_NAME, &obj));
526 *name = (char *)obj.data;
530 /** Define the \p get_name_by_id function for this blob type. */
531 #define DEFINE_GET_NAME_BY_ID(table_name, cmd_prefix) \
532 int cmd_prefix ## _get_name_by_id(uint32_t id, char **name) \
534 return blob_get_name_by_id(table_name ## _table, id, name); \
538 static int blob_get_def_by_name(struct osl_table *table, char *name,
539 struct osl_object *def)
542 struct osl_object obj = {.data = name, .size = strlen(name) + 1};
548 ret = osl(osl_get_row(table, BLOBCOL_NAME, &obj, &row));
551 return osl(osl_open_disk_object(table, row, BLOBCOL_DEF, def));
554 /** Define the \p get_def_by_id function for this blob type. */
555 #define DEFINE_GET_DEF_BY_NAME(table_name, cmd_prefix) \
556 int cmd_prefix ## _get_def_by_name(char *name, struct osl_object *def) \
558 return blob_get_def_by_name(table_name ## _table, name, def); \
561 static int blob_get_def_by_id(struct osl_table *table, uint32_t id,
562 struct osl_object *def)
565 struct osl_object obj = {.data = &id, .size = sizeof(id)};
571 ret = osl(osl_get_row(table, BLOBCOL_ID, &obj, &row));
574 return osl(osl_open_disk_object(table, row, BLOBCOL_DEF, def));
577 /** Define the \p get_def_by_id function for this blob type. */
578 #define DEFINE_GET_DEF_BY_ID(table_name, cmd_prefix) \
579 int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def) \
581 return blob_get_def_by_id(table_name ## _table, id, def); \
584 static int blob_get_name_and_def_by_row(struct osl_table *table,
585 const struct osl_row *row, char **name, struct osl_object *def)
587 struct osl_object obj;
588 int ret = osl(osl_get_object(table, row, BLOBCOL_NAME, &obj));
592 return osl(osl_open_disk_object(table, row, BLOBCOL_DEF, def));
594 /** Define the \p get_name_and_def_by_row function for this blob type. */
595 #define DEFINE_GET_NAME_AND_DEF_BY_ROW(table_name, cmd_prefix) \
596 int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
597 char **name, struct osl_object *def) \
599 return blob_get_name_and_def_by_row(table_name ## _table, \
603 /** Define the \p close function for this blob type. */
604 #define DEFINE_BLOB_CLOSE(table_name) \
605 static void table_name ## _close(void) \
607 osl_close_table(table_name ## _table, OSL_MARK_CLEAN); \
608 table_name ## _table = NULL; \
611 /** Define the \p create function for this blob type. */
612 #define DEFINE_BLOB_CREATE(table_name) \
613 static int table_name ## _create(const char *dir) \
615 table_name ## _table_desc.dir = dir; \
616 return osl_create_table(&table_name ## _table_desc); \
619 static int blob_open(struct osl_table **table,
620 struct osl_table_description *desc,
625 ret = osl(osl_open_table(desc, table));
629 if (ret >= 0 || ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
634 #define DEFINE_BLOB_OPEN(table_name) \
635 static int table_name ## _open(const char *dir) \
637 return blob_open(&table_name ## _table, \
638 &table_name ## _table_desc, dir); \
642 /** Define the \p init function for this blob type. */
643 #define DEFINE_BLOB_INIT(table_name) \
644 void table_name ## _init(struct afs_table *t) \
646 t->open = table_name ## _open; \
647 t->close = table_name ## _close; \
648 t->create = table_name ## _create;\
649 t->event_handler = table_name ##_event_handler; \
650 table_name ## _table = NULL; \
654 /** Define all functions for this blob type. */
655 #define DEFINE_BLOB_FUNCTIONS(table_name, cmd_prefix) \
656 DEFINE_BLOB_OPEN(table_name) \
657 DEFINE_BLOB_CLOSE(table_name) \
658 DEFINE_BLOB_CREATE(table_name) \
659 DEFINE_BLOB_INIT(table_name) \
660 DEFINE_BLOB_COMMAND(ls, table_name, cmd_prefix) \
661 DEFINE_BLOB_COMMAND(cat, table_name, cmd_prefix) \
662 DEFINE_BLOB_COMMAND(add, table_name, cmd_prefix) \
663 DEFINE_BLOB_COMMAND(rm, table_name, cmd_prefix) \
664 DEFINE_BLOB_COMMAND(mv, table_name, cmd_prefix) \
665 DEFINE_GET_NAME_BY_ID(table_name, cmd_prefix); \
666 DEFINE_GET_DEF_BY_ID(table_name, cmd_prefix); \
667 DEFINE_GET_DEF_BY_NAME(table_name, cmd_prefix); \
668 DEFINE_GET_NAME_AND_DEF_BY_ROW(table_name, cmd_prefix); \
670 /* doxygen isn't smart enough to recognize these */
671 /** \cond blob_function */
672 DEFINE_BLOB_FUNCTIONS(lyrics, lyr);
673 DEFINE_BLOB_FUNCTIONS(images, img);
674 DEFINE_BLOB_FUNCTIONS(moods, mood);
675 DEFINE_BLOB_FUNCTIONS(playlists, pl);
676 /** \endcond blob_function */