sbin/newfs_hammer2/newfs_hammer2.c

   1 /*
   2  * Copyright (c) 2011-2015 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@dragonflybsd.org>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  */
  34
  35 #include <sys/types.h>
  36 #include <sys/diskslice.h>
  37 #include <sys/diskmbr.h>
  38 #include <sys/stat.h>
  39 #include <sys/time.h>
  40 #include <sys/sysctl.h>
  41 #include <vfs/hammer2/hammer2_xxhash.h>
  42 #include <vfs/hammer2/hammer2_disk.h>
  43
  44 #include <stdio.h>
  45 #include <stdlib.h>
  46 #include <stdarg.h>
  47 #include <stddef.h>
  48 #include <unistd.h>
  49 #include <string.h>
  50 #include <errno.h>
  51 #include <fcntl.h>
  52 #include <assert.h>
  53 #include <err.h>
  54 #include <uuid.h>
  55
  56 #define MAXLABELS       HAMMER2_SET_COUNT
  57
  58 #define hammer2_icrc32(buf, size)       iscsi_crc32((buf), (size))
  59 #define hammer2_icrc32c(buf, size, crc) iscsi_crc32_ext((buf), (size), (crc))
  60 uint32_t iscsi_crc32(const void *buf, size_t size);
  61 uint32_t iscsi_crc32_ext(const void *buf, size_t size, uint32_t ocrc);
  62
  63 static hammer2_off_t check_volume(const char *path, int *fdp);
  64 static int64_t getsize(const char *str, int64_t minval, int64_t maxval, int pw);
  65 static const char *sizetostr(hammer2_off_t size);
  66 static uint64_t nowtime(void);
  67 static int blkrefary_cmp(const void *b1, const void *b2);
  68 static void usage(void);
  69
  70 static void format_hammer2(int fd, hammer2_off_t total_space,
  71                                 hammer2_off_t free_space);
  72 static void alloc_direct(hammer2_off_t *basep, hammer2_blockref_t *bref,
  73                                 size_t bytes);
  74 static hammer2_key_t dirhash(const unsigned char *name, size_t len);
  75
  76 static int Hammer2Version = -1;
  77 static int ForceOpt = 0;
  78 static uuid_t Hammer2_FSType;   /* static filesystem type id for HAMMER2 */
  79 static uuid_t Hammer2_VolFSID;  /* unique filesystem id in volu header */
  80 static uuid_t Hammer2_SupCLID;  /* PFS cluster id in super-root inode */
  81 static uuid_t Hammer2_SupFSID;  /* PFS unique id in super-root inode */
  82 static uuid_t Hammer2_PfsCLID[MAXLABELS];
  83 static uuid_t Hammer2_PfsFSID[MAXLABELS];
  84 static const char *Label[MAXLABELS];
  85 static hammer2_off_t BootAreaSize;
  86 static hammer2_off_t AuxAreaSize;
  87 static int NLabels;
  88
  89 #define GIG     ((hammer2_off_t)1024*1024*1024)
  90
  91 int
  92 main(int ac, char **av)
  93 {
  94         uint32_t status;
  95         hammer2_off_t total_space;
  96         hammer2_off_t free_space;
  97         hammer2_off_t reserved_space;
  98         int ch;
  99         int fd = -1;
 100         int i;
 101         int defaultlabels = 1;
 102         char *vol_fsid;
 103         char *sup_clid_name;
 104         char *sup_fsid_name;
 105         char *pfs_clid_name;
 106         char *pfs_fsid_name;
 107
 108         Label[NLabels++] = "LOCAL";
 109
 110         /*
 111          * Sanity check basic filesystem structures.  No cookies for us
 112          * if it gets broken!
 113          */
 114         assert(sizeof(hammer2_volume_data_t) == HAMMER2_VOLUME_BYTES);
 115         assert(sizeof(hammer2_inode_data_t) == HAMMER2_INODE_BYTES);
 116         assert(sizeof(hammer2_blockref_t) == HAMMER2_BLOCKREF_BYTES);
 117
 118         /*
 119          * Generate a filesystem id and lookup the filesystem type
 120          */
 121         srandomdev();
 122         uuidgen(&Hammer2_VolFSID, 1);
 123         uuidgen(&Hammer2_SupCLID, 1);
 124         uuidgen(&Hammer2_SupFSID, 1);
 125         uuid_from_string(HAMMER2_UUID_STRING, &Hammer2_FSType, &status);
 126         /*uuid_name_lookup(&Hammer2_FSType, "DragonFly HAMMER2", &status);*/
 127         if (status != uuid_s_ok) {
 128                 errx(1, "uuids file does not have the DragonFly "
 129                         "HAMMER2 filesystem type");
 130         }
 131
 132         /*
 133          * Parse arguments
 134          */
 135         while ((ch = getopt(ac, av, "fL:b:m:r:V:")) != -1) {
 136                 switch(ch) {
 137                 case 'f':
 138                         ForceOpt = 1;
 139                         break;
 140                 case 'L':
 141                         defaultlabels = 0;
 142                         if (strcasecmp(optarg, "none") == 0) {
 143                                 break;
 144                         }
 145                         if (NLabels >= MAXLABELS) {
 146                                 errx(1,
 147                                      "Limit of %d local labels",
 148                                      MAXLABELS - 1);
 149                         }
 150                         Label[NLabels++] = optarg;
 151                         if (strlen(Label[NLabels-1]) > HAMMER2_INODE_MAXNAME) {
 152                                 errx(1, "Root directory label too long "
 153                                         "(64 chars max)\n");
 154                         }
 155                         break;
 156                 case 'b':
 157                         BootAreaSize = getsize(optarg,
 158                                          HAMMER2_NEWFS_ALIGN,
 159                                          HAMMER2_BOOT_MAX_BYTES, 2);
 160                         break;
 161                 case 'r':
 162                         AuxAreaSize = getsize(optarg,
 163                                          HAMMER2_NEWFS_ALIGN,
 164                                          HAMMER2_REDO_MAX_BYTES, 2);
 165                         break;
 166                 case 'V':
 167                         Hammer2Version = strtol(optarg, NULL, 0);
 168                         if (Hammer2Version < HAMMER2_VOL_VERSION_MIN ||
 169                             Hammer2Version >= HAMMER2_VOL_VERSION_WIP) {
 170                                 errx(1,
 171                                      "I don't understand how to format "
 172                                      "HAMMER2 version %d\n",
 173                                      Hammer2Version);
 174                         }
 175                         break;
 176                 default:
 177                         usage();
 178                         break;
 179                 }
 180         }
 181
 182         /*
 183          * Check Hammer2 version
 184          */
 185         if (Hammer2Version < 0) {
 186                 size_t olen = sizeof(Hammer2Version);
 187                 Hammer2Version = HAMMER2_VOL_VERSION_DEFAULT;
 188                 if (sysctlbyname("vfs.hammer2.supported_version",
 189                                  &Hammer2Version, &olen, NULL, 0) == 0) {
 190                         if (Hammer2Version >= HAMMER2_VOL_VERSION_WIP) {
 191                                 Hammer2Version = HAMMER2_VOL_VERSION_WIP - 1;
 192                                 fprintf(stderr,
 193                                         "newfs_hammer2: WARNING: HAMMER2 VFS "
 194                                         "supports higher version than I "
 195                                         "understand,\n"
 196                                         "using version %d\n",
 197                                         Hammer2Version);
 198                         }
 199                 } else {
 200                         fprintf(stderr,
 201                                 "newfs_hammer2: WARNING: HAMMER2 VFS not "
 202                                 "loaded, cannot get version info.\n"
 203                                 "Using version %d\n",
 204                                 HAMMER2_VOL_VERSION_DEFAULT);
 205                 }
 206         }
 207
 208         ac -= optind;
 209         av += optind;
 210
 211         if (ac != 1 || av[0][0] == 0) {
 212                 fprintf(stderr, "Exactly one disk device must be specified\n");
 213                 exit(1);
 214         }
 215
 216         /*
 217          * Adjust Label[] and NLabels.
 218          */
 219         if (defaultlabels == 0) {
 220                 NLabels = 1;
 221         } else {
 222                 char c = av[0][strlen(av[0]) - 1];
 223                 if (c == 'a')
 224                         Label[NLabels++] = "BOOT";
 225                 else if (c == 'd')
 226                         Label[NLabels++] = "ROOT";
 227                 else
 228                         Label[NLabels++] = "DATA";
 229         }
 230
 231         /*
 232          * Collect volume information.
 233          */
 234         total_space = check_volume(av[0], &fd);
 235
 236         /*
 237          * ~typically 8MB alignment to avoid edge cases for reserved blocks
 238          * and so raid stripes (if any) operate efficiently.
 239          */
 240         total_space &= ~HAMMER2_VOLUME_ALIGNMASK64;
 241
 242         /*
 243          * Calculate defaults for the boot area size and round to the
 244          * volume alignment boundary.
 245          *
 246          * NOTE: These areas are currently not used for booting but are
 247          *       reserved for future filesystem expansion.
 248          */
 249         if (BootAreaSize == 0) {
 250                 BootAreaSize = HAMMER2_BOOT_NOM_BYTES;
 251                 while (BootAreaSize > total_space / 20)
 252                         BootAreaSize >>= 1;
 253                 if (BootAreaSize < HAMMER2_BOOT_MIN_BYTES)
 254                         BootAreaSize = HAMMER2_BOOT_MIN_BYTES;
 255         } else if (BootAreaSize < HAMMER2_BOOT_MIN_BYTES) {
 256                 BootAreaSize = HAMMER2_BOOT_MIN_BYTES;
 257         }
 258         BootAreaSize = (BootAreaSize + HAMMER2_VOLUME_ALIGNMASK64) &
 259                        ~HAMMER2_VOLUME_ALIGNMASK64;
 260
 261         /*
 262          * Calculate defaults for the redo area size and round to the
 263          * volume alignment boundary.
 264          *
 265          * NOTE: These areas are currently not used for logging but are
 266          *       reserved for future filesystem expansion.
 267          */
 268         if (AuxAreaSize == 0) {
 269                 AuxAreaSize = HAMMER2_REDO_NOM_BYTES;
 270                 while (AuxAreaSize > total_space / 20)
 271                         AuxAreaSize >>= 1;
 272                 if (AuxAreaSize < HAMMER2_REDO_MIN_BYTES)
 273                         AuxAreaSize = HAMMER2_REDO_MIN_BYTES;
 274         } else if (AuxAreaSize < HAMMER2_REDO_MIN_BYTES) {
 275                 AuxAreaSize = HAMMER2_REDO_MIN_BYTES;
 276         }
 277         AuxAreaSize = (AuxAreaSize + HAMMER2_VOLUME_ALIGNMASK64) &
 278                        ~HAMMER2_VOLUME_ALIGNMASK64;
 279
 280         /*
 281          * We'll need to stuff this in the volume header soon.
 282          */
 283         uuid_to_string(&Hammer2_VolFSID, &vol_fsid, &status);
 284         uuid_to_string(&Hammer2_SupCLID, &sup_clid_name, &status);
 285         uuid_to_string(&Hammer2_SupFSID, &sup_fsid_name, &status);
 286
 287         /*
 288          * Calculate the amount of reserved space.  HAMMER2_ZONE_SEG (4MB)
 289          * is reserved at the beginning of every 2GB of storage, rounded up.
 290          * Thus a 200MB filesystem will still have a 4MB reserve area.
 291          *
 292          * We also include the boot and redo areas in the reserve.  The
 293          * reserve is used to help 'df' calculate the amount of available
 294          * space.
 295          */
 296         reserved_space = ((total_space + HAMMER2_ZONE_MASK64) /
 297                           HAMMER2_ZONE_BYTES64) * HAMMER2_ZONE_SEG64;
 298
 299         free_space = total_space - reserved_space -
 300                      BootAreaSize - AuxAreaSize;
 301
 302         format_hammer2(fd, total_space, free_space);
 303         fsync(fd);
 304         close(fd);
 305
 306         printf("---------------------------------------------\n");
 307         printf("version:          %d\n", Hammer2Version);
 308         printf("total-size:       %s (%jd bytes)\n",
 309                sizetostr(total_space),
 310                (intmax_t)total_space);
 311         printf("boot-area-size:   %s\n", sizetostr(BootAreaSize));
 312         printf("aux-area-size:    %s\n", sizetostr(AuxAreaSize));
 313         printf("topo-reserved:    %s\n", sizetostr(reserved_space));
 314         printf("free-space:       %s\n", sizetostr(free_space));
 315         printf("vol-fsid:         %s\n", vol_fsid);
 316         printf("sup-clid:         %s\n", sup_clid_name);
 317         printf("sup-fsid:         %s\n", sup_fsid_name);
 318         for (i = 0; i < NLabels; ++i) {
 319                 printf("PFS \"%s\"\n", Label[i]);
 320                 uuid_to_string(&Hammer2_PfsCLID[i], &pfs_clid_name, &status);
 321                 uuid_to_string(&Hammer2_PfsFSID[i], &pfs_fsid_name, &status);
 322                 printf("    clid %s\n", pfs_clid_name);
 323                 printf("    fsid %s\n", pfs_fsid_name);
 324         }
 325         printf("\n");
 326
 327         return(0);
 328 }
 329
 330 static
 331 void
 332 usage(void)
 333 {
 334         fprintf(stderr,
 335                 "usage: newfs_hammer2 -L label [-f] [-b bootsize] "
 336                 "[-r redosize] [-V version] special ...\n"
 337         );
 338         exit(1);
 339 }
 340
 341 /*
 342  * Convert the size in bytes to a human readable string.
 343  */
 344 static
 345 const char *
 346 sizetostr(hammer2_off_t size)
 347 {
 348         static char buf[32];
 349
 350         if (size < 1024 / 2) {
 351                 snprintf(buf, sizeof(buf), "%6.2f", (double)size);
 352         } else if (size < 1024 * 1024 / 2) {
 353                 snprintf(buf, sizeof(buf), "%6.2fKB",
 354                         (double)size / 1024);
 355         } else if (size < 1024 * 1024 * 1024LL / 2) {
 356                 snprintf(buf, sizeof(buf), "%6.2fMB",
 357                         (double)size / (1024 * 1024));
 358         } else if (size < 1024 * 1024 * 1024LL * 1024LL / 2) {
 359                 snprintf(buf, sizeof(buf), "%6.2fGB",
 360                         (double)size / (1024 * 1024 * 1024LL));
 361         } else {
 362                 snprintf(buf, sizeof(buf), "%6.2fTB",
 363                         (double)size / (1024 * 1024 * 1024LL * 1024LL));
 364         }
 365         return(buf);
 366 }
 367
 368 /*
 369  * Convert a string to a 64 bit signed integer with various requirements.
 370  */
 371 static int64_t
 372 getsize(const char *str, int64_t minval, int64_t maxval, int powerof2)
 373 {
 374         int64_t val;
 375         char *ptr;
 376
 377         val = strtoll(str, &ptr, 0);
 378         switch(*ptr) {
 379         case 't':
 380         case 'T':
 381                 val *= 1024;
 382                 /* fall through */
 383         case 'g':
 384         case 'G':
 385                 val *= 1024;
 386                 /* fall through */
 387         case 'm':
 388         case 'M':
 389                 val *= 1024;
 390                 /* fall through */
 391         case 'k':
 392         case 'K':
 393                 val *= 1024;
 394                 break;
 395         default:
 396                 errx(1, "Unknown suffix in number '%s'\n", str);
 397                 /* not reached */
 398         }
 399         if (ptr[1]) {
 400                 errx(1, "Unknown suffix in number '%s'\n", str);
 401                 /* not reached */
 402         }
 403         if (val < minval) {
 404                 errx(1, "Value too small: %s, min is %s\n",
 405                      str, sizetostr(minval));
 406                 /* not reached */
 407         }
 408         if (val > maxval) {
 409                 errx(1, "Value too large: %s, max is %s\n",
 410                      str, sizetostr(maxval));
 411                 /* not reached */
 412         }
 413         if ((powerof2 & 1) && (val ^ (val - 1)) != ((val << 1) - 1)) {
 414                 errx(1, "Value not power of 2: %s\n", str);
 415                 /* not reached */
 416         }
 417         if ((powerof2 & 2) && (val & HAMMER2_NEWFS_ALIGNMASK)) {
 418                 errx(1, "Value not an integral multiple of %dK: %s",
 419                      HAMMER2_NEWFS_ALIGN / 1024, str);
 420                 /* not reached */
 421         }
 422         return(val);
 423 }
 424
 425 static uint64_t
 426 nowtime(void)
 427 {
 428         struct timeval tv;
 429         uint64_t xtime;
 430
 431         gettimeofday(&tv, NULL);
 432         xtime = tv.tv_sec * 1000000LL + tv.tv_usec;
 433         return(xtime);
 434 }
 435
 436 /*
 437  * Figure out how big the volume is.
 438  */
 439 static
 440 hammer2_off_t
 441 check_volume(const char *path, int *fdp)
 442 {
 443         struct partinfo pinfo;
 444         struct stat st;
 445         hammer2_off_t size;
 446
 447         /*
 448          * Get basic information about the volume
 449          */
 450         *fdp = open(path, O_RDWR);
 451         if (*fdp < 0)
 452                 err(1, "Unable to open %s R+W", path);
 453         if (ioctl(*fdp, DIOCGPART, &pinfo) < 0) {
 454                 /*
 455                  * Allow the formatting of regular files as HAMMER2 volumes
 456                  */
 457                 if (fstat(*fdp, &st) < 0)
 458                         err(1, "Unable to stat %s", path);
 459                 size = st.st_size;
 460         } else {
 461                 /*
 462                  * When formatting a block device as a HAMMER2 volume the
 463                  * sector size must be compatible.  HAMMER2 uses 64K
 464                  * filesystem buffers but logical buffers for direct I/O
 465                  * can be as small as HAMMER2_LOGSIZE (16KB).
 466                  */
 467                 if (pinfo.reserved_blocks) {
 468                         errx(1, "HAMMER2 cannot be placed in a partition "
 469                                 "which overlaps the disklabel or MBR");
 470                 }
 471                 if (pinfo.media_blksize > HAMMER2_PBUFSIZE ||
 472                     HAMMER2_PBUFSIZE % pinfo.media_blksize) {
 473                         errx(1, "A media sector size of %d is not supported",
 474                              pinfo.media_blksize);
 475                 }
 476                 size = pinfo.media_size;
 477         }
 478         printf("Volume %-15s size %s\n", path, sizetostr(size));
 479         return (size);
 480 }
 481
 482 /*
 483  * Create the volume header, the super-root directory inode, and
 484  * the writable snapshot subdirectory (named via the label) which
 485  * is to be the initial mount point, or at least the first mount point.
 486  *
 487  * [----reserved_area----][boot_area][aux_area]
 488  * [[vol_hdr]...         ]                     [sroot][root]...
 489  *
 490  * The sroot and root inodes eat 512 bytes each.  newfs labels can only be
 491  * 64 bytes so the root (snapshot) inode does not need to extend past 512
 492  * bytes.  We use the correct hash slot correct but note that because
 493  * directory hashes are chained 16x, any slot in the inode will work.
 494  *
 495  * Also format the allocation map.
 496  *
 497  * NOTE: The passed total_space is 8MB-aligned to avoid edge cases.
 498  */
 499 static
 500 void
 501 format_hammer2(int fd, hammer2_off_t total_space, hammer2_off_t free_space)
 502 {
 503         char *buf = malloc(HAMMER2_PBUFSIZE);
 504         hammer2_volume_data_t *vol;
 505         hammer2_inode_data_t *rawip;
 506         hammer2_blockref_t sroot_blockref;
 507         hammer2_blockref_t root_blockref[MAXLABELS];
 508         uint64_t now;
 509         hammer2_off_t volu_base = 0;
 510         hammer2_off_t boot_base = HAMMER2_ZONE_SEG;
 511         hammer2_off_t aux_base = boot_base + BootAreaSize;
 512         hammer2_off_t alloc_base = aux_base + AuxAreaSize;
 513         hammer2_off_t tmp_base;
 514         size_t n;
 515         int i;
 516
 517         /*
 518          * Clear the entire reserve for the first 2G segment and
 519          * make sure we can write to the last block.
 520          */
 521         bzero(buf, HAMMER2_PBUFSIZE);
 522         tmp_base = volu_base;
 523         for (i = 0; i < HAMMER2_ZONE_BLOCKS_SEG; ++i) {
 524                 n = pwrite(fd, buf, HAMMER2_PBUFSIZE, tmp_base);
 525                 if (n != HAMMER2_PBUFSIZE) {
 526                         perror("write");
 527                         exit(1);
 528                 }
 529                 tmp_base += HAMMER2_PBUFSIZE;
 530         }
 531
 532         n = pwrite(fd, buf, HAMMER2_PBUFSIZE,
 533                    volu_base + total_space - HAMMER2_PBUFSIZE);
 534         if (n != HAMMER2_PBUFSIZE) {
 535                 perror("write (at-end-of-volume)");
 536                 exit(1);
 537         }
 538
 539         /*
 540          * Make sure alloc_base won't cross the reserved area at the
 541          * beginning of each 2GB zone.
 542          *
 543          * Reserve space for the super-root inode and the root inode.
 544          * Make sure they are in the same 64K block to simplify our code.
 545          */
 546         assert((alloc_base & HAMMER2_PBUFMASK) == 0);
 547         assert(alloc_base < HAMMER2_ZONE_BYTES64 - HAMMER2_ZONE_SEG);
 548         now = nowtime();
 549         bzero(buf, HAMMER2_PBUFSIZE);
 550
 551         alloc_base &= ~HAMMER2_PBUFMASK64;
 552         alloc_direct(&alloc_base, &sroot_blockref, HAMMER2_INODE_BYTES);
 553
 554         for (i = 0; i < NLabels; ++i) {
 555                 uuidgen(&Hammer2_PfsCLID[i], 1);
 556                 uuidgen(&Hammer2_PfsFSID[i], 1);
 557
 558                 alloc_direct(&alloc_base, &root_blockref[i],
 559                              HAMMER2_INODE_BYTES);
 560                 assert(((sroot_blockref.data_off ^ root_blockref[i].data_off) &
 561                         HAMMER2_OFF_MASK_HI) == 0);
 562
 563                 /*
 564                  * Format the root directory inode, which is left empty.
 565                  */
 566                 rawip = (void *)(buf + (HAMMER2_OFF_MASK_LO &
 567                                         root_blockref[i].data_off));
 568                 rawip->meta.version = HAMMER2_INODE_VERSION_ONE;
 569                 rawip->meta.ctime = now;
 570                 rawip->meta.mtime = now;
 571                 /* rawip->atime = now; NOT IMPL MUST BE ZERO */
 572                 rawip->meta.btime = now;
 573                 rawip->meta.type = HAMMER2_OBJTYPE_DIRECTORY;
 574                 rawip->meta.mode = 0755;
 575                 rawip->meta.inum = 1;   /* root inode, inumber 1 */
 576                 rawip->meta.nlinks = 1; /* directory link count compat */
 577
 578                 rawip->meta.name_len = strlen(Label[i]);
 579                 bcopy(Label[i], rawip->filename, rawip->meta.name_len);
 580                 rawip->meta.name_key =
 581                                 dirhash(rawip->filename, rawip->meta.name_len);
 582
 583                 /*
 584                  * Compression mode and supported copyids.
 585                  *
 586                  * Do not allow compression when creating any "BOOT" label
 587                  * (pfs-create also does the same if the pfs is named "BOOT")
 588                  */
 589                 if (strcasecmp(Label[i], "BOOT") == 0) {
 590                         rawip->meta.comp_algo = HAMMER2_ENC_ALGO(
 591                                                     HAMMER2_COMP_AUTOZERO);
 592                         rawip->meta.check_algo = HAMMER2_ENC_ALGO(
 593                                                     HAMMER2_CHECK_XXHASH64);
 594                 } else  {
 595                         rawip->meta.comp_algo = HAMMER2_ENC_ALGO(
 596                                                     HAMMER2_COMP_NEWFS_DEFAULT);
 597                         rawip->meta.check_algo = HAMMER2_ENC_ALGO(
 598                                                     HAMMER2_CHECK_XXHASH64);
 599                 }
 600
 601                 /*
 602                  * NOTE: We leave nmasters set to 0, which means that we
 603                  *       don't know how many masters there are.  The quorum
 604                  *       calculation will effectively be 1 ( 0 / 2 + 1 ).
 605                  */
 606                 rawip->meta.pfs_clid = Hammer2_PfsCLID[i];
 607                 rawip->meta.pfs_fsid = Hammer2_PfsFSID[i];
 608                 rawip->meta.pfs_type = HAMMER2_PFSTYPE_MASTER;
 609                 rawip->meta.op_flags |= HAMMER2_OPFLAG_PFSROOT;
 610
 611                 /* first allocatable inode number */
 612                 rawip->meta.pfs_inum = 16;
 613
 614                 /* rawip->u.blockset is left empty */
 615
 616                 /*
 617                  * The root blockref will be stored in the super-root inode as
 618                  * the only directory entry.  The copyid here is the actual
 619                  * copyid of the storage ref.
 620                  *
 621                  * The key field for a directory entry's blockref is
 622                  * essentially the name key for the entry.
 623                  */
 624                 root_blockref[i].key = rawip->meta.name_key;
 625                 root_blockref[i].copyid = HAMMER2_COPYID_LOCAL;
 626                 root_blockref[i].keybits = 0;
 627                 root_blockref[i].check.xxhash64.value =
 628                                 XXH64(rawip, sizeof(*rawip), XXH_HAMMER2_SEED);
 629                 root_blockref[i].type = HAMMER2_BREF_TYPE_INODE;
 630                 root_blockref[i].methods =
 631                                 HAMMER2_ENC_CHECK(HAMMER2_CHECK_XXHASH64) |
 632                                 HAMMER2_ENC_COMP(HAMMER2_COMP_NONE);
 633                 root_blockref[i].mirror_tid = 16;
 634                 root_blockref[i].flags = HAMMER2_BREF_FLAG_PFSROOT;
 635         }
 636
 637         /*
 638          * Format the super-root directory inode, giving it one directory
 639          * entry (root_blockref) and fixup the icrc method.
 640          *
 641          * The superroot contains one directory entry pointing at the root
 642          * inode (named via the label).  Inodes contain one blockset which
 643          * is fully associative so we can put the entry anywhere without
 644          * having to worry about the hash.  Use index 0.
 645          */
 646         rawip = (void *)(buf + (HAMMER2_OFF_MASK_LO & sroot_blockref.data_off));
 647         rawip->meta.version = HAMMER2_INODE_VERSION_ONE;
 648         rawip->meta.ctime = now;
 649         rawip->meta.mtime = now;
 650         /* rawip->meta.atime = now; NOT IMPL MUST BE ZERO */
 651         rawip->meta.btime = now;
 652         rawip->meta.type = HAMMER2_OBJTYPE_DIRECTORY;
 653         rawip->meta.mode = 0700;        /* super-root - root only */
 654         rawip->meta.inum = 0;           /* super root inode, inumber 0 */
 655         rawip->meta.nlinks = 2;         /* directory link count compat */
 656
 657         rawip->meta.name_len = 0;       /* super-root is unnamed */
 658         rawip->meta.name_key = 0;
 659
 660         rawip->meta.comp_algo = HAMMER2_ENC_ALGO(HAMMER2_COMP_AUTOZERO);
 661         rawip->meta.check_algo = HAMMER2_ENC_ALGO(HAMMER2_CHECK_XXHASH64);
 662
 663         /*
 664          * The super-root is flagged as a PFS and typically given its own
 665          * random FSID, making it possible to mirror an entire HAMMER2 disk
 666          * snapshots and all if desired.  PFS ids are used to match up
 667          * mirror sources and targets and cluster copy sources and targets.
 668          *
 669          * (XXX whole-disk logical mirroring is not really supported in
 670          *  the first attempt because each PFS is in its own modify/mirror
 671          *  transaction id domain, so normal mechanics cannot cross a PFS
 672          *  boundary).
 673          */
 674         rawip->meta.pfs_clid = Hammer2_SupCLID;
 675         rawip->meta.pfs_fsid = Hammer2_SupFSID;
 676         rawip->meta.pfs_type = HAMMER2_PFSTYPE_SUPROOT;
 677         snprintf(rawip->filename, sizeof(rawip->filename), "SUPROOT");
 678         rawip->meta.name_key = 0;
 679         rawip->meta.name_len = strlen(rawip->filename);
 680
 681         /* The super-root has an inode number of 0 */
 682         rawip->meta.pfs_inum = 0;
 683
 684         /*
 685          * Currently newfs_hammer2 just throws the PFS inodes into the
 686          * top-level block table at the volume root and doesn't try to
 687          * create an indirect block, so we are limited to ~4 at filesystem
 688          * creation time.  More can be added after mounting.
 689          */
 690         qsort(root_blockref, NLabels, sizeof(root_blockref[0]), blkrefary_cmp);
 691         for (i = 0; i < NLabels; ++i)
 692                 rawip->u.blockset.blockref[i] = root_blockref[i];
 693
 694         /*
 695          * The sroot blockref will be stored in the volume header.
 696          */
 697         sroot_blockref.copyid = HAMMER2_COPYID_LOCAL;
 698         sroot_blockref.keybits = 0;
 699         sroot_blockref.check.xxhash64.value =
 700                                         XXH64(rawip, sizeof(*rawip), XXH_HAMMER2_SEED);
 701         sroot_blockref.type = HAMMER2_BREF_TYPE_INODE;
 702         sroot_blockref.methods = HAMMER2_ENC_CHECK(HAMMER2_CHECK_XXHASH64) |
 703                                  HAMMER2_ENC_COMP(HAMMER2_COMP_AUTOZERO);
 704         sroot_blockref.mirror_tid = 16;
 705         rawip = NULL;
 706
 707         /*
 708          * Write out the 64K HAMMER2 block containing the root and sroot.
 709          */
 710         n = pwrite(fd, buf, HAMMER2_PBUFSIZE,
 711                    sroot_blockref.data_off & HAMMER2_OFF_MASK_HI);
 712         if (n != HAMMER2_PBUFSIZE) {
 713                 perror("write");
 714                 exit(1);
 715         }
 716
 717         /*
 718          * Format the volume header.
 719          *
 720          * The volume header points to sroot_blockref.  Also be absolutely
 721          * sure that allocator_beg is set.
 722          */
 723         bzero(buf, HAMMER2_PBUFSIZE);
 724         vol = (void *)buf;
 725
 726         vol->magic = HAMMER2_VOLUME_ID_HBO;
 727         vol->boot_beg = boot_base;
 728         vol->boot_end = boot_base + BootAreaSize;
 729         vol->aux_beg = aux_base;
 730         vol->aux_end = aux_base + AuxAreaSize;
 731         vol->volu_size = total_space;
 732         vol->version = Hammer2Version;
 733         vol->flags = 0;
 734
 735         vol->fsid = Hammer2_VolFSID;
 736         vol->fstype = Hammer2_FSType;
 737
 738         vol->peer_type = DMSG_PEER_HAMMER2;     /* LNK_CONN identification */
 739
 740         vol->allocator_size = free_space;
 741         vol->allocator_free = free_space;
 742         vol->allocator_beg = alloc_base;
 743
 744         vol->sroot_blockset.blockref[0] = sroot_blockref;
 745         vol->mirror_tid = 16;   /* all blockref mirror TIDs set to 16 */
 746         vol->freemap_tid = 16;  /* all blockref mirror TIDs set to 16 */
 747         vol->icrc_sects[HAMMER2_VOL_ICRC_SECT1] =
 748                         hammer2_icrc32((char *)vol + HAMMER2_VOLUME_ICRC1_OFF,
 749                                        HAMMER2_VOLUME_ICRC1_SIZE);
 750
 751         /*
 752          * Set ICRC_SECT0 after all remaining elements of sect0 have been
 753          * populated in the volume header.  Note hat ICRC_SECT* (except for
 754          * SECT0) are part of sect0.
 755          */
 756         vol->icrc_sects[HAMMER2_VOL_ICRC_SECT0] =
 757                         hammer2_icrc32((char *)vol + HAMMER2_VOLUME_ICRC0_OFF,
 758                                        HAMMER2_VOLUME_ICRC0_SIZE);
 759         vol->icrc_volheader =
 760                         hammer2_icrc32((char *)vol + HAMMER2_VOLUME_ICRCVH_OFF,
 761                                        HAMMER2_VOLUME_ICRCVH_SIZE);
 762
 763         /*
 764          * Write the volume header and all alternates.
 765          */
 766         for (i = 0; i < HAMMER2_NUM_VOLHDRS; ++i) {
 767                 if (i * HAMMER2_ZONE_BYTES64 >= total_space)
 768                         break;
 769                 n = pwrite(fd, buf, HAMMER2_PBUFSIZE,
 770                            volu_base + i * HAMMER2_ZONE_BYTES64);
 771                 if (n != HAMMER2_PBUFSIZE) {
 772                         perror("write");
 773                         exit(1);
 774                 }
 775         }
 776
 777         /*
 778          * Cleanup
 779          */
 780         free(buf);
 781 }
 782
 783 static void
 784 alloc_direct(hammer2_off_t *basep, hammer2_blockref_t *bref, size_t bytes)
 785 {
 786         int radix;
 787
 788         radix = 0;
 789         assert(bytes);
 790         while ((bytes & 1) == 0) {
 791                 bytes >>= 1;
 792                 ++radix;
 793         }
 794         assert(bytes == 1);
 795         if (radix < HAMMER2_RADIX_MIN)
 796                 radix = HAMMER2_RADIX_MIN;
 797
 798         bzero(bref, sizeof(*bref));
 799         bref->data_off = *basep | radix;
 800         bref->vradix = radix;
 801
 802         *basep += 1U << radix;
 803 }
 804
 805 /*
 806  * Borrow HAMMER1's directory hash algorithm #1 with a few modifications.
 807  * The filename is split into fields which are hashed separately and then
 808  * added together.
 809  *
 810  * Differences include: bit 63 must be set to 1 for HAMMER2 (HAMMER1 sets
 811  * it to 0), this is because bit63=0 is used for hidden hardlinked inodes.
 812  * (This means we do not need to do a 0-check/or-with-0x100000000 either).
 813  *
 814  * Also, the iscsi crc code is used instead of the old crc32 code.
 815  */
 816 static hammer2_key_t
 817 dirhash(const unsigned char *name, size_t len)
 818 {
 819         const unsigned char *aname = name;
 820         uint32_t crcx;
 821         uint64_t key;
 822         size_t i;
 823         size_t j;
 824
 825         /*
 826          * Filesystem version 6 or better will create directories
 827          * using the ALG1 dirhash.  This hash breaks the filename
 828          * up into domains separated by special characters and
 829          * hashes each domain independently.
 830          *
 831          * We also do a simple sub-sort using the first character
 832          * of the filename in the top 5-bits.
 833          */
 834         key = 0;
 835
 836         /*
 837          * m32
 838          */
 839         crcx = 0;
 840         for (i = j = 0; i < len; ++i) {
 841                 if (aname[i] == '.' ||
 842                     aname[i] == '-' ||
 843                     aname[i] == '_' ||
 844                     aname[i] == '~') {
 845                         if (i != j)
 846                                 crcx += hammer2_icrc32(aname + j, i - j);
 847                         j = i + 1;
 848                 }
 849         }
 850         if (i != j)
 851                 crcx += hammer2_icrc32(aname + j, i - j);
 852
 853         /*
 854          * The directory hash utilizes the top 32 bits of the 64-bit key.
 855          * Bit 63 must be set to 1.
 856          */
 857         crcx |= 0x80000000U;
 858         key |= (uint64_t)crcx << 32;
 859
 860         /*
 861          * l16 - crc of entire filename
 862          *
 863          * This crc reduces degenerate hash collision conditions
 864          */
 865         crcx = hammer2_icrc32(aname, len);
 866         crcx = crcx ^ (crcx << 16);
 867         key |= crcx & 0xFFFF0000U;
 868
 869         /*
 870          * Set bit 15.  This allows readdir to strip bit 63 so a positive
 871          * 64-bit cookie/offset can always be returned, and still guarantee
 872          * that the values 0x0000-0x7FFF are available for artificial entries.
 873          * ('.' and '..').
 874          */
 875         key |= 0x8000U;
 876
 877         return (key);
 878 }
 879
 880 static int
 881 blkrefary_cmp(const void *b1, const void *b2)
 882 {
 883         const hammer2_blockref_t *bref1 = b1;
 884         const hammer2_blockref_t *bref2 = b2;
 885         if (bref1->key < bref2->key)
 886                 return(-1);
 887         if (bref1->key > bref2->key)
 888                 return(1);
 889         return 0;
 890 }