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 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _BOOTADM_H 27 #define _BOOTADM_H 28 29 #ifdef __cplusplus 30 extern "C" { 31 #endif 32 33 #include <assert.h> 34 35 #ifndef TEXT_DOMAIN 36 #define TEXT_DOMAIN "SUNW_OST_OSCMD" 37 #endif /* TEXT_DOMAIN */ 38 39 /* Type definitions */ 40 41 /* GRUB menu per-line classification */ 42 typedef enum { 43 BAM_INVALID = 0, 44 BAM_EMPTY, 45 BAM_COMMENT, 46 BAM_GLOBAL, 47 BAM_ENTRY, 48 BAM_TITLE 49 } menu_flag_t; 50 51 /* struct for menu.lst contents */ 52 typedef struct line { 53 int lineNum; /* Line number in menu.lst */ 54 int entryNum; /* menu boot entry #. ENTRY_INIT if not applicable */ 55 char *cmd; 56 char *sep; 57 char *arg; 58 char *line; 59 menu_flag_t flags; 60 struct line *next; 61 struct line *prev; 62 } line_t; 63 64 typedef struct entry { 65 struct entry *next; 66 struct entry *prev; 67 line_t *start; 68 line_t *end; 69 int entryNum; 70 uint_t flags; 71 } entry_t; 72 73 /* For flags value in entry_t */ 74 #define BAM_ENTRY_BOOTADM 0x01 /* entry created by bootadm */ 75 #define BAM_ENTRY_LU 0x02 /* entry created by Live Upgrade */ 76 #define BAM_ENTRY_CHAINLOADER 0x04 /* chainloader entry; do not disturb */ 77 #define BAM_ENTRY_ROOT 0x08 /* entry has a root line */ 78 #define BAM_ENTRY_FAILSAFE 0x10 /* failsafe entry */ 79 #define BAM_ENTRY_DBOOT 0x20 /* Is dboot (normal or failsafe) */ 80 #define BAM_ENTRY_32BIT 0x40 /* Is a 32-bit entry */ 81 #define BAM_ENTRY_HV 0x80 /* Is a hypervisor entry */ 82 #define BAM_ENTRY_FINDROOT 0x100 /* entry has a findroot line */ 83 #define BAM_ENTRY_MULTIBOOT 0x200 /* is multiboot (normal or failsafe) */ 84 #define BAM_ENTRY_64BIT 0x400 /* Is a 64-bit entry */ 85 86 #define BAM_ENTRY_UPGFSKERNEL 0x800 /* Upgrade failsafe kernel entry */ 87 #define BAM_ENTRY_UPGFSMODULE 0x1000 /* Upgrade failsafe module entry */ 88 89 typedef struct { 90 line_t *start; 91 line_t *end; 92 line_t *curdefault; /* line containing default */ 93 line_t *olddefault; /* old default line (commented) */ 94 line_t *old_rc_default; /* old default line for bootenv.rc */ 95 entry_t *entries; /* os entries */ 96 } menu_t; 97 98 typedef enum { 99 BAM_ERROR = -1, /* Must be negative. add_boot_entry() depends on it */ 100 BAM_SUCCESS = 0, 101 BAM_WRITE = 2, 102 BAM_MSG, /* Used by upgrade_menu() */ 103 BAM_NOCHANGE /* Used by cvt_to_hyper()/cvt_to_metal() */ 104 } error_t; 105 106 /* 107 * Menu related 108 * menu_cmd_t and menu_cmds must be kept in sync 109 * 110 * The *_DOLLAR_CMD values must be 1 greater than the 111 * respective [KERNEL|MODULE]_CMD values. 112 */ 113 typedef enum { 114 DEFAULT_CMD = 0, 115 TIMEOUT_CMD, 116 TITLE_CMD, 117 ROOT_CMD, 118 KERNEL_CMD, 119 KERNEL_DOLLAR_CMD, /* Must be KERNEL_CMD + 1 */ 120 MODULE_CMD, 121 MODULE_DOLLAR_CMD, /* Must be MODULE_CMD + 1 */ 122 SEP_CMD, 123 COMMENT_CMD, 124 CHAINLOADER_CMD, 125 ARGS_CMD, 126 FINDROOT_CMD, 127 BOOTFS_CMD 128 } menu_cmd_t; 129 130 extern char *menu_cmds[]; 131 132 /* For multi- or direct-boot */ 133 typedef enum { 134 BAM_DIRECT_NOT_SET, 135 BAM_DIRECT_MULTIBOOT, 136 BAM_DIRECT_DBOOT 137 } direct_or_multi_t; 138 139 /* Is there a hypervisor present? */ 140 typedef enum { 141 BAM_HV_UNKNOWN, 142 BAM_HV_NO, 143 BAM_HV_PRESENT 144 } hv_t; 145 146 /* Is there findroot capability present ? */ 147 typedef enum { 148 BAM_FINDROOT_UNKNOWN, 149 BAM_FINDROOT_ABSENT, 150 BAM_FINDROOT_PRESENT 151 } findroot_t; 152 153 extern int bam_verbose; 154 extern int bam_force; 155 extern direct_or_multi_t bam_direct; 156 extern hv_t bam_is_hv; 157 extern findroot_t bam_is_findroot; 158 extern int bam_debug; 159 160 extern void bam_add_line(menu_t *mp, entry_t *entry, line_t *prev, line_t *lp); 161 extern void update_numbering(menu_t *mp); 162 extern error_t set_global(menu_t *, char *, int); 163 extern error_t upgrade_menu(menu_t *, char *, char *); 164 extern error_t cvt_to_hyper(menu_t *, char *, char *); 165 extern error_t cvt_to_metal(menu_t *, char *, char *); 166 extern void *s_calloc(size_t, size_t); 167 extern void *s_realloc(void *, size_t); 168 extern char *s_fgets(char *buf, int n, FILE *fp); 169 extern void bam_error(char *format, ...); 170 extern void bam_print(char *, ...); 171 extern void bam_print_stderr(char *format, ...); 172 extern void bam_derror(char *format, ...); 173 extern error_t get_boot_cap(const char *osroot); 174 extern char *get_special(char *); 175 extern char *os_to_grubdisk(char *, int); 176 extern void update_line(line_t *); 177 extern int add_boot_entry(menu_t *, char *, char *, char *, char *, char *, 178 char *); 179 extern error_t delete_boot_entry(menu_t *, int, int); 180 extern int is_grub(const char *); 181 extern char *get_grubsign(char *osroot, char *osdev); 182 extern char *get_grubroot(char *osroot, char *osdev, char *menu_root); 183 extern int root_optional(char *osroot, char *menu_root); 184 extern void unlink_line(menu_t *mp, line_t *lp); 185 extern void line_free(line_t *lp); 186 extern char *s_strdup(char *); 187 extern int is_sparc(void); 188 189 #define BAM_MAXLINE 8192 190 191 /* menu.lst comments created by bootadm */ 192 #define BAM_BOOTADM_HDR "---------- ADDED BY BOOTADM - DO NOT EDIT ----------" 193 #define BAM_BOOTADM_FTR "---------------------END BOOTADM--------------------" 194 195 /* 196 * menu.lst comments create by Live Upgrade. Note that these are the end of 197 * the comment strings - there will be other text before them. 198 */ 199 #define BAM_LU_HDR " - ADDED BY LIVE UPGRADE - DO NOT EDIT -----" 200 #define BAM_LU_FTR " -------------- END LIVE UPGRADE ------------" 201 202 #define BAM_OLDDEF "BOOTADM SAVED DEFAULT: " 203 #define BAM_OLD_RC_DEF "BOOTADM RC SAVED DEFAULT: " 204 205 /* Title used for failsafe entries */ 206 #define FAILSAFE_TITLE "Solaris failsafe" 207 208 /* Title used for hv entries */ 209 #define NEW_HV_ENTRY "Solaris xVM" 210 211 /* ZFS boot option */ 212 #define ZFS_BOOT "-B $ZFS-BOOTFS" 213 214 /* multiboot */ 215 #define MULTI_BOOT "/platform/i86pc/multiboot" 216 #define MULTI_BOOT_FAILSAFE "/boot/multiboot" 217 #define MULTI_BOOT_FAILSAFE_UNIX "kernel/unix" 218 #define MULTI_BOOT_FAILSAFE_LINE "/boot/multiboot kernel/unix -s" 219 220 /* directboot kernels */ 221 #define DIRECT_BOOT_32 "/platform/i86pc/kernel/unix" 222 #define DIRECT_BOOT_64 "/platform/i86pc/kernel/amd64/unix" 223 #define DIRECT_BOOT_KERNEL "/platform/i86pc/kernel/$ISADIR/unix" 224 #define DIRECT_BOOT_FAILSAFE_32 "/boot/platform/i86pc/kernel/unix" 225 #define DIRECT_BOOT_FAILSAFE_64 "/boot/platform/i86pc/kernel/amd64/unix" 226 #define DIRECT_BOOT_FAILSAFE_KERNEL \ 227 "/boot/platform/i86pc/kernel/$ISADIR/unix" 228 #define DIRECT_BOOT_FAILSAFE_LINE DIRECT_BOOT_FAILSAFE_KERNEL " -s" 229 #define DIRECT_BOOT_KERNEL_ZFS DIRECT_BOOT_KERNEL " " ZFS_BOOT 230 #define DIRECT_BOOT_PREFIX "/platform/i86pc/" 231 #define KERNEL_PREFIX "/platform/i86pc/" 232 #define AMD_UNIX_SPACE "/amd64/unix " 233 #define UNIX_SPACE "/unix " 234 235 /* xVM kernels */ 236 #define XEN_KERNEL_SUBSTR "xen.gz" 237 238 /* Boot archives */ 239 #define ARCHIVE_PREFIX "/platform/" 240 #define ARCHIVE_SUFFIX "/boot_archive" 241 #define CACHEDIR_SUFFIX "/archive_cache" 242 #define UPDATEDIR_SUFFIX "/updates" 243 #define DIRECT_BOOT_ARCHIVE "/platform/i86pc/$ISADIR/boot_archive" 244 #define DIRECT_BOOT_ARCHIVE_32 "/platform/i86pc/boot_archive" 245 #define DIRECT_BOOT_ARCHIVE_64 "/platform/i86pc/amd64/boot_archive" 246 #define MULTIBOOT_ARCHIVE DIRECT_BOOT_ARCHIVE_32 247 #define FAILSAFE_ARCHIVE "/boot/$ISADIR/x86.miniroot-safe" 248 #define FAILSAFE_ARCHIVE_32 "/boot/x86.miniroot-safe" 249 #define FAILSAFE_ARCHIVE_64 "/boot/amd64/x86.miniroot-safe" 250 #define CACHEDIR_32 "/platform/i86pc/archive_cache" 251 #define CACHEDIR_64 "/platform/i86pc/amd64/archive_cache" 252 #define UPDATEDIR_32 "/platform/i86pc/updates" 253 #define UPDATEDIR_64 "/platform/i86pc/amd64/updates" 254 255 /* Hypervisors */ 256 #define XEN_64 "/boot/amd64/xen.gz" 257 #define XEN_MENU "/boot/$ISADIR/xen.gz" 258 #define HYPERVISOR_KERNEL "/platform/i86xpv/kernel/$ISADIR/unix" 259 #define XEN_KERNEL_MODULE_LINE HYPERVISOR_KERNEL " " HYPERVISOR_KERNEL 260 #define XEN_KERNEL_MODULE_LINE_ZFS \ 261 HYPERVISOR_KERNEL " " HYPERVISOR_KERNEL " " ZFS_BOOT 262 263 /* Helpers */ 264 #define MKISOFS_PATH "/usr/bin/mkisofs" 265 #define DD_PATH_USR "/usr/bin/dd" 266 #define LOCKFS_PATH "/usr/sbin/lockfs" 267 268 /* A first guess at the number of entries in a menu */ 269 #define BAM_ENTRY_NUM 10 270 271 /* toggle for whether delete_boot_entry prints an error message or not */ 272 #define DBE_PRINTERR 0 273 #define DBE_QUIET 1 274 275 /* 276 * Debugging defines 277 */ 278 #define INJECT_ERROR1(x, y) \ 279 { \ 280 if (bam_debug) { \ 281 char *inj = getenv("_BOOTADM_INJECT"); \ 282 if (inj && strcmp(inj, (x)) == 0) { \ 283 y; \ 284 } \ 285 } \ 286 } 287 288 #define INJECT_ERROR2(x, y, z) \ 289 { \ 290 if (bam_debug) { \ 291 char *inj = getenv("_BOOTADM_INJECT"); \ 292 if (inj && strcmp(inj, (x)) == 0) { \ 293 y; \ 294 z; \ 295 } \ 296 } \ 297 } 298 299 #define BAM_DPRINTF(x) {if (bam_debug) bam_derror x; } 300 301 #ifdef __cplusplus 302 } 303 #endif 304 305 #endif /* _BOOTADM_H */ 306