Added annotations to i386/pmap.c i386/kdebug.c and i386/cpuinfo.c
[akaros.git] / kern / include / ros / memlayout.h
1 #ifndef ROS_INC_MEMLAYOUT_H
2 #define ROS_INC_MEMLAYOUT_H
3
4 #ifndef __ASSEMBLER__
5 #include <arch/types.h>
6 #include <arch/mmu.h>
7 #endif /* not __ASSEMBLER__ */
8
9 /*
10  * This file contains definitions for memory management in our OS,
11  * which are relevant to both the kernel and user-mode software.
12  */
13
14 /*
15  * Virtual memory map:                                Permissions
16  *                                                    kernel/user
17  *
18  *    4 Gig -------->  +------------------------------+
19  *                     |                              | RW/--
20  *                     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21  *                     :              .               :
22  *                     :              .               :
23  *                     :              .               :
24  *                     |~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~| RW/--
25  *                     |                              | RW/--
26  *                     |   Remapped Physical Memory   | RW/--
27  *                     |                              | RW/--
28  *    KERNBASE ----->  +------------------------------+ 0xc0000000
29  *                     |  Cur. Page Table (Kern. RW)  | RW/--  PTSIZE
30  *    VPT,KSTACKTOP--> +------------------------------+ 0xbfc00000      --+
31  *                     |         Kernel Stack         | RW/--  KSTKSIZE   |
32  *                     | - - - - - - - - - - - - - - -|                 PTSIZE
33  *                     |      Invalid Memory (*)      | --/--             |
34  *    ULIM      ----> +------------------------------+ 0xbf800000      --+
35  *                     |  Cur. Page Table (User R-)   | R-/R-  PTSIZE
36  *    UVPT      ---->  +------------------------------+ 0xbf400000      --+
37  *                     | Unmapped (expandable region) |                   |
38  *                     |                              | R-/R-            PTSIZE
39  *                     |     Per-Process R/O Info     |                   |
40  * UTOP, UINFO  ---->  +------------------------------+ 0xbf000000      --+
41  *                     | Unmapped (expandable region) |                   |
42  *                     |                              | RW/RW            PTSIZE
43  *                     |     Per-Process R/W Data     |                   |
44  *    UDATA     ---->  +------------------------------+ 0xbec00000      --+
45  *                     |    Global Shared R/W Data    | RW/RW  PGSIZE
46  * UXSTACKTOP,UGDATA ->+------------------------------+ 0xbebff000
47  *                     |     User Exception Stack     | RW/RW  PGSIZE
48  *                     +------------------------------+ 0xbebfe000
49  *                     |       Empty Memory (*)       | --/--  PGSIZE
50  *    USTACKTOP  --->  +------------------------------+ 0xbebfd000
51  *                     |      Normal User Stack       | RW/RW  PGSIZE
52  *                     +------------------------------+ 0xbebfc000
53  *                     |                              |
54  *                     |                              |
55  *                     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
56  *                     .                              .
57  *                     .                              .
58  *                     .                              .
59  *                     |~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~|
60  *                     |     Program Data & Heap      |
61  *    UTEXT -------->  +------------------------------+ 0x00800000
62  *    PFTEMP ------->  |       Empty Memory (*)       |        PTSIZE
63  *                     |                              |
64  *    UTEMP -------->  +------------------------------+ 0x00400000      --+
65  *                     |       Empty Memory (*)       |                   |
66  *                     | - - - - - - - - - - - - - - -|                   |
67  *                     |  User STAB Data (optional)   |                 PTSIZE
68  *    USTABDATA ---->  +------------------------------+ 0x00200000        |
69  *                     |       Empty Memory (*)       |                   |
70  *    0 ------------>  +------------------------------+                 --+
71  *
72  * (*) Note: The kernel ensures that "Invalid Memory" (ULIM) is *never*
73  *     mapped.  "Empty Memory" is normally unmapped, but user programs may
74  *     map pages there if desired.  ROS user programs map pages temporarily
75  *     at UTEMP.
76  */
77
78
79 // All physical memory mapped at this address
80 #define KERNBASE        0xC0000000
81
82 // At IOPHYSMEM (640K) there is a 384K hole for I/O.  From the kernel,
83 // IOPHYSMEM can be addressed at KERNBASE + IOPHYSMEM.  The hole ends
84 // at physical address EXTPHYSMEM.
85 #define IOPHYSMEM       0x0A0000
86 #define VGAPHYSMEM      0x0A0000
87 #define DEVPHYSMEM      0x0C0000
88 #define BIOSPHYSMEM     0x0F0000
89 #define EXTPHYSMEM      0x100000
90
91 // Virtual page table.  Entry PDX(VPT) in the PD contains a pointer to
92 // the page directory itself, thereby turning the PD into a page table,
93 // which maps all the PTEs containing the page mappings for the entire
94 // virtual address space into that 4 Meg region starting at VPT.
95 #define VPT             (KERNBASE - PTSIZE)
96 #define KSTACKTOP       VPT
97 #define KSTKSHIFT       (PGSHIFT+3)             // KSTKSIZE == 8*PGSIZE
98 #define KSTKSIZE        (1 << KSTKSHIFT)        // size of a kernel stack
99 #define ULIM            (KSTACKTOP - PTSIZE)
100
101 /*
102  * User read-only mappings! Anything below here til UTOP are readonly to user.
103  * They are global pages mapped in at env allocation time.
104  */
105
106 // Same as VPT but read-only for users
107 #define UVPT            (ULIM - PTSIZE)
108
109 /*
110  * Top of user VM. User can manipulate VA from UTOP-1 and down!
111  */
112
113 // Top of user-accessible VM
114 #define UTOP            (UVPT - PTSIZE)
115 // Read-only, per-process shared info structures
116 #define UINFO           UTOP
117
118 // Read-write, per-process shared page for sending asynchronous 
119 // syscalls to the kernel
120 #define UDATA    (UTOP - PTSIZE)
121
122 // Read-write, global page.  Shared by all processes.  Can't be trusted.
123 #define UGDATA   (UDATA - PGSIZE)
124
125 // Top of one-page user exception stack
126 #define UXSTACKTOP      UGDATA
127 // Next page left invalid to guard against exception stack overflow; then:
128 // Top of normal user stack
129 #define USTACKTOP       (UXSTACKTOP - 2*PGSIZE)
130
131 // Where user programs generally begin
132 #define UTEXT           (2*PTSIZE)
133
134 // Used for temporary page mappings.  Typed 'void*' for convenience
135 #define UTEMP           ((void*) PTSIZE)
136 // Used for temporary page mappings for the user page-fault handler
137 // (should not conflict with other temporary page mappings)
138 #define PFTEMP          (UTEMP + PTSIZE - PGSIZE)
139 // The location of the user-level STABS data structure
140 #define USTABDATA       (PTSIZE / 2)
141
142
143 #ifndef __ASSEMBLER__
144
145 /*
146  * The page directory entry corresponding to the virtual address range
147  * [VPT, VPT + PTSIZE) points to the page directory itself.  Thus, the page
148  * directory is treated as a page table as well as a page directory.
149  *
150  * One result of treating the page directory as a page table is that all PTEs
151  * can be accessed through a "virtual page table" at virtual address VPT (to
152  * which vpt is set in entry.S).  The PTE for page number N is stored in
153  * vpt[N].  (It's worth drawing a diagram of this!)
154  *
155  * A second consequence is that the contents of the current page directory
156  * will always be available at virtual address (VPT + (VPT >> PGSHIFT)), to
157  * which vpd is set in entry.S.
158  */
159 typedef uint32_t pte_t;
160 typedef uint32_t pde_t;
161
162 extern volatile pte_t (COUNT(PTSIZE) vpt)[];     // VA of "virtual page table"
163 extern volatile pde_t (COUNT(PTSIZE) vpd)[];     // VA of current page directory
164
165 #endif /* !__ASSEMBLER__ */
166 #endif /* !ROS_INC_MEMLAYOUT_H */