lib/e2p/feature.c

   1 /*
   2  * feature.c --- convert between features and strings
   3  *
   4  * Copyright (C) 1999  Theodore Ts'o <tytso@mit.edu>
   5  *
   6  * %Begin-Header%
   7  * This file may be redistributed under the terms of the GNU Library
   8  * General Public License, version 2.
   9  * %End-Header%
  10  */
  11
  12 #include "config.h"
  13 #include <stdio.h>
  14 #include <stdlib.h>
  15 #include <string.h>
  16 #include <ctype.h>
  17 #include <errno.h>
  18
  19 #include "e2p.h"
  20 #include <ext2fs/ext2fs.h>
  21 #include <ext2fs/kernel-jbd.h>
  22
  23 struct feature {
  24         int             compat;
  25         unsigned int    mask;
  26         const char      *string;
  27 };
  28
  29 static struct feature feature_list[] = {
  30         {       E2P_FEATURE_COMPAT, EXT2_FEATURE_COMPAT_DIR_PREALLOC,
  31                         "dir_prealloc" },
  32         {       E2P_FEATURE_COMPAT, EXT3_FEATURE_COMPAT_HAS_JOURNAL,
  33                         "has_journal" },
  34         {       E2P_FEATURE_COMPAT, EXT2_FEATURE_COMPAT_IMAGIC_INODES,
  35                         "imagic_inodes" },
  36         {       E2P_FEATURE_COMPAT, EXT2_FEATURE_COMPAT_EXT_ATTR,
  37                         "ext_attr" },
  38         {       E2P_FEATURE_COMPAT, EXT2_FEATURE_COMPAT_DIR_INDEX,
  39                         "dir_index" },
  40         {       E2P_FEATURE_COMPAT, EXT2_FEATURE_COMPAT_RESIZE_INODE,
  41                         "resize_inode" },
  42         {       E2P_FEATURE_COMPAT, EXT2_FEATURE_COMPAT_LAZY_BG,
  43                         "lazy_bg" },
  44         {       E2P_FEATURE_COMPAT, EXT2_FEATURE_COMPAT_EXCLUDE_BITMAP,
  45                         "snapshot_bitmap" },
  46         {       E2P_FEATURE_COMPAT, EXT4_FEATURE_COMPAT_SPARSE_SUPER2,
  47                         "sparse_super2" },
  48         {       E2P_FEATURE_COMPAT, EXT4_FEATURE_COMPAT_FAST_COMMIT,
  49                         "fast_commit" },
  50         {       E2P_FEATURE_COMPAT, EXT4_FEATURE_COMPAT_STABLE_INODES,
  51                         "stable_inodes" },
  52
  53         {       E2P_FEATURE_RO_INCOMPAT, EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER,
  54                         "sparse_super" },
  55         {       E2P_FEATURE_RO_INCOMPAT, EXT2_FEATURE_RO_COMPAT_LARGE_FILE,
  56                         "large_file" },
  57         {       E2P_FEATURE_RO_INCOMPAT, EXT4_FEATURE_RO_COMPAT_HUGE_FILE,
  58                         "huge_file" },
  59         {       E2P_FEATURE_RO_INCOMPAT, EXT4_FEATURE_RO_COMPAT_GDT_CSUM,
  60                         "uninit_bg" },
  61         {       E2P_FEATURE_RO_INCOMPAT, EXT4_FEATURE_RO_COMPAT_GDT_CSUM,
  62                         "uninit_groups" },
  63         {       E2P_FEATURE_RO_INCOMPAT, EXT4_FEATURE_RO_COMPAT_DIR_NLINK,
  64                         "dir_nlink" },
  65         {       E2P_FEATURE_RO_INCOMPAT, EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE,
  66                         "extra_isize" },
  67         {       E2P_FEATURE_RO_INCOMPAT, EXT4_FEATURE_RO_COMPAT_QUOTA,
  68                         "quota" },
  69         {       E2P_FEATURE_RO_INCOMPAT, EXT4_FEATURE_RO_COMPAT_BIGALLOC,
  70                         "bigalloc"},
  71         {       E2P_FEATURE_RO_INCOMPAT, EXT4_FEATURE_RO_COMPAT_METADATA_CSUM,
  72                         "metadata_csum"},
  73         {       E2P_FEATURE_RO_INCOMPAT, EXT4_FEATURE_RO_COMPAT_REPLICA,
  74                         "replica" },
  75         {       E2P_FEATURE_RO_INCOMPAT, EXT4_FEATURE_RO_COMPAT_READONLY,
  76                         "read-only" },
  77         {       E2P_FEATURE_RO_INCOMPAT, EXT4_FEATURE_RO_COMPAT_PROJECT,
  78                         "project"},
  79         {       E2P_FEATURE_RO_INCOMPAT, EXT4_FEATURE_RO_COMPAT_SHARED_BLOCKS,
  80                         "shared_blocks"},
  81         {       E2P_FEATURE_RO_INCOMPAT, EXT4_FEATURE_RO_COMPAT_VERITY,
  82                         "verity"},
  83
  84         {       E2P_FEATURE_INCOMPAT, EXT2_FEATURE_INCOMPAT_COMPRESSION,
  85                         "compression" },
  86         {       E2P_FEATURE_INCOMPAT, EXT2_FEATURE_INCOMPAT_FILETYPE,
  87                         "filetype" },
  88         {       E2P_FEATURE_INCOMPAT, EXT3_FEATURE_INCOMPAT_RECOVER,
  89                         "needs_recovery" },
  90         {       E2P_FEATURE_INCOMPAT, EXT3_FEATURE_INCOMPAT_JOURNAL_DEV,
  91                         "journal_dev" },
  92         {       E2P_FEATURE_INCOMPAT, EXT3_FEATURE_INCOMPAT_EXTENTS,
  93                         "extent" },
  94         {       E2P_FEATURE_INCOMPAT, EXT3_FEATURE_INCOMPAT_EXTENTS,
  95                         "extents" },
  96         {       E2P_FEATURE_INCOMPAT, EXT2_FEATURE_INCOMPAT_META_BG,
  97                         "meta_bg" },
  98         {       E2P_FEATURE_INCOMPAT, EXT4_FEATURE_INCOMPAT_64BIT,
  99                         "64bit" },
 100         {       E2P_FEATURE_INCOMPAT, EXT4_FEATURE_INCOMPAT_MMP,
 101                         "mmp" },
 102         {       E2P_FEATURE_INCOMPAT, EXT4_FEATURE_INCOMPAT_FLEX_BG,
 103                         "flex_bg"},
 104         {       E2P_FEATURE_INCOMPAT, EXT4_FEATURE_INCOMPAT_EA_INODE,
 105                         "ea_inode"},
 106         {       E2P_FEATURE_INCOMPAT, EXT4_FEATURE_INCOMPAT_DIRDATA,
 107                         "dirdata"},
 108         {       E2P_FEATURE_INCOMPAT, EXT4_FEATURE_INCOMPAT_CSUM_SEED,
 109                         "metadata_csum_seed"},
 110         {       E2P_FEATURE_INCOMPAT, EXT4_FEATURE_INCOMPAT_LARGEDIR,
 111                         "large_dir"},
 112         {       E2P_FEATURE_INCOMPAT, EXT4_FEATURE_INCOMPAT_INLINE_DATA,
 113                         "inline_data"},
 114         {       E2P_FEATURE_INCOMPAT, EXT4_FEATURE_INCOMPAT_ENCRYPT,
 115                         "encrypt"},
 116         {       E2P_FEATURE_INCOMPAT, EXT4_FEATURE_INCOMPAT_CASEFOLD,
 117                         "casefold"},
 118         {       E2P_FEATURE_INCOMPAT, EXT4_FEATURE_INCOMPAT_CASEFOLD,
 119                         "fname_encoding"},
 120         {       0, 0, 0 },
 121 };
 122
 123 static struct feature jrnl_feature_list[] = {
 124        {       E2P_FEATURE_COMPAT, JFS_FEATURE_COMPAT_CHECKSUM,
 125                        "journal_checksum" },
 126
 127        {       E2P_FEATURE_INCOMPAT, JFS_FEATURE_INCOMPAT_REVOKE,
 128                        "journal_incompat_revoke" },
 129        {       E2P_FEATURE_INCOMPAT, JFS_FEATURE_INCOMPAT_64BIT,
 130                        "journal_64bit" },
 131        {       E2P_FEATURE_INCOMPAT, JFS_FEATURE_INCOMPAT_ASYNC_COMMIT,
 132                        "journal_async_commit" },
 133        {       E2P_FEATURE_INCOMPAT, JFS_FEATURE_INCOMPAT_CSUM_V2,
 134                        "journal_checksum_v2" },
 135        {       E2P_FEATURE_INCOMPAT, JFS_FEATURE_INCOMPAT_CSUM_V3,
 136                        "journal_checksum_v3" },
 137        {       0, 0, 0 },
 138 };
 139
 140 const char *e2p_feature2string(int compat, unsigned int mask)
 141 {
 142         struct feature  *f;
 143         static char buf[20];
 144         char    fchar;
 145         int     fnum;
 146
 147         for (f = feature_list; f->string; f++) {
 148                 if ((compat == f->compat) &&
 149                     (mask == f->mask))
 150                         return f->string;
 151         }
 152         switch (compat) {
 153         case  E2P_FEATURE_COMPAT:
 154                 fchar = 'C';
 155                 break;
 156         case E2P_FEATURE_INCOMPAT:
 157                 fchar = 'I';
 158                 break;
 159         case E2P_FEATURE_RO_INCOMPAT:
 160                 fchar = 'R';
 161                 break;
 162         default:
 163                 fchar = '?';
 164                 break;
 165         }
 166         for (fnum = 0; mask >>= 1; fnum++);
 167         sprintf(buf, "FEATURE_%c%d", fchar, fnum);
 168         return buf;
 169 }
 170
 171 int e2p_string2feature(char *string, int *compat_type, unsigned int *mask)
 172 {
 173         struct feature  *f;
 174         char            *eptr;
 175         int             num;
 176
 177         for (f = feature_list; f->string; f++) {
 178                 if (!strcasecmp(string, f->string)) {
 179                         *compat_type = f->compat;
 180                         *mask = f->mask;
 181                         return 0;
 182                 }
 183         }
 184         if (strncasecmp(string, "FEATURE_", 8))
 185                 return 1;
 186
 187         switch (string[8]) {
 188         case 'c':
 189         case 'C':
 190                 *compat_type = E2P_FEATURE_COMPAT;
 191                 break;
 192         case 'i':
 193         case 'I':
 194                 *compat_type = E2P_FEATURE_INCOMPAT;
 195                 break;
 196         case 'r':
 197         case 'R':
 198                 *compat_type = E2P_FEATURE_RO_INCOMPAT;
 199                 break;
 200         default:
 201                 return 1;
 202         }
 203         if (string[9] == 0)
 204                 return 1;
 205         num = strtol(string+9, &eptr, 10);
 206         if (num > 31 || num < 0)
 207                 return 1;
 208         if (*eptr)
 209                 return 1;
 210         *mask = 1 << num;
 211         return 0;
 212 }
 213
 214 const char *e2p_jrnl_feature2string(int compat, unsigned int mask)
 215 {
 216         struct feature  *f;
 217         static char buf[20];
 218         char    fchar;
 219         int     fnum;
 220
 221         for (f = jrnl_feature_list; f->string; f++) {
 222                 if ((compat == f->compat) &&
 223                     (mask == f->mask))
 224                         return f->string;
 225         }
 226         switch (compat) {
 227         case  E2P_FEATURE_COMPAT:
 228                 fchar = 'C';
 229                 break;
 230         case E2P_FEATURE_INCOMPAT:
 231                 fchar = 'I';
 232                 break;
 233         case E2P_FEATURE_RO_INCOMPAT:
 234                 fchar = 'R';
 235                 break;
 236         default:
 237                 fchar = '?';
 238                 break;
 239         }
 240         for (fnum = 0; mask >>= 1; fnum++);
 241         sprintf(buf, "FEATURE_%c%d", fchar, fnum);
 242         return buf;
 243 }
 244
 245 int e2p_jrnl_string2feature(char *string, int *compat_type, unsigned int *mask)
 246 {
 247         struct feature  *f;
 248         char            *eptr;
 249         int             num;
 250
 251         for (f = jrnl_feature_list; f->string; f++) {
 252                 if (!strcasecmp(string, f->string)) {
 253                         *compat_type = f->compat;
 254                         *mask = f->mask;
 255                         return 0;
 256                 }
 257         }
 258         if (strncasecmp(string, "FEATURE_", 8))
 259                 return 1;
 260
 261         switch (string[8]) {
 262         case 'c':
 263         case 'C':
 264                 *compat_type = E2P_FEATURE_COMPAT;
 265                 break;
 266         case 'i':
 267         case 'I':
 268                 *compat_type = E2P_FEATURE_INCOMPAT;
 269                 break;
 270         case 'r':
 271         case 'R':
 272                 *compat_type = E2P_FEATURE_RO_INCOMPAT;
 273                 break;
 274         default:
 275                 return 1;
 276         }
 277         if (string[9] == 0)
 278                 return 1;
 279         num = strtol(string+9, &eptr, 10);
 280         if (num > 31 || num < 0)
 281                 return 1;
 282         if (*eptr)
 283                 return 1;
 284         *mask = 1 << num;
 285         return 0;
 286 }
 287 static char *skip_over_blanks(char *cp)
 288 {
 289         while (*cp && isspace(*cp))
 290                 cp++;
 291         return cp;
 292 }
 293
 294 static char *skip_over_word(char *cp)
 295 {
 296         while (*cp && !isspace(*cp) && *cp != ',')
 297                 cp++;
 298         return cp;
 299 }
 300
 301 /*
 302  * Edit a feature set array as requested by the user.  The ok_array,
 303  * if set, allows the application to limit what features the user is
 304  * allowed to set or clear using this function.  If clear_ok_array is set,
 305  * then use it tell whether or not it is OK to clear a filesystem feature.
 306  */
 307 int e2p_edit_feature2(const char *str, __u32 *compat_array, __u32 *ok_array,
 308                       __u32 *clear_ok_array, int *type_err,
 309                       unsigned int *mask_err)
 310 {
 311         char            *cp, *buf, *next;
 312         int             neg;
 313         unsigned int    mask;
 314         int             compat_type;
 315         int             rc = 0;
 316
 317         if (!clear_ok_array)
 318                 clear_ok_array = ok_array;
 319
 320         if (type_err)
 321                 *type_err = 0;
 322         if (mask_err)
 323                 *mask_err = 0;
 324
 325         buf = malloc(strlen(str)+1);
 326         if (!buf)
 327                 return 1;
 328         strcpy(buf, str);
 329         for (cp = buf; cp && *cp; cp = next ? next+1 : 0) {
 330                 neg = 0;
 331                 cp = skip_over_blanks(cp);
 332                 next = skip_over_word(cp);
 333
 334                 if (*next == 0)
 335                         next = 0;
 336                 else
 337                         *next = 0;
 338
 339                 if ((strcasecmp(cp, "none") == 0) ||
 340                     (strcasecmp(cp, "clear") == 0)) {
 341                         compat_array[0] = 0;
 342                         compat_array[1] = 0;
 343                         compat_array[2] = 0;
 344                         continue;
 345                 }
 346
 347                 switch (*cp) {
 348                 case '-':
 349                 case '^':
 350                         neg++;
 351                         /* fallthrough */
 352                 case '+':
 353                         cp++;
 354                         break;
 355                 }
 356                 if (e2p_string2feature(cp, &compat_type, &mask)) {
 357                         rc = 1;
 358                         break;
 359                 }
 360                 if (neg) {
 361                         if (clear_ok_array &&
 362                             !(clear_ok_array[compat_type] & mask)) {
 363                                 rc = 1;
 364                                 if (type_err)
 365                                         *type_err = (compat_type |
 366                                                      E2P_FEATURE_NEGATE_FLAG);
 367                                 if (mask_err)
 368                                         *mask_err = mask;
 369                                 break;
 370                         }
 371                         compat_array[compat_type] &= ~mask;
 372                 } else {
 373                         if (ok_array && !(ok_array[compat_type] & mask)) {
 374                                 rc = 1;
 375                                 if (type_err)
 376                                         *type_err = compat_type;
 377                                 if (mask_err)
 378                                         *mask_err = mask;
 379                                 break;
 380                         }
 381                         compat_array[compat_type] |= mask;
 382                 }
 383         }
 384         free(buf);
 385         return rc;
 386 }
 387
 388 int e2p_edit_feature(const char *str, __u32 *compat_array, __u32 *ok_array)
 389 {
 390         return e2p_edit_feature2(str, compat_array, ok_array, 0, 0, 0);
 391 }
 392
 393 #ifdef TEST_PROGRAM
 394 int main(int argc, char **argv)
 395 {
 396         int compat, compat2, i;
 397         unsigned int mask, mask2;
 398         const char *str;
 399         struct feature *f;
 400
 401         for (i = 0; i < 2; i++) {
 402                 if (i == 0) {
 403                         f = feature_list;
 404                         printf("Feature list:\n");
 405                 } else {
 406                         printf("\nJournal feature list:\n");
 407                         f = jrnl_feature_list;
 408                 }
 409                 for (; f->string; f++) {
 410                         if (i == 0) {
 411                                 e2p_string2feature((char *)f->string, &compat,
 412                                                    &mask);
 413                                 str = e2p_feature2string(compat, mask);
 414                         } else {
 415                                 e2p_jrnl_string2feature((char *)f->string,
 416                                                         &compat, &mask);
 417                                 str = e2p_jrnl_feature2string(compat, mask);
 418                         }
 419
 420                         printf("\tCompat = %d, Mask = %u, %s\n",
 421                                compat, mask, f->string);
 422                         if (strcmp(f->string, str)) {
 423                                 if (e2p_string2feature((char *) str, &compat2,
 424                                                        &mask2) ||
 425                                     (compat2 != compat) ||
 426                                     (mask2 != mask)) {
 427                                         fprintf(stderr, "Failure!\n");
 428                                         exit(1);
 429                                 }
 430                         }
 431                 }
 432         }
 433         exit(0);
 434 }
 435 #endif