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
  34 #define G_LABEL_CLASS_NAME      "LABEL"
  35
  36 #define G_LABEL_MAGIC           "GEOM::LABEL"
  37 /*
  38  * Version history:
  39  * 1 - Initial version number.
  40  * 2 - Added md_provsize field to metadata.
  41  */
  42 #define G_LABEL_VERSION         2
  43 #define G_LABEL_DIR             "label"
  44
  45 #ifdef _KERNEL
  46 extern u_int g_label_debug;
  47
  48 #define G_LABEL_DEBUG(lvl, ...) do {                                    \
  49         if (g_label_debug >= (lvl)) {                                   \
  50                 printf("GEOM_LABEL");                                   \
  51                 if (g_label_debug > 0)                                  \
  52                         printf("[%u]", lvl);                            \
  53                 printf(": ");                                           \
  54                 printf(__VA_ARGS__);                                    \
  55                 printf("\n");                                           \
  56         }                                                               \
  57 } while (0)
  58
  59 typedef void g_label_taste_t (struct g_consumer *cp, char *label, size_t size);
  60
  61 struct g_label_desc {
  62         g_label_taste_t *ld_taste;
  63         char            *ld_dir;
  64 };
  65
  66 /* Supported labels. */
  67 extern const struct g_label_desc g_label_ufs_id;
  68 extern const struct g_label_desc g_label_ufs_volume;
  69 extern const struct g_label_desc g_label_iso9660;
  70 extern const struct g_label_desc g_label_msdosfs;
  71 extern const struct g_label_desc g_label_ext2fs;
  72 extern const struct g_label_desc g_label_reiserfs;
  73 extern const struct g_label_desc g_label_ntfs;
  74 #endif  /* _KERNEL */
  75
  76 struct g_label_metadata {
  77         char            md_magic[16];   /* Magic value. */
  78         uint32_t        md_version;     /* Version number. */
  79         char            md_label[16];   /* Label. */
  80         uint64_t        md_provsize;    /* Provider's size. */
  81 };
  82 static __inline void
  83 label_metadata_encode(const struct g_label_metadata *md, u_char *data)
  84 {
  85
  86         bcopy(md->md_magic, data, sizeof(md->md_magic));
  87         le32enc(data + 16, md->md_version);
  88         bcopy(md->md_label, data + 20, sizeof(md->md_label));
  89         le64enc(data + 36, md->md_provsize);
  90 }
  91 static __inline void
  92 label_metadata_decode(const u_char *data, struct g_label_metadata *md)
  93 {
  94
  95         bcopy(data, md->md_magic, sizeof(md->md_magic));
  96         md->md_version = le32dec(data + 16);
  97         bcopy(data + 20, md->md_label, sizeof(md->md_label));
  98         md->md_provsize = le64dec(data + 36);
  99 }
 100 #endif  /* _G_LABEL_H_ */