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