2 * Copyright (C) 2007-2014 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
) {
141 .max_size_handler
= afs_max_size_handler
,
144 struct pattern_match_data pmd
= {
146 .patterns
= {.data
= (char *)query
->data
+ sizeof(uint32_t),
147 .size
= query
->size
- sizeof(uint32_t)},
148 .pm_flags
= PM_NO_PATTERN_MATCHES_EVERYTHING
| PM_SKIP_EMPTY_NAME
,
149 .match_col_num
= BLOBCOL_NAME
,
151 .action
= print_blob
,
155 if (lbad
.flags
& BLOB_LS_FLAG_REVERSE
)
156 pmd
.pm_flags
|= PM_REVERSE_LOOP
;
157 if (!(lbad
.flags
& BLOB_LS_FLAG_SORT_BY_ID
))
158 pmd
.loop_col_num
= BLOBCOL_NAME
;
160 pmd
.loop_col_num
= BLOBCOL_ID
;
161 ret
= for_each_matching_row(&pmd
);
163 para_printf(&lbad
.pb
, "%s\n", para_strerror(-ret
));
164 else if (pmd
.num_matches
== 0 && pmd
.patterns
.size
> 0)
165 para_printf(&lbad
.pb
, "no matches\n");
167 pass_buffer_as_shm(fd
, SBD_OUTPUT
, lbad
.pb
.buf
, lbad
.pb
.offset
);
171 static int com_lsblob(callback_function
*f
, struct command_context
*cc
)
174 struct osl_object options
= {.data
= &flags
, .size
= sizeof(flags
)};
177 for (i
= 1; i
< cc
->argc
; i
++) {
178 const char *arg
= cc
->argv
[i
];
181 if (!strcmp(arg
, "--")) {
185 if (!strcmp(arg
, "-l")) {
186 flags
|= BLOB_LS_FLAG_LONG
;
189 if (!strcmp(arg
, "-i")) {
190 flags
|= BLOB_LS_FLAG_SORT_BY_ID
;
193 if (!strcmp(arg
, "-r")) {
194 flags
|= BLOB_LS_FLAG_REVERSE
;
200 // return -E_BLOB_SYNTAX;
201 return send_option_arg_callback_request(&options
, cc
->argc
- i
,
202 cc
->argv
+ i
, f
, afs_cb_result_handler
, cc
);
205 static int cat_blob(struct osl_table
*table
, struct osl_row
*row
,
206 __a_unused
const char *name
, void *data
)
208 int ret
= 0, ret2
, fd
= *(int *)data
;
209 struct osl_object obj
;
211 ret
= osl(osl_open_disk_object(table
, row
, BLOBCOL_DEF
, &obj
));
213 return (ret
== osl(-E_OSL_EMPTY
))? 0 : ret
;
214 assert(obj
.size
> 0);
215 ret
= pass_buffer_as_shm(fd
, SBD_OUTPUT
, obj
.data
, obj
.size
);
216 ret2
= osl(osl_close_disk_object(&obj
));
217 return (ret
< 0)? ret
: ret2
;
220 static void com_catblob_callback(struct osl_table
*table
, int fd
,
221 const struct osl_object
*query
)
223 struct pattern_match_data pmd
= {
226 .loop_col_num
= BLOBCOL_NAME
,
227 .match_col_num
= BLOBCOL_NAME
,
228 .pm_flags
= PM_SKIP_EMPTY_NAME
,
232 for_each_matching_row(&pmd
);
233 if (pmd
.num_matches
== 0) {
234 char err_msg
[] = "no matches\n";
235 pass_buffer_as_shm(fd
, SBD_OUTPUT
, err_msg
, sizeof(err_msg
));
239 static int com_catblob(callback_function
*f
, struct command_context
*cc
)
242 return -E_BLOB_SYNTAX
;
243 return send_standard_callback_request(cc
->argc
- 1, cc
->argv
+ 1, f
,
244 afs_cb_result_handler
, cc
);
247 /** Used for removing rows from a blob table. */
249 /** Message buffer. */
250 struct para_buffer pb
;
253 static int remove_blob(struct osl_table
*table
, struct osl_row
*row
,
254 const char *name
, void *data
)
256 struct rmblob_data
*rmbd
= data
;
257 int ret
= osl(osl_del_row(table
, row
));
259 para_printf(&rmbd
->pb
, "%s: %s\n", name
, para_strerror(-ret
));
265 static void com_rmblob_callback(struct osl_table
*table
, int fd
,
266 const struct osl_object
*query
)
269 struct rmblob_data rmbd
= {
271 .max_size
= shm_get_shmmax(),
272 .private_data
= &(struct afs_max_size_handler_data
) {
276 .max_size_handler
= afs_max_size_handler
,
279 struct pattern_match_data pmd
= {
282 .loop_col_num
= BLOBCOL_NAME
,
283 .match_col_num
= BLOBCOL_NAME
,
284 .pm_flags
= PM_SKIP_EMPTY_NAME
,
286 .action
= remove_blob
288 ret
= for_each_matching_row(&pmd
);
290 ret2
= para_printf(&rmbd
.pb
, "%s\n", para_strerror(-ret
));
294 if (pmd
.num_matches
== 0)
295 ret2
= para_printf(&rmbd
.pb
, "no matches, nothing removed\n");
297 ret2
= para_printf(&rmbd
.pb
, "removed %d blobs\n", pmd
.num_matches
);
298 afs_event(BLOB_RENAME
, NULL
, table
);
301 if (ret2
>= 0 && rmbd
.pb
.offset
)
302 pass_buffer_as_shm(fd
, SBD_OUTPUT
, rmbd
.pb
.buf
, rmbd
.pb
.offset
);
306 static int com_rmblob(callback_function
*f
, struct command_context
*cc
)
309 return -E_MOOD_SYNTAX
;
310 return send_option_arg_callback_request(NULL
, cc
->argc
- 1, cc
->argv
+ 1, f
,
311 afs_cb_result_handler
, cc
);
314 static void com_addblob_callback(struct osl_table
*table
, int fd
,
315 const struct osl_object
*query
)
317 struct osl_object objs
[NUM_BLOB_COLUMNS
];
318 char *name
= query
->data
, *msg
;
319 size_t name_len
= strlen(name
) + 1, msg_len
;
324 ret
= osl(osl_get_num_rows(table
, &num_rows
));
327 if (!num_rows
) { /* this is the first entry ever added */
328 /* insert dummy row containing the id */
329 id
= 2; /* this entry will be entry #1, so 2 is the next */
330 objs
[BLOBCOL_ID
].data
= &id
;
331 objs
[BLOBCOL_ID
].size
= sizeof(id
);
332 objs
[BLOBCOL_NAME
].data
= "";
333 objs
[BLOBCOL_NAME
].size
= 1;
334 objs
[BLOBCOL_DEF
].data
= "";
335 objs
[BLOBCOL_DEF
].size
= 1;
336 ret
= osl(osl_add_row(table
, objs
));
340 /* check if name already exists */
342 struct osl_object obj
= {.data
= name
, .size
= name_len
};
343 ret
= osl(osl_get_row(table
, BLOBCOL_NAME
, &obj
, &row
));
344 if (ret
< 0 && ret
!= -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND
))
346 if (ret
>= 0) { /* we already have a blob with this name */
347 ret
= osl(osl_get_object(table
, row
, BLOBCOL_ID
, &obj
));
350 id
= *(uint32_t *)obj
.data
;
351 obj
.data
= name
+ name_len
;
352 obj
.size
= query
->size
- name_len
;
353 ret
= osl(osl_update_object(table
, row
, BLOBCOL_DEF
, &obj
));
356 /* new blob, get id of the dummy row and increment it */
359 ret
= osl(osl_get_row(table
, BLOBCOL_NAME
, &obj
, &row
));
362 ret
= osl(osl_get_object(table
, row
, BLOBCOL_ID
, &obj
));
365 id
= *(uint32_t *)obj
.data
+ 1;
367 ret
= osl(osl_update_object(table
, row
, BLOBCOL_ID
, &obj
));
372 objs
[BLOBCOL_ID
].data
= &id
;
373 objs
[BLOBCOL_ID
].size
= sizeof(id
);
374 objs
[BLOBCOL_NAME
].data
= name
;
375 objs
[BLOBCOL_NAME
].size
= name_len
;
376 objs
[BLOBCOL_DEF
].data
= name
+ name_len
;
377 objs
[BLOBCOL_DEF
].size
= query
->size
- name_len
;
378 ret
= osl(osl_add_row(table
, objs
));
381 afs_event(BLOB_ADD
, NULL
, table
);
384 msg_len
= xasprintf(&msg
, "could not add %s: %s\n", name
,
385 para_strerror(-ret
));
387 msg_len
= xasprintf(&msg
, "added %s as id %u\n", name
, id
);
388 pass_buffer_as_shm(fd
, SBD_OUTPUT
, msg
, msg_len
);
392 /* Write input from fd to dynamically allocated buffer, but maximal 10M. */
393 static int fd2buf(struct stream_cipher_context
*scc
, struct osl_object
*obj
)
395 size_t max_size
= 10 * 1024 * 1024;
403 ret
= recv_sb(scc
, SBD_BLOB_DATA
, max_size
, &iov
);
412 if (iov
.iov_len
== 0) /* end of blob */
415 obj
->data
= iov
.iov_base
;
416 obj
->size
= iov
.iov_len
;
418 obj
->data
= para_realloc(obj
->data
, obj
->size
+ iov
.iov_len
);
419 memcpy(obj
->data
+ obj
->size
, iov
.iov_base
, iov
.iov_len
);
420 obj
->size
+= iov
.iov_len
;
422 max_size
-= iov
.iov_len
;
429 * Read data from a file descriptor, and send it to the afs process.
431 * \param cc Contains the file descriptor to read data from.
432 * \param arg_obj Pointer to the arguments to \a f.
433 * \param f The callback function.
434 * \param result_handler See \ref send_callback_request.
435 * \param private_result_data See \ref send_callback_request.
437 * This function is used by the addblob commands that instruct para_server to
438 * store arbitrary data in a blob table. Input data is read and decrypted from
439 * the file descriptor given by \a cc. This data is concatenated with the
440 * buffer given by \a arg_obj, and the combined buffer is made available to the
441 * afs process via the callback method. See \ref send_callback_request for
444 * \return Negative on errors, the return value of the underlying call to
445 * send_callback_request() otherwise.
447 static int stdin_command(struct command_context
*cc
, struct osl_object
*arg_obj
,
448 callback_function
*f
, callback_result_handler
*result_handler
,
449 void *private_result_data
)
451 struct osl_object query
, stdin_obj
;
454 ret
= send_sb(&cc
->scc
, NULL
, 0, SBD_AWAITING_DATA
, false);
457 ret
= fd2buf(&cc
->scc
, &stdin_obj
);
460 query
.size
= arg_obj
->size
+ stdin_obj
.size
;
461 query
.data
= para_malloc(query
.size
);
462 memcpy(query
.data
, arg_obj
->data
, arg_obj
->size
);
463 if (stdin_obj
.size
> 0)
464 memcpy((char *)query
.data
+ arg_obj
->size
, stdin_obj
.data
,
466 free(stdin_obj
.data
);
467 ret
= send_callback_request(f
, &query
, result_handler
, private_result_data
);
472 static int com_addblob(callback_function
*f
, struct command_context
*cc
)
474 struct osl_object arg_obj
;
477 return -E_BLOB_SYNTAX
;
478 if (!*cc
->argv
[1]) /* empty name is reserved for the dummy row */
479 return -E_BLOB_SYNTAX
;
480 arg_obj
.size
= strlen(cc
->argv
[1]) + 1;
481 arg_obj
.data
= (char *)cc
->argv
[1];
482 return stdin_command(cc
, &arg_obj
, f
, afs_cb_result_handler
, cc
);
485 /* FIXME: Print output to client, not to log file */
486 static void com_mvblob_callback(struct osl_table
*table
, __a_unused
int fd
,
487 const struct osl_object
*query
)
489 char *src
= (char *) query
->data
;
490 struct osl_object obj
= {.data
= src
, .size
= strlen(src
) + 1};
491 char *dest
= src
+ obj
.size
;
493 int ret
= osl(osl_get_row(table
, BLOBCOL_NAME
, &obj
, &row
));
498 obj
.size
= strlen(dest
) + 1;
499 ret
= osl(osl_update_object(table
, row
, BLOBCOL_NAME
, &obj
));
502 afs_event(BLOB_RENAME
, NULL
, table
);
505 PARA_NOTICE_LOG("%s\n", para_strerror(-ret
));
508 static int com_mvblob(callback_function
*f
, struct command_context
*cc
)
511 return -E_MOOD_SYNTAX
;
512 return send_option_arg_callback_request(NULL
, cc
->argc
- 1,
513 cc
->argv
+ 1, f
, NULL
, NULL
);
516 #define DEFINE_BLOB_COMMAND(cmd_name, table_name, cmd_prefix) \
517 static void com_ ## cmd_name ## cmd_prefix ## _callback(int fd, const struct osl_object *query) \
519 return com_ ## cmd_name ## blob_callback(table_name ## _table, fd, query); \
521 int com_ ## cmd_name ## cmd_prefix(struct command_context *cc) \
523 return com_ ## cmd_name ## blob(com_ ## cmd_name ## cmd_prefix ## _callback, cc); \
526 static int blob_get_name_by_id(struct osl_table
*table
, uint32_t id
,
530 struct osl_object obj
= {.data
= &id
, .size
= sizeof(id
)};
536 ret
= osl(osl_get_row(table
, BLOBCOL_ID
, &obj
, &row
));
539 ret
= osl(osl_get_object(table
, row
, BLOBCOL_NAME
, &obj
));
542 *name
= (char *)obj
.data
;
546 /** Define the \p get_name_by_id function for this blob type. */
547 #define DEFINE_GET_NAME_BY_ID(table_name, cmd_prefix) \
548 int cmd_prefix ## _get_name_by_id(uint32_t id, char **name) \
550 return blob_get_name_by_id(table_name ## _table, id, name); \
554 static int blob_get_def_by_name(struct osl_table
*table
, char *name
,
555 struct osl_object
*def
)
558 struct osl_object obj
= {.data
= name
, .size
= strlen(name
) + 1};
564 ret
= osl(osl_get_row(table
, BLOBCOL_NAME
, &obj
, &row
));
567 return osl(osl_open_disk_object(table
, row
, BLOBCOL_DEF
, def
));
570 /** Define the \p get_def_by_id function for this blob type. */
571 #define DEFINE_GET_DEF_BY_NAME(table_name, cmd_prefix) \
572 int cmd_prefix ## _get_def_by_name(char *name, struct osl_object *def) \
574 return blob_get_def_by_name(table_name ## _table, name, def); \
577 static int blob_get_def_by_id(struct osl_table
*table
, uint32_t id
,
578 struct osl_object
*def
)
581 struct osl_object obj
= {.data
= &id
, .size
= sizeof(id
)};
587 ret
= osl(osl_get_row(table
, BLOBCOL_ID
, &obj
, &row
));
590 return osl(osl_open_disk_object(table
, row
, BLOBCOL_DEF
, def
));
593 /** Define the \p get_def_by_id function for this blob type. */
594 #define DEFINE_GET_DEF_BY_ID(table_name, cmd_prefix) \
595 int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def) \
597 return blob_get_def_by_id(table_name ## _table, id, def); \
600 static int blob_get_name_and_def_by_row(struct osl_table
*table
,
601 const struct osl_row
*row
, char **name
, struct osl_object
*def
)
603 struct osl_object obj
;
604 int ret
= osl(osl_get_object(table
, row
, BLOBCOL_NAME
, &obj
));
608 return osl(osl_open_disk_object(table
, row
, BLOBCOL_DEF
, def
));
610 /** Define the \p get_name_and_def_by_row function for this blob type. */
611 #define DEFINE_GET_NAME_AND_DEF_BY_ROW(table_name, cmd_prefix) \
612 int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
613 char **name, struct osl_object *def) \
615 return blob_get_name_and_def_by_row(table_name ## _table, \
619 /** Define the \p close function for this blob type. */
620 #define DEFINE_BLOB_CLOSE(table_name) \
621 static void table_name ## _close(void) \
623 osl_close_table(table_name ## _table, OSL_MARK_CLEAN); \
624 table_name ## _table = NULL; \
627 /** Define the \p create function for this blob type. */
628 #define DEFINE_BLOB_CREATE(table_name) \
629 static int table_name ## _create(const char *dir) \
631 table_name ## _table_desc.dir = dir; \
632 return osl_create_table(&table_name ## _table_desc); \
635 static int blob_open(struct osl_table
**table
,
636 struct osl_table_description
*desc
,
641 ret
= osl(osl_open_table(desc
, table
));
645 if (ret
>= 0 || ret
== -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT
))
650 #define DEFINE_BLOB_OPEN(table_name) \
651 static int table_name ## _open(const char *dir) \
653 return blob_open(&table_name ## _table, \
654 &table_name ## _table_desc, dir); \
658 /** Define the \p init function for this blob type. */
659 #define DEFINE_BLOB_INIT(table_name) \
660 void table_name ## _init(struct afs_table *t) \
662 t->open = table_name ## _open; \
663 t->close = table_name ## _close; \
664 t->create = table_name ## _create;\
665 t->event_handler = table_name ##_event_handler; \
666 table_name ## _table = NULL; \
670 /** Define all functions for this blob type. */
671 #define DEFINE_BLOB_FUNCTIONS(table_name, cmd_prefix) \
672 DEFINE_BLOB_OPEN(table_name) \
673 DEFINE_BLOB_CLOSE(table_name) \
674 DEFINE_BLOB_CREATE(table_name) \
675 DEFINE_BLOB_INIT(table_name) \
676 DEFINE_BLOB_COMMAND(ls, table_name, cmd_prefix) \
677 DEFINE_BLOB_COMMAND(cat, table_name, cmd_prefix) \
678 DEFINE_BLOB_COMMAND(add, table_name, cmd_prefix) \
679 DEFINE_BLOB_COMMAND(rm, table_name, cmd_prefix) \
680 DEFINE_BLOB_COMMAND(mv, table_name, cmd_prefix) \
681 DEFINE_GET_NAME_BY_ID(table_name, cmd_prefix); \
682 DEFINE_GET_DEF_BY_ID(table_name, cmd_prefix); \
683 DEFINE_GET_DEF_BY_NAME(table_name, cmd_prefix); \
684 DEFINE_GET_NAME_AND_DEF_BY_ROW(table_name, cmd_prefix); \
686 /* doxygen isn't smart enough to recognize these */
687 /** \cond blob_function */
688 DEFINE_BLOB_FUNCTIONS(lyrics
, lyr
);
689 DEFINE_BLOB_FUNCTIONS(images
, img
);
690 DEFINE_BLOB_FUNCTIONS(moods
, mood
);
691 DEFINE_BLOB_FUNCTIONS(playlists
, pl
);
692 /** \endcond blob_function */