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 static int com_addatt_callback(struct afs_callback_arg *aca)
173 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(ADDATT);
178 ret = lls(lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr));
180 num_inputs = lls_num_inputs(aca->lpr);
181 for (i = 0; i < num_inputs; i++) {
182 const char *name = lls_input(i, aca->lpr);
183 struct osl_object objs[NUM_ATT_COLUMNS];
185 unsigned char bitnum;
188 if (len == 0 || name[len - 1] == '-' || name[len - 1] == '+') {
189 para_printf(&aca->pbout,
190 "invalid attribute name: %s\n", name);
193 ret = get_attribute_bitnum_by_name(name, &bitnum);
195 para_printf(&aca->pbout,
196 "attribute \"%s\" already exists\n", name);
199 if (ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND)) /* error */
201 objs[ATTCOL_BITNUM].size = 1;
202 /* find smallest unused attribute */
203 for (bitnum = 0; bitnum < 64; bitnum++) {
204 objs[ATTCOL_BITNUM].data = &bitnum;
205 ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM,
206 &objs[ATTCOL_BITNUM], &row));
207 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
208 break; /* this bitnum is unused, use it */
209 if (ret < 0) /* error */
211 /* this bit is already in use, try next bit */
214 ret = -E_ATT_TABLE_FULL;
217 objs[ATTCOL_NAME].data = (char *)name;
218 objs[ATTCOL_NAME].size = len + 1;
219 ret = osl(osl_add_row(attribute_table, objs));
222 ret = afs_event(ATTRIBUTE_ADD, &aca->pbout, NULL);
225 greatest_att_bitnum = PARA_MAX(greatest_att_bitnum, (int)bitnum);
229 para_printf(&aca->pbout, "error while adding %s\n",
230 lls_input(i, aca->lpr));
231 lls_free_parse_result(aca->lpr, cmd);
235 static int com_addatt(struct command_context *cc, struct lls_parse_result *lpr)
237 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(ADDATT);
239 int ret = lls(lls_check_arg_count(lpr, 1, 64, &errctx));
242 send_errctx(cc, errctx);
245 return send_lls_callback_request(com_addatt_callback, cmd, lpr, cc);
247 EXPORT_SERVER_CMD_HANDLER(addatt);
249 static int com_mvatt_callback(struct afs_callback_arg *aca)
251 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(MVATT);
252 const char *old, *new;
253 struct osl_object obj;
257 ret = lls(lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr));
259 old = lls_input(0, aca->lpr);
260 new = lls_input(1, aca->lpr);
261 obj.data = (char *)old;
262 obj.size = strlen(old) + 1;
263 ret = osl(osl_get_row(attribute_table, ATTCOL_NAME, &obj, &row));
266 obj.data = (char *)new;
267 obj.size = strlen(new) + 1;
268 /* The update fails if the destination attribute exists. */
269 ret = osl(osl_update_object(attribute_table, row, ATTCOL_NAME, &obj));
272 para_printf(&aca->pbout, "cannot rename %s to %s\n", old, new);
274 ret = afs_event(ATTRIBUTE_RENAME, &aca->pbout, NULL);
275 lls_free_parse_result(aca->lpr, cmd);
279 static int com_mvatt(struct command_context *cc, struct lls_parse_result *lpr)
281 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(MVATT);
283 int ret = lls(lls_check_arg_count(lpr, 2, 2, &errctx));
285 send_errctx(cc, errctx);
288 return send_lls_callback_request(com_mvatt_callback, cmd, lpr, cc);
290 EXPORT_SERVER_CMD_HANDLER(mvatt);
292 static int remove_attribute(struct osl_table *table, struct osl_row *row,
293 const char *name, void *data)
295 struct afs_callback_arg *aca = data;
297 struct rmatt_event_data red = {.name = name};
299 ret = get_attribute_bitnum_by_name(name, &red.bitnum);
301 para_printf(&aca->pbout, "cannot remove %s\n", name);
304 para_printf(&aca->pbout, "removing attribute %s\n", name);
305 ret = osl(osl_del_row(table, row));
307 para_printf(&aca->pbout, "cannot remove %s\n", name);
310 return afs_event(ATTRIBUTE_REMOVE, &aca->pbout, &red);
313 static int com_rmatt_callback(struct afs_callback_arg *aca)
315 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(RMATT);
317 struct pattern_match_data pmd = {
318 .table = attribute_table,
319 .loop_col_num = ATTCOL_BITNUM,
320 .match_col_num = ATTCOL_NAME,
322 .action = remove_attribute
324 ret = lls(lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr));
327 ret = for_each_matching_row(&pmd);
330 if (pmd.num_matches == 0)
333 lls_free_parse_result(aca->lpr, cmd);
337 static int com_rmatt(struct command_context *cc, struct lls_parse_result *lpr)
339 const struct lls_command *cmd = SERVER_CMD_CMD_PTR(RMATT);
341 int ret = lls(lls_check_arg_count(lpr, 1, INT_MAX, &errctx));
344 send_errctx(cc, errctx);
347 return send_lls_callback_request(com_rmatt_callback, cmd, lpr, cc);
349 EXPORT_SERVER_CMD_HANDLER(rmatt);
352 * Return a binary representation of the given attribute value.
354 * \param atts Pointer to the attribute value.
357 * This function prints a string of at most 64 characters plus the terminating
358 * \p NULL character into \a buf which must be provided by the caller and at
359 * least 65 bytes long. The "x" character is used for set attributes and "-" is
360 * used for unset attributes.
362 * In practice, not all 64 attributes are defined. In this case, the function
363 * only prints \a N + 1 characters where \a N is the greatest id of a defined
366 void get_attribute_bitmap(const uint64_t *atts, char *buf)
369 const uint64_t one = 1;
371 for (i = 0; i <= greatest_att_bitnum; i++)
372 buf[greatest_att_bitnum - i] = (*atts & (one << i))? 'x' : '-';
377 * Get a string containing the set attributes in text form.
379 * \param atts The attribute bitmap.
380 * \param delim The delimiter to separate matching attribute names.
381 * \param text Result pointer.
383 * \return Positive on success, negative on errors. If no attributes have
384 * been defined, \a *text is NULL.
386 int get_attribute_text(uint64_t *atts, const char *delim, char **text)
389 const uint64_t one = 1;
392 if (greatest_att_bitnum < 0) { /* no attributes available */
393 *text = para_strdup("(no attributes available)");
396 for (i = 0; i <= greatest_att_bitnum; i++) {
397 unsigned char bn = i;
398 struct osl_object obj = {.data = &bn, .size = 1};
401 if (!(*atts & (one << i)))
403 ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM, &obj, &row));
406 ret = osl(osl_get_object(attribute_table, row, ATTCOL_NAME, &obj));
410 char *tmp = make_message("%s%s%s", *text, delim, (char *)obj.data);
414 *text = para_strdup(obj.data);
416 if (!*text) /* no attributes set */
417 *text = para_strdup("");
424 static int att_logical_or(struct osl_row *row, void *data)
426 uint64_t *att_mask = data, one = 1;
427 struct osl_object bitnum_obj;
428 int ret = osl_get_object(attribute_table, row, ATTCOL_BITNUM, &bitnum_obj);
432 *att_mask |= one << *(unsigned char *)bitnum_obj.data;
437 * Compute the attribute bit mask and check each afs info bitmap.
439 * \param aca The query field of \a aca is ignored.
441 * This iterates over all attributes in the attribute table and computes the
442 * logical or of 1 << b where b is the bit number of the attribute. The
443 * resulting bit mask is passed to aft_check_attributes() which performs the
448 * \sa \ref aft_check_attributes().
450 int attribute_check_callback(struct afs_callback_arg *aca)
453 uint64_t att_mask = 0; /* bits corresponding to a attributes */
455 ret = osl_rbtree_loop(attribute_table, ATTCOL_BITNUM, &att_mask,
458 PARA_ERROR_LOG("attribute table loop failed: %s\n",
459 para_strerror(-ret));
462 return aft_check_attributes(att_mask, &aca->pbout);
465 static void attribute_close(void)
467 osl_close_table(attribute_table, OSL_MARK_CLEAN);
468 attribute_table = NULL;
471 static int attribute_open(const char *dir)
475 attribute_table_desc.dir = dir;
476 ret = osl(osl_open_table(&attribute_table_desc, &attribute_table));
477 greatest_att_bitnum = -1; /* no atts available */
479 find_greatest_att_bitnum();
482 attribute_table = NULL;
483 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
488 static int attribute_create(const char *dir)
490 attribute_table_desc.dir = dir;
491 return osl(osl_create_table(&attribute_table_desc));
494 /** The attribute table stores name/bitnum pairs. */
495 const struct afs_table_operations attr_ops = { /* no event handler */
496 .open = attribute_open,
497 .close = attribute_close,
498 .create = attribute_create,