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