file_cmds/mtree/misc.c

   1 /*-
   2  * Copyright (c) 1991, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #if 0
  31 #ifndef lint
  32 static char sccsid[] = "@(#)misc.c      8.1 (Berkeley) 6/6/93";
  33 #endif /*not lint */
  34 #endif
  35 #include <sys/cdefs.h>
  36 #include <errno.h>
  37 __FBSDID("$FreeBSD: src/usr.sbin/mtree/misc.c,v 1.16 2005/03/29 11:44:17 tobez Exp $");
  38
  39 #include <sys/types.h>
  40 #include <sys/stat.h>
  41 #include <err.h>
  42 #include <fts.h>
  43 #include <stdint.h>
  44 #include <stdio.h>
  45 #include <unistd.h>
  46 #include "metrics.h"
  47 #include "mtree.h"
  48 #include "extern.h"
  49 #import <sys/attr.h>
  50 #include <vis.h>
  51
  52 typedef struct _key {
  53         const char *name;                       /* key name */
  54         u_int val;                      /* value */
  55
  56 #define NEEDVALUE       0x01
  57         u_int flags;
  58 } KEY;
  59
  60 /* NB: the following table must be sorted lexically. */
  61 static KEY keylist[] = {
  62         {"acldigest",           F_ACL,          NEEDVALUE},
  63         {"atime",               F_ATIME,        NEEDVALUE},
  64         {"btime",               F_BTIME,        NEEDVALUE},
  65         {"cksum",               F_CKSUM,        NEEDVALUE},
  66         {"ctime",               F_CTIME,        NEEDVALUE},
  67         {"flags",               F_FLAGS,        NEEDVALUE},
  68         {"gid",                 F_GID,          NEEDVALUE},
  69         {"gname",               F_GNAME,        NEEDVALUE},
  70         {"ignore",              F_IGN,          0},
  71         {"inode",               F_INODE,        NEEDVALUE},
  72         {"link",                F_SLINK,        NEEDVALUE},
  73 #ifdef ENABLE_MD5
  74         {"md5digest",           F_MD5,          NEEDVALUE},
  75 #endif
  76         {"mode",                F_MODE,         NEEDVALUE},
  77         {"nlink",               F_NLINK,        NEEDVALUE},
  78         {"nochange",            F_NOCHANGE,     0},
  79         {"ptime",               F_PTIME,        NEEDVALUE},
  80 #ifdef ENABLE_RMD160
  81         {"ripemd160digest",     F_RMD160,       NEEDVALUE},
  82 #endif
  83 #ifdef ENABLE_SHA1
  84         {"sha1digest",          F_SHA1,         NEEDVALUE},
  85 #endif
  86 #ifdef ENABLE_SHA256
  87         {"sha256digest",        F_SHA256,       NEEDVALUE},
  88 #endif
  89         {"siblingid",           F_SIBLINGID,    NEEDVALUE},
  90         {"size",                F_SIZE,         NEEDVALUE},
  91         {"time",                F_TIME,         NEEDVALUE},
  92         {"type",                F_TYPE,         NEEDVALUE},
  93         {"uid",                 F_UID,          NEEDVALUE},
  94         {"uname",               F_UNAME,        NEEDVALUE},
  95         {"xattrsdigest",        F_XATTRS,       NEEDVALUE},
  96 };
  97
  98 int keycompare(const void *, const void *);
  99
 100 u_int
 101 parsekey(char *name, int *needvaluep)
 102 {
 103         KEY *k, tmp;
 104
 105         tmp.name = name;
 106         k = (KEY *)bsearch(&tmp, keylist, sizeof(keylist) / sizeof(KEY),
 107             sizeof(KEY), keycompare);
 108         if (k == NULL) {
 109                 RECORD_FAILURE(107, EINVAL);
 110                 errx(1, "line %d: unknown keyword %s", lineno, name);
 111         }
 112
 113         if (needvaluep)
 114                 *needvaluep = k->flags & NEEDVALUE ? 1 : 0;
 115         return (k->val);
 116 }
 117
 118 int
 119 keycompare(const void *a, const void *b)
 120 {
 121         return (strcmp(((const KEY *)a)->name, ((const KEY *)b)->name));
 122 }
 123
 124 char *
 125 flags_to_string(u_long fflags)
 126 {
 127         int error = 0;
 128         char *string;
 129
 130         string = fflagstostr(fflags);
 131         if (string != NULL && *string == '\0') {
 132                 free(string);
 133                 string = strdup("none");
 134         }
 135         if (string == NULL) {
 136                 error = errno;
 137                 RECORD_FAILURE(108, error);
 138                 errc(1, error, NULL);
 139         }
 140
 141         return string;
 142 }
 143
 144 // escape path and always return a new string so it can be freed
 145 char *
 146 escape_path(char *string)
 147 {
 148         char *escapedPath = calloc(1, strlen(string) * 4  +  1);
 149         if (escapedPath == NULL) {
 150                 RECORD_FAILURE(109, ENOMEM);
 151                 errx(1, "escape_path(): calloc() failed");
 152         }
 153         strvis(escapedPath, string, VIS_NL | VIS_CSTYLE | VIS_OCTAL);
 154
 155         return escapedPath;
 156 }
 157
 158 struct ptimebuf {
 159         uint32_t length;
 160         attribute_set_t returned_attrs;
 161         struct timespec st_ptimespec;
 162 } __attribute__((aligned(4), packed));
 163
 164 // ptime is not supported on root filesystems or HFS filesystems older than the feature being introduced
 165 struct timespec
 166 ptime(char *path, int *supported) {
 167
 168         int error = 0;
 169         int ret = 0;
 170         struct ptimebuf buf;
 171         struct attrlist list = {
 172                 .bitmapcount = ATTR_BIT_MAP_COUNT,
 173                 .commonattr = ATTR_CMN_RETURNED_ATTRS | ATTR_CMN_ADDEDTIME,
 174         };
 175         ret = getattrlist(path, &list, &buf, sizeof(buf), FSOPT_NOFOLLOW);
 176         if (ret) {
 177                 error = errno;
 178                 RECORD_FAILURE(110, error);
 179                 errc(1, error, "ptime: getattrlist");
 180         }
 181
 182         *supported = 0;
 183         if (buf.returned_attrs.commonattr & ATTR_CMN_ADDEDTIME) {
 184                 *supported = 1;
 185         }
 186
 187         return buf.st_ptimespec;
 188
 189 }