attribute.c

   1 /* Copyright (C) 1997 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
   2
   3 /** \file attribute.c Attribute handling functions. */
   4
   5 #include <regex.h>
   6 #include <osl.h>
   7 #include <lopsub.h>
   8
   9 #include "server_cmd.lsg.h"
  10 #include "para.h"
  11 #include "error.h"
  12 #include "crypt.h"
  13 #include "string.h"
  14 #include "afh.h"
  15 #include "afs.h"
  16 #include "ipc.h"
  17 #include "sideband.h"
  18 #include "command.h"
  19
  20 static struct osl_table *attribute_table;
  21 static int greatest_att_bitnum;
  22
  23 /** The columns of the attribute table. */
  24 enum attribute_table_columns {
  25         /** The bit number (0-63). */
  26         ATTCOL_BITNUM,
  27         /** The name of the attribute. */
  28         ATTCOL_NAME,
  29         /** Number of columns in this table. */
  30         NUM_ATT_COLUMNS
  31 };
  32
  33 static int char_compare(const struct osl_object *obj1, const struct osl_object *obj2)
  34 {
  35         const unsigned char *c1 = (const unsigned char*)obj1->data;
  36         const unsigned char *c2 = (const unsigned char*)obj2->data;
  37         if (*c1 > *c2)
  38                 return 1;
  39         if (*c1 < *c2)
  40                 return -1;
  41         return 0;
  42 }
  43
  44 static struct osl_column_description att_cols[] = {
  45         [ATTCOL_BITNUM] = {
  46                 .storage_type = OSL_MAPPED_STORAGE,
  47                 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
  48                 .name = "bitnum",
  49                 .compare_function = char_compare,
  50                 .data_size = 1
  51         },
  52         [ATTCOL_NAME] = {
  53                 .storage_type = OSL_MAPPED_STORAGE,
  54                 .storage_flags = OSL_RBTREE | OSL_UNIQUE,
  55                 .name = "name",
  56                 .compare_function = string_compare,
  57         }
  58 };
  59
  60 static struct osl_table_description attribute_table_desc = {
  61         .name = "attributes",
  62         .num_columns = NUM_ATT_COLUMNS,
  63         .flags = 0,
  64         .column_descriptions = att_cols
  65 };
  66
  67 static void find_greatest_att_bitnum(void)
  68 {
  69         unsigned char c = 63;
  70         do {
  71                 struct osl_row *row;
  72                 struct osl_object obj = {.data = &c, .size = 1};
  73                 if (osl_get_row(attribute_table, ATTCOL_BITNUM, &obj,
  74                                 &row) >= 0) {
  75                         greatest_att_bitnum = c;
  76                         return;
  77                 }
  78         } while (c--);
  79         PARA_INFO_LOG("no attributes\n");
  80         greatest_att_bitnum = -E_NO_ATTRIBUTES;
  81 }
  82
  83 /**
  84  * Retrieve the identifier (number) of an attribute.
  85  *
  86  * \param att_name The name of the attribute.
  87  * \param bitnum Result pointer.
  88  *
  89  * \return Positive on success, negative on errors.
  90  */
  91 int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum)
  92 {
  93         struct osl_object obj = {.data = (char *)att_name,
  94                 .size = strlen(att_name) + 1};
  95         struct osl_row *row;
  96         int ret = osl(osl_get_row(attribute_table, ATTCOL_NAME, &obj, &row));
  97
  98         if (ret < 0)
  99                 return ret;
 100         ret = osl(osl_get_object(attribute_table, row, ATTCOL_BITNUM, &obj));
 101         if (ret < 0)
 102                 return ret;
 103         *bitnum = *(unsigned char *)obj.data;
 104         return 1;
 105 }
 106
 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)
 110 {
 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;
 114         int ret;
 115
 116         if (!l_given) {
 117                 para_printf(&aca->pbout, "%s\n", name);
 118                 return 1;
 119         }
 120         ret = osl(osl_get_object(table, row, ATTCOL_BITNUM, &bitnum_obj));
 121         if (ret < 0) {
 122                 para_printf(&aca->pbout, "%s: %s\n", name, para_strerror(-ret));
 123                 return ret;
 124         }
 125         para_printf(&aca->pbout, "%u\t%s\n", *(unsigned char*)bitnum_obj.data,
 126                 name);
 127         return 1;
 128 }
 129
 130 static int com_lsatt_callback(struct afs_callback_arg *aca)
 131 {
 132         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(LSATT);
 133         bool i_given, r_given;
 134         int ret;
 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,
 140                 .data = aca,
 141                 .action = print_attribute
 142         };
 143
 144         ret = lls(lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr));
 145         assert(ret >= 0);
 146         pmd.lpr = 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);
 149
 150         if (i_given)
 151                 pmd.loop_col_num = ATTCOL_BITNUM;
 152         if (r_given)
 153                 pmd.pm_flags |= PM_REVERSE_LOOP;
 154         ret = for_each_matching_row(&pmd);
 155         if (ret < 0)
 156                 goto out;
 157         if (pmd.num_matches == 0)
 158                 ret = -E_NO_MATCH;
 159 out:
 160         lls_free_parse_result(aca->lpr, cmd);
 161         return ret;
 162 }
 163
 164 static int com_lsatt(struct command_context *cc, struct lls_parse_result *lpr)
 165 {
 166         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(LSATT);
 167         return send_lls_callback_request(com_lsatt_callback, cmd, lpr, cc);
 168 }
 169 EXPORT_SERVER_CMD_HANDLER(lsatt);
 170
 171 struct addatt_event_data {
 172         const char *name;
 173         unsigned char bitnum;
 174 };
 175
 176 static int com_addatt_callback(struct afs_callback_arg *aca)
 177 {
 178         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(ADDATT);
 179         int i, ret = 1;
 180         size_t len;
 181         unsigned num_inputs;
 182
 183         ret = lls(lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr));
 184         assert(ret >= 0);
 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];
 189                 struct osl_row *row;
 190                 unsigned char bitnum;
 191                 struct addatt_event_data aed;
 192
 193                 len = strlen(name);
 194                 if (len == 0 || name[len - 1] == '-' || name[len - 1] == '+') {
 195                         para_printf(&aca->pbout,
 196                                 "invalid attribute name: %s\n", name);
 197                         continue;
 198                 }
 199                 ret = get_attribute_bitnum_by_name(name, &bitnum);
 200                 if (ret >= 0) {
 201                         para_printf(&aca->pbout,
 202                                 "attribute \"%s\" already exists\n", name);
 203                         continue;
 204                 }
 205                 if (ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND)) /* error */
 206                         goto out;
 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 */
 216                                 goto out;
 217                         /* this bit is already in use, try next bit */
 218                 }
 219                 if (bitnum == 64) {
 220                         ret = -E_ATT_TABLE_FULL;
 221                         goto out;
 222                 }
 223                 objs[ATTCOL_NAME].data = (char *)name;
 224                 objs[ATTCOL_NAME].size = len + 1;
 225                 ret = osl(osl_add_row(attribute_table, objs));
 226                 if (ret < 0)
 227                         goto out;
 228                 aed.name = name;
 229                 aed.bitnum = bitnum;
 230                 ret = afs_event(ATTRIBUTE_ADD, &aca->pbout, &aed);
 231                 if (ret < 0)
 232                         goto out;
 233                 greatest_att_bitnum = PARA_MAX(greatest_att_bitnum, (int)bitnum);
 234         }
 235 out:
 236         if (ret < 0)
 237                 para_printf(&aca->pbout, "error while adding %s\n",
 238                         lls_input(i, aca->lpr));
 239         return ret;
 240 }
 241
 242 static int com_addatt(struct command_context *cc, struct lls_parse_result *lpr)
 243 {
 244         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(ADDATT);
 245         char *errctx;
 246         int ret = lls(lls_check_arg_count(lpr, 1, 64, &errctx));
 247
 248         if (ret < 0) {
 249                 send_errctx(cc, errctx);
 250                 return ret;
 251         }
 252         return send_lls_callback_request(com_addatt_callback, cmd, lpr, cc);
 253 }
 254 EXPORT_SERVER_CMD_HANDLER(addatt);
 255
 256 static int com_mvatt_callback(struct afs_callback_arg *aca)
 257 {
 258         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(MVATT);
 259         const char *old, *new;
 260         struct osl_object obj;
 261         struct osl_row *row;
 262         int ret;
 263
 264         ret = lls(lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr));
 265         assert(ret >= 0);
 266         old = lls_input(0, aca->lpr);
 267         new = lls_input(1, aca->lpr);
 268         obj.data = (char *)old;
 269         obj.size = strlen(old) + 1;
 270         ret = osl(osl_get_row(attribute_table, ATTCOL_NAME, &obj, &row));
 271         if (ret < 0)
 272                 goto out;
 273         obj.data = (char *)new;
 274         obj.size = strlen(new) + 1;
 275         /* The update fails if the destination attribute exists. */
 276         ret = osl(osl_update_object(attribute_table, row, ATTCOL_NAME, &obj));
 277 out:
 278         if (ret < 0)
 279                 para_printf(&aca->pbout, "cannot rename %s to %s\n", old, new);
 280         else
 281                 ret = afs_event(ATTRIBUTE_RENAME, &aca->pbout, NULL);
 282         lls_free_parse_result(aca->lpr, cmd);
 283         return ret;
 284 }
 285
 286 static int com_mvatt(struct command_context *cc, struct lls_parse_result *lpr)
 287 {
 288         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(MVATT);
 289         char *errctx;
 290         int ret = lls(lls_check_arg_count(lpr, 2, 2, &errctx));
 291         if (ret < 0) {
 292                 send_errctx(cc, errctx);
 293                 return ret;
 294         }
 295         return send_lls_callback_request(com_mvatt_callback, cmd, lpr, cc);
 296 }
 297 EXPORT_SERVER_CMD_HANDLER(mvatt);
 298
 299 static int remove_attribute(struct osl_table *table, struct osl_row *row,
 300                 const char *name, void *data)
 301 {
 302         struct afs_callback_arg *aca = data;
 303         int ret;
 304         struct rmatt_event_data red = {.name = name};
 305
 306         ret = get_attribute_bitnum_by_name(name, &red.bitnum);
 307         if (ret < 0) {
 308                 para_printf(&aca->pbout, "cannot remove %s\n", name);
 309                 return ret;
 310         }
 311         para_printf(&aca->pbout, "removing attribute %s\n", name);
 312         ret = osl(osl_del_row(table, row));
 313         if (ret < 0) {
 314                 para_printf(&aca->pbout, "cannot remove %s\n", name);
 315                 return ret;
 316         }
 317         return afs_event(ATTRIBUTE_REMOVE, &aca->pbout, &red);
 318 }
 319
 320 static int com_rmatt_callback(struct afs_callback_arg *aca)
 321 {
 322         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(RMATT);
 323         int ret;
 324         struct pattern_match_data pmd = {
 325                 .table = attribute_table,
 326                 .loop_col_num = ATTCOL_BITNUM,
 327                 .match_col_num = ATTCOL_NAME,
 328                 .data = aca,
 329                 .action = remove_attribute
 330         };
 331         ret = lls(lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr));
 332         assert(ret >= 0);
 333         pmd.lpr = aca->lpr;
 334         ret = for_each_matching_row(&pmd);
 335         if (ret < 0)
 336                 goto out;
 337         if (pmd.num_matches == 0)
 338                 ret = -E_NO_MATCH;
 339 out:
 340         lls_free_parse_result(aca->lpr, cmd);
 341         return ret;
 342 }
 343
 344 static int com_rmatt(struct command_context *cc, struct lls_parse_result *lpr)
 345 {
 346         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(RMATT);
 347         char *errctx;
 348         int ret = lls(lls_check_arg_count(lpr, 1, INT_MAX, &errctx));
 349
 350         if (ret < 0) {
 351                 send_errctx(cc, errctx);
 352                 return ret;
 353         }
 354         return send_lls_callback_request(com_rmatt_callback, cmd, lpr, cc);
 355 }
 356 EXPORT_SERVER_CMD_HANDLER(rmatt);
 357
 358 /**
 359  * Return a binary representation of the given attribute value.
 360  *
 361  * \param atts Pointer to the attribute value.
 362  * \param buf Result.
 363  *
 364  * This function prints a string of at most 64 characters plus the terminating
 365  * \p NULL character into \a buf which must be provided by the caller and at
 366  * least 65 bytes long. The "x" character is used for set attributes and "-" is
 367  * used for unset attributes.
 368  *
 369  * In practice, not all 64 attributes are defined. In this case, the function
 370  * only prints \a N + 1 characters where \a N is the greatest id of a defined
 371  * attribute.
 372  */
 373 void get_attribute_bitmap(const uint64_t *atts, char *buf)
 374 {
 375         int i;
 376         const uint64_t one = 1;
 377
 378         for (i = 0; i <= greatest_att_bitnum; i++)
 379                 buf[greatest_att_bitnum - i] = (*atts & (one << i))? 'x' : '-';
 380         buf[i] = '\0';
 381 }
 382
 383 /**
 384  * Get a string containing the set attributes in text form.
 385  *
 386  * \param atts The attribute bitmap.
 387  * \param delim The delimiter to separate matching attribute names.
 388  * \param text Result pointer.
 389  *
 390  * \return Positive on success, negative on errors. If no attributes have
 391  * been defined, \a *text is NULL.
 392  */
 393 int get_attribute_text(uint64_t *atts, const char *delim, char **text)
 394 {
 395         int i, ret;
 396         const uint64_t one = 1;
 397
 398         *text = NULL;
 399         if (greatest_att_bitnum < 0) { /* no attributes available */
 400                 *text = para_strdup("(no attributes available)");
 401                 return 1;
 402         }
 403         for (i = 0; i <= greatest_att_bitnum; i++) {
 404                 unsigned char bn = i;
 405                 struct osl_object obj = {.data = &bn, .size = 1};
 406                 struct osl_row *row;
 407
 408                 if (!(*atts & (one << i)))
 409                         continue;
 410                 ret = osl(osl_get_row(attribute_table, ATTCOL_BITNUM, &obj, &row));
 411                 if (ret < 0)
 412                         goto err;
 413                 ret = osl(osl_get_object(attribute_table, row, ATTCOL_NAME, &obj));
 414                 if (ret < 0)
 415                         goto err;
 416                 if (*text) {
 417                         char *tmp = make_message("%s%s%s", *text, delim, (char *)obj.data);
 418                         free(*text);
 419                         *text = tmp;
 420                 } else
 421                         *text = para_strdup(obj.data);
 422         }
 423         if (!*text) /* no attributes set */
 424                 *text = para_strdup("");
 425         return 1;
 426 err:
 427         free(*text);
 428         return ret;
 429 }
 430
 431 static int att_logical_or(struct osl_row *row, void *data)
 432 {
 433         uint64_t *att_mask = data, one = 1;
 434         struct osl_object bitnum_obj;
 435         int ret = osl_get_object(attribute_table, row, ATTCOL_BITNUM, &bitnum_obj);
 436
 437         if (ret < 0)
 438                 return ret;
 439         *att_mask |= one << *(unsigned char *)bitnum_obj.data;
 440         return 0;
 441 }
 442
 443 /**
 444  * Compute the attribute bit mask and check each afs info bitmap.
 445  *
 446  * \param aca The query field of \a aca is ignored.
 447  *
 448  * This iterates over all attributes in the attribute table and computes the
 449  * logical or of 1 << b where b is the bit number of the attribute. The
 450  * resulting bit mask is passed to aft_check_attributes() which performs the
 451  * actual check.
 452  *
 453  * \return Standard.
 454  *
 455  * \sa \ref aft_check_attributes().
 456  */
 457 int attribute_check_callback(struct afs_callback_arg *aca)
 458 {
 459         int ret;
 460         uint64_t att_mask = 0; /* bits corresponding to a attributes */
 461
 462         ret = osl_rbtree_loop(attribute_table, ATTCOL_BITNUM, &att_mask,
 463                 att_logical_or);
 464         if (ret < 0) {
 465                 PARA_ERROR_LOG("attribute table loop failed: %s\n",
 466                         para_strerror(-ret));
 467                 return ret;
 468         }
 469         return aft_check_attributes(att_mask, &aca->pbout);
 470 }
 471
 472 /**
 473  * Close the attribute table.
 474  *
 475  * \sa \ref osl_close_table().
 476  */
 477 static void attribute_close(void)
 478 {
 479         osl_close_table(attribute_table, OSL_MARK_CLEAN);
 480         attribute_table = NULL;
 481 }
 482
 483 /**
 484  * Open the attribute table.
 485  *
 486  * \param dir The database directory.
 487  *
 488  * \return Positive on success, negative on errors.
 489  *
 490  * \sa \ref osl_open_table().
 491  */
 492 static int attribute_open(const char *dir)
 493 {
 494         int ret;
 495
 496         attribute_table_desc.dir = dir;
 497         ret = osl(osl_open_table(&attribute_table_desc, &attribute_table));
 498         greatest_att_bitnum = -1; /* no atts available */
 499         if (ret >= 0) {
 500                 find_greatest_att_bitnum();
 501                 return ret;
 502         }
 503         attribute_table = NULL;
 504         if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
 505                 return 1;
 506         return ret;
 507 }
 508
 509 static int attribute_create(const char *dir)
 510 {
 511         attribute_table_desc.dir = dir;
 512         return osl(osl_create_table(&attribute_table_desc));
 513 }
 514
 515 /**
 516  * Initialize the attribute table structure.
 517  *
 518  * \param t The table structure to initialize.
 519  */
 520 void attribute_init(struct afs_table *t)
 521 {
 522         t->open = attribute_open;
 523         t->close = attribute_close;
 524         t->create = attribute_create;
 525 }