2 * Copyright (C) 1997 Andre Noll <maan@tuebingen.mpg.de>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file attribute.c Attribute handling functions. */
22 static struct osl_table *attribute_table;
23 static int greatest_att_bitnum;
25 /** The columns of the attribute table. */
26 enum attribute_table_columns {
27 /** The bit number (0-63). */
29 /** The name of the attribute. */
31 /** Number of columns in this table. */
35 static int char_compare(const struct osl_object *obj1, const struct osl_object *obj2)
37 const unsigned char *c1 = (const unsigned char*)obj1->data;
38 const unsigned char *c2 = (const unsigned char*)obj2->data;
46 static struct osl_column_description att_cols[] = {
48 .storage_type = OSL_MAPPED_STORAGE,
49 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
51 .compare_function = char_compare,
55 .storage_type = OSL_MAPPED_STORAGE,
56 .storage_flags = OSL_RBTREE | OSL_UNIQUE,
58 .compare_function = string_compare,
62 static struct osl_table_description attribute_table_desc = {
64 .num_columns = NUM_ATT_COLUMNS,
66 .column_descriptions = att_cols
69 static void find_greatest_att_bitnum(void)
74 struct osl_object obj = {.data = &c, .size = 1};
75 if (osl_get_row(attribute_table, ATTCOL_BITNUM, &obj,
77 greatest_att_bitnum = c;
81 PARA_INFO_LOG("no attributes\n");
82 greatest_att_bitnum = -E_NO_ATTRIBUTES;
86 * Retrieve the identifier (number) of an attribute.
88 * \param att_name The name of the attribute.
89 * \param bitnum Result pointer.
91 * \return Positive on success, negative on errors.
93 int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum)
95 struct osl_object obj = {.data = (char *)att_name,
96 .size = strlen(att_name) + 1};
98 int ret = osl(osl_get_row(attribute_table, ATTCOL_NAME, &obj, &row));
102 ret = osl(osl_get_object(attribute_table, row, ATTCOL_BITNUM, &obj));
105 *bitnum = *(unsigned char *)obj.data;
110 * Flags used by the lsatt command.
112 * \param \sa com_lsatt().
115 /** Whether "-a" was given for the lsatt command. */
116 LSATT_FLAG_SORT_BY_ID = 1,
117 /** Whether "-l" was given for the lsatt command. */
119 /** Reverse sort order. */
120 LSATT_FLAG_REVERSE = 4
123 /** Data passed to the action function of lsatt */
124 struct lsatt_action_data {
125 /** The result buffer. */
126 struct para_buffer pb;
127 /** The given flags for the lsatt command. */
131 static int print_attribute(struct osl_table *table, struct osl_row *row,
132 const char *name, void *data)
134 struct lsatt_action_data *laad = data;
135 struct osl_object bitnum_obj;
138 if (!(laad->flags & LSATT_FLAG_LONG)) {
139 para_printf(&laad->pb, "%s\n", name);
142 ret = osl(osl_get_object(table, row, ATTCOL_BITNUM, &bitnum_obj));
144 para_printf(&laad->pb, "%s: %s\n", name, para_strerror(-ret));
147 para_printf(&laad->pb, "%u\t%s\n", *(unsigned char*)bitnum_obj.data,
152 static int com_lsatt_callback(struct afs_callback_arg *aca)
155 struct lsatt_action_data laad = {
156 .flags = *(unsigned *)aca->query.data,
158 .max_size = shm_get_shmmax(),
159 .private_data = &(struct afs_max_size_handler_data) {
163 .max_size_handler = afs_max_size_handler
167 struct pattern_match_data pmd = {
168 .table = attribute_table,
169 .loop_col_num = ATTCOL_BITNUM,
170 .match_col_num = ATTCOL_NAME,
171 .patterns = {.data = (char *)aca->query.data + sizeof(laad.flags),
172 .size = aca->query.size - sizeof(laad.flags)},
173 .pm_flags = PM_NO_PATTERN_MATCHES_EVERYTHING,
175 .action = print_attribute
177 if (laad.flags & LSATT_FLAG_SORT_BY_ID)
178 pmd.loop_col_num = ATTCOL_NAME;
179 if (laad.flags & LSATT_FLAG_REVERSE)
180 pmd.pm_flags |= PM_REVERSE_LOOP;
181 ret = for_each_matching_row(&pmd);
184 if (pmd.num_matches == 0)
187 flush_and_free_pb(&laad.pb);
191 int com_lsatt(struct command_context *cc)
194 struct osl_object options = {.data = &flags, .size = sizeof(flags)};
197 for (i = 1; i < cc->argc; i++) {
198 const char *arg = cc->argv[i];
201 if (!strcmp(arg, "--")) {
205 if (!strcmp(arg, "-i")) {
206 flags |= LSATT_FLAG_SORT_BY_ID;
209 if (!strcmp(arg, "-l")) {
210 flags |= LSATT_FLAG_LONG;
213 if (!strcmp(arg, "-r")) {
214 flags |= LSATT_FLAG_REVERSE;
218 return send_option_arg_callback_request(&options, cc->argc - i, cc->argv + i,
219 com_lsatt_callback, afs_cb_result_handler, cc);
222 struct addatt_event_data {
224 unsigned char bitnum;
228 static int com_addatt_callback(struct afs_callback_arg *aca)
232 struct para_buffer pb = {
233 .max_size = shm_get_shmmax(),
234 .private_data = &(struct afs_max_size_handler_data) {
238 .max_size_handler = afs_max_size_handler
244 p < (char *)aca->query.data + aca->query.size;
247 struct osl_object objs[NUM_ATT_COLUMNS];
249 unsigned char bitnum;
250 struct addatt_event_data aed;
253 if (!len || p[len - 1] == '-' || p[len - 1] == '+') {
254 para_printf(&pb, "invalid attribute name: %s\n", p);
257 ret = get_attribute_bitnum_by_name(p, &bitnum);
259 para_printf(&pb, "attribute \"%s\" already exists\n", p);
262 if (ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND)) /* error */
264 objs[ATTCOL_BITNUM].size = 1;
265 /* find smallest unused attribute */
266 for (bitnum = 0; bitnum < 64; bitnum++) {
267 objs[ATTCOL_BITNUM].data = &bitnum;
268 ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM,
269 &objs[ATTCOL_BITNUM], &row));
270 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
271 break; /* this bitnum is unused, use it */
272 if (ret < 0) /* error */
274 /* this bit is already in use, try next bit */
277 ret = -E_ATT_TABLE_FULL;
280 objs[ATTCOL_NAME].data = p;
281 objs[ATTCOL_NAME].size = len + 1;
282 ret = osl(osl_add_row(attribute_table, objs));
287 ret = afs_event(ATTRIBUTE_ADD, &pb, &aed);
290 greatest_att_bitnum = PARA_MAX(greatest_att_bitnum, (int)bitnum);
294 para_printf(&pb, "%s: %s\n", p, para_strerror(-ret));
295 flush_and_free_pb(&pb);
299 int com_addatt(struct command_context *cc)
304 return -E_ATTR_SYNTAX;
305 ret = send_standard_callback_request(cc->argc - 1, cc->argv + 1,
306 com_addatt_callback, afs_cb_result_handler, cc);
308 send_strerror(cc, -ret);
312 static int com_mvatt_callback(struct afs_callback_arg *aca)
314 char *old = aca->query.data;
315 size_t size = strlen(old) + 1;
316 char *new = old + size;
317 struct osl_object obj = {.data = old, .size = size};
319 struct para_buffer pb = {
320 .max_size = shm_get_shmmax(),
321 .private_data = &(struct afs_max_size_handler_data) {
325 .max_size_handler = afs_max_size_handler,
329 ret = osl(osl_get_row(attribute_table, ATTCOL_NAME, &obj, &row));
333 obj.size = strlen(new) + 1;
334 ret = osl(osl_update_object(attribute_table, row, ATTCOL_NAME, &obj));
337 para_printf(&pb, "cannot rename %s to %s\n", old, new);
339 ret = afs_event(ATTRIBUTE_RENAME, &pb, NULL);
340 flush_and_free_pb(&pb);
344 int com_mvatt(struct command_context *cc)
347 return -E_ATTR_SYNTAX;
348 return send_standard_callback_request(cc->argc - 1, cc->argv + 1,
349 com_mvatt_callback, afs_cb_result_handler, cc);
352 static int remove_attribute(struct osl_table *table, struct osl_row *row,
353 const char *name, void *data)
355 struct para_buffer *pb = data;
357 struct rmatt_event_data red = {.name = name};
359 ret = get_attribute_bitnum_by_name(name, &red.bitnum);
361 para_printf(pb, "cannot remove %s\n", name);
364 para_printf(pb, "removing attribute %s\n", name);
365 ret = osl(osl_del_row(table, row));
367 para_printf(pb, "cannot remove %s\n", name);
370 return afs_event(ATTRIBUTE_REMOVE, pb, &red);
373 static int com_rmatt_callback(struct afs_callback_arg *aca)
375 struct para_buffer pb = {
376 .max_size = shm_get_shmmax(),
377 .private_data = &(struct afs_max_size_handler_data) {
381 .max_size_handler = afs_max_size_handler,
384 struct pattern_match_data pmd = {
385 .table = attribute_table,
386 .patterns = aca->query,
387 .loop_col_num = ATTCOL_BITNUM,
388 .match_col_num = ATTCOL_NAME,
390 .action = remove_attribute
392 ret = for_each_matching_row(&pmd);
395 if (pmd.num_matches == 0)
398 flush_and_free_pb(&pb);
402 int com_rmatt(struct command_context *cc)
405 return -E_ATTR_SYNTAX;
406 return send_standard_callback_request(cc->argc - 1, cc->argv + 1,
407 com_rmatt_callback, afs_cb_result_handler, cc);
411 * Return a binary representation of the given attribute value.
413 * \param atts Pointer to the attribute value.
416 * This function prints a string of at most 64 characters plus the terminating
417 * \p NULL character into \a buf which must be provided by the caller and at
418 * least 65 bytes long. The "x" character is used for set attributes and "-" is
419 * used for unset attributes.
421 * In practice, not all 64 attributes are defined. In this case, the function
422 * only prints \a N + 1 characters where \a N is the greatest id of a defined
425 void get_attribute_bitmap(const uint64_t *atts, char *buf)
428 const uint64_t one = 1;
430 for (i = 0; i <= greatest_att_bitnum; i++)
431 buf[greatest_att_bitnum - i] = (*atts & (one << i))? 'x' : '-';
436 * Get a string containing the set attributes in text form.
438 * \param atts The attribute bitmap.
439 * \param delim The delimiter to separate matching attribute names.
440 * \param text Result pointer.
442 * \return Positive on success, negative on errors. If no attributes have
443 * been defined, \a *text is NULL.
445 int get_attribute_text(uint64_t *atts, const char *delim, char **text)
448 const uint64_t one = 1;
451 if (greatest_att_bitnum < 0) { /* no attributes available */
452 *text = para_strdup("(no attributes available)");
455 for (i = 0; i <= greatest_att_bitnum; i++) {
456 unsigned char bn = i;
457 struct osl_object obj = {.data = &bn, .size = 1};
460 if (!(*atts & (one << i)))
462 ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM, &obj, &row));
465 ret = osl(osl_get_object(attribute_table, row, ATTCOL_NAME, &obj));
469 char *tmp = make_message("%s%s%s", *text, delim, (char *)obj.data);
473 *text = para_strdup(obj.data);
475 if (!*text) /* no attributes set */
476 *text = para_strdup("");
483 static int att_logical_or(struct osl_row *row, void *data)
485 uint64_t *att_mask = data;
486 struct osl_object bitnum_obj;
487 int ret = osl_get_object(attribute_table, row, ATTCOL_BITNUM, &bitnum_obj);
491 *att_mask |= 1 << *(unsigned char *)bitnum_obj.data;
496 * Compute the attribute bit mask and check each afs info bitmap.
498 * \param aca The query field of \a aca is ignored.
500 * This iterates over all attributes in the attribute table and computes the
501 * logical or of 1 << b where b is the bit number of the attribute. The
502 * resulting bit mask is passed to aft_check_attributes() which performs the
507 * \sa \ref aft_check_attributes().
509 int attribute_check_callback(struct afs_callback_arg *aca)
512 uint64_t att_mask = 0; /* bits corresponding to a attributes */
513 struct para_buffer pb = {
514 .max_size = shm_get_shmmax(),
515 .private_data = &(struct afs_max_size_handler_data) {
519 .max_size_handler = afs_max_size_handler,
522 ret = osl_rbtree_loop(attribute_table, ATTCOL_BITNUM, &att_mask,
525 PARA_ERROR_LOG("attribute table loop failed: %s\n",
526 para_strerror(-ret));
529 ret = aft_check_attributes(att_mask, &pb);
530 flush_and_free_pb(&pb);
535 * Close the attribute table.
537 * \sa osl_close_table().
539 static void attribute_close(void)
541 osl_close_table(attribute_table, OSL_MARK_CLEAN);
542 attribute_table = NULL;
546 * Open the attribute table.
548 * \param dir The database directory.
550 * \return Positive on success, negative on errors.
552 * \sa osl_open_table().
554 static int attribute_open(const char *dir)
558 attribute_table_desc.dir = dir;
559 ret = osl(osl_open_table(&attribute_table_desc, &attribute_table));
560 greatest_att_bitnum = -1; /* no atts available */
562 find_greatest_att_bitnum();
565 attribute_table = NULL;
566 if (ret >= 0 || ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
571 static int attribute_create(const char *dir)
573 attribute_table_desc.dir = dir;
574 return osl(osl_create_table(&attribute_table_desc));
578 * Initialize the attribute table structure.
580 * \param t The table structure to initialize.
582 void attribute_init(struct afs_table *t)
584 t->open = attribute_open;
585 t->close = attribute_close;
586 t->create = attribute_create;