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