/* [<][>][^][v][top][bottom][index][help] */
1 /*
2 * Copyright (c) 2000, 2001, 2002, 2003, 2004, 2005, 2008, 2009
3 * The President and Fellows of Harvard College.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
13 * 3. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE UNIVERSITY AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE UNIVERSITY OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30 #ifndef _ADDRSPACE_H_
31 #define _ADDRSPACE_H_
32
33 /*
34 * Address space structure and operations.
35 */
36
37
38 #include <vm.h>
39
40 struct vnode;
41
42
43 /*
44 * Address space - data structure associated with the virtual memory
45 * space of a process.
46 *
47 * You write this.
48 */
49
50 struct addrspace {
51 vaddr_t as_vbase1;
52 paddr_t as_pbase1;
53 size_t as_npages1;
54 vaddr_t as_vbase2;
55 paddr_t as_pbase2;
56 size_t as_npages2;
57 paddr_t as_stackpbase;
58 };
59
60 /*
61 * Functions in addrspace.c:
62 *
63 * as_create - create a new empty address space. You need to make
64 * sure this gets called in all the right places. You
65 * may find you want to change the argument list. May
66 * return NULL on out-of-memory error.
67 *
68 * as_copy - create a new address space that is an exact copy of
69 * an old one. Probably calls as_create to get a new
70 * empty address space and fill it in, but that's up to
71 * you.
72 *
73 * as_activate - make curproc's address space the one currently
74 * "seen" by the processor.
75 *
76 * as_deactivate - unload curproc's address space so it isn't
77 * currently "seen" by the processor.
78 *
79 * as_destroy - dispose of an address space. You may need to change
80 * the way this works if implementing user-level threads.
81 *
82 * as_define_region - set up a region of memory within the address
83 * space.
84 *
85 * as_prepare_load - this is called before actually loading from an
86 * executable into the address space.
87 *
88 * as_complete_load - this is called when loading from an executable
89 * is complete.
90 *
91 * as_define_stack - set up the stack region in the address space.
92 * (Normally called *after* as_complete_load().) Hands
93 * back the initial stack pointer for the new process.
94 */
95
96 struct addrspace *as_create(void);
97 int as_copy(struct addrspace *src, struct addrspace **ret);
98 void as_activate(void);
99 void as_deactivate(void);
100 void as_destroy(struct addrspace *);
101
102 int as_define_region(struct addrspace *as,
103 vaddr_t vaddr, size_t sz,
104 int readable,
105 int writeable,
106 int executable);
107 int as_prepare_load(struct addrspace *as);
108 int as_complete_load(struct addrspace *as);
109 int as_define_stack(struct addrspace *as, vaddr_t *initstackptr);
110
111
112 /*
113 * Functions in loadelf.c
114 * load_elf - load an ELF user program executable into the current
115 * address space. Returns the entry point (initial PC)
116 * in the space pointed to by ENTRYPOINT.
117 */
118
119 int load_elf(struct vnode *v, vaddr_t *entrypoint);
120
121
122 #endif /* _ADDRSPACE_H_ */