attribute.c

   1 /*
   2  * Copyright (C) 1997 Andre Noll <maan@tuebingen.mpg.de>
   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                 para_printf(&laad->pb, "%s\n", name);
 140                 return 1;
 141         }
 142         ret = osl(osl_get_object(table, row, ATTCOL_BITNUM, &bitnum_obj));
 143         if (ret < 0) {
 144                 para_printf(&laad->pb, "%s: %s\n", name, para_strerror(-ret));
 145                 return ret;
 146         }
 147         para_printf(&laad->pb, "%u\t%s\n", *(unsigned char*)bitnum_obj.data,
 148                 name);
 149         return 1;
 150 }
 151
 152 static int com_lsatt_callback(int fd, const struct osl_object *query)
 153 {
 154         int ret;
 155         struct lsatt_action_data laad = {
 156                 .flags = *(unsigned *) query->data,
 157                 .pb = {
 158                         .max_size = shm_get_shmmax(),
 159                         .private_data = &(struct afs_max_size_handler_data) {
 160                                 .fd = fd,
 161                                 .band = SBD_OUTPUT
 162                         },
 163                         .max_size_handler = afs_max_size_handler
 164                 }
 165
 166         };
 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 *)query->data + sizeof(laad.flags),
 172                         .size = query->size - sizeof(laad.flags)},
 173                 .pm_flags = PM_NO_PATTERN_MATCHES_EVERYTHING,
 174                 .data = &laad,
 175                 .action = print_attribute
 176         };
 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);
 182         if (ret < 0)
 183                 goto out;
 184         if (pmd.num_matches == 0)
 185                 ret = -E_NO_MATCH;
 186 out:
 187         flush_and_free_pb(&laad.pb);
 188         return ret;
 189 }
 190
 191 int com_lsatt(struct command_context *cc)
 192 {
 193         unsigned flags = 0;
 194         struct osl_object options = {.data = &flags, .size = sizeof(flags)};
 195         int i;
 196
 197         for (i = 1; i < cc->argc; i++) {
 198                 const char *arg = cc->argv[i];
 199                 if (arg[0] != '-')
 200                         break;
 201                 if (!strcmp(arg, "--")) {
 202                         i++;
 203                         break;
 204                 }
 205                 if (!strcmp(arg, "-i")) {
 206                         flags |= LSATT_FLAG_SORT_BY_ID;
 207                         continue;
 208                 }
 209                 if (!strcmp(arg, "-l")) {
 210                         flags |= LSATT_FLAG_LONG;
 211                         continue;
 212                 }
 213                 if (!strcmp(arg, "-r")) {
 214                         flags |= LSATT_FLAG_REVERSE;
 215                         continue;
 216                 }
 217         }
 218         return send_option_arg_callback_request(&options, cc->argc - i, cc->argv + i,
 219                 com_lsatt_callback, afs_cb_result_handler, cc);
 220 }
 221
 222 struct addatt_event_data {
 223         const char *name;
 224         unsigned char bitnum;
 225 };
 226
 227
 228 static int com_addatt_callback(int fd, const struct osl_object *query)
 229 {
 230         char *p;
 231         int ret = 1;
 232         struct para_buffer pb = {
 233                 .max_size = shm_get_shmmax(),
 234                 .private_data = &(struct afs_max_size_handler_data) {
 235                         .fd = fd,
 236                         .band = SBD_OUTPUT
 237                 },
 238                 .max_size_handler = afs_max_size_handler
 239         };
 240         size_t len;
 241
 242         for (p = query->data; p < (char *)query->data + query->size; p += len + 1) {
 243                 struct osl_object objs[NUM_ATT_COLUMNS];
 244                 struct osl_row *row;
 245                 unsigned char bitnum;
 246                 struct addatt_event_data aed;
 247
 248                 len = strlen(p);
 249                 if (!len || p[len - 1] == '-' || p[len - 1] == '+') {
 250                         para_printf(&pb, "invalid attribute name: %s\n", p);
 251                         continue;
 252                 }
 253                 ret = get_attribute_bitnum_by_name(p, &bitnum);
 254                 if (ret >= 0) {
 255                         para_printf(&pb, "attribute \"%s\" already exists\n", p);
 256                         continue;
 257                 }
 258                 if (ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND)) /* error */
 259                         goto out;
 260                 objs[ATTCOL_BITNUM].size = 1;
 261                 /* find smallest unused attribute */
 262                 for (bitnum = 0; bitnum < 64; bitnum++) {
 263                         objs[ATTCOL_BITNUM].data = &bitnum;
 264                         ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM,
 265                                 &objs[ATTCOL_BITNUM], &row));
 266                         if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
 267                                 break; /* this bitnum is unused, use it */
 268                         if (ret < 0) /* error */
 269                                 goto out;
 270                         /* this bit is already in use, try next bit */
 271                 }
 272                 if (bitnum == 64) {
 273                         ret = -E_ATT_TABLE_FULL;
 274                         goto out;
 275                 }
 276                 objs[ATTCOL_NAME].data = p;
 277                 objs[ATTCOL_NAME].size = len + 1;
 278                 ret = osl(osl_add_row(attribute_table, objs));
 279                 if (ret < 0)
 280                         goto out;
 281                 aed.name = p;
 282                 aed.bitnum = bitnum;
 283                 afs_event(ATTRIBUTE_ADD, &pb, &aed);
 284                 greatest_att_bitnum = PARA_MAX(greatest_att_bitnum, (int)bitnum);
 285         }
 286 out:
 287         if (ret < 0)
 288                 para_printf(&pb, "%s: %s\n", p, para_strerror(-ret));
 289         flush_and_free_pb(&pb);
 290         return 0;
 291 }
 292
 293 int com_addatt(struct command_context *cc)
 294 {
 295         int ret;
 296
 297         if (cc->argc < 2)
 298                 return -E_ATTR_SYNTAX;
 299         ret = send_standard_callback_request(cc->argc - 1, cc->argv + 1,
 300                 com_addatt_callback, afs_cb_result_handler, cc);
 301         if (ret < 0)
 302                 send_strerror(cc, -ret);
 303         return ret;
 304 }
 305
 306 static int com_mvatt_callback(int fd, const struct osl_object *query)
 307 {
 308         char *old = query->data;
 309         size_t size = strlen(old) + 1;
 310         char *new = old + size;
 311         struct osl_object obj = {.data = old, .size = size};
 312         struct osl_row *row;
 313         struct para_buffer pb = {
 314                 .max_size = shm_get_shmmax(),
 315                 .private_data = &(struct afs_max_size_handler_data) {
 316                         .fd = fd,
 317                         .band = SBD_OUTPUT
 318                 },
 319                 .max_size_handler = afs_max_size_handler,
 320         };
 321         int ret;
 322
 323         ret = osl(osl_get_row(attribute_table, ATTCOL_NAME, &obj, &row));
 324         if (ret < 0)
 325                 goto out;
 326         obj.data = new;
 327         obj.size = strlen(new) + 1;
 328         ret = osl(osl_update_object(attribute_table, row, ATTCOL_NAME, &obj));
 329 out:
 330         if (ret < 0)
 331                 para_printf(&pb, "%s\n", para_strerror(-ret));
 332         else
 333                 afs_event(ATTRIBUTE_RENAME, &pb, NULL);
 334         flush_and_free_pb(&pb);
 335         return 0;
 336 }
 337
 338 int com_mvatt(struct command_context *cc)
 339 {
 340         int ret;
 341
 342         if (cc->argc != 3)
 343                 return -E_ATTR_SYNTAX;
 344         ret = send_standard_callback_request(cc->argc - 1, cc->argv + 1,
 345                 com_mvatt_callback, afs_cb_result_handler, cc);
 346         if (ret < 0)
 347                 send_strerror(cc, -ret);
 348         return ret;
 349 }
 350
 351 /** Data passed to the action handler of com_rmatt(). */
 352 struct remove_attribute_action_data {
 353         /** Message buffer. */
 354         struct para_buffer pb;
 355         /** Number of attributes removed. */
 356         int num_removed;
 357         /** Bitwise "or" of the removed attributes. */
 358         uint64_t mask_of_removed_atts;
 359 };
 360
 361 /* returns succcess even on errors to keep the loop going */
 362 static int remove_attribute(struct osl_table *table, struct osl_row *row,
 363                 const char *name, void *data)
 364 {
 365         struct remove_attribute_action_data *raad = data;
 366         int ret;
 367         struct rmatt_event_data red = {.name = name};
 368
 369         ret = get_attribute_bitnum_by_name(name, &red.bitnum);
 370         if (ret < 0) {
 371                 para_printf(&raad->pb, "%s: %s\n", name, para_strerror(-ret));
 372                 return 0;
 373         }
 374         ret = osl(osl_del_row(table, row));
 375         if (ret < 0) {
 376                 para_printf(&raad->pb, "%s: %s\n", name, para_strerror(-ret));
 377                 return 0;
 378         }
 379         para_printf(&raad->pb, "removed attribute %s\n", name);
 380         raad->num_removed++;
 381         raad->mask_of_removed_atts |= (1 << red.bitnum);
 382         afs_event(ATTRIBUTE_REMOVE, &raad->pb, &red);
 383         return 1;
 384 }
 385
 386 static int com_rmatt_callback(int fd, const struct osl_object *query)
 387 {
 388         struct remove_attribute_action_data raad = {
 389                 .num_removed = 0,
 390                 .pb = {
 391                         .max_size = shm_get_shmmax(),
 392                         .private_data = &(struct afs_max_size_handler_data) {
 393                                 .fd = fd,
 394                                 .band = SBD_OUTPUT
 395                         },
 396                         .max_size_handler = afs_max_size_handler,
 397                 }
 398         };
 399         int ret;
 400         struct pattern_match_data pmd = {
 401                 .table = attribute_table,
 402                 .patterns = *query,
 403                 .loop_col_num = ATTCOL_BITNUM,
 404                 .match_col_num = ATTCOL_NAME,
 405                 .data = &raad,
 406                 .action = remove_attribute
 407         };
 408         ret = for_each_matching_row(&pmd);
 409         if (ret < 0)
 410                 para_printf(&raad.pb, "%s\n", para_strerror(-ret));
 411         else if (!raad.num_removed)
 412                 para_printf(&raad.pb, "no match -- nothing removed\n");
 413         flush_and_free_pb(&raad.pb);
 414         return 0;
 415 }
 416
 417 int com_rmatt(struct command_context *cc)
 418 {
 419         int ret;
 420
 421         if (cc->argc < 2)
 422                 return -E_ATTR_SYNTAX;
 423         ret = send_standard_callback_request(cc->argc - 1, cc->argv + 1,
 424                 com_rmatt_callback, afs_cb_result_handler, cc);
 425         if (ret < 0)
 426                 send_strerror(cc, -ret);
 427         return ret;
 428 }
 429
 430 /**
 431  * Return a binary representation of the given attribute value.
 432  *
 433  * \param atts Pointer to the attribute value.
 434  * \param buf Result.
 435  *
 436  * This function prints a string of at most 64 characters plus the terminating
 437  * \p NULL character into \a buf which must be provided by the caller and at
 438  * least 65 bytes long. The "x" character is used for set attributes and "-" is
 439  * used for unset attributes.
 440  *
 441  * In practice, not all 64 attributes are defined. In this case, the function
 442  * only prints \a N + 1 characters where \a N is the greatest id of a defined
 443  * attribute.
 444  */
 445 void get_attribute_bitmap(const uint64_t *atts, char *buf)
 446 {
 447         int i;
 448         const uint64_t one = 1;
 449
 450         for (i = 0; i <= greatest_att_bitnum; i++)
 451                 buf[greatest_att_bitnum - i] = (*atts & (one << i))? 'x' : '-';
 452         buf[i] = '\0';
 453 }
 454
 455 /**
 456  * Get a string containing the set attributes in text form.
 457  *
 458  * \param atts The attribute bitmap.
 459  * \param delim The delimiter to separate matching attribute names.
 460  * \param text Result pointer.
 461  *
 462  * \return Positive on success, negative on errors. If no attributes have
 463  * been defined, \a *text is NULL.
 464  */
 465 int get_attribute_text(uint64_t *atts, const char *delim, char **text)
 466 {
 467         int i, ret;
 468         const uint64_t one = 1;
 469
 470         *text = NULL;
 471         if (greatest_att_bitnum < 0) { /* no attributes available */
 472                 *text = para_strdup("(no attributes available)");
 473                 return 1;
 474         }
 475         for (i = 0; i <= greatest_att_bitnum; i++) {
 476                 unsigned char bn = i;
 477                 struct osl_object obj = {.data = &bn, .size = 1};
 478                 struct osl_row *row;
 479
 480                 if (!(*atts & (one << i)))
 481                         continue;
 482                 ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM, &obj, &row));
 483                 if (ret < 0)
 484                         goto err;
 485                 ret = osl(osl_get_object(attribute_table, row, ATTCOL_NAME, &obj));
 486                 if (ret < 0)
 487                         goto err;
 488                 if (*text) {
 489                         char *tmp = make_message("%s%s%s", *text, delim, (char *)obj.data);
 490                         free(*text);
 491                         *text = tmp;
 492                 } else
 493                         *text = para_strdup(obj.data);
 494         }
 495         if (!*text) /* no attributes set */
 496                 *text = para_strdup("");
 497         return 1;
 498 err:
 499         free(*text);
 500         return ret;
 501 }
 502
 503 /**
 504  * Close the attribute table.
 505  *
 506  * \sa osl_close_table().
 507  */
 508 static void attribute_close(void)
 509 {
 510         osl_close_table(attribute_table, OSL_MARK_CLEAN);
 511         attribute_table = NULL;
 512 }
 513
 514 /**
 515  * Open the attribute table.
 516  *
 517  * \param dir The database directory.
 518  *
 519  * \return Positive on success, negative on errors.
 520  *
 521  * \sa osl_open_table().
 522  */
 523 static int attribute_open(const char *dir)
 524 {
 525         int ret;
 526
 527         attribute_table_desc.dir = dir;
 528         ret = osl(osl_open_table(&attribute_table_desc, &attribute_table));
 529         greatest_att_bitnum = -1; /* no atts available */
 530         if (ret >= 0) {
 531                 find_greatest_att_bitnum();
 532                 return ret;
 533         }
 534         attribute_table = NULL;
 535         if (ret >= 0 || ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
 536                 return 1;
 537         return ret;
 538 }
 539
 540 static int attribute_create(const char *dir)
 541 {
 542         attribute_table_desc.dir = dir;
 543         return osl(osl_create_table(&attribute_table_desc));
 544 }
 545
 546 /**
 547  * Initialize the attribute table structure.
 548  *
 549  * \param t The table structure to initialize.
 550  */
 551 void attribute_init(struct afs_table *t)
 552 {
 553         t->open = attribute_open;
 554         t->close = attribute_close;
 555         t->create = attribute_create;
 556 }