sys/geom/label/g_label.h

   1 /*-
   2  * Copyright (c) 2004-2005 Pawel Jakub Dawidek <pjd@FreeBSD.org>
   3  * 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  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _G_LABEL_H_
  30 #define _G_LABEL_H_
  31
  32 #include <sys/endian.h>
  33 #ifdef _KERNEL
  34 #include <sys/sysctl.h>
  35 #endif
  36
  37 #define G_LABEL_CLASS_NAME      "LABEL"
  38
  39 #define G_LABEL_MAGIC           "GEOM::LABEL"
  40 /*
  41  * Version history:
  42  * 1 - Initial version number.
  43  * 2 - Added md_provsize field to metadata.
  44  */
  45 #define G_LABEL_VERSION         2
  46 #define G_LABEL_DIR             "label"
  47
  48 #ifdef _KERNEL
  49 extern u_int g_label_debug;
  50
  51 #define G_LABEL_DEBUG(lvl, ...) do {                                    \
  52         if (g_label_debug >= (lvl)) {                                   \
  53                 printf("GEOM_LABEL");                                   \
  54                 if (g_label_debug > 0)                                  \
  55                         printf("[%u]", lvl);                            \
  56                 printf(": ");                                           \
  57                 printf(__VA_ARGS__);                                    \
  58                 printf("\n");                                           \
  59         }                                                               \
  60 } while (0)
  61
  62 SYSCTL_DECL(_kern_geom_label);
  63
  64 #define G_LABEL_INIT(kind, label, descr)                                \
  65         SYSCTL_NODE(_kern_geom_label, OID_AUTO, kind, CTLFLAG_RD,       \
  66             NULL, "");                                                  \
  67         SYSCTL_INT(_kern_geom_label_##kind, OID_AUTO, enable,           \
  68             CTLFLAG_RW, &label.ld_enabled, 1, descr);                   \
  69         TUNABLE_INT("kern.geom.label." __XSTRING(kind) ".enable",       \
  70             &label.ld_enabled)
  71
  72 typedef void g_label_taste_t (struct g_consumer *cp, char *label, size_t size);
  73
  74 struct g_label_desc {
  75         g_label_taste_t *ld_taste;
  76         char            *ld_dir;
  77         int              ld_enabled;
  78 };
  79
  80 /* Supported labels. */
  81 extern struct g_label_desc g_label_ufs_id;
  82 extern struct g_label_desc g_label_ufs_volume;
  83 extern struct g_label_desc g_label_iso9660;
  84 extern struct g_label_desc g_label_msdosfs;
  85 extern struct g_label_desc g_label_ext2fs;
  86 extern struct g_label_desc g_label_reiserfs;
  87 extern struct g_label_desc g_label_ntfs;
  88 extern struct g_label_desc g_label_gpt;
  89 extern struct g_label_desc g_label_gpt_uuid;
  90 #endif  /* _KERNEL */
  91
  92 struct g_label_metadata {
  93         char            md_magic[16];   /* Magic value. */
  94         uint32_t        md_version;     /* Version number. */
  95         char            md_label[16];   /* Label. */
  96         uint64_t        md_provsize;    /* Provider's size. */
  97 };
  98 static __inline void
  99 label_metadata_encode(const struct g_label_metadata *md, u_char *data)
 100 {
 101
 102         bcopy(md->md_magic, data, sizeof(md->md_magic));
 103         le32enc(data + 16, md->md_version);
 104         bcopy(md->md_label, data + 20, sizeof(md->md_label));
 105         le64enc(data + 36, md->md_provsize);
 106 }
 107 static __inline void
 108 label_metadata_decode(const u_char *data, struct g_label_metadata *md)
 109 {
 110
 111         bcopy(data, md->md_magic, sizeof(md->md_magic));
 112         md->md_version = le32dec(data + 16);
 113         bcopy(data + 20, md->md_label, sizeof(md->md_label));
 114         md->md_provsize = le64dec(data + 36);
 115 }
 116 #endif  /* _G_LABEL_H_ */