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