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 * Copyright 2013 Nexenta Systems, Inc. All rights reserved. 25 * Copyright 2015 Toomas Soome <tsoome@me.com> 26 * Copyright (c) 2015 by Delphix. All rights reserved. 27 */ 28 29 #ifndef _LIBBE_PRIV_H 30 #define _LIBBE_PRIV_H 31 32 #include <libnvpair.h> 33 #include <libzfs.h> 34 #include <instzones_api.h> 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 #define ARCH_LENGTH MAXNAMELEN 41 #define BE_AUTO_NAME_MAX_TRY 3 42 #define BE_AUTO_NAME_DELIM '-' 43 #define BE_DEFAULTS "/etc/default/be" 44 #define BE_DFLT_BENAME_STARTS "BENAME_STARTS_WITH=" 45 #define BE_CONTAINER_DS_NAME "ROOT" 46 #define BE_DEFAULT_CONSOLE "text" 47 #define BE_POLICY_PROPERTY "org.opensolaris.libbe:policy" 48 #define BE_UUID_PROPERTY "org.opensolaris.libbe:uuid" 49 #define BE_PLCY_STATIC "static" 50 #define BE_PLCY_VOLATILE "volatile" 51 #define BE_GRUB_MENU "/boot/grub/menu.lst" 52 #define BE_SPARC_MENU "/boot/menu.lst" 53 #define BE_GRUB_COMMENT "#============ End of LIBBE entry =============" 54 #define BE_GRUB_SPLASH "splashimage /boot/solaris.xpm" 55 #define BE_GRUB_FOREGROUND "foreground 343434" 56 #define BE_GRUB_BACKGROUND "background F7FBFF" 57 #define BE_GRUB_DEFAULT "default 0" 58 #define BE_WHITE_SPACE " \t\r\n" 59 #define BE_CAP_FILE "/boot/grub/capability" 60 #define BE_INSTALL_GRUB "/sbin/installgrub" 61 #define BE_GRUB_STAGE_1 "/boot/grub/stage1" 62 #define BE_GRUB_STAGE_2 "/boot/grub/stage2" 63 #define BE_INSTALL_BOOT "/usr/sbin/installboot" 64 #define BE_SPARC_BOOTBLK "/lib/fs/zfs/bootblk" 65 66 #define ZFS_CLOSE(_zhp) \ 67 if (_zhp) { \ 68 zfs_close(_zhp); \ 69 _zhp = NULL; \ 70 } 71 72 #define BE_ZONE_PARENTBE_PROPERTY "org.opensolaris.libbe:parentbe" 73 #define BE_ZONE_ACTIVE_PROPERTY "org.opensolaris.libbe:active" 74 #define BE_ZONE_SUPPORTED_BRANDS "ipkg labeled" 75 #define BE_ZONE_SUPPORTED_BRANDS_DELIM " " 76 77 /* Maximum length for the BE name. */ 78 #define BE_NAME_MAX_LEN 64 79 80 #define MAX(a, b) ((a) > (b) ? (a) : (b)) 81 #define MIN(a, b) ((a) < (b) ? (a) : (b)) 82 83 typedef struct be_transaction_data { 84 char *obe_name; /* Original BE name */ 85 char *obe_root_ds; /* Original BE root dataset */ 86 char *obe_zpool; /* Original BE pool */ 87 char *obe_snap_name; /* Original BE snapshot name */ 88 char *obe_altroot; /* Original BE altroot */ 89 char *nbe_name; /* New BE name */ 90 char *nbe_root_ds; /* New BE root dataset */ 91 char *nbe_zpool; /* New BE pool */ 92 char *nbe_desc; /* New BE description */ 93 nvlist_t *nbe_zfs_props; /* New BE dataset properties */ 94 char *policy; /* BE policy type */ 95 } be_transaction_data_t; 96 97 typedef struct be_mount_data { 98 char *altroot; /* Location of where to mount BE */ 99 boolean_t shared_fs; /* Mount shared file sytsems */ 100 boolean_t shared_rw; /* Mount shared file systems rw */ 101 } be_mount_data_t; 102 103 typedef struct be_unmount_data { 104 char *altroot; /* Location of where BE is mounted */ 105 boolean_t force; /* Forcibly unmount */ 106 } be_unmount_data_t; 107 108 typedef struct be_destroy_data { 109 boolean_t destroy_snaps; /* Destroy snapshots of BE */ 110 boolean_t force_unmount; /* Forcibly unmount BE if mounted */ 111 uuid_t gz_be_uuid; /* UUID of the global zone BE */ 112 } be_destroy_data_t; 113 114 typedef struct be_demote_data { 115 zfs_handle_t *clone_zhp; /* clone dataset to promote */ 116 time_t origin_creation; /* snapshot creation time of clone */ 117 const char *snapshot; /* snapshot of dataset being demoted */ 118 boolean_t find_in_BE; /* flag noting to find clone in BE */ 119 } be_demote_data_t; 120 121 typedef struct be_fs_list_data { 122 char *altroot; 123 char **fs_list; 124 int fs_num; 125 } be_fs_list_data_t; 126 127 typedef struct be_plcy_list { 128 char *be_plcy_name; 129 int be_num_max; 130 int be_num_min; 131 time_t be_age_max; 132 int be_usage_pcnt; 133 struct be_plcy_list *be_next_plcy; 134 }be_plcy_list_t; 135 136 struct be_defaults { 137 boolean_t be_deflt_rpool_container; 138 char be_deflt_bename_starts_with[ZFS_MAX_DATASET_NAME_LEN]; 139 }; 140 141 /* Library globals */ 142 extern libzfs_handle_t *g_zfs; 143 extern boolean_t do_print; 144 145 /* be_create.c */ 146 int be_set_uuid(char *); 147 int be_get_uuid(const char *, uuid_t *); 148 149 /* be_list.c */ 150 int _be_list(char *, be_node_list_t **); 151 int be_get_zone_be_list(char *, char *, be_node_list_t **); 152 153 /* be_mount.c */ 154 int _be_mount(char *, char **, int); 155 int _be_unmount(char *, int); 156 int be_mount_pool(zfs_handle_t *, char **, char **, boolean_t *); 157 int be_unmount_pool(zfs_handle_t *, char *, char *); 158 int be_mount_zone_root(zfs_handle_t *, be_mount_data_t *); 159 int be_unmount_zone_root(zfs_handle_t *, be_unmount_data_t *); 160 int be_get_legacy_fs(char *, char *, char *, char *, be_fs_list_data_t *); 161 void be_free_fs_list(be_fs_list_data_t *); 162 char *be_get_ds_from_dir(char *); 163 int be_make_tmp_mountpoint(char **); 164 165 /* be_snapshot.c */ 166 int _be_create_snapshot(char *, char **, char *); 167 int _be_destroy_snapshot(char *, char *); 168 169 /* be_utils.c */ 170 boolean_t be_zfs_init(void); 171 void be_zfs_fini(void); 172 void be_make_root_ds(const char *, const char *, char *, int); 173 void be_make_container_ds(const char *, char *, int); 174 char *be_make_name_from_ds(const char *, char *); 175 int be_append_menu(char *, char *, char *, char *, char *); 176 int be_remove_menu(char *, char *, char *); 177 int be_update_menu(char *, char *, char *, char *); 178 int be_default_grub_bootfs(const char *, char **); 179 boolean_t be_has_menu_entry(char *, char *, int *); 180 int be_run_cmd(char *, char *, int, char *, int); 181 int be_change_grub_default(char *, char *); 182 int be_update_vfstab(char *, char *, char *, be_fs_list_data_t *, char *); 183 int be_update_zone_vfstab(zfs_handle_t *, char *, char *, char *, 184 be_fs_list_data_t *); 185 int be_maxsize_avail(zfs_handle_t *, uint64_t *); 186 char *be_auto_snap_name(void); 187 char *be_auto_be_name(char *); 188 char *be_auto_zone_be_name(char *, char *); 189 char *be_default_policy(void); 190 boolean_t valid_be_policy(char *); 191 boolean_t be_valid_auto_snap_name(char *); 192 boolean_t be_valid_be_name(const char *); 193 void be_print_err(char *, ...); 194 int be_find_current_be(be_transaction_data_t *); 195 int zfs_err_to_be_err(libzfs_handle_t *); 196 int errno_to_be_err(int); 197 198 /* be_activate.c */ 199 int _be_activate(char *); 200 int be_activate_current_be(void); 201 boolean_t be_is_active_on_boot(char *); 202 203 /* be_zones.c */ 204 void be_make_zoneroot(char *, char *, int); 205 int be_find_active_zone_root(zfs_handle_t *, char *, char *, int); 206 int be_find_mounted_zone_root(char *, char *, char *, int); 207 boolean_t be_zone_supported(char *); 208 zoneBrandList_t *be_get_supported_brandlist(void); 209 int be_zone_get_parent_uuid(const char *, uuid_t *); 210 int be_zone_set_parent_uuid(char *, uuid_t); 211 boolean_t be_zone_compare_uuids(char *); 212 213 /* check architecture functions */ 214 char *be_get_default_isa(void); 215 char *be_get_platform(void); 216 boolean_t be_is_isa(char *); 217 boolean_t be_has_grub(void); 218 219 /* callback functions */ 220 int be_exists_callback(zpool_handle_t *, void *); 221 int be_find_zpool_callback(zpool_handle_t *, void *); 222 int be_zpool_find_current_be_callback(zpool_handle_t *, void *); 223 int be_zfs_find_current_be_callback(zfs_handle_t *, void *); 224 int be_check_be_roots_callback(zpool_handle_t *, void *); 225 226 /* defaults */ 227 void be_get_defaults(struct be_defaults *defaults); 228 229 #ifdef __cplusplus 230 } 231 #endif 232 233 #endif /* _LIBBE_PRIV_H */ 234