1168404Spjd/* 2185029Spjd * CDDL HEADER SART 3168404Spjd * 4168404Spjd * The contents of this file are subject to the terms of the 5168404Spjd * Common Development and Distribution License (the "License"). 6168404Spjd * You may not use this file except in compliance with the License. 7168404Spjd * 8168404Spjd * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9168404Spjd * or http://www.opensolaris.org/os/licensing. 10168404Spjd * See the License for the specific language governing permissions 11168404Spjd * and limitations under the License. 12168404Spjd * 13168404Spjd * When distributing Covered Code, include this CDDL HEADER in each 14168404Spjd * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15168404Spjd * If applicable, add the following below this CDDL HEADER, with the 16168404Spjd * fields enclosed by brackets "[]" replaced with your own identifying 17168404Spjd * information: Portions Copyright [yyyy] [name of copyright owner] 18168404Spjd * 19168404Spjd * CDDL HEADER END 20168404Spjd */ 21168404Spjd 22168404Spjd/* 23219089Spjd * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 24226706Spjd * Copyright (c) 2011 Pawel Jakub Dawidek <pawel@dawidek.net>. 25226706Spjd * All rights reserved. 26263407Sdelphij * Copyright (c) 2013 by Delphix. All rights reserved. 27247540Smm * Copyright (c) 2013 Martin Matuska <mm@FreeBSD.org>. All rights reserved. 28168404Spjd */ 29168404Spjd 30248571Smm#ifndef _LIBZFS_IMPL_H 31248571Smm#define _LIBZFS_IMPL_H 32168404Spjd 33168404Spjd#include <sys/dmu.h> 34168404Spjd#include <sys/fs/zfs.h> 35168404Spjd#include <sys/zfs_ioctl.h> 36185029Spjd#include <sys/spa.h> 37168404Spjd#include <sys/nvpair.h> 38168404Spjd 39185029Spjd#include <libshare.h> 40168404Spjd#include <libuutil.h> 41168404Spjd#include <libzfs.h> 42248571Smm#include <libzfs_core.h> 43248571Smm#include <libzfs_compat.h> 44168404Spjd 45168404Spjd#ifdef __cplusplus 46168404Spjdextern "C" { 47168404Spjd#endif 48168404Spjd 49185029Spjd#ifdef VERIFY 50185029Spjd#undef VERIFY 51185029Spjd#endif 52185029Spjd#define VERIFY verify 53185029Spjd 54219089Spjdtypedef struct libzfs_fru { 55219089Spjd char *zf_device; 56219089Spjd char *zf_fru; 57219089Spjd struct libzfs_fru *zf_chain; 58219089Spjd struct libzfs_fru *zf_next; 59219089Spjd} libzfs_fru_t; 60219089Spjd 61168404Spjdstruct libzfs_handle { 62168404Spjd int libzfs_error; 63168404Spjd int libzfs_fd; 64168404Spjd FILE *libzfs_mnttab; 65168404Spjd FILE *libzfs_sharetab; 66185029Spjd zpool_handle_t *libzfs_pool_handles; 67168404Spjd uu_avl_pool_t *libzfs_ns_avlpool; 68168404Spjd uu_avl_t *libzfs_ns_avl; 69168404Spjd uint64_t libzfs_ns_gen; 70168404Spjd int libzfs_desc_active; 71168404Spjd char libzfs_action[1024]; 72168404Spjd char libzfs_desc[1024]; 73168404Spjd int libzfs_printerr; 74219089Spjd int libzfs_storeerr; /* stuff error messages into buffer */ 75185029Spjd void *libzfs_sharehdl; /* libshare handle */ 76185029Spjd uint_t libzfs_shareflags; 77209962Smm boolean_t libzfs_mnttab_enable; 78209962Smm avl_tree_t libzfs_mnttab_cache; 79219089Spjd int libzfs_pool_iter; 80219089Spjd libzfs_fru_t **libzfs_fru_hash; 81219089Spjd libzfs_fru_t *libzfs_fru_list; 82219089Spjd char libzfs_chassis_id[256]; 83168404Spjd}; 84219089Spjd 85185029Spjd#define ZFSSHARE_MISS 0x01 /* Didn't find entry in cache */ 86168404Spjd 87168404Spjdstruct zfs_handle { 88168404Spjd libzfs_handle_t *zfs_hdl; 89185029Spjd zpool_handle_t *zpool_hdl; 90168404Spjd char zfs_name[ZFS_MAXNAMELEN]; 91168404Spjd zfs_type_t zfs_type; /* type including snapshot */ 92168404Spjd zfs_type_t zfs_head_type; /* type excluding snapshot */ 93168404Spjd dmu_objset_stats_t zfs_dmustats; 94168404Spjd nvlist_t *zfs_props; 95168404Spjd nvlist_t *zfs_user_props; 96219089Spjd nvlist_t *zfs_recvd_props; 97168404Spjd boolean_t zfs_mntcheck; 98168404Spjd char *zfs_mntopts; 99205198Sdelphij uint8_t *zfs_props_table; 100168404Spjd}; 101168404Spjd 102168404Spjd/* 103168404Spjd * This is different from checking zfs_type, because it will also catch 104168404Spjd * snapshots of volumes. 105168404Spjd */ 106168404Spjd#define ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME) 107168404Spjd 108168404Spjdstruct zpool_handle { 109168404Spjd libzfs_handle_t *zpool_hdl; 110185029Spjd zpool_handle_t *zpool_next; 111168404Spjd char zpool_name[ZPOOL_MAXNAMELEN]; 112168404Spjd int zpool_state; 113168404Spjd size_t zpool_config_size; 114168404Spjd nvlist_t *zpool_config; 115168404Spjd nvlist_t *zpool_old_config; 116168404Spjd nvlist_t *zpool_props; 117185029Spjd diskaddr_t zpool_start_block; 118168404Spjd}; 119168404Spjd 120228103Smmtypedef enum { 121185029Spjd PROTO_NFS = 0, 122185029Spjd PROTO_SMB = 1, 123185029Spjd PROTO_END = 2 124185029Spjd} zfs_share_proto_t; 125185029Spjd 126185029Spjd/* 127185029Spjd * The following can be used as a bitmask and any new values 128185029Spjd * added must preserve that capability. 129185029Spjd */ 130185029Spjdtypedef enum { 131185029Spjd SHARED_NOT_SHARED = 0x0, 132185029Spjd SHARED_NFS = 0x2, 133185029Spjd SHARED_SMB = 0x4 134185029Spjd} zfs_share_type_t; 135185029Spjd 136168404Spjdint zfs_error(libzfs_handle_t *, int, const char *); 137168404Spjdint zfs_error_fmt(libzfs_handle_t *, int, const char *, ...); 138168404Spjdvoid zfs_error_aux(libzfs_handle_t *, const char *, ...); 139168404Spjdvoid *zfs_alloc(libzfs_handle_t *, size_t); 140168404Spjdvoid *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t); 141219089Spjdchar *zfs_asprintf(libzfs_handle_t *, const char *, ...); 142168404Spjdchar *zfs_strdup(libzfs_handle_t *, const char *); 143168404Spjdint no_memory(libzfs_handle_t *); 144168404Spjd 145168404Spjdint zfs_standard_error(libzfs_handle_t *, int, const char *); 146168404Spjdint zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...); 147168404Spjdint zpool_standard_error(libzfs_handle_t *, int, const char *); 148168404Spjdint zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...); 149168404Spjd 150168404Spjdint get_dependents(libzfs_handle_t *, boolean_t, const char *, char ***, 151168404Spjd size_t *); 152228103Smmzfs_handle_t *make_dataset_handle_zc(libzfs_handle_t *, zfs_cmd_t *); 153230438Spjdzfs_handle_t *make_dataset_simple_handle_zc(zfs_handle_t *, zfs_cmd_t *); 154168404Spjd 155185029Spjdint zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t, 156185029Spjd nvlist_t *, char **, uint64_t *, const char *); 157185029Spjdint zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, 158185029Spjd zfs_type_t type); 159168404Spjd 160185029Spjd/* 161185029Spjd * Use this changelist_gather() flag to force attempting mounts 162185029Spjd * on each change node regardless of whether or not it is currently 163185029Spjd * mounted. 164185029Spjd */ 165226676Spjd#define CL_GATHER_MOUNT_ALWAYS 0x01 166226676Spjd/* 167226705Spjd * Use this changelist_gather() flag to prevent unmounting of file systems. 168226676Spjd */ 169226705Spjd#define CL_GATHER_DONT_UNMOUNT 0x02 170185029Spjd 171168404Spjdtypedef struct prop_changelist prop_changelist_t; 172168404Spjd 173168404Spjdint zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t); 174185029Spjdint zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *); 175185029Spjdint zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *); 176168404Spjdint zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *); 177168404Spjdint zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **); 178168404Spjdvoid zcmd_free_nvlists(zfs_cmd_t *); 179168404Spjd 180168404Spjdint changelist_prefix(prop_changelist_t *); 181168404Spjdint changelist_postfix(prop_changelist_t *); 182168404Spjdvoid changelist_rename(prop_changelist_t *, const char *, const char *); 183185029Spjdvoid changelist_remove(prop_changelist_t *, const char *); 184168404Spjdvoid changelist_free(prop_changelist_t *); 185185029Spjdprop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int, int); 186185029Spjdint changelist_unshare(prop_changelist_t *, zfs_share_proto_t *); 187168404Spjdint changelist_haszonedchild(prop_changelist_t *); 188168404Spjd 189168404Spjdvoid remove_mountpoint(zfs_handle_t *); 190185029Spjdint create_parents(libzfs_handle_t *, char *, int); 191185029Spjdboolean_t isa_child_of(const char *dataset, const char *parent); 192168404Spjd 193168404Spjdzfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *); 194263407Sdelphijzfs_handle_t *make_bookmark_handle(zfs_handle_t *, const char *, 195263407Sdelphij nvlist_t *props); 196168404Spjd 197168404Spjdint zpool_open_silent(libzfs_handle_t *, const char *, zpool_handle_t **); 198168404Spjd 199185029Spjdboolean_t zpool_name_valid(libzfs_handle_t *, boolean_t, const char *); 200168404Spjd 201219089Spjdint zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type, 202219089Spjd boolean_t modifying); 203219089Spjd 204168404Spjdvoid namespace_clear(libzfs_handle_t *); 205168404Spjd 206185029Spjd/* 207185029Spjd * libshare (sharemgr) interfaces used internally. 208185029Spjd */ 209185029Spjd 210185029Spjdextern int zfs_init_libshare(libzfs_handle_t *, int); 211185029Spjdextern void zfs_uninit_libshare(libzfs_handle_t *); 212185029Spjdextern int zfs_parse_options(char *, zfs_share_proto_t); 213185029Spjd 214209962Smmextern int zfs_unshare_proto(zfs_handle_t *, 215185029Spjd const char *, zfs_share_proto_t *); 216185029Spjd 217219089Spjdextern void libzfs_fru_clear(libzfs_handle_t *, boolean_t); 218185029Spjd 219168404Spjd#ifdef __cplusplus 220168404Spjd} 221168404Spjd#endif 222168404Spjd 223248571Smm#endif /* _LIBZFS_IMPL_H */ 224