sys/boot/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 #ifndef _BOOT_LIBZFS_H_
  30 #define _BOOT_LIBZFS_H_
  31
  32 #define ZFS_MAXNAMELEN  256
  33
  34 /*
  35  * ZFS fully-qualified device descriptor.
  36  * Note, this must match the 'struct devdesc' declaration in bootstrap.h.
  37  * Arch-specific device descriptors should be binary compatible with this
  38  * structure if they are to support ZFS.
  39  */
  40 struct zfs_devdesc
  41 {
  42     struct devsw        *d_dev;
  43     int                 d_type;
  44     int                 d_unit;
  45     void                *d_opendata;
  46     uint64_t            pool_guid;
  47     uint64_t            root_guid;
  48 };
  49
  50 #ifdef LOADER_GELI_SUPPORT
  51 #include <crypto/intake.h>
  52 #endif
  53
  54 struct zfs_boot_args
  55 {
  56     uint32_t            size;
  57     uint32_t            reserved;
  58     uint64_t            pool;
  59     uint64_t            root;
  60     uint64_t            primary_pool;
  61     uint64_t            primary_vdev;
  62     union {
  63         char            gelipw[256];
  64         struct {
  65             char                notapw; /*
  66                                          * single null byte to stop keybuf
  67                                          * being interpreted as a password
  68                                          */
  69             uint32_t            keybuf_sentinel;
  70 #ifdef LOADER_GELI_SUPPORT
  71             struct keybuf       *keybuf;
  72 #else
  73             void                *keybuf;
  74 #endif
  75         };
  76     };
  77 };
  78
  79 int     zfs_parsedev(struct zfs_devdesc *dev, const char *devspec,
  80                      const char **path);
  81 char    *zfs_fmtdev(void *vdev);
  82 int     zfs_probe_dev(const char *devname, uint64_t *pool_guid);
  83 int     zfs_list(const char *name);
  84 void    init_zfs_bootenv(char *currdev);
  85 int     zfs_bootenv(const char *name);
  86 int     zfs_belist_add(const char *name, uint64_t __unused);
  87 int     zfs_set_env(void);
  88
  89 extern struct devsw zfs_dev;
  90 extern struct fs_ops zfs_fsops;
  91
  92 #endif /*_BOOT_LIBZFS_H_*/