2 * Copyright (C) 2007-2011 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. */
21 #include "portable_io.h"
24 * Compare two osl objects pointing to unsigned integers of 32 bit size.
26 * \param obj1 Pointer to the first integer.
27 * \param obj2 Pointer to the second integer.
29 * \return The values required for an osl compare function.
31 * \sa osl_compare_func, osl_hash_compare().
33 static int uint32_compare(const struct osl_object
*obj1
, const struct osl_object
*obj2
)
35 uint32_t d1
= read_u32((const char *)obj1
->data
);
36 uint32_t d2
= read_u32((const char *)obj2
->data
);
45 static struct osl_column_description blob_cols
[] = {
47 .storage_type
= OSL_MAPPED_STORAGE
,
48 .storage_flags
= OSL_RBTREE
| OSL_UNIQUE
| OSL_FIXED_SIZE
,
51 .compare_function
= uint32_compare
54 .storage_type
= OSL_MAPPED_STORAGE
,
55 .storage_flags
= OSL_RBTREE
| OSL_UNIQUE
,
57 .compare_function
= string_compare
60 .storage_type
= OSL_DISK_STORAGE
,
66 /** Define an osl table description for a blob table. */
67 #define DEFINE_BLOB_TABLE_DESC(table_name) \
68 struct osl_table_description table_name ## _table_desc = { \
69 .name = #table_name, \
70 .num_columns = NUM_BLOB_COLUMNS, \
71 .flags = OSL_LARGE_TABLE, \
72 .column_descriptions = blob_cols \
75 /** Define a pointer to an osl blob table with a canonical name. */
76 #define DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table;
79 /** Define a blob table. */
80 #define INIT_BLOB_TABLE(table_name) \
81 DEFINE_BLOB_TABLE_DESC(table_name); \
82 DEFINE_BLOB_TABLE_PTR(table_name);
84 /** \cond doxygen isn't smart enough to recognize these */
85 INIT_BLOB_TABLE(lyrics
);
86 INIT_BLOB_TABLE(images
);
87 INIT_BLOB_TABLE(moods
);
88 INIT_BLOB_TABLE(playlists
);
91 /** Flags that may be passed to the \p ls functions of each blob type. */
93 /** List both id and name. */
94 BLOB_LS_FLAG_LONG
= 1,
95 /** Reverse sort order. */
96 BLOB_LS_FLAG_REVERSE
= 2,
97 /** Sort by id instead of name. */
98 BLOB_LS_FLAG_SORT_BY_ID
= 4,
101 /** Structure passed to the \p print_blob function. */
102 struct lsblob_action_data
{
103 /** The flags given at the command line. */
105 /** Message buffer. */
106 struct para_buffer pb
;
109 static int print_blob(struct osl_table
*table
, struct osl_row
*row
,
110 const char *name
, void *data
)
112 struct lsblob_action_data
*lbad
= data
;
113 struct osl_object obj
;
117 if (!(lbad
->flags
& BLOB_LS_FLAG_LONG
))
118 return para_printf(&lbad
->pb
, "%s\n", name
);
119 ret
= osl(osl_get_object(table
, row
, BLOBCOL_ID
, &obj
));
121 para_printf(&lbad
->pb
, "%s: %s\n", name
, para_strerror(-ret
));
124 id
= *(uint32_t *)obj
.data
;
125 return para_printf(&lbad
->pb
, "%u\t%s\n", id
, name
);
128 static void com_lsblob_callback(struct osl_table
*table
,
129 int fd
, const struct osl_object
*query
)
131 struct lsblob_action_data lbad
= {
132 .flags
= *(uint32_t *)query
->data
,
136 .max_size_handler
= pass_buffer_as_shm
139 struct pattern_match_data pmd
= {
141 .patterns
= {.data
= (char *)query
->data
+ sizeof(uint32_t),
142 .size
= query
->size
- sizeof(uint32_t)},
143 .pm_flags
= PM_NO_PATTERN_MATCHES_EVERYTHING
| PM_SKIP_EMPTY_NAME
,
144 .match_col_num
= BLOBCOL_NAME
,
146 .action
= print_blob
,
150 if (lbad
.flags
& BLOB_LS_FLAG_REVERSE
)
151 pmd
.pm_flags
|= PM_REVERSE_LOOP
;
152 if (!(lbad
.flags
& BLOB_LS_FLAG_SORT_BY_ID
))
153 pmd
.loop_col_num
= BLOBCOL_NAME
;
155 pmd
.loop_col_num
= BLOBCOL_ID
;
156 ret
= for_each_matching_row(&pmd
);
158 para_printf(&lbad
.pb
, "%s\n", para_strerror(-ret
));
160 pass_buffer_as_shm(lbad
.pb
.buf
, lbad
.pb
.offset
, &fd
);
164 static int com_lsblob(callback_function
*f
, struct stream_cipher_context
*scc
, int argc
, char * const * const argv
)
167 struct osl_object options
= {.data
= &flags
, .size
= sizeof(flags
)};
170 for (i
= 1; i
< argc
; i
++) {
171 const char *arg
= argv
[i
];
174 if (!strcmp(arg
, "--")) {
178 if (!strcmp(arg
, "-l")) {
179 flags
|= BLOB_LS_FLAG_LONG
;
182 if (!strcmp(arg
, "-i")) {
183 flags
|= BLOB_LS_FLAG_SORT_BY_ID
;
186 if (!strcmp(arg
, "-r")) {
187 flags
|= BLOB_LS_FLAG_REVERSE
;
193 // return -E_BLOB_SYNTAX;
194 return send_option_arg_callback_request(&options
, argc
- i
,
195 argv
+ i
, f
, sc_send_result
, scc
);
198 static int cat_blob(struct osl_table
*table
, struct osl_row
*row
,
199 __a_unused
const char *name
, void *data
)
202 struct osl_object obj
;
204 ret
= osl(osl_open_disk_object(table
, row
, BLOBCOL_DEF
, &obj
));
208 ret
= pass_buffer_as_shm(obj
.data
, obj
.size
, data
);
209 ret2
= osl(osl_close_disk_object(&obj
));
210 return (ret
< 0)? ret
: ret2
;
213 static void com_catblob_callback(struct osl_table
*table
, int fd
,
214 const struct osl_object
*query
)
216 struct pattern_match_data pmd
= {
219 .loop_col_num
= BLOBCOL_NAME
,
220 .match_col_num
= BLOBCOL_NAME
,
221 .pm_flags
= PM_SKIP_EMPTY_NAME
,
225 for_each_matching_row(&pmd
);
228 static int com_catblob(callback_function
*f
, struct stream_cipher_context
*scc
, int argc
,
229 char * const * const argv
)
232 return -E_BLOB_SYNTAX
;
233 return send_standard_callback_request(argc
- 1, argv
+ 1, f
,
234 sc_send_result
, scc
);
237 /** Used for removing rows from a blob table. */
239 /** Message buffer. */
240 struct para_buffer pb
;
241 /** Number of removed blobs. */
242 unsigned num_removed
;
245 static int remove_blob(struct osl_table
*table
, struct osl_row
*row
,
246 const char *name
, void *data
)
248 struct rmblob_data
*rmbd
= data
;
249 int ret
= osl(osl_del_row(table
, row
));
251 para_printf(&rmbd
->pb
, "%s: %s\n", name
, para_strerror(-ret
));
258 static void com_rmblob_callback(struct osl_table
*table
, int fd
,
259 const struct osl_object
*query
)
262 struct rmblob_data rmbd
= {
267 .max_size_handler
= pass_buffer_as_shm
270 struct pattern_match_data pmd
= {
273 .loop_col_num
= BLOBCOL_NAME
,
274 .match_col_num
= BLOBCOL_NAME
,
275 .pm_flags
= PM_SKIP_EMPTY_NAME
,
277 .action
= remove_blob
279 ret
= for_each_matching_row(&pmd
);
281 ret2
= para_printf(&rmbd
.pb
, "%s\n", para_strerror(-ret
));
285 if (!rmbd
.num_removed
)
286 ret2
= para_printf(&rmbd
.pb
, "no matches, nothing removed\n");
288 ret2
= para_printf(&rmbd
.pb
, "removed %d blobs\n", rmbd
.num_removed
);
289 afs_event(BLOB_RENAME
, NULL
, table
);
292 if (ret2
>= 0 && rmbd
.pb
.offset
)
293 pass_buffer_as_shm(rmbd
.pb
.buf
, rmbd
.pb
.offset
, &fd
);
297 static int com_rmblob(callback_function
*f
, struct stream_cipher_context
*scc
, int argc
,
298 char * const * const argv
)
301 return -E_MOOD_SYNTAX
;
302 return send_option_arg_callback_request(NULL
, argc
- 1, argv
+ 1, f
,
303 sc_send_result
, scc
);
306 static void com_addblob_callback(struct osl_table
*table
, __a_unused
int fd
,
307 const struct osl_object
*query
)
309 struct osl_object objs
[NUM_BLOB_COLUMNS
];
310 char *name
= query
->data
;
311 size_t name_len
= strlen(name
) + 1;
316 ret
= osl(osl_get_num_rows(table
, &num_rows
));
319 if (!num_rows
) { /* this is the first entry ever added */
320 /* insert dummy row containing the id */
321 id
= 2; /* this entry will be entry #1, so 2 is the next */
322 objs
[BLOBCOL_ID
].data
= &id
;
323 objs
[BLOBCOL_ID
].size
= sizeof(id
);
324 objs
[BLOBCOL_NAME
].data
= "";
325 objs
[BLOBCOL_NAME
].size
= 1;
326 objs
[BLOBCOL_DEF
].data
= "";
327 objs
[BLOBCOL_DEF
].size
= 1;
328 ret
= osl(osl_add_row(table
, objs
));
332 /* check if name already exists */
334 struct osl_object obj
= {.data
= name
, .size
= name_len
};
335 ret
= osl(osl_get_row(table
, BLOBCOL_NAME
, &obj
, &row
));
336 if (ret
< 0 && ret
!= -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND
))
338 if (ret
>= 0) { /* we already have a blob with this name */
339 obj
.data
= name
+ name_len
;
340 obj
.size
= query
->size
- name_len
;
341 ret
= osl(osl_update_object(table
, row
, BLOBCOL_DEF
, &obj
));
344 /* new blob, get id of the dummy row and increment it */
347 ret
= osl(osl_get_row(table
, BLOBCOL_NAME
, &obj
, &row
));
350 ret
= osl(osl_get_object(table
, row
, BLOBCOL_ID
, &obj
));
353 id
= *(uint32_t *)obj
.data
+ 1;
355 ret
= osl(osl_update_object(table
, row
, BLOBCOL_ID
, &obj
));
360 objs
[BLOBCOL_ID
].data
= &id
;
361 objs
[BLOBCOL_ID
].size
= sizeof(id
);
362 objs
[BLOBCOL_NAME
].data
= name
;
363 objs
[BLOBCOL_NAME
].size
= name_len
;
364 objs
[BLOBCOL_DEF
].data
= name
+ name_len
;
365 objs
[BLOBCOL_DEF
].size
= query
->size
- name_len
;
366 ret
= osl(osl_add_row(table
, objs
));
369 afs_event(BLOB_ADD
, NULL
, table
);
372 PARA_NOTICE_LOG("%s\n", para_strerror(-ret
));
376 * write input from fd to dynamically allocated buffer,
377 * but maximal max_size byte.
379 static int fd2buf(struct stream_cipher_context
*scc
, unsigned max_size
, struct osl_object
*obj
)
381 const size_t chunk_size
= 1024;
382 size_t size
= 2048, received
= 0;
384 char *buf
= para_malloc(size
);
387 ret
= sc_recv_bin_buffer(scc
, buf
+ received
, chunk_size
);
391 if (received
+ chunk_size
>= size
) {
393 ret
= -E_INPUT_TOO_LARGE
;
396 buf
= para_realloc(buf
, size
);
400 obj
->size
= received
;
407 * Read data from a file descriptor, and send it to the afs process.
409 * \param scc crypt context containing the file descriptor to read data from.
410 * \param arg_obj Pointer to the arguments to \a f.
411 * \param f The callback function.
412 * \param max_len Don't read more than that many bytes from stdin.
413 * \param result_handler See \ref send_callback_request.
414 * \param private_result_data See \ref send_callback_request.
416 * This function is used by commands that wish to let para_server store
417 * arbitrary data specified by the user (for instance the add_blob family of
418 * commands). First, at most \a max_len bytes are read and decrypted from the
419 * file descriptor given by \a scc. The result is concatenated with the buffer
420 * given by \a arg_obj, and the combined buffer is made available to the afs
421 * process via the callback method. See \ref send_callback_request for details.
423 * \return Negative on errors, the return value of the underlying call to
424 * send_callback_request() otherwise.
426 static int stdin_command(struct stream_cipher_context
*scc
, struct osl_object
*arg_obj
,
427 callback_function
*f
, unsigned max_len
,
428 callback_result_handler
*result_handler
,
429 void *private_result_data
)
431 struct osl_object query
, stdin_obj
;
434 ret
= sc_send_buffer(scc
, AWAITING_DATA_MSG
);
437 ret
= fd2buf(scc
, max_len
, &stdin_obj
);
440 query
.size
= arg_obj
->size
+ stdin_obj
.size
;
441 query
.data
= para_malloc(query
.size
);
442 memcpy(query
.data
, arg_obj
->data
, arg_obj
->size
);
443 memcpy((char *)query
.data
+ arg_obj
->size
, stdin_obj
.data
, stdin_obj
.size
);
444 free(stdin_obj
.data
);
445 ret
= send_callback_request(f
, &query
, result_handler
, private_result_data
);
450 static int com_addblob(callback_function
*f
, struct stream_cipher_context
*scc
, int argc
,
451 char * const * const argv
)
453 struct osl_object arg_obj
;
456 return -E_BLOB_SYNTAX
;
457 if (!*argv
[1]) /* empty name is reserved for the dummy row */
458 return -E_BLOB_SYNTAX
;
459 arg_obj
.size
= strlen(argv
[1]) + 1;
460 arg_obj
.data
= (char *)argv
[1];
461 return stdin_command(scc
, &arg_obj
, f
, 10 * 1024 * 1024, NULL
, NULL
);
464 /* FIXME: Print output to client, not to log file */
465 static void com_mvblob_callback(struct osl_table
*table
, __a_unused
int fd
,
466 const struct osl_object
*query
)
468 char *src
= (char *) query
->data
;
469 struct osl_object obj
= {.data
= src
, .size
= strlen(src
) + 1};
470 char *dest
= src
+ obj
.size
;
472 int ret
= osl(osl_get_row(table
, BLOBCOL_NAME
, &obj
, &row
));
477 obj
.size
= strlen(dest
) + 1;
478 ret
= osl(osl_update_object(table
, row
, BLOBCOL_NAME
, &obj
));
481 afs_event(BLOB_RENAME
, NULL
, table
);
484 PARA_NOTICE_LOG("%s\n", para_strerror(-ret
));
487 static int com_mvblob(callback_function
*f
, __a_unused
struct stream_cipher_context
*scc
,
488 int argc
, char * const * const argv
)
491 return -E_MOOD_SYNTAX
;
492 return send_option_arg_callback_request(NULL
, argc
- 1, argv
+ 1, f
,
496 #define DEFINE_BLOB_COMMAND(cmd_name, table_name, cmd_prefix) \
497 static void com_ ## cmd_name ## cmd_prefix ## _callback(int fd, const struct osl_object *query) \
499 return com_ ## cmd_name ## blob_callback(table_name ## _table, fd, query); \
501 int com_ ## cmd_name ## cmd_prefix(struct stream_cipher_context *scc, int argc, char * const * const argv) \
503 return com_ ## cmd_name ## blob(com_ ## cmd_name ## cmd_prefix ## _callback, scc, argc, argv); \
506 static int blob_get_name_by_id(struct osl_table
*table
, uint32_t id
,
510 struct osl_object obj
= {.data
= &id
, .size
= sizeof(id
)};
516 ret
= osl(osl_get_row(table
, BLOBCOL_ID
, &obj
, &row
));
519 ret
= osl(osl_get_object(table
, row
, BLOBCOL_NAME
, &obj
));
522 *name
= (char *)obj
.data
;
526 /** Define the \p get_name_by_id function for this blob type. */
527 #define DEFINE_GET_NAME_BY_ID(table_name, cmd_prefix) \
528 int cmd_prefix ## _get_name_by_id(uint32_t id, char **name) \
530 return blob_get_name_by_id(table_name ## _table, id, name); \
534 static int blob_get_def_by_name(struct osl_table
*table
, char *name
,
535 struct osl_object
*def
)
538 struct osl_object obj
= {.data
= name
, .size
= strlen(name
) + 1};
544 ret
= osl(osl_get_row(table
, BLOBCOL_NAME
, &obj
, &row
));
547 return osl(osl_open_disk_object(table
, row
, BLOBCOL_DEF
, def
));
550 /** Define the \p get_def_by_id function for this blob type. */
551 #define DEFINE_GET_DEF_BY_NAME(table_name, cmd_prefix) \
552 int cmd_prefix ## _get_def_by_name(char *name, struct osl_object *def) \
554 return blob_get_def_by_name(table_name ## _table, name, def); \
557 static int blob_get_def_by_id(struct osl_table
*table
, uint32_t id
,
558 struct osl_object
*def
)
561 struct osl_object obj
= {.data
= &id
, .size
= sizeof(id
)};
567 ret
= osl(osl_get_row(table
, BLOBCOL_ID
, &obj
, &row
));
570 return osl(osl_open_disk_object(table
, row
, BLOBCOL_DEF
, def
));
573 /** Define the \p get_def_by_id function for this blob type. */
574 #define DEFINE_GET_DEF_BY_ID(table_name, cmd_prefix) \
575 int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def) \
577 return blob_get_def_by_id(table_name ## _table, id, def); \
580 static int blob_get_name_and_def_by_row(struct osl_table
*table
,
581 const struct osl_row
*row
, char **name
, struct osl_object
*def
)
583 struct osl_object obj
;
584 int ret
= osl(osl_get_object(table
, row
, BLOBCOL_NAME
, &obj
));
588 return osl(osl_open_disk_object(table
, row
, BLOBCOL_DEF
, def
));
590 /** Define the \p get_name_and_def_by_row function for this blob type. */
591 #define DEFINE_GET_NAME_AND_DEF_BY_ROW(table_name, cmd_prefix) \
592 int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
593 char **name, struct osl_object *def) \
595 return blob_get_name_and_def_by_row(table_name ## _table, \
599 /** Define the \p close function for this blob type. */
600 #define DEFINE_BLOB_CLOSE(table_name) \
601 static void table_name ## _close(void) \
603 osl_close_table(table_name ## _table, OSL_MARK_CLEAN); \
604 table_name ## _table = NULL; \
607 /** Define the \p create function for this blob type. */
608 #define DEFINE_BLOB_CREATE(table_name) \
609 static int table_name ## _create(const char *dir) \
611 table_name ## _table_desc.dir = dir; \
612 return osl_create_table(&table_name ## _table_desc); \
615 static int blob_open(struct osl_table
**table
,
616 struct osl_table_description
*desc
,
621 ret
= osl(osl_open_table(desc
, table
));
625 if (ret
>= 0 || ret
== -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT
))
630 #define DEFINE_BLOB_OPEN(table_name) \
631 static int table_name ## _open(const char *dir) \
633 return blob_open(&table_name ## _table, \
634 &table_name ## _table_desc, dir); \
638 /** Define the \p init function for this blob type. */
639 #define DEFINE_BLOB_INIT(table_name) \
640 void table_name ## _init(struct afs_table *t) \
642 t->open = table_name ## _open; \
643 t->close = table_name ## _close; \
644 t->create = table_name ## _create;\
645 t->event_handler = table_name ##_event_handler; \
646 table_name ## _table = NULL; \
650 /** Define all functions for this blob type. */
651 #define DEFINE_BLOB_FUNCTIONS(table_name, cmd_prefix) \
652 DEFINE_BLOB_OPEN(table_name) \
653 DEFINE_BLOB_CLOSE(table_name) \
654 DEFINE_BLOB_CREATE(table_name) \
655 DEFINE_BLOB_INIT(table_name) \
656 DEFINE_BLOB_COMMAND(ls, table_name, cmd_prefix) \
657 DEFINE_BLOB_COMMAND(cat, table_name, cmd_prefix) \
658 DEFINE_BLOB_COMMAND(add, table_name, cmd_prefix) \
659 DEFINE_BLOB_COMMAND(rm, table_name, cmd_prefix) \
660 DEFINE_BLOB_COMMAND(mv, table_name, cmd_prefix) \
661 DEFINE_GET_NAME_BY_ID(table_name, cmd_prefix); \
662 DEFINE_GET_DEF_BY_ID(table_name, cmd_prefix); \
663 DEFINE_GET_DEF_BY_NAME(table_name, cmd_prefix); \
664 DEFINE_GET_NAME_AND_DEF_BY_ROW(table_name, cmd_prefix); \
666 /** \cond doxygen isn't smart enough to recognize these */
667 DEFINE_BLOB_FUNCTIONS(lyrics
, lyr
);
668 DEFINE_BLOB_FUNCTIONS(images
, img
);
669 DEFINE_BLOB_FUNCTIONS(moods
, mood
);
670 DEFINE_BLOB_FUNCTIONS(playlists
, pl
);