[1] | 1 | /* |
---|
| 2 | * page.h - physical page descriptor and related operations |
---|
| 3 | * |
---|
| 4 | * Authors Ghassan Almalles (2008,2009,2010,2011,2012) |
---|
[632] | 5 | * Alain Greiner (2016,2017,2018,2019) |
---|
[1] | 6 | * |
---|
| 7 | * Copyright (c) UPMC Sorbonne Universites |
---|
| 8 | * |
---|
| 9 | * This file is part of ALMOS-MKH. |
---|
| 10 | * |
---|
| 11 | * ALMOS-MKH is free software; you can redistribute it and/or modify it |
---|
| 12 | * under the terms of the GNU General Public License as published by |
---|
| 13 | * the Free Software Foundation; version 2.0 of the License. |
---|
| 14 | * |
---|
| 15 | * ALMOS-MKH is distributed in the hope that it will be useful, but |
---|
| 16 | * WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
---|
| 18 | * General Public License for more details. |
---|
| 19 | * |
---|
| 20 | * You should have received a copy of the GNU General Public License |
---|
| 21 | * along with ALMOS-MKH; if not, write to the Free Software Foundation, |
---|
| 22 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
---|
| 23 | */ |
---|
| 24 | |
---|
| 25 | #ifndef _PAGE_H_ |
---|
| 26 | #define _PAGE_H_ |
---|
| 27 | |
---|
[14] | 28 | #include <kernel_config.h> |
---|
[457] | 29 | #include <hal_kernel_types.h> |
---|
[567] | 30 | #include <remote_busylock.h> |
---|
[1] | 31 | #include <list.h> |
---|
| 32 | |
---|
| 33 | /*** Forward declarations ***/ |
---|
| 34 | |
---|
| 35 | struct mapper_s; |
---|
[18] | 36 | |
---|
[1] | 37 | /************************************************************************************* |
---|
| 38 | * This defines the flags that can be attached to a physical page. |
---|
| 39 | ************************************************************************************/ |
---|
| 40 | |
---|
| 41 | #define PG_INIT 0x0001 // page descriptor has been initialised |
---|
| 42 | #define PG_RESERVED 0x0002 // cannot be allocated by PPM |
---|
[623] | 43 | #define PG_FREE 0x0004 // page not yet allocated by PPM |
---|
[1] | 44 | #define PG_DIRTY 0x0040 // page has been written |
---|
[567] | 45 | #define PG_COW 0x0080 // page is copy-on-write |
---|
[1] | 46 | |
---|
| 47 | /************************************************************************************* |
---|
| 48 | * This structure defines a physical page descriptor. |
---|
[606] | 49 | * - The remote_busylock is used to allows any remote thread to atomically |
---|
[635] | 50 | * test/modify the forks counter or the flags. |
---|
[606] | 51 | * - The list entry is used to register the page in a free list or in dirty list. |
---|
[625] | 52 | * The refcount is used for page release to KMEM. |
---|
| 53 | * NOTE: the size is 48 bytes for a 32 bits core. |
---|
[1] | 54 | ************************************************************************************/ |
---|
| 55 | |
---|
| 56 | typedef struct page_s |
---|
| 57 | { |
---|
[23] | 58 | uint32_t flags; /*! flags defined above (4) */ |
---|
[68] | 59 | uint32_t order; /*! log2( number of small pages) (4) */ |
---|
[1] | 60 | struct mapper_s * mapper; /*! local pointer on associated mapper (4) */ |
---|
| 61 | uint32_t index; /*! page index in mapper (4) */ |
---|
[18] | 62 | list_entry_t list; /*! for both dirty pages and free pages (8) */ |
---|
[625] | 63 | int32_t refcount; /*! references counter for page release (4) */ |
---|
[433] | 64 | uint32_t forks; /*! number of pending forks (4) */ |
---|
[606] | 65 | remote_busylock_t lock; /*! protect forks or flags modifs (16) */ |
---|
[1] | 66 | } |
---|
| 67 | page_t; |
---|
| 68 | |
---|
| 69 | /************************************************************************************* |
---|
[632] | 70 | * This function must be called by a thread running in the local cluster. |
---|
| 71 | * It initializes the page descriptor. |
---|
[23] | 72 | ************************************************************************************* |
---|
[1] | 73 | * @ page : pointer to page descriptor |
---|
| 74 | ************************************************************************************/ |
---|
| 75 | inline void page_init( page_t * page ); |
---|
| 76 | |
---|
| 77 | /************************************************************************************* |
---|
[632] | 78 | * This function must be called by a thread running in the local cluster. |
---|
| 79 | * It atomically set one or several flags in page descriptor flags. |
---|
[23] | 80 | ************************************************************************************* |
---|
[1] | 81 | * @ page : pointer to page descriptor. |
---|
[18] | 82 | * @ value : all non zero bits in value will be set. |
---|
[1] | 83 | ************************************************************************************/ |
---|
| 84 | inline void page_set_flag( page_t * page, |
---|
[23] | 85 | uint32_t value ); |
---|
[1] | 86 | |
---|
| 87 | /************************************************************************************* |
---|
[632] | 88 | * This function must be called by a thread running in the local cluster. |
---|
| 89 | * It atomically reset one or several flags in page descriptor flags. |
---|
[23] | 90 | ************************************************************************************* |
---|
[1] | 91 | * @ page : pointer to page descriptor. |
---|
[18] | 92 | * @ value : all non zero bits in value will be cleared. |
---|
[1] | 93 | ************************************************************************************/ |
---|
| 94 | inline void page_clear_flag( page_t * page, |
---|
[23] | 95 | uint32_t value ); |
---|
[1] | 96 | |
---|
| 97 | /************************************************************************************* |
---|
[632] | 98 | * This function must be called by a thread running in the local cluster. |
---|
| 99 | * It tests the value of one or several flags in page descriptor flags. |
---|
[23] | 100 | ************************************************************************************* |
---|
[1] | 101 | * @ page : pointer to page descriptor. |
---|
| 102 | * @ value : all non zero bits will be tested. |
---|
[18] | 103 | * @ returns true if at least one non zero bit in value is set / false otherwise. |
---|
[1] | 104 | ************************************************************************************/ |
---|
| 105 | inline bool_t page_is_flag( page_t * page, |
---|
[23] | 106 | uint32_t value ); |
---|
[1] | 107 | |
---|
| 108 | /************************************************************************************* |
---|
[632] | 109 | * This function must be called by a thread running in the local cluster. |
---|
| 110 | * It resets to 0 all bytes in a given page. |
---|
[23] | 111 | ************************************************************************************* |
---|
[1] | 112 | * @ page : pointer on page descriptor. |
---|
| 113 | ************************************************************************************/ |
---|
| 114 | void page_zero( page_t * page ); |
---|
| 115 | |
---|
| 116 | /************************************************************************************* |
---|
[632] | 117 | * This function must be called by a thread running in the local cluster. |
---|
| 118 | * It atomically increments the page refcount. |
---|
[23] | 119 | ************************************************************************************* |
---|
[1] | 120 | * @ page : pointer on page descriptor. |
---|
| 121 | ************************************************************************************/ |
---|
| 122 | inline void page_refcount_up( page_t * page ); |
---|
| 123 | |
---|
| 124 | /************************************************************************************* |
---|
[632] | 125 | * This function must be called by a thread running in the local cluster. |
---|
| 126 | * It atomically decrements the page refcount. |
---|
[23] | 127 | ************************************************************************************* |
---|
[1] | 128 | * @ page : pointer on page descriptor. |
---|
| 129 | ************************************************************************************/ |
---|
| 130 | inline void page_refcount_down( page_t * page ); |
---|
| 131 | |
---|
[632] | 132 | |
---|
| 133 | |
---|
| 134 | |
---|
[635] | 135 | |
---|
[1] | 136 | /************************************************************************************* |
---|
[635] | 137 | * This function must be called by a thread running in the local cluster. |
---|
| 138 | * It initializes the page descriptor. |
---|
| 139 | ************************************************************************************* |
---|
| 140 | * @ page_xp : extended pointer to page descriptor. |
---|
| 141 | ************************************************************************************/ |
---|
| 142 | inline void page_remote_init( xptr_t page_xp ); |
---|
| 143 | |
---|
| 144 | /************************************************************************************* |
---|
[632] | 145 | * This function can be called by any thread running in any cluster. |
---|
| 146 | * It atomically set one or several flags in a remote page descriptor |
---|
| 147 | * identified by the <page_xp> argument. |
---|
[23] | 148 | ************************************************************************************* |
---|
[632] | 149 | * @ page_xp : extended pointer to page descriptor. |
---|
| 150 | * @ value : all non zero bits in value will be set. |
---|
[1] | 151 | ************************************************************************************/ |
---|
[632] | 152 | inline void page_remote_set_flag( xptr_t page_xp, |
---|
| 153 | uint32_t value ); |
---|
[1] | 154 | |
---|
[632] | 155 | /************************************************************************************* |
---|
| 156 | * This function can be called by any thread running in any cluster. |
---|
| 157 | * It atomically reset one or several flags in a remote page descriptor |
---|
| 158 | * identified by the <page_xp> argument. |
---|
| 159 | ************************************************************************************* |
---|
| 160 | * @ page_xp : extended pointer to page descriptor. |
---|
| 161 | * @ value : all non zero bits in value will be cleared. |
---|
| 162 | ************************************************************************************/ |
---|
| 163 | inline void page_remote_clear_flag( xptr_t page_xp, |
---|
| 164 | uint32_t value ); |
---|
[1] | 165 | |
---|
[632] | 166 | /************************************************************************************* |
---|
| 167 | * This function can be called by any thread running in any cluster. |
---|
| 168 | * It tests the value of one or several flags in a remote page descriptor |
---|
| 169 | * identified by the <page_xp> argument. |
---|
| 170 | ************************************************************************************* |
---|
| 171 | * @ page_xp : extended pointer to page descriptor. |
---|
| 172 | * @ value : all non zero bits will be tested. |
---|
| 173 | * @ returns true if at least one non zero bit in value is set / false otherwise. |
---|
| 174 | ************************************************************************************/ |
---|
| 175 | inline bool_t page_remote_is_flag( xptr_t page_xp, |
---|
| 176 | uint32_t value ); |
---|
| 177 | |
---|
| 178 | /************************************************************************************* |
---|
| 179 | * This function can be called by any thread running in any cluster. |
---|
| 180 | * It atomically increments the refcount for the remote page identified by |
---|
| 181 | * the <page_xp> argument. |
---|
| 182 | ************************************************************************************* |
---|
| 183 | * @ page_xp : extended pointer on page descriptor. |
---|
| 184 | ************************************************************************************/ |
---|
| 185 | inline void page_remote_refcount_up( xptr_t page_xp ); |
---|
| 186 | |
---|
| 187 | /************************************************************************************* |
---|
| 188 | * This function can be called by any thread running in any cluster. |
---|
| 189 | * It atomically decrements the refcount for the remote page identified by |
---|
| 190 | * the <page_xp> argument. |
---|
| 191 | ************************************************************************************* |
---|
| 192 | * @ page_xp : extended pointer on page descriptor. |
---|
| 193 | ************************************************************************************/ |
---|
| 194 | inline void page_remote_refcount_down( xptr_t page_xp ); |
---|
| 195 | |
---|
| 196 | /************************************************************************************* |
---|
| 197 | * This debug function can be called by any thread running in any cluster. |
---|
| 198 | * It displays the values contained in a page descriptor. |
---|
| 199 | ************************************************************************************* |
---|
| 200 | * @ page_xp : extended pointer on page descriptor. |
---|
| 201 | ************************************************************************************/ |
---|
| 202 | void page_remote_display( xptr_t page_xp ); |
---|
| 203 | |
---|
[1] | 204 | #endif /* _PAGE_H_ */ |
---|