2 * Copyright (c) 2011 Doug Rabson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * USERBOOT interface versions
32 #define USERBOOT_VERSION_1 1
33 #define USERBOOT_VERSION_2 2
34 #define USERBOOT_VERSION_3 3
37 * Version 4 added more generic callbacks for setting up
38 * registers and descriptors. The callback structure is
39 * backward compatible (new callbacks have been added at
42 #define USERBOOT_VERSION_4 4
45 * Version 5 added a callback for indicating that the guest
46 * should be restarted with a different interpreter. The callback
47 * structure is still backward compatible.
49 #define USERBOOT_VERSION_5 5
52 * Exit codes from the loader
54 #define USERBOOT_EXIT_QUIT 1
55 #define USERBOOT_EXIT_REBOOT 2
57 struct loader_callbacks {
63 * Wait until a key is pressed on the console and then return it
65 int (*getc)(void *arg);
68 * Write the character ch to the console
70 void (*putc)(void *arg, int ch);
73 * Return non-zero if a key can be read from the console
75 int (*poll)(void *arg);
82 * Open a file in the host filesystem
84 int (*open)(void *arg, const char *filename, void **h_return);
89 int (*close)(void *arg, void *h);
92 * Return non-zero if the file is a directory
94 int (*isdir)(void *arg, void *h);
97 * Read size bytes from a file. The number of bytes remaining
98 * in dst after reading is returned in *resid_return
100 int (*read)(void *arg, void *h, void *dst, size_t size,
101 size_t *resid_return);
104 * Read an entry from a directory. The entry's inode number is
105 * returned in *fileno_return, its type in *type_return and
106 * the name length in *namelen_return. The name itself is
107 * copied to the buffer name which must be at least PATH_MAX
110 int (*readdir)(void *arg, void *h, uint32_t *fileno_return,
111 uint8_t *type_return, size_t *namelen_return, char *name);
114 * Seek to a location within an open file
116 int (*seek)(void *arg, void *h, uint64_t offset,
120 * Return some stat(2) related information about the file
122 int (*stat)(void *arg, void *h, int *mode_return,
123 int *uid_return, int *gid_return, uint64_t *size_return);
130 * Read from a disk image at the given offset
132 int (*diskread)(void *arg, int unit, uint64_t offset,
133 void *dst, size_t size, size_t *resid_return);
136 * Guest virtual machine i/o
140 * Copy to the guest address space
142 int (*copyin)(void *arg, const void *from,
143 uint64_t to, size_t size);
146 * Copy from the guest address space
148 int (*copyout)(void *arg, uint64_t from,
149 void *to, size_t size);
152 * Set a guest register value
154 void (*setreg)(void *arg, int, uint64_t);
157 * Set a guest MSR value
159 void (*setmsr)(void *arg, int, uint64_t);
162 * Set a guest CR value
164 void (*setcr)(void *arg, int, uint64_t);
167 * Set the guest GDT address
169 void (*setgdt)(void *arg, uint64_t, size_t);
172 * Transfer control to the guest at the given address
174 void (*exec)(void *arg, uint64_t pc);
181 * Sleep for usec microseconds
183 void (*delay)(void *arg, int usec);
186 * Exit with the given exit code
188 void (*exit)(void *arg, int v);
191 * Return guest physical memory map details
193 void (*getmem)(void *arg, uint64_t *lowmem,
197 * ioctl interface to the disk device
199 int (*diskioctl)(void *arg, int unit, u_long cmd,
203 * Returns an environment variable in the form "name=value".
205 * If there are no more variables that need to be set in the
206 * loader environment then return NULL.
208 * 'num' is used as a handle for the callback to identify which
209 * environment variable to return next. It will begin at 0 and
210 * each invocation will add 1 to the previous value of 'num'.
212 char * (*getenv)(void *arg, int num);
215 * Version 4 additions.
217 int (*vm_set_register)(void *arg, int vcpu, int reg, uint64_t val);
218 int (*vm_set_desc)(void *arg, int vcpu, int reg, uint64_t base,
219 u_int limit, u_int access);
222 * Version 5 addition.
224 void (*swap_interpreter)(void *arg, const char *interp);