usr/src/lib/libbe/common/libbe_priv.h

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