source: trunk/hal/generic/hal_gpt.h @ 383

Last change on this file since 383 was 383, checked in by max@…, 4 years ago

Use constant flags.

File size: 9.7 KB
Line 
1/*
2 * hal_gpt.h - Generic Page Table API definition.
3 *
4 * Authors  Alain Greiner (2016)
5 *
6 * Copyright (c) UPMC Sorbonne Universites
7 *
8 * This file is part of ALMOS-MKH.
9 *
10 * ALMOS-MKH is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2.0 of the License.
13 *
14 * ALMOS-MKH is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with ALMOS-MKH; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
24#ifndef _GPT_H_
25#define _GPT_H_
26
27#include <hal_types.h>
28
29/////////////////////////////////////////////////////////////////////////////////////////
30//           Generic Page Table Definition (implementation in hal_gpt.c)
31//
32// It is specified as a simple (one dimensional) array indexed by the VPN (vpn_t type),
33// even if implementations can use a more sophisticated organisation (two-levels or more).
34// - The number of entries (number of pages in a virtual space) is architecture
35//   dependent, and is defined as (CONFIG_USER_SPACE_SIZE / CONFIG_PPM_PAGE_SIZE).
36// - Each entry contains a Physical Page Number (ppn_t type), and a set of attributes,
37//   defined as masks on a 32 bits-vector.
38//
39// Any arch-specific implementation must implement this API.
40/////////////////////////////////////////////////////////////////////////////////////////
41
42/****  Forward declarations  ****/
43
44struct page_s;
45
46/****************************************************************************************
47 * These macros define the masks for the Generic Page Table Entry attributes.
48 ***************************************************************************************/
49
50#define GPT_MAPPED      0x0000  /*! PTE is mapped                                 */
51#define GPT_SMALL       0x0001  /*! PTE is a small page                           */
52#define GPT_READABLE    0x0002  /*! PTE is readable                               */
53#define GPT_WRITABLE    0x0004  /*! PTE is writable                               */
54#define GPT_EXECUTABLE  0x0008  /*! PTE is executable                             */
55#define GPT_CACHABLE    0x0010  /*! PTE can be cached                             */
56#define GPT_USER        0x0020  /*! PTE is user accessible                        */
57#define GPT_DIRTY       0x0040  /*! PTE has been "recently" written               */
58#define GPT_ACCESSED    0x0080  /*! PTE has been "recently" accessed              */
59#define GPT_GLOBAL      0x0100  /*! PTE is kept in TLB at context switch          */
60#define GPT_COW         0x0200  /*! PTE must be copied on write                   */
61#define GPT_SWAP        0x0400  /*! PTE swapped on disk (not implemented yet)     */
62#define GPT_LOCKED      0x0800  /*! PTE is protected against concurrent access    */
63
64/****************************************************************************************
65 * This structure defines the Generic Page Table descriptor.
66 ***************************************************************************************/
67
68typedef struct gpt_s
69{
70        void           * ptr;    /*! local pointer on GPT root                             */
71        ppn_t            ppn;    /*! PPN of GPT root                                       */
72        struct page_s  * page;   /*! local pointer on GPT root page descriptor             */
73}
74gpt_t;
75
76
77/****************************************************************************************
78 * This function allocates physical memory for first level page table (PT1),
79 * and initializes the page table descriptor.
80 ****************************************************************************************
81 * @ gpt     : pointer on generic page table descriptor.
82 * @ returns 0 if success / returns ENOMEM if error.
83 ***************************************************************************************/
84error_t hal_gpt_create( gpt_t * gpt );
85
86/****************************************************************************************
87 * This function releases all memory dynamically allocated for a generic page table.
88 * For a multi-levels radix tree implementation, it includes all nodes in the tree.
89 * If the calling thread is running in the reference cluster, it checks that user PTE
90 * entries are unmapped, and releases the mapped physical pages.
91 * The kernel pages are not released.
92 ****************************************************************************************
93 * @ gpt     : pointer on generic page table descriptor.
94 ***************************************************************************************/
95void hal_gpt_destroy( gpt_t * gpt);
96
97/****************************************************************************************
98 * This function prints on the kernel terminal the content of a generic page table.
99 ****************************************************************************************
100 * @ gpt     : pointer on generic page table descriptor.
101 ***************************************************************************************/
102void hal_gpt_print( gpt_t * gpt);
103
104/****************************************************************************************
105 * This blocking function gets a lock on a PTE (Page Table Entry) identified
106 * by its VPN, and returns only when the PTE has been successfully locked.
107 * If the target PTE is not present, it allocates and maps a physical page.
108 * A big page cannot be locked.
109 ****************************************************************************************
110 * @ gpt     : pointer on the generic page table
111 * @ vpn     : virtual page number of the target PTE.
112 * @ returns 0 if success / return ENOMEM or EINVAL if error.
113 ***************************************************************************************/
114error_t hal_gpt_lock_pte( gpt_t * gpt,
115                          vpn_t   vpn );
116
117/****************************************************************************************
118 * This function releases the lock on a PTE identified by its VPN.
119 ****************************************************************************************
120 * @ gpt     : pointer on the generic page table
121 * @ vpn     : virtual page number of the target PTE.
122 * @ returns 0 if success / returns EINVAL if error.
123 ***************************************************************************************/
124error_t hal_gpt_unlock_pte( gpt_t * gpt,
125                            vpn_t   vpn );
126
127/****************************************************************************************
128 * This function maps a page table entry identified by its VPN, from values defined
129 * by the ppn and attr arguments. It allocates physical memory for the local generic
130 * page table itself if required.
131 ****************************************************************************************
132 * @ gpt       : [in] pointer on the page table
133 * @ vpn       : [in] virtual page number
134 * @ ppn       : [in] physical page number
135 * @ attr      : [in] generic attributes
136 * @ returns 0 if success / returns ENOMEM if error
137 ***************************************************************************************/
138error_t hal_gpt_set_pte( gpt_t    * gpt,
139                         vpn_t      vpn,
140                         ppn_t      ppn,
141                         uint32_t   attr );
142
143/****************************************************************************************
144 * This function unmaps a page table entry identified by its VPN.
145 * If the calling thread is running in the reference cluster, it sends a broadcast RPC
146 * to update all other page table copies.
147 ****************************************************************************************
148 * @ gpt       : [in] pointer on the page table
149 * @ vpn       : [in] virtual page number
150 ***************************************************************************************/
151void hal_gpt_reset_pte( gpt_t * gpt,
152                        vpn_t   vpn );
153
154/****************************************************************************************
155 * This function returns in the ppn and attr arguments the value of a page table
156 * entry identified by its VPN.  It returns attr == 0 if the page is not mapped.
157 ****************************************************************************************
158 * @ gpt       : [in]  pointer on the page table
159 * @ vpn       : [in]  virtual page number
160 * @ attr      : [out] generic attributes
161 * @ ppn       : [out] physical page number
162 ***************************************************************************************/
163void hal_gpt_get_pte( gpt_t    * gpt,
164                      vpn_t      vpn,
165                      uint32_t * attr,
166                      ppn_t    * ppn );
167
168/****************************************************************************************
169 * This function copies all valid entries from the source <src_gpt> to the <dst_gpt>.
170 * The <src_gpt> and the <dst_gpt> point on the same physical pages.
171 * If the <cow> argument is true, the GPT_WRITABLE attribute is reset for all writable
172 * entries in both <src_gpt> and <dst_gpt>, and the PG_COW flag is registered in all
173 * writable physical page descriptors, to support the Copy-On-Write mechanism.
174 ****************************************************************************************
175 * @ dst_gpt   : [in]  pointer on the destination GPT.
176 * @ src_gpt   : [in]  pointer on the source GPT.
177 * @ cow       : [in]  activate the COPY-On-Write mechanism if true.
178 ***************************************************************************************/
179error_t hal_gpt_copy( gpt_t    * dst_gpt,
180                      gpt_t    * src_gpt,
181                      bool_t     cow );
182
183
184#endif  /* _GPT_H_ */
Note: See TracBrowser for help on using the repository browser.