1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved. 24 */ 25 26 /* 27 * Copyright 2013 Nexenta Systems, Inc. All rights reserved. 28 */ 29 30 #ifndef _LIBBE_H 31 #define _LIBBE_H 32 33 #include <libnvpair.h> 34 #include <uuid/uuid.h> 35 #include <libzfs.h> 36 37 #ifdef __cplusplus 38 extern "C" { 39 #endif 40 41 #define BE_ATTR_ORIG_BE_NAME "orig_be_name" 42 #define BE_ATTR_ORIG_BE_POOL "orig_be_pool" 43 #define BE_ATTR_SNAP_NAME "snap_name" 44 45 #define BE_ATTR_NEW_BE_NAME "new_be_name" 46 #define BE_ATTR_NEW_BE_POOL "new_be_pool" 47 #define BE_ATTR_NEW_BE_DESC "new_be_desc" 48 #define BE_ATTR_POLICY "policy" 49 #define BE_ATTR_ZFS_PROPERTIES "zfs_properties" 50 51 #define BE_ATTR_FS_NAMES "fs_names" 52 #define BE_ATTR_FS_NUM "fs_num" 53 #define BE_ATTR_SHARED_FS_NAMES "shared_fs_names" 54 #define BE_ATTR_SHARED_FS_NUM "shared_fs_num" 55 56 #define BE_ATTR_MOUNTPOINT "mountpoint" 57 #define BE_ATTR_MOUNT_FLAGS "mount_flags" 58 #define BE_ATTR_UNMOUNT_FLAGS "unmount_flags" 59 #define BE_ATTR_DESTROY_FLAGS "destroy_flags" 60 #define BE_ATTR_ROOT_DS "root_ds" 61 #define BE_ATTR_UUID_STR "uuid_str" 62 63 #define BE_ATTR_ACTIVE "active" 64 #define BE_ATTR_ACTIVE_ON_BOOT "active_boot" 65 #define BE_ATTR_GLOBAL_ACTIVE "global_active" 66 #define BE_ATTR_SPACE "space_used" 67 #define BE_ATTR_DATASET "dataset" 68 #define BE_ATTR_STATUS "status" 69 #define BE_ATTR_DATE "date" 70 #define BE_ATTR_MOUNTED "mounted" 71 72 /* 73 * libbe error codes 74 * 75 * NOTE: there is a copy of this enum in beadm/messages.py. To keep these 76 * in sync please make sure to add any new error messages at the end 77 * of this enumeration. 78 */ 79 enum { 80 BE_SUCCESS = 0, 81 BE_ERR_ACCESS = 4000, /* permission denied */ 82 BE_ERR_ACTIVATE_CURR, /* Activation of current BE failed */ 83 BE_ERR_AUTONAME, /* auto naming failed */ 84 BE_ERR_BE_NOENT, /* No such BE */ 85 BE_ERR_BUSY, /* mount busy */ 86 BE_ERR_CANCELED, /* operation canceled */ 87 BE_ERR_CLONE, /* BE clone failed */ 88 BE_ERR_COPY, /* BE copy failed */ 89 BE_ERR_CREATDS, /* dataset creation failed */ 90 BE_ERR_CURR_BE_NOT_FOUND, /* Can't find current BE */ 91 BE_ERR_DESTROY, /* failed to destroy BE or snapshot */ 92 BE_ERR_DEMOTE, /* BE demotion failed */ 93 BE_ERR_DSTYPE, /* invalid dataset type */ 94 BE_ERR_BE_EXISTS, /* BE exists */ 95 BE_ERR_INIT, /* be_zfs_init failed */ 96 BE_ERR_INTR, /* interupted system call */ 97 BE_ERR_INVAL, /* invalid argument */ 98 BE_ERR_INVALPROP, /* invalid property for dataset */ 99 BE_ERR_INVALMOUNTPOINT, /* Unexpected mountpoint */ 100 BE_ERR_MOUNT, /* mount failed */ 101 BE_ERR_MOUNTED, /* already mounted */ 102 BE_ERR_NAMETOOLONG, /* name > BUFSIZ */ 103 BE_ERR_NOENT, /* Doesn't exist */ 104 BE_ERR_POOL_NOENT, /* No such pool */ 105 BE_ERR_NODEV, /* No such device */ 106 BE_ERR_NOTMOUNTED, /* File system not mounted */ 107 BE_ERR_NOMEM, /* not enough memory */ 108 BE_ERR_NONINHERIT, /* property is not inheritable for BE dataset */ 109 BE_ERR_NXIO, /* No such device or address */ 110 BE_ERR_NOSPC, /* No space on device */ 111 BE_ERR_NOTSUP, /* Operation not supported */ 112 BE_ERR_OPEN, /* open failed */ 113 BE_ERR_PERM, /* Not owner */ 114 BE_ERR_UNAVAIL, /* The BE is currently unavailable */ 115 BE_ERR_PROMOTE, /* BE promotion failed */ 116 BE_ERR_ROFS, /* read only file system */ 117 BE_ERR_READONLYDS, /* read only dataset */ 118 BE_ERR_READONLYPROP, /* read only property */ 119 BE_ERR_SS_EXISTS, /* snapshot exists */ 120 BE_ERR_SS_NOENT, /* No such snapshot */ 121 BE_ERR_UMOUNT, /* unmount failed */ 122 BE_ERR_UMOUNT_CURR_BE, /* Can't unmount current BE */ 123 BE_ERR_UMOUNT_SHARED, /* unmount of shared File System failed */ 124 BE_ERR_UNKNOWN, /* Unknown error */ 125 BE_ERR_ZFS, /* ZFS returned an error */ 126 BE_ERR_DESTROY_CURR_BE, /* Cannot destroy current BE */ 127 BE_ERR_GEN_UUID, /* Failed to generate uuid */ 128 BE_ERR_PARSE_UUID, /* Failed to parse uuid */ 129 BE_ERR_NO_UUID, /* BE has no uuid */ 130 BE_ERR_ZONE_NO_PARENTBE, /* Zone root dataset has no parent uuid */ 131 BE_ERR_ZONE_MULTIPLE_ACTIVE, /* Zone has multiple active roots */ 132 BE_ERR_ZONE_NO_ACTIVE_ROOT, /* Zone has no active root for this BE */ 133 BE_ERR_ZONE_ROOT_NOT_LEGACY, /* Zone root dataset mntpt is not legacy */ 134 BE_ERR_NO_MOUNTED_ZONE, /* Zone not mounted in alternate BE */ 135 BE_ERR_MOUNT_ZONEROOT, /* Failed to mount a zone root */ 136 BE_ERR_UMOUNT_ZONEROOT, /* Failed to unmount a zone root */ 137 BE_ERR_ZONES_UNMOUNT, /* Unable to unmount a zone. */ 138 BE_ERR_FAULT, /* Bad Address */ 139 BE_ERR_RENAME_ACTIVE, /* Renaming the active BE is not supported */ 140 BE_ERR_NO_MENU, /* Missing boot menu file */ 141 BE_ERR_DEV_BUSY, /* Device is Busy */ 142 BE_ERR_BAD_MENU_PATH, /* Invalid path for menu.lst file */ 143 BE_ERR_ZONE_SS_EXISTS, /* zone snapshot already exists */ 144 BE_ERR_ADD_SPLASH_ICT, /* Add_splash_image ICT failed */ 145 BE_ERR_BOOTFILE_INST, /* Error installing boot files */ 146 BE_ERR_EXTCMD /* External command error */ 147 } be_errno_t; 148 149 /* 150 * Data structures used to return the listing and information of BEs. 151 */ 152 typedef struct be_dataset_list { 153 uint64_t be_ds_space_used; 154 boolean_t be_ds_mounted; 155 char *be_dataset_name; 156 time_t be_ds_creation; /* Date/time stamp when created */ 157 char *be_ds_mntpt; 158 char *be_ds_plcy_type; /* cleanup policy type */ 159 struct be_dataset_list *be_next_dataset; 160 } be_dataset_list_t; 161 162 typedef struct be_snapshot_list { 163 uint64_t be_snapshot_space_used; /* bytes of disk space used */ 164 char *be_snapshot_name; 165 time_t be_snapshot_creation; /* Date/time stamp when created */ 166 char *be_snapshot_type; /* cleanup policy type */ 167 struct be_snapshot_list *be_next_snapshot; 168 } be_snapshot_list_t; 169 170 typedef struct be_node_list { 171 boolean_t be_mounted; /* is BE currently mounted */ 172 boolean_t be_active_on_boot; /* is this BE active on boot */ 173 boolean_t be_active; /* is this BE active currently */ 174 boolean_t be_global_active; /* is zone's BE associated with */ 175 /* an active global BE */ 176 uint64_t be_space_used; 177 char *be_node_name; 178 char *be_rpool; 179 char *be_root_ds; 180 char *be_mntpt; 181 char *be_policy_type; /* cleanup policy type */ 182 char *be_uuid_str; /* string representation of uuid */ 183 time_t be_node_creation; /* Date/time stamp when created */ 184 struct be_dataset_list *be_node_datasets; 185 uint_t be_node_num_datasets; 186 struct be_snapshot_list *be_node_snapshots; 187 uint_t be_node_num_snapshots; 188 struct be_node_list *be_next_node; 189 } be_node_list_t; 190 191 /* Flags used with mounting a BE */ 192 #define BE_MOUNT_FLAG_NULL 0x00000000 193 #define BE_MOUNT_FLAG_SHARED_FS 0x00000001 194 #define BE_MOUNT_FLAG_SHARED_RW 0x00000002 195 #define BE_MOUNT_FLAG_NO_ZONES 0x00000004 196 197 /* Flags used with unmounting a BE */ 198 #define BE_UNMOUNT_FLAG_NULL 0x00000000 199 #define BE_UNMOUNT_FLAG_FORCE 0x00000001 200 201 /* Flags used with destroying a BE */ 202 #define BE_DESTROY_FLAG_NULL 0x00000000 203 #define BE_DESTROY_FLAG_SNAPSHOTS 0x00000001 204 #define BE_DESTROY_FLAG_FORCE_UNMOUNT 0x00000002 205 206 /* 207 * BE functions 208 */ 209 int be_init(nvlist_t *); 210 int be_destroy(nvlist_t *); 211 int be_copy(nvlist_t *); 212 213 int be_mount(nvlist_t *); 214 int be_unmount(nvlist_t *); 215 216 int be_rename(nvlist_t *); 217 218 int be_activate(nvlist_t *); 219 220 int be_create_snapshot(nvlist_t *); 221 int be_destroy_snapshot(nvlist_t *); 222 int be_rollback(nvlist_t *); 223 224 /* 225 * Functions for listing and getting information about existing BEs. 226 */ 227 int be_list(char *, be_node_list_t **); 228 void be_free_list(be_node_list_t *); 229 int be_max_avail(char *, uint64_t *); 230 char *be_err_to_str(int); 231 232 /* 233 * Library functions 234 */ 235 void libbe_print_errors(boolean_t); 236 237 #ifdef __cplusplus 238 } 239 #endif 240 241 #endif /* _LIBBE_H */ 242