1 /* Copyright (C) 1997 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
3 /** \file attribute.c Attribute handling functions. */
9 #include "server_cmd.lsg.h"
20 static struct osl_table *attribute_table;
21 static int greatest_att_bitnum;
23 /** The columns of the attribute table. */
24 enum attribute_table_columns {
25 /** The bit number (0-63). */
27 /** The name of the attribute. */
29 /** Number of columns in this table. */
33 static int char_compare(const struct osl_object *obj1, const struct osl_object *obj2)
35 const unsigned char *c1 = (const unsigned char*)obj1->data;
36 const unsigned char *c2 = (const unsigned char*)obj2->data;
44 static struct osl_column_description att_cols[] = {
46 .storage_type = OSL_MAPPED_STORAGE,
47 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
49 .compare_function = char_compare,
53 .storage_type = OSL_MAPPED_STORAGE,
54 .storage_flags = OSL_RBTREE | OSL_UNIQUE,
56 .compare_function = string_compare,
60 static struct osl_table_description attribute_table_desc = {
62 .num_columns = NUM_ATT_COLUMNS,
64 .column_descriptions = att_cols
67 static void find_greatest_att_bitnum(void)
72 struct osl_object obj = {.data = &c, .size = 1};
73 if (osl_get_row(attribute_table, ATTCOL_BITNUM, &obj,
75 greatest_att_bitnum = c;
79 PARA_INFO_LOG("no attributes\n");
80 greatest_att_bitnum = -E_NO_ATTRIBUTES;
84 * Retrieve the identifier (number) of an attribute.
86 * \param att_name The name of the attribute.
87 * \param bitnum Result pointer.
89 * \return Positive on success, negative on errors.
91 int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum)
93 struct osl_object obj = {.data = (char *)att_name,
94 .size = strlen(att_name) + 1};
96 int ret = osl(osl_get_row(attribute_table, ATTCOL_NAME, &obj, &row));
100 ret = osl(osl_get_object(attribute_table, row, ATTCOL_BITNUM, &obj));
103 *bitnum = *(unsigned char *)obj.data;
107 /* Data passed to the action function of lsatt */
108 static int print_attribute(struct osl_table *table, struct osl_row *row,
109 const char *name, void *data)
111 struct afs_callback_arg *aca = data;
112 bool l_given = SERVER_CMD_OPT_GIVEN(LSATT, LONG, aca->lpr);
113 struct osl_object bitnum_obj;
117 para_printf(&aca->pbout, "%s\n", name);
120 ret = osl(osl_get_object(table, row, ATTCOL_BITNUM, &bitnum_obj));
122 para_printf(&aca->pbout, "%s: %s\n", name, para_strerror(-ret));
125 para_printf(&aca->pbout, "%u\t%s\n", *(unsigned char*)bitnum_obj.data,
130 static int com_lsatt_callback(struct afs_callback_arg *aca)
132 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(LSATT);
133 bool i_given, r_given;
135 struct pattern_match_data pmd = {
136 .table = attribute_table,
137 .loop_col_num = ATTCOL_NAME,
138 .match_col_num = ATTCOL_NAME,
139 .pm_flags = PM_NO_PATTERN_MATCHES_EVERYTHING,
141 .action = print_attribute
144 ret = lls(lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr));
147 i_given = SERVER_CMD_OPT_GIVEN(LSATT, ID_SORT, aca->lpr);
148 r_given = SERVER_CMD_OPT_GIVEN(LSATT, REVERSE, aca->lpr);
151 pmd.loop_col_num = ATTCOL_BITNUM;
153 pmd.pm_flags |= PM_REVERSE_LOOP;
154 ret = for_each_matching_row(&pmd);
157 if (pmd.num_matches == 0)
160 lls_free_parse_result(aca->lpr, cmd);
164 static int com_lsatt(struct command_context *cc, struct lls_parse_result *lpr)
166 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(LSATT);
167 return send_lls_callback_request(com_lsatt_callback, cmd, lpr, cc);
169 EXPORT_SERVER_CMD_HANDLER(lsatt);
171 struct addatt_event_data {
173 unsigned char bitnum;
176 static int com_addatt_callback(struct afs_callback_arg *aca)
178 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(ADDATT);
183 ret = lls(lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr));
185 num_inputs = lls_num_inputs(aca->lpr);
186 for (i = 0; i < num_inputs; i++) {
187 const char *name = lls_input(i, aca->lpr);
188 struct osl_object objs[NUM_ATT_COLUMNS];
190 unsigned char bitnum;
191 struct addatt_event_data aed;
194 if (len == 0 || name[len - 1] == '-' || name[len - 1] == '+') {
195 para_printf(&aca->pbout,
196 "invalid attribute name: %s\n", name);
199 ret = get_attribute_bitnum_by_name(name, &bitnum);
201 para_printf(&aca->pbout,
202 "attribute \"%s\" already exists\n", name);
205 if (ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND)) /* error */
207 objs[ATTCOL_BITNUM].size = 1;
208 /* find smallest unused attribute */
209 for (bitnum = 0; bitnum < 64; bitnum++) {
210 objs[ATTCOL_BITNUM].data = &bitnum;
211 ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM,
212 &objs[ATTCOL_BITNUM], &row));
213 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
214 break; /* this bitnum is unused, use it */
215 if (ret < 0) /* error */
217 /* this bit is already in use, try next bit */
220 ret = -E_ATT_TABLE_FULL;
223 objs[ATTCOL_NAME].data = (char *)name;
224 objs[ATTCOL_NAME].size = len + 1;
225 ret = osl(osl_add_row(attribute_table, objs));
230 ret = afs_event(ATTRIBUTE_ADD, &aca->pbout, &aed);
233 greatest_att_bitnum = PARA_MAX(greatest_att_bitnum, (int)bitnum);
237 para_printf(&aca->pbout, "error while adding %s\n",
238 lls_input(i, aca->lpr));
239 lls_free_parse_result(aca->lpr, cmd);
243 static int com_addatt(struct command_context *cc, struct lls_parse_result *lpr)
245 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(ADDATT);
247 int ret = lls(lls_check_arg_count(lpr, 1, 64, &errctx));
250 send_errctx(cc, errctx);
253 return send_lls_callback_request(com_addatt_callback, cmd, lpr, cc);
255 EXPORT_SERVER_CMD_HANDLER(addatt);
257 static int com_mvatt_callback(struct afs_callback_arg *aca)
259 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(MVATT);
260 const char *old, *new;
261 struct osl_object obj;
265 ret = lls(lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr));
267 old = lls_input(0, aca->lpr);
268 new = lls_input(1, aca->lpr);
269 obj.data = (char *)old;
270 obj.size = strlen(old) + 1;
271 ret = osl(osl_get_row(attribute_table, ATTCOL_NAME, &obj, &row));
274 obj.data = (char *)new;
275 obj.size = strlen(new) + 1;
276 /* The update fails if the destination attribute exists. */
277 ret = osl(osl_update_object(attribute_table, row, ATTCOL_NAME, &obj));
280 para_printf(&aca->pbout, "cannot rename %s to %s\n", old, new);
282 ret = afs_event(ATTRIBUTE_RENAME, &aca->pbout, NULL);
283 lls_free_parse_result(aca->lpr, cmd);
287 static int com_mvatt(struct command_context *cc, struct lls_parse_result *lpr)
289 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(MVATT);
291 int ret = lls(lls_check_arg_count(lpr, 2, 2, &errctx));
293 send_errctx(cc, errctx);
296 return send_lls_callback_request(com_mvatt_callback, cmd, lpr, cc);
298 EXPORT_SERVER_CMD_HANDLER(mvatt);
300 static int remove_attribute(struct osl_table *table, struct osl_row *row,
301 const char *name, void *data)
303 struct afs_callback_arg *aca = data;
305 struct rmatt_event_data red = {.name = name};
307 ret = get_attribute_bitnum_by_name(name, &red.bitnum);
309 para_printf(&aca->pbout, "cannot remove %s\n", name);
312 para_printf(&aca->pbout, "removing attribute %s\n", name);
313 ret = osl(osl_del_row(table, row));
315 para_printf(&aca->pbout, "cannot remove %s\n", name);
318 return afs_event(ATTRIBUTE_REMOVE, &aca->pbout, &red);
321 static int com_rmatt_callback(struct afs_callback_arg *aca)
323 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(RMATT);
325 struct pattern_match_data pmd = {
326 .table = attribute_table,
327 .loop_col_num = ATTCOL_BITNUM,
328 .match_col_num = ATTCOL_NAME,
330 .action = remove_attribute
332 ret = lls(lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr));
335 ret = for_each_matching_row(&pmd);
338 if (pmd.num_matches == 0)
341 lls_free_parse_result(aca->lpr, cmd);
345 static int com_rmatt(struct command_context *cc, struct lls_parse_result *lpr)
347 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(RMATT);
349 int ret = lls(lls_check_arg_count(lpr, 1, INT_MAX, &errctx));
352 send_errctx(cc, errctx);
355 return send_lls_callback_request(com_rmatt_callback, cmd, lpr, cc);
357 EXPORT_SERVER_CMD_HANDLER(rmatt);
360 * Return a binary representation of the given attribute value.
362 * \param atts Pointer to the attribute value.
365 * This function prints a string of at most 64 characters plus the terminating
366 * \p NULL character into \a buf which must be provided by the caller and at
367 * least 65 bytes long. The "x" character is used for set attributes and "-" is
368 * used for unset attributes.
370 * In practice, not all 64 attributes are defined. In this case, the function
371 * only prints \a N + 1 characters where \a N is the greatest id of a defined
374 void get_attribute_bitmap(const uint64_t *atts, char *buf)
377 const uint64_t one = 1;
379 for (i = 0; i <= greatest_att_bitnum; i++)
380 buf[greatest_att_bitnum - i] = (*atts & (one << i))? 'x' : '-';
385 * Get a string containing the set attributes in text form.
387 * \param atts The attribute bitmap.
388 * \param delim The delimiter to separate matching attribute names.
389 * \param text Result pointer.
391 * \return Positive on success, negative on errors. If no attributes have
392 * been defined, \a *text is NULL.
394 int get_attribute_text(uint64_t *atts, const char *delim, char **text)
397 const uint64_t one = 1;
400 if (greatest_att_bitnum < 0) { /* no attributes available */
401 *text = para_strdup("(no attributes available)");
404 for (i = 0; i <= greatest_att_bitnum; i++) {
405 unsigned char bn = i;
406 struct osl_object obj = {.data = &bn, .size = 1};
409 if (!(*atts & (one << i)))
411 ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM, &obj, &row));
414 ret = osl(osl_get_object(attribute_table, row, ATTCOL_NAME, &obj));
418 char *tmp = make_message("%s%s%s", *text, delim, (char *)obj.data);
422 *text = para_strdup(obj.data);
424 if (!*text) /* no attributes set */
425 *text = para_strdup("");
432 static int att_logical_or(struct osl_row *row, void *data)
434 uint64_t *att_mask = data, one = 1;
435 struct osl_object bitnum_obj;
436 int ret = osl_get_object(attribute_table, row, ATTCOL_BITNUM, &bitnum_obj);
440 *att_mask |= one << *(unsigned char *)bitnum_obj.data;
445 * Compute the attribute bit mask and check each afs info bitmap.
447 * \param aca The query field of \a aca is ignored.
449 * This iterates over all attributes in the attribute table and computes the
450 * logical or of 1 << b where b is the bit number of the attribute. The
451 * resulting bit mask is passed to aft_check_attributes() which performs the
456 * \sa \ref aft_check_attributes().
458 int attribute_check_callback(struct afs_callback_arg *aca)
461 uint64_t att_mask = 0; /* bits corresponding to a attributes */
463 ret = osl_rbtree_loop(attribute_table, ATTCOL_BITNUM, &att_mask,
466 PARA_ERROR_LOG("attribute table loop failed: %s\n",
467 para_strerror(-ret));
470 return aft_check_attributes(att_mask, &aca->pbout);
473 static void attribute_close(void)
475 osl_close_table(attribute_table, OSL_MARK_CLEAN);
476 attribute_table = NULL;
479 static int attribute_open(const char *dir)
483 attribute_table_desc.dir = dir;
484 ret = osl(osl_open_table(&attribute_table_desc, &attribute_table));
485 greatest_att_bitnum = -1; /* no atts available */
487 find_greatest_att_bitnum();
490 attribute_table = NULL;
491 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
496 static int attribute_create(const char *dir)
498 attribute_table_desc.dir = dir;
499 return osl(osl_create_table(&attribute_table_desc));
503 * Initialize the attribute table structure.
505 * \param t The table structure to initialize.
507 void attribute_init(struct afs_table *t)
509 t->open = attribute_open;
510 t->close = attribute_close;
511 t->create = attribute_create;