metadata.c revision 271132
1132718Skan/*- 290075Sobrien * Copyright (c) 1998 Michael Smith <msmith@freebsd.org> 3169689Skan * Copyright (C) 2006 Semihalf, Piotr Kruszynski <ppk@semihalf.com> 4169689Skan * Copyright (C) 2007-2008 Semihalf, Rafal Jaworowski <raj@semihalf.com> 590075Sobrien * All rights reserved. 6132718Skan * 790075Sobrien * Redistribution and use in source and binary forms, with or without 8132718Skan * modification, are permitted provided that the following conditions 990075Sobrien * are met: 1090075Sobrien * 1. Redistributions of source code must retain the above copyright 1190075Sobrien * notice, this list of conditions and the following disclaimer. 1290075Sobrien * 2. Redistributions in binary form must reproduce the above copyright 13132718Skan * notice, this list of conditions and the following disclaimer in the 1490075Sobrien * documentation and/or other materials provided with the distribution. 1590075Sobrien * 1690075Sobrien * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1790075Sobrien * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1890075Sobrien * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19132718Skan * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20169689Skan * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21169689Skan * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2290075Sobrien * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2390075Sobrien * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24132718Skan * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25132718Skan * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2690075Sobrien * SUCH DAMAGE. 27132718Skan */ 28132718Skan 29132718Skan#include <sys/cdefs.h> 3090075Sobrien__FBSDID("$FreeBSD: stable/10/sys/boot/uboot/common/metadata.c 271132 2014-09-04 20:47:14Z emaste $"); 31132718Skan 32132718Skan#include <stand.h> 33132718Skan#include <sys/param.h> 34132718Skan#include <sys/reboot.h> 3590075Sobrien#include <sys/linker.h> 36132718Skan#include <sys/boot.h> 37132718Skan 3890075Sobrien#include <machine/elf.h> 3990075Sobrien#include <machine/metadata.h> 40132718Skan 4190075Sobrien#include "api_public.h" 42132718Skan#include "bootstrap.h" 43132718Skan#include "glue.h" 44132718Skan 45132718Skan#if defined(LOADER_FDT_SUPPORT) 46169689Skan#include "libuboot.h" 47132718Skan#endif 48132718Skan 49132718Skanstatic int 50132718Skanmd_getboothowto(char *kargs) 51132718Skan{ 5290075Sobrien char *cp; 53169689Skan char *p; 54169689Skan int howto; 55132718Skan int active; 5690075Sobrien int i; 57132718Skan 58132718Skan /* Parse kargs */ 59132718Skan howto = 0; 60132718Skan if (kargs != NULL) { 61132718Skan cp = kargs; 62132718Skan active = 0; 6390075Sobrien while (*cp != 0) { 64132718Skan if (!active && (*cp == '-')) 65132718Skan active = 1; 66132718Skan else if (active) 67132718Skan switch (*cp) { 6890075Sobrien case 'a': 69132718Skan howto |= RB_ASKNAME; 70132718Skan break; 7190075Sobrien case 'C': 72169689Skan howto |= RB_CDROM; 73132718Skan break; 74169689Skan case 'd': 75169689Skan howto |= RB_KDB; 76132718Skan break; 7790075Sobrien case 'D': 78132718Skan howto |= RB_MULTIPLE; 79132718Skan break; 80132718Skan case 'm': 81169689Skan howto |= RB_MUTE; 82169689Skan break; 83169689Skan case 'g': 84169689Skan howto |= RB_GDB; 85169689Skan break; 86169689Skan case 'h': 87132718Skan howto |= RB_SERIAL; 88132718Skan break; 89132718Skan case 'p': 90132718Skan howto |= RB_PAUSE; 91132718Skan break; 92169689Skan case 'r': 93169689Skan howto |= RB_DFLTROOT; 94169689Skan break; 95169689Skan case 's': 96169689Skan howto |= RB_SINGLE; 97169689Skan break; 98132718Skan case 'v': 99132718Skan howto |= RB_VERBOSE; 100132718Skan break; 101132718Skan default: 102132718Skan active = 0; 103132718Skan break; 104132718Skan } 105132718Skan cp++; 106169689Skan } 107169689Skan } 108132718Skan 109132718Skan /* get equivalents from the environment */ 110132718Skan for (i = 0; howto_names[i].ev != NULL; i++) { 111132718Skan if (getenv(howto_names[i].ev) != NULL) 112132718Skan howto |= howto_names[i].mask; 113169689Skan } 114169689Skan if ((p = getenv("console"))) { 115169689Skan if (!strcmp(p, "comconsole")) 116132718Skan howto |= RB_SERIAL; 117132718Skan if (!strcmp(p, "nullconsole")) 11890075Sobrien howto |= RB_MUTE; 119169689Skan } 120132718Skan 121132718Skan return(howto); 12290075Sobrien} 123132718Skan 12490075Sobrien/* 125132718Skan * Copy the environment into the load area starting at (addr). 126132718Skan * Each variable is formatted as <name>=<value>, with a single nul 127132718Skan * separating each variable, and a double nul terminating the environment. 128132718Skan */ 129132718Skanstatic vm_offset_t 130132718Skanmd_copyenv(vm_offset_t addr) 131132718Skan{ 13290075Sobrien struct env_var *ep; 133132718Skan 134132718Skan /* traverse the environment */ 135169689Skan for (ep = environ; ep != NULL; ep = ep->ev_next) { 136169689Skan archsw.arch_copyin(ep->ev_name, addr, strlen(ep->ev_name)); 137169689Skan addr += strlen(ep->ev_name); 138169689Skan archsw.arch_copyin("=", addr, 1); 139132718Skan addr++; 140132718Skan if (ep->ev_value != NULL) { 141132718Skan archsw.arch_copyin(ep->ev_value, addr, 142132718Skan strlen(ep->ev_value)); 143169689Skan addr += strlen(ep->ev_value); 144169689Skan } 145132718Skan archsw.arch_copyin("", addr, 1); 146169689Skan addr++; 147132718Skan } 148169689Skan archsw.arch_copyin("", addr, 1); 149169689Skan addr++; 150132718Skan return(addr); 151132718Skan} 152132718Skan 153132718Skan/* 154169689Skan * Copy module-related data into the load area, where it can be 15590075Sobrien * used as a directory for loaded modules. 156169689Skan * 15790075Sobrien * Module data is presented in a self-describing format. Each datum 158169689Skan * is preceded by a 32-bit identifier and a 32-bit size field. 159169689Skan * 16090075Sobrien * Currently, the following data are saved: 161132718Skan * 162132718Skan * MOD_NAME (variable) module name (string) 163132718Skan * MOD_TYPE (variable) module type (string) 164132718Skan * MOD_ARGS (variable) module parameters (string) 165169689Skan * MOD_ADDR sizeof(vm_offset_t) module load address 16690075Sobrien * MOD_SIZE sizeof(size_t) module size 16790075Sobrien * MOD_METADATA (variable) type-specific metadata 16890075Sobrien */ 16990075Sobrien#define COPY32(v, a, c) { \ 17090075Sobrien u_int32_t x = (v); \ 171132718Skan if (c) \ 17290075Sobrien archsw.arch_copyin(&x, a, sizeof(x)); \ 173132718Skan a += sizeof(x); \ 174132718Skan} 175132718Skan 176132718Skan#define MOD_STR(t, a, s, c) { \ 177169689Skan COPY32(t, a, c); \ 17890075Sobrien COPY32(strlen(s) + 1, a, c) \ 179132718Skan if (c) \ 180169689Skan archsw.arch_copyin(s, a, strlen(s) + 1);\ 181132718Skan a += roundup(strlen(s) + 1, sizeof(u_long));\ 18290075Sobrien} 183117395Skan 184132718Skan#define MOD_NAME(a, s, c) MOD_STR(MODINFO_NAME, a, s, c) 185169689Skan#define MOD_TYPE(a, s, c) MOD_STR(MODINFO_TYPE, a, s, c) 186117395Skan#define MOD_ARGS(a, s, c) MOD_STR(MODINFO_ARGS, a, s, c) 187169689Skan 188169689Skan#define MOD_VAR(t, a, s, c) { \ 189169689Skan COPY32(t, a, c); \ 190169689Skan COPY32(sizeof(s), a, c); \ 191169689Skan if (c) \ 192117395Skan archsw.arch_copyin(&s, a, sizeof(s)); \ 193132718Skan a += roundup(sizeof(s), sizeof(u_long)); \ 194132718Skan} 195132718Skan 196132718Skan#define MOD_ADDR(a, s, c) MOD_VAR(MODINFO_ADDR, a, s, c) 197169689Skan#define MOD_SIZE(a, s, c) MOD_VAR(MODINFO_SIZE, a, s, c) 198132718Skan 199132718Skan#define MOD_METADATA(a, mm, c) { \ 200132718Skan COPY32(MODINFO_METADATA | mm->md_type, a, c);\ 201132718Skan COPY32(mm->md_size, a, c); \ 202132718Skan if (c) \ 203132718Skan archsw.arch_copyin(mm->md_data, a, mm->md_size);\ 204169689Skan a += roundup(mm->md_size, sizeof(u_long)); \ 205169689Skan} 206169689Skan 207169689Skan#define MOD_END(a, c) { \ 208169689Skan COPY32(MODINFO_END, a, c); \ 209169689Skan COPY32(0, a, c); \ 210169689Skan} 211169689Skan 212169689Skanstatic vm_offset_t 213169689Skanmd_copymodules(vm_offset_t addr) 214169689Skan{ 215169689Skan struct preloaded_file *fp; 216169689Skan struct file_metadata *md; 217169689Skan int c; 218169689Skan vm_offset_t a; 219169689Skan 220169689Skan c = addr != 0; 221169689Skan /* start with the first module on the list, should be the kernel */ 222169689Skan for (fp = file_findfile(NULL, NULL); fp != NULL; fp = fp->f_next) { 223169689Skan 224169689Skan MOD_NAME(addr, fp->f_name, c); /* this field must be first */ 225169689Skan MOD_TYPE(addr, fp->f_type, c); 226169689Skan if (fp->f_args) 227169689Skan MOD_ARGS(addr, fp->f_args, c); 228169689Skan a = fp->f_addr - __elfN(relocation_offset); 229169689Skan MOD_ADDR(addr, a, c); 230169689Skan MOD_SIZE(addr, fp->f_size, c); 231169689Skan for (md = fp->f_metadata; md != NULL; md = md->md_next) { 232169689Skan if (!(md->md_type & MODINFOMD_NOCOPY)) 233169689Skan MOD_METADATA(addr, md, c); 234169689Skan } 235169689Skan } 236169689Skan MOD_END(addr, c); 237 return(addr); 238} 239 240/* 241 * Load the information expected by a kernel. 242 * 243 * - The 'boothowto' argument is constructed 244 * - The 'bootdev' argument is constructed 245 * - The kernel environment is copied into kernel space. 246 * - Module metadata are formatted and placed in kernel space. 247 */ 248int 249md_load(char *args, vm_offset_t *modulep) 250{ 251 struct preloaded_file *kfp, *bfp; 252 struct preloaded_file *xp; 253 struct file_metadata *md; 254 struct bootinfo *bip; 255 vm_offset_t kernend; 256 vm_offset_t addr; 257 vm_offset_t envp; 258 vm_offset_t size; 259 vm_offset_t vaddr; 260#if defined(LOADER_FDT_SUPPORT) 261 vm_offset_t dtbp; 262 int dtb_size; 263#endif 264 char *rootdevname; 265 int howto; 266 int i; 267 268 /* 269 * These metadata addreses must be converted for kernel after 270 * relocation. 271 */ 272 uint32_t mdt[] = { 273 MODINFOMD_SSYM, MODINFOMD_ESYM, MODINFOMD_KERNEND, 274 MODINFOMD_ENVP, 275#if defined(LOADER_FDT_SUPPORT) 276 MODINFOMD_DTBP 277#endif 278 }; 279 280 howto = md_getboothowto(args); 281 282 /* 283 * Allow the environment variable 'rootdev' to override the supplied 284 * device. This should perhaps go to MI code and/or have $rootdev 285 * tested/set by MI code before launching the kernel. 286 */ 287 rootdevname = getenv("rootdev"); 288 if (rootdevname == NULL) 289 rootdevname = getenv("currdev"); 290 /* Try reading the /etc/fstab file to select the root device */ 291 getrootmount(rootdevname); 292 293 /* Find the last module in the chain */ 294 addr = 0; 295 for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) { 296 if (addr < (xp->f_addr + xp->f_size)) 297 addr = xp->f_addr + xp->f_size; 298 } 299 /* Pad to a page boundary */ 300 addr = roundup(addr, PAGE_SIZE); 301 302 /* Copy our environment */ 303 envp = addr; 304 addr = md_copyenv(addr); 305 306 /* Pad to a page boundary */ 307 addr = roundup(addr, PAGE_SIZE); 308 309#if defined(LOADER_FDT_SUPPORT) 310 /* Handle device tree blob */ 311 dtbp = addr; 312 dtb_size = fdt_copy(addr); 313 314 /* Pad to a page boundary */ 315 if (dtb_size) 316 addr += roundup(dtb_size, PAGE_SIZE); 317#endif 318 319 kernend = 0; 320 kfp = file_findfile(NULL, "elf32 kernel"); 321 if (kfp == NULL) 322 kfp = file_findfile(NULL, "elf kernel"); 323 if (kfp == NULL) 324 panic("can't find kernel file"); 325 file_addmetadata(kfp, MODINFOMD_HOWTO, sizeof howto, &howto); 326 file_addmetadata(kfp, MODINFOMD_ENVP, sizeof envp, &envp); 327 328#if defined(LOADER_FDT_SUPPORT) 329 if (dtb_size) 330 file_addmetadata(kfp, MODINFOMD_DTBP, sizeof dtbp, &dtbp); 331 else 332 pager_output("WARNING! Trying to fire up the kernel, but no " 333 "device tree blob found!\n"); 334#endif 335 336 file_addmetadata(kfp, MODINFOMD_KERNEND, sizeof kernend, &kernend); 337 338 /* Figure out the size and location of the metadata */ 339 *modulep = addr; 340 size = md_copymodules(0); 341 kernend = roundup(addr + size, PAGE_SIZE); 342 343 /* Provide MODINFOMD_KERNEND */ 344 md = file_findmetadata(kfp, MODINFOMD_KERNEND); 345 bcopy(&kernend, md->md_data, sizeof kernend); 346 347 /* Convert addresses to the final VA */ 348 *modulep -= __elfN(relocation_offset); 349 350 /* Do relocation fixup on metadata of each module. */ 351 for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) { 352 for (i = 0; i < sizeof mdt / sizeof mdt[0]; i++) { 353 md = file_findmetadata(xp, mdt[i]); 354 if (md) { 355 bcopy(md->md_data, &vaddr, sizeof vaddr); 356 vaddr -= __elfN(relocation_offset); 357 bcopy(&vaddr, md->md_data, sizeof vaddr); 358 } 359 } 360 } 361 362 /* Only now copy actual modules and metadata */ 363 (void)md_copymodules(addr); 364 365 return (0); 366} 367