metadata.c revision 85720
1158559Snyan/*- 2158559Snyan * Copyright (c) 1998 Michael Smith <msmith@freebsd.org> 3158559Snyan * All rights reserved. 4158559Snyan * 5158559Snyan * Redistribution and use in source and binary forms, with or without 6158559Snyan * modification, are permitted provided that the following conditions 7158559Snyan * are met: 8158559Snyan * 1. Redistributions of source code must retain the above copyright 9158559Snyan * notice, this list of conditions and the following disclaimer. 10158559Snyan * 2. Redistributions in binary form must reproduce the above copyright 11158559Snyan * notice, this list of conditions and the following disclaimer in the 12158559Snyan * documentation and/or other materials provided with the distribution. 13158559Snyan * 14158559Snyan * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15158559Snyan * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16158559Snyan * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17158559Snyan * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18158559Snyan * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19158559Snyan * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20158559Snyan * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21158559Snyan * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22158559Snyan * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23158559Snyan * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24158559Snyan * SUCH DAMAGE. 25158559Snyan * 26158559Snyan * from: FreeBSD: src/sys/boot/i386/libi386/bootinfo.c,v 1.29 27158559Snyan * $FreeBSD: head/sys/boot/sparc64/loader/metadata.c 85720 2001-10-30 06:37:36Z jake $ 28158559Snyan */ 29158559Snyan 30158559Snyan#include <stand.h> 31158559Snyan#include <sys/param.h> 32158559Snyan#include <sys/reboot.h> 33158559Snyan#include <sys/linker.h> 34158559Snyan 35158559Snyan#include "bootstrap.h" 36158559Snyan#include "libofw.h" 37158559Snyan 38158559Snyan/* 39158559Snyan * Return a 'boothowto' value corresponding to the kernel arguments in 40158559Snyan * (kargs) and any relevant environment variables. 41158559Snyan */ 42158559Snyanstatic struct 43158559Snyan{ 44158559Snyan const char *ev; 45158559Snyan int mask; 46158559Snyan} howto_names[] = { 47158559Snyan {"boot_askname", RB_ASKNAME}, 48158559Snyan {"boot_cdrom", RB_CDROM}, 49158559Snyan {"boot_userconfig", RB_CONFIG}, 50158559Snyan {"boot_ddb", RB_KDB}, 51158559Snyan {"boot_gdb", RB_GDB}, 52158559Snyan {"boot_single", RB_SINGLE}, 53158559Snyan {"boot_verbose", RB_VERBOSE}, 54158559Snyan {NULL, 0} 55158559Snyan}; 56158559Snyan 57158559Snyanint 58158559Snyanmd_getboothowto(char *kargs) 59158559Snyan{ 60158559Snyan char *cp; 61158559Snyan int howto; 62158559Snyan int active; 63158559Snyan int i; 64158559Snyan 65158559Snyan /* Parse kargs */ 66158559Snyan howto = 0; 67158559Snyan if (kargs != NULL) { 68158559Snyan cp = kargs; 69158559Snyan active = 0; 70158559Snyan while (*cp != 0) { 71158559Snyan if (!active && (*cp == '-')) { 72158559Snyan active = 1; 73158559Snyan } else if (active) 74158559Snyan switch (*cp) { 75158559Snyan case 'a': 76158559Snyan howto |= RB_ASKNAME; 77158559Snyan break; 78158559Snyan case 'c': 79158559Snyan howto |= RB_CONFIG; 80158559Snyan break; 81158559Snyan case 'C': 82158559Snyan howto |= RB_CDROM; 83158559Snyan break; 84158559Snyan case 'd': 85158559Snyan howto |= RB_KDB; 86158559Snyan break; 87158559Snyan case 'D': 88158559Snyan howto |= RB_MULTIPLE; 89158559Snyan break; 90158559Snyan case 'm': 91158559Snyan howto |= RB_MUTE; 92158559Snyan break; 93158559Snyan case 'g': 94158559Snyan howto |= RB_GDB; 95158559Snyan break; 96158559Snyan case 'h': 97158559Snyan howto |= RB_SERIAL; 98158559Snyan break; 99158559Snyan case 'r': 100158559Snyan howto |= RB_DFLTROOT; 101158559Snyan break; 102158559Snyan case 's': 103158559Snyan howto |= RB_SINGLE; 104158559Snyan break; 105158559Snyan case 'v': 106158559Snyan howto |= RB_VERBOSE; 107158559Snyan break; 108158559Snyan default: 109158559Snyan active = 0; 110158559Snyan break; 111158559Snyan } 112158559Snyan cp++; 113158559Snyan } 114158559Snyan } 115158559Snyan /* get equivalents from the environment */ 116158559Snyan for (i = 0; howto_names[i].ev != NULL; i++) 117158559Snyan if (getenv(howto_names[i].ev) != NULL) 118158559Snyan howto |= howto_names[i].mask; 119158559Snyan if (!strcmp(getenv("console"), "comconsole")) 120158559Snyan howto |= RB_SERIAL; 121158559Snyan if (!strcmp(getenv("console"), "nullconsole")) 122158559Snyan howto |= RB_MUTE; 123158559Snyan return(howto); 124158559Snyan} 125158559Snyan 126158559Snyan/* 127158559Snyan * Copy the environment into the load area starting at (addr). 128158559Snyan * Each variable is formatted as <name>=<value>, with a single nul 129158559Snyan * separating each variable, and a double nul terminating the environment. 130158559Snyan */ 131158559Snyanvm_offset_t 132158559Snyanmd_copyenv(vm_offset_t addr) 133158559Snyan{ 134158559Snyan struct env_var *ep; 135158559Snyan 136158559Snyan /* traverse the environment */ 137158559Snyan for (ep = environ; ep != NULL; ep = ep->ev_next) { 138158559Snyan archsw.arch_copyin(ep->ev_name, addr, strlen(ep->ev_name)); 139158559Snyan addr += strlen(ep->ev_name); 140158559Snyan archsw.arch_copyin("=", addr, 1); 141158559Snyan addr++; 142158559Snyan if (ep->ev_value != NULL) { 143158559Snyan archsw.arch_copyin(ep->ev_value, addr, strlen(ep->ev_value)); 144158559Snyan addr += strlen(ep->ev_value); 145158559Snyan } 146158559Snyan archsw.arch_copyin("", addr, 1); 147158559Snyan addr++; 148158559Snyan } 149158559Snyan archsw.arch_copyin("", addr, 1); 150158559Snyan addr++; 151158559Snyan return(addr); 152158559Snyan} 153158559Snyan 154158559Snyan/* 155158559Snyan * Copy module-related data into the load area, where it can be 156158559Snyan * used as a directory for loaded modules. 157158559Snyan * 158158559Snyan * Module data is presented in a self-describing format. Each datum 159158559Snyan * is preceded by a 32-bit identifier and a 32-bit size field. 160158559Snyan * 161158559Snyan * Currently, the following data are saved: 162158559Snyan * 163158559Snyan * MOD_NAME (variable) module name (string) 164158559Snyan * MOD_TYPE (variable) module type (string) 165158559Snyan * MOD_ARGS (variable) module parameters (string) 166158559Snyan * MOD_ADDR sizeof(vm_offset_t) module load address 167158559Snyan * MOD_SIZE sizeof(size_t) module size 168158559Snyan * MOD_METADATA (variable) type-specific metadata 169158559Snyan */ 170158559Snyan#define COPY32(v, a, c) { \ 171158559Snyan u_int32_t x = (v); \ 172158559Snyan if (c) \ 173158559Snyan archsw.arch_copyin(&x, a, sizeof(x)); \ 174158559Snyan a += sizeof(x); \ 175158559Snyan} 176158559Snyan 177158559Snyan#define MOD_STR(t, a, s, c) { \ 178158559Snyan COPY32(t, a, c); \ 179158559Snyan COPY32(strlen(s) + 1, a, c) \ 180158559Snyan if (c) \ 181158559Snyan archsw.arch_copyin(s, a, strlen(s) + 1);\ 182158559Snyan a += roundup(strlen(s) + 1, sizeof(u_long));\ 183158559Snyan} 184158559Snyan 185158559Snyan#define MOD_NAME(a, s, c) MOD_STR(MODINFO_NAME, a, s, c) 186158559Snyan#define MOD_TYPE(a, s, c) MOD_STR(MODINFO_TYPE, a, s, c) 187158559Snyan#define MOD_ARGS(a, s, c) MOD_STR(MODINFO_ARGS, a, s, c) 188158559Snyan 189158559Snyan#define MOD_VAR(t, a, s, c) { \ 190158559Snyan COPY32(t, a, c); \ 191158559Snyan COPY32(sizeof(s), a, c); \ 192158559Snyan if (c) \ 193158559Snyan archsw.arch_copyin(&s, a, sizeof(s)); \ 194158559Snyan a += roundup(sizeof(s), sizeof(u_long)); \ 195158559Snyan} 196158559Snyan 197158559Snyan#define MOD_ADDR(a, s, c) MOD_VAR(MODINFO_ADDR, a, s, c) 198158559Snyan#define MOD_SIZE(a, s, c) MOD_VAR(MODINFO_SIZE, a, s, c) 199158559Snyan 200158559Snyan#define MOD_METADATA(a, mm, c) { \ 201158559Snyan COPY32(MODINFO_METADATA | mm->md_type, a, c);\ 202158559Snyan COPY32(mm->md_size, a, c); \ 203158559Snyan if (c) \ 204158559Snyan archsw.arch_copyin(mm->md_data, a, mm->md_size);\ 205158559Snyan a += roundup(mm->md_size, sizeof(u_long)); \ 206158559Snyan} 207158559Snyan 208158559Snyan#define MOD_END(a, c) { \ 209158559Snyan COPY32(MODINFO_END, a, c); \ 210158559Snyan COPY32(0, a, c); \ 211158559Snyan} 212158559Snyan 213158559Snyanvm_offset_t 214158559Snyanmd_copymodules(vm_offset_t addr) 215158559Snyan{ 216158559Snyan struct preloaded_file *fp; 217158559Snyan struct file_metadata *md; 218158559Snyan int c; 219158559Snyan 220158559Snyan c = addr != 0; 221158559Snyan /* start with the first module on the list, should be the kernel */ 222158559Snyan for (fp = file_findfile(NULL, NULL); fp != NULL; fp = fp->f_next) { 223158559Snyan 224158559Snyan MOD_NAME(addr, fp->f_name, c); /* this field must come first */ 225158559Snyan MOD_TYPE(addr, fp->f_type, c); 226158559Snyan if (fp->f_args) 227158559Snyan MOD_ARGS(addr, fp->f_args, c); 228158559Snyan MOD_ADDR(addr, fp->f_addr, c); 229158559Snyan MOD_SIZE(addr, fp->f_size, c); 230158559Snyan for (md = fp->f_metadata; md != NULL; md = md->md_next) { 231158559Snyan if (!(md->md_type & MODINFOMD_NOCOPY)) { 232158559Snyan MOD_METADATA(addr, md, c); 233158559Snyan } 234158559Snyan } 235158559Snyan } 236158559Snyan MOD_END(addr, c); 237158559Snyan return(addr); 238158559Snyan} 239158559Snyan 240158559Snyan/* 241158559Snyan * Load the information expected by a sparc64 kernel. 242158559Snyan * 243158559Snyan * - The 'boothowto' argument is constructed 244158559Snyan * - The 'bootdev' argument is constructed 245158559Snyan * - The kernel environment is copied into kernel space. 246158559Snyan * - Module metadata are formatted and placed in kernel space. 247158559Snyan */ 248158559Snyanint 249158559Snyanmd_load(char *args, vm_offset_t *modulep) 250158559Snyan{ 251158559Snyan struct preloaded_file *kfp; 252158559Snyan struct preloaded_file *xp; 253158559Snyan struct file_metadata *md; 254158559Snyan struct ofw_devdesc *rootdev; 255158559Snyan vm_offset_t kernend; 256158559Snyan vm_offset_t addr; 257158559Snyan vm_offset_t envp; 258158559Snyan vm_offset_t size; 259158559Snyan char *rootdevname; 260158559Snyan int howto; 261158559Snyan 262158559Snyan howto = md_getboothowto(args); 263158559Snyan 264158559Snyan /* 265158559Snyan * Allow the environment variable 'rootdev' to override the supplied device 266158559Snyan * This should perhaps go to MI code and/or have $rootdev tested/set by 267158559Snyan * MI code before launching the kernel. 268158559Snyan */ 269158559Snyan rootdevname = getenv("rootdev"); 270158559Snyan ofw_getdev((void **)(&rootdev), rootdevname, NULL); 271158559Snyan if (rootdev == NULL) { /* bad $rootdev/$currdev */ 272158559Snyan printf("can't determine root device\n"); 273158559Snyan return(EINVAL); 274158559Snyan } 275158559Snyan 276158559Snyan /* Try reading the /etc/fstab file to select the root device */ 277158559Snyan getrootmount(ofw_fmtdev((void *)rootdev)); 278158559Snyan 279158559Snyan free(rootdev); 280158559Snyan 281158559Snyan /* find the last module in the chain */ 282158559Snyan addr = 0; 283158559Snyan for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) { 284158559Snyan if (addr < (xp->f_addr + xp->f_size)) 285158559Snyan addr = xp->f_addr + xp->f_size; 286158559Snyan } 287158559Snyan /* pad to a page boundary */ 288158559Snyan addr = roundup(addr, PAGE_SIZE); 289158559Snyan 290158559Snyan /* copy our environment */ 291158559Snyan envp = addr; 292158559Snyan addr = md_copyenv(addr); 293158559Snyan 294158559Snyan /* pad to a page boundary */ 295158559Snyan addr = roundup(addr, PAGE_SIZE); 296158559Snyan 297158559Snyan kernend = 0; 298158559Snyan kfp = file_findfile(NULL, "elf kernel"); 299158559Snyan if (kfp == NULL) 300158559Snyan panic("can't find kernel file"); 301158559Snyan file_addmetadata(kfp, MODINFOMD_HOWTO, sizeof howto, &howto); 302158559Snyan file_addmetadata(kfp, MODINFOMD_ENVP, sizeof envp, &envp); 303158559Snyan file_addmetadata(kfp, MODINFOMD_KERNEND, sizeof kernend, &kernend); 304158559Snyan 305158559Snyan *modulep = addr; 306158559Snyan size = md_copymodules(0); 307158559Snyan kernend = roundup(addr + size, PAGE_SIZE); 308158559Snyan 309158559Snyan md = file_findmetadata(kfp, MODINFOMD_KERNEND); 310158559Snyan bcopy(&kernend, md->md_data, sizeof kernend); 311158559Snyan 312158559Snyan (void)md_copymodules(addr); 313158559Snyan 314158559Snyan return(0); 315158559Snyan} 316158559Snyan