stand/libsa/zfs/libzfs.h

   1 /*-
   2  * Copyright (c) 2012 Andriy Gapon <avg@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 AUTHOR 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 AUTHOR 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 #include <zfsimpl.h>
  30
  31 #ifdef LOADER_GELI_SUPPORT
  32 #include <crypto/intake.h>
  33 #endif
  34
  35 #ifndef _BOOT_LIBZFS_H_
  36 #define _BOOT_LIBZFS_H_
  37
  38 #define ZFS_MAXNAMELEN  256
  39
  40 /*
  41  * ZFS fully-qualified device descriptor.
  42  */
  43 struct zfs_devdesc {
  44         struct devdesc  dd;             /* Must be first. */
  45         uint64_t        pool_guid;
  46         uint64_t        root_guid;
  47 };
  48
  49 /* nvp implementation version */
  50 #define NV_VERSION              0
  51
  52 /* nvlist persistent unique name flags, stored in nvl_nvflags */
  53 #define NV_UNIQUE_NAME          0x1
  54 #define NV_UNIQUE_NAME_TYPE     0x2
  55
  56 #define NV_ALIGN4(x)            (((x) + 3) & ~3)
  57
  58 /*
  59  * nvlist header.
  60  * nvlist has 4 bytes header followed by version and flags, then nvpairs
  61  * and the list is terminated by double zero.
  62  */
  63 typedef struct {
  64         char nvh_encoding;
  65         char nvh_endian;
  66         char nvh_reserved1;
  67         char nvh_reserved2;
  68 } nvs_header_t;
  69
  70 typedef struct {
  71         nvs_header_t nv_header;
  72         size_t nv_asize;
  73         size_t nv_size;
  74         uint8_t *nv_data;
  75         uint8_t *nv_idx;
  76 } nvlist_t;
  77
  78 /*
  79  * nvpair header.
  80  * nvpair has encoded and decoded size
  81  * name string (size and data)
  82  * data type and number of elements
  83  * data
  84  */
  85 typedef struct {
  86         unsigned encoded_size;
  87         unsigned decoded_size;
  88 } nvp_header_t;
  89
  90 /*
  91  * nvlist stream head.
  92  */
  93 typedef struct {
  94         unsigned nvl_version;
  95         unsigned nvl_nvflag;
  96         nvp_header_t nvl_pair;
  97 } nvs_data_t;
  98
  99 typedef struct {
 100         unsigned nv_size;
 101         uint8_t nv_data[];      /* NV_ALIGN4(string) */
 102 } nv_string_t;
 103
 104 typedef struct {
 105         unsigned nv_type;       /* data_type_t */
 106         unsigned nv_nelem;      /* number of elements */
 107         uint8_t nv_data[];      /* data stream */
 108 } nv_pair_data_t;
 109
 110 nvlist_t *nvlist_create(int);
 111 void nvlist_destroy(nvlist_t *);
 112 nvlist_t *nvlist_import(const uint8_t *, char, char);
 113 int nvlist_remove(nvlist_t *, const char *, data_type_t);
 114 void nvlist_print(nvlist_t *, unsigned int);
 115 int nvlist_find(const nvlist_t *, const char *, data_type_t,
 116     int *, void *, int *);
 117 int nvlist_next(nvlist_t *);
 118
 119 int     zfs_parsedev(struct zfs_devdesc *dev, const char *devspec,
 120                      const char **path);
 121 char    *zfs_fmtdev(void *vdev);
 122 int     zfs_nextboot(void *vdev, char *buf, size_t size);
 123 int     zfs_probe_dev(const char *devname, uint64_t *pool_guid);
 124 int     zfs_list(const char *name);
 125 uint64_t ldi_get_size(void *);
 126 void    init_zfs_bootenv(const char *currdev);
 127 int     zfs_bootenv(const char *name);
 128 int     zfs_belist_add(const char *name, uint64_t __unused);
 129 int     zfs_set_env(void);
 130
 131 extern struct devsw zfs_dev;
 132 extern struct fs_ops zfs_fsops;
 133
 134 #endif /*_BOOT_LIBZFS_H_*/