Merge branch 't/sched_improvements'
[paraslash.git] / attribute.c
1 /*
2 * Copyright (C) 1997-2014 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file attribute.c Attribute handling functions. */
8
9 #include <regex.h>
10 #include <osl.h>
11
12 #include "para.h"
13 #include "error.h"
14 #include "crypt.h"
15 #include "string.h"
16 #include "afh.h"
17 #include "afs.h"
18 #include "ipc.h"
19 #include "sideband.h"
20 #include "command.h"
21
22 static struct osl_table *attribute_table;
23 static int greatest_att_bitnum;
24
25 /** The columns of the attribute table. */
26 enum attribute_table_columns {
27 /** The bit number (0-63). */
28 ATTCOL_BITNUM,
29 /** The name of the attribute. */
30 ATTCOL_NAME,
31 /** Number of columns in this table. */
32 NUM_ATT_COLUMNS
33 };
34
35 static int char_compare(const struct osl_object *obj1, const struct osl_object *obj2)
36 {
37 const unsigned char *c1 = (const unsigned char*)obj1->data;
38 const unsigned char *c2 = (const unsigned char*)obj2->data;
39 if (*c1 > *c2)
40 return 1;
41 if (*c1 < *c2)
42 return -1;
43 return 0;
44 }
45
46 static struct osl_column_description att_cols[] = {
47 [ATTCOL_BITNUM] = {
48 .storage_type = OSL_MAPPED_STORAGE,
49 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
50 .name = "bitnum",
51 .compare_function = char_compare,
52 .data_size = 1
53 },
54 [ATTCOL_NAME] = {
55 .storage_type = OSL_MAPPED_STORAGE,
56 .storage_flags = OSL_RBTREE | OSL_UNIQUE,
57 .name = "name",
58 .compare_function = string_compare,
59 }
60 };
61
62 static struct osl_table_description attribute_table_desc = {
63 .name = "attributes",
64 .num_columns = NUM_ATT_COLUMNS,
65 .flags = 0,
66 .column_descriptions = att_cols
67 };
68
69 static void find_greatest_att_bitnum(void)
70 {
71 unsigned char c = 63;
72 do {
73 struct osl_row *row;
74 struct osl_object obj = {.data = &c, .size = 1};
75 if (osl_get_row(attribute_table, ATTCOL_BITNUM, &obj,
76 &row) >= 0) {
77 greatest_att_bitnum = c;
78 return;
79 }
80 } while (c--);
81 PARA_INFO_LOG("no attributes\n");
82 greatest_att_bitnum = -E_NO_ATTRIBUTES;
83 }
84
85 /**
86 * Retrieve the identifier (number) of an attribute.
87 *
88 * \param att_name The name of the attribute.
89 * \param bitnum Result pointer.
90 *
91 * \return Positive on success, negative on errors.
92 */
93 int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum)
94 {
95 struct osl_object obj = {.data = (char *)att_name,
96 .size = strlen(att_name) + 1};
97 struct osl_row *row;
98 int ret = osl(osl_get_row(attribute_table, ATTCOL_NAME, &obj, &row));
99
100 if (ret < 0)
101 return ret;
102 ret = osl(osl_get_object(attribute_table, row, ATTCOL_BITNUM, &obj));
103 if (ret < 0)
104 return ret;
105 *bitnum = *(unsigned char *)obj.data;
106 return 1;
107 }
108
109 /**
110 * Flags used by the lsatt command.
111 *
112 * \param \sa com_lsatt().
113 */
114 enum lsatt_flags {
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. */
118 LSATT_FLAG_LONG = 2,
119 /** Reverse sort order. */
120 LSATT_FLAG_REVERSE = 4
121 };
122
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. */
128 unsigned flags;
129 };
130
131 static int print_attribute(struct osl_table *table, struct osl_row *row,
132 const char *name, void *data)
133 {
134 struct lsatt_action_data *laad = data;
135 struct osl_object bitnum_obj;
136 int ret;
137
138 if (!(laad->flags & LSATT_FLAG_LONG))
139 return para_printf(&laad->pb, "%s\n", name);
140 ret = osl(osl_get_object(table, row, ATTCOL_BITNUM, &bitnum_obj));
141 if (ret < 0) {
142 para_printf(&laad->pb, "%s: %s\n", name, para_strerror(-ret));
143 return ret;
144 }
145 return para_printf(&laad->pb, "%u\t%s\n", *(unsigned char*)bitnum_obj.data,
146 name);
147 }
148
149 static void com_lsatt_callback(int fd, const struct osl_object *query)
150 {
151 struct lsatt_action_data laad = {
152 .flags = *(unsigned *) query->data,
153 .pb = {
154 .max_size = shm_get_shmmax(),
155 .private_data = &(struct afs_max_size_handler_data) {
156 .fd = fd,
157 .band = SBD_OUTPUT
158 },
159 .max_size_handler = afs_max_size_handler
160 }
161
162 };
163 struct pattern_match_data pmd = {
164 .table = attribute_table,
165 .loop_col_num = ATTCOL_BITNUM,
166 .match_col_num = ATTCOL_NAME,
167 .patterns = {.data = (char *)query->data + sizeof(laad.flags),
168 .size = query->size - sizeof(laad.flags)},
169 .pm_flags = PM_NO_PATTERN_MATCHES_EVERYTHING,
170 .data = &laad,
171 .action = print_attribute
172 };
173 if (laad.flags & LSATT_FLAG_SORT_BY_ID)
174 pmd.loop_col_num = ATTCOL_NAME;
175 if (laad.flags & LSATT_FLAG_REVERSE)
176 pmd.pm_flags |= PM_REVERSE_LOOP;
177 for_each_matching_row(&pmd);
178 if (laad.pb.offset)
179 pass_buffer_as_shm(fd, SBD_OUTPUT, laad.pb.buf, laad.pb.offset);
180 free(laad.pb.buf);
181 }
182
183 int com_lsatt(struct command_context *cc)
184 {
185 unsigned flags = 0;
186 struct osl_object options = {.data = &flags, .size = sizeof(flags)};
187 int ret, i;
188
189 for (i = 1; i < cc->argc; i++) {
190 const char *arg = cc->argv[i];
191 if (arg[0] != '-')
192 break;
193 if (!strcmp(arg, "--")) {
194 i++;
195 break;
196 }
197 if (!strcmp(arg, "-i")) {
198 flags |= LSATT_FLAG_SORT_BY_ID;
199 continue;
200 }
201 if (!strcmp(arg, "-l")) {
202 flags |= LSATT_FLAG_LONG;
203 continue;
204 }
205 if (!strcmp(arg, "-r")) {
206 flags |= LSATT_FLAG_REVERSE;
207 continue;
208 }
209 }
210 ret = send_option_arg_callback_request(&options, cc->argc - i, cc->argv + i,
211 com_lsatt_callback, afs_cb_result_handler, cc);
212 if (ret < 0)
213 send_strerror(cc, -ret);
214 else if (ret == 0 && cc->argc > 1)
215 ret = send_sb_va(&cc->scc, SBD_ERROR_LOG, "no matches\n");
216 return ret;
217 }
218
219 struct addatt_event_data {
220 const char *name;
221 unsigned char bitnum;
222 };
223
224
225 static void com_addatt_callback(int fd, const struct osl_object *query)
226 {
227 char *p;
228 int ret = 1, ret2 = 0;
229 struct para_buffer pb = {
230 .max_size = shm_get_shmmax(),
231 .private_data = &(struct afs_max_size_handler_data) {
232 .fd = fd,
233 .band = SBD_OUTPUT
234 },
235 .max_size_handler = afs_max_size_handler
236 };
237 size_t len;
238
239 for (p = query->data; p < (char *)query->data + query->size; p += len + 1) {
240 struct osl_object objs[NUM_ATT_COLUMNS];
241 struct osl_row *row;
242 unsigned char bitnum;
243 struct addatt_event_data aed;
244
245 len = strlen(p);
246 if (!len || p[len - 1] == '-' || p[len - 1] == '+') {
247 ret2 = para_printf(&pb, "invalid attribute name: %s\n", p);
248 if (ret2 < 0)
249 goto out;
250 continue;
251 }
252 ret = get_attribute_bitnum_by_name(p, &bitnum);
253 if (ret >= 0) {
254 ret2 = para_printf(&pb, "attribute \"%s\" already exists\n", p);
255 if (ret2 < 0)
256 goto out;
257 continue;
258 }
259 if (ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND)) /* error */
260 goto out;
261 objs[ATTCOL_BITNUM].size = 1;
262 /* find smallest unused attribute */
263 for (bitnum = 0; bitnum < 64; bitnum++) {
264 objs[ATTCOL_BITNUM].data = &bitnum;
265 ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM,
266 &objs[ATTCOL_BITNUM], &row));
267 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
268 break; /* this bitnum is unused, use it */
269 if (ret < 0) /* error */
270 goto out;
271 /* this bit is already in use, try next bit */
272 }
273 if (bitnum == 64) {
274 ret = -E_ATT_TABLE_FULL;
275 goto out;
276 }
277 objs[ATTCOL_NAME].data = p;
278 objs[ATTCOL_NAME].size = len + 1;
279 ret = osl(osl_add_row(attribute_table, objs));
280 if (ret < 0)
281 goto out;
282 aed.name = p;
283 aed.bitnum = bitnum;
284 afs_event(ATTRIBUTE_ADD, &pb, &aed);
285 greatest_att_bitnum = PARA_MAX(greatest_att_bitnum, (int)bitnum);
286 }
287 out:
288 if (ret < 0 && ret2 >= 0)
289 para_printf(&pb, "%s: %s\n", p, para_strerror(-ret));
290 if (pb.offset)
291 pass_buffer_as_shm(fd, SBD_OUTPUT, pb.buf, pb.offset);
292 free(pb.buf);
293 }
294
295 int com_addatt(struct command_context *cc)
296 {
297 int ret;
298
299 if (cc->argc < 2)
300 return -E_ATTR_SYNTAX;
301 ret = send_standard_callback_request(cc->argc - 1, cc->argv + 1,
302 com_addatt_callback, afs_cb_result_handler, cc);
303 if (ret < 0)
304 send_strerror(cc, -ret);
305 return ret;
306 }
307
308 static void com_mvatt_callback(int fd, const struct osl_object *query)
309 {
310 char *old = query->data;
311 size_t size = strlen(old) + 1;
312 char *new = old + size;
313 struct osl_object obj = {.data = old, .size = size};
314 struct osl_row *row;
315 struct para_buffer pb = {
316 .max_size = shm_get_shmmax(),
317 .private_data = &(struct afs_max_size_handler_data) {
318 .fd = fd,
319 .band = SBD_OUTPUT
320 },
321 .max_size_handler = afs_max_size_handler,
322 };
323 int ret;
324
325 ret = osl(osl_get_row(attribute_table, ATTCOL_NAME, &obj, &row));
326 if (ret < 0)
327 goto out;
328 obj.data = new;
329 obj.size = strlen(new) + 1;
330 ret = osl(osl_update_object(attribute_table, row, ATTCOL_NAME, &obj));
331 out:
332 if (ret < 0)
333 para_printf(&pb, "%s\n", para_strerror(-ret));
334 else
335 afs_event(ATTRIBUTE_RENAME, &pb, NULL);
336 if (pb.offset)
337 pass_buffer_as_shm(fd, SBD_OUTPUT, pb.buf, pb.offset);
338 free(pb.buf);
339 }
340
341 int com_mvatt(struct command_context *cc)
342 {
343 int ret;
344
345 if (cc->argc != 3)
346 return -E_ATTR_SYNTAX;
347 ret = send_standard_callback_request(cc->argc - 1, cc->argv + 1,
348 com_mvatt_callback, afs_cb_result_handler, cc);
349 if (ret < 0)
350 send_strerror(cc, -ret);
351 return ret;
352 }
353
354 /** Data passed to the action handler of com_rmatt(). */
355 struct remove_attribute_action_data {
356 /** Message buffer. */
357 struct para_buffer pb;
358 /** Number of attributes removed. */
359 int num_removed;
360 /** Bitwise "or" of the removed attributes. */
361 uint64_t mask_of_removed_atts;
362 };
363
364 static int remove_attribute(struct osl_table *table, struct osl_row *row,
365 const char *name, void *data)
366 {
367 struct remove_attribute_action_data *raad = data;
368 int ret;
369 struct rmatt_event_data red = {.name = name};
370
371 ret = get_attribute_bitnum_by_name(name, &red.bitnum);
372 if (ret < 0)
373 return para_printf(&raad->pb, "%s: %s\n", name, para_strerror(-ret));
374 ret = osl(osl_del_row(table, row));
375 if (ret < 0)
376 return para_printf(&raad->pb, "%s: %s\n", name, para_strerror(-ret));
377 ret = para_printf(&raad->pb, "removed attribute %s\n", name);
378 raad->num_removed++;
379 raad->mask_of_removed_atts |= (1 << red.bitnum);
380 afs_event(ATTRIBUTE_REMOVE, &raad->pb, &red);
381 return ret;
382 }
383
384 static void com_rmatt_callback(int fd, const struct osl_object *query)
385 {
386 struct remove_attribute_action_data raad = {
387 .num_removed = 0,
388 .pb = {
389 .max_size = shm_get_shmmax(),
390 .private_data = &(struct afs_max_size_handler_data) {
391 .fd = fd,
392 .band = SBD_OUTPUT
393 },
394 .max_size_handler = afs_max_size_handler,
395 }
396 };
397 int ret, ret2 = 0;
398 struct pattern_match_data pmd = {
399 .table = attribute_table,
400 .patterns = *query,
401 .loop_col_num = ATTCOL_BITNUM,
402 .match_col_num = ATTCOL_NAME,
403 .data = &raad,
404 .action = remove_attribute
405 };
406 ret = for_each_matching_row(&pmd);
407 if (ret < 0)
408 ret2 = para_printf(&raad.pb, "%s\n", para_strerror(-ret));
409 else if (!raad.num_removed)
410 ret2 = para_printf(&raad.pb, "no match -- nothing removed\n");
411 if (ret2 >= 0 && raad.pb.offset)
412 pass_buffer_as_shm(fd, SBD_OUTPUT, raad.pb.buf, raad.pb.offset);
413 free(raad.pb.buf);
414 }
415
416 int com_rmatt(struct command_context *cc)
417 {
418 int ret;
419
420 if (cc->argc < 2)
421 return -E_ATTR_SYNTAX;
422 ret = send_standard_callback_request(cc->argc - 1, cc->argv + 1,
423 com_rmatt_callback, afs_cb_result_handler, cc);
424 if (ret < 0)
425 send_strerror(cc, -ret);
426 return ret;
427 }
428
429 /**
430 * Return a binary representation of the given attribute value.
431 *
432 * \param atts Pointer to the attribute value.
433 * \param buf Result.
434 *
435 * This function prints a string of at most 64 characters plus the terminating
436 * \p NULL character into \a buf which must be provided by the caller and at
437 * least 65 bytes long. The "x" character is used for set attributes and "-" is
438 * used for unset attributes.
439 *
440 * In practice, not all 64 attributes are defined. In this case, the function
441 * only prints \a N + 1 characters where \a N is the greatest id of a defined
442 * attribute.
443 */
444 void get_attribute_bitmap(const uint64_t *atts, char *buf)
445 {
446 int i;
447 const uint64_t one = 1;
448
449 for (i = 0; i <= greatest_att_bitnum; i++)
450 buf[greatest_att_bitnum - i] = (*atts & (one << i))? 'x' : '-';
451 buf[i] = '\0';
452 }
453
454 /**
455 * Get a string containing the set attributes in text form.
456 *
457 * \param atts The attribute bitmap.
458 * \param delim The delimiter to separate matching attribute names.
459 * \param text Result pointer.
460 *
461 * \return Positive on success, negative on errors. If no attributes have
462 * been defined, \a *text is NULL.
463 */
464 int get_attribute_text(uint64_t *atts, const char *delim, char **text)
465 {
466 int i, ret;
467 const uint64_t one = 1;
468
469 *text = NULL;
470 if (greatest_att_bitnum < 0) { /* no attributes available */
471 *text = para_strdup("(no attributes available)");
472 return 1;
473 }
474 for (i = 0; i <= greatest_att_bitnum; i++) {
475 unsigned char bn = i;
476 struct osl_object obj = {.data = &bn, .size = 1};
477 struct osl_row *row;
478
479 if (!(*atts & (one << i)))
480 continue;
481 ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM, &obj, &row));
482 if (ret < 0)
483 goto err;
484 ret = osl(osl_get_object(attribute_table, row, ATTCOL_NAME, &obj));
485 if (ret < 0)
486 goto err;
487 if (*text) {
488 char *tmp = make_message("%s%s%s", *text, delim, (char *)obj.data);
489 free(*text);
490 *text = tmp;
491 } else
492 *text = para_strdup(obj.data);
493 }
494 if (!*text) /* no attributes set */
495 *text = para_strdup("");
496 return 1;
497 err:
498 free(*text);
499 return ret;
500 }
501
502 /**
503 * Close the attribute table.
504 *
505 * \sa osl_close_table().
506 */
507 static void attribute_close(void)
508 {
509 osl_close_table(attribute_table, OSL_MARK_CLEAN);
510 attribute_table = NULL;
511 }
512
513 /**
514 * Open the attribute table.
515 *
516 * \param dir The database directory.
517 *
518 * \return Positive on success, negative on errors.
519 *
520 * \sa osl_open_table().
521 */
522 static int attribute_open(const char *dir)
523 {
524 int ret;
525
526 attribute_table_desc.dir = dir;
527 ret = osl(osl_open_table(&attribute_table_desc, &attribute_table));
528 greatest_att_bitnum = -1; /* no atts available */
529 if (ret >= 0) {
530 find_greatest_att_bitnum();
531 return ret;
532 }
533 attribute_table = NULL;
534 if (ret >= 0 || ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
535 return 1;
536 return ret;
537 }
538
539 static int attribute_create(const char *dir)
540 {
541 attribute_table_desc.dir = dir;
542 return osl(osl_create_table(&attribute_table_desc));
543 }
544
545 /**
546 * Initialize the attribute table structure.
547 *
548 * \param t The table structure to initialize.
549 */
550 void attribute_init(struct afs_table *t)
551 {
552 t->open = attribute_open;
553 t->close = attribute_close;
554 t->create = attribute_create;
555 }