source: trunk/kernel/mm/mapper.h @ 611

Last change on this file since 611 was 611, checked in by alain, 3 years ago

Introduce sigificant modifs in VFS to support the <ls> command,
and the . and .. directories entries.

File size: 15.0 KB
Line 
1/*
2 * mapper.h - Kernel cache for VFS files/directories definition.
3 *
4 * Authors   Mohamed Lamine Karaoui (2015)
5 *           Alain Greiner (2016,2017,2018)
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 _MAPPER_H_
26#define _MAPPER_H_
27
28#include <hal_kernel_types.h>
29#include <hal_atomic.h>
30#include <xlist.h>
31#include <grdxt.h>
32#include <rwlock.h>
33
34/****  Forward declarations ****/
35
36struct page_s;
37struct vfs_inode_s;
38
39/*******************************************************************************************
40 * The mapper implements the kernel cache for a given file or directory.
41 * There is one mapper per file/dir. It is implemented as a three levels radix tree,
42 * entirely stored in the same cluster as the inode representing the file/dir.
43 * - The fast retrieval key is the page index in the file.
44 *   The ix1_width, ix2_width, ix3_width sub-indexes are configuration parameters.
45 * - The leaves are pointers on physical page descriptors, dynamically allocated
46 *   in the local cluster.
47 * - The mapper is protected by a "remote_rwlock", to support several simultaneous
48 *   "readers", and only one "writer".
49 * - A "reader" thread, calling the mapper_remote_get_page() function to get a page
50 *   descriptor pointer from the page index in file, can be remote (running in any cluster).
51 * - A "writer" thread, calling the mapper_handle_miss() function to handle a page miss
52 *   must be local (running in the mapper cluster).
53 * - The vfs_mapper_move_page() function access the file system to handle a mapper miss,
54 *   or update a dirty page on device.
55 * - The vfs_mapper_load_all() functions is used to load all pages of a directory
56 *   into the mapper (prefetch).
57 * - the mapper_move_user() function is used to move data to or from an user buffer.
58 *   This user space buffer can be physically distributed in several clusters.
59 * - the mapper_move_kernel() function is used to move data to or from a remote kernel
60 *   buffer, that can be physically located in any cluster.
61 * - In the present implementation the cache size for a given file increases on demand,
62 *   and the  allocated memory is only released when the mapper/inode is destroyed.
63 ******************************************************************************************/
64
65
66/*******************************************************************************************
67 * This structure defines the mapper descriptor.
68 ******************************************************************************************/
69
70typedef struct mapper_s
71{
72        struct vfs_inode_s * inode;           /*! owner inode                                     */
73    uint32_t             type;        /*! file system type                                */
74        grdxt_t              rt;              /*! embedded pages cache descriptor (radix tree)    */
75        remote_rwlock_t      lock;        /*! several readers / only one writer               */
76        uint32_t                 refcount;    /*! several vsegs can refer the same file           */
77        xlist_entry_t        vsegs_root;  /*! root of list of vsegs refering this mapper      */
78        xlist_entry_t        wait_root;   /*! root of list of threads waiting on mapper       */
79    list_entry_t         dirty_root;  /*! root of list of dirty pages                     */
80}
81mapper_t;
82
83/*******************************************************************************************
84 * This structure defines a "fragment". It is used to move data between the kernel mapper,
85 * and an user buffer, that can be split in several distributed physical pages located
86 * in different clusters. A fragment is a set of contiguous bytes in the file.
87 * - It can be stored in one single physical page in the user buffer.
88 * - It can spread two successive physical pages in the kernel mapper.
89 ******************************************************************************************/
90
91typedef struct fragment_s
92{
93    uint32_t    file_offset;         /*! offset of fragment in file (i.e. in mapper)      */
94    uint32_t    size;                /*! number of bytes in fragment                      */
95    cxy_t       buf_cxy;             /*! user buffer cluster identifier                   */
96    void      * buf_ptr;             /*! local pointer on first byte in user buffer       */
97}
98fragment_t;
99
100/*******************************************************************************************
101 * This function allocates physical memory for a mapper descriptor, and initializes it
102 * (refcount <= 0) / inode <= NULL).
103 * It must be executed by a thread running in the cluster containing the mapper.
104 *******************************************************************************************
105 * @ type   : type of the mapper to create.
106 * @ return : pointer on created mapper if success / return NULL if no memory
107 ******************************************************************************************/
108mapper_t * mapper_create( vfs_fs_type_t type );
109
110/*******************************************************************************************
111 * This function releases all physical memory allocated for a mapper.
112 * Both the mapper descriptor and the radix tree are released.
113 * It does NOT synchronize dirty pages. Use the vfs_sync_inode() function if required.
114 * It must be executed by a thread running in the cluster containing the mapper.
115 *******************************************************************************************
116 * @ mapper      : target mapper.
117 ******************************************************************************************/
118void mapper_destroy( mapper_t * mapper );
119
120/*******************************************************************************************
121 * This function load from device a missing page identified by the <page_id> argument
122 * into the mapper identified by the <mapper> local pointer.
123 * It allocates a physical page from the local cluster, initialise by accessing device,
124 * and register the page in the mapper radix tree.
125 * It must be executed by a thread running in the cluster containing the mapper.
126 * WARNING : the calling function mapper_remote_get_page() is supposed to take and release
127 * the lock protecting the mapper in WRITE_MODE.
128 *******************************************************************************************
129 * @ mapper      : [in]  target mapper.
130 * @ page_id : [in]  missing page index in file.
131 * @ page_xp : [out] buffer for extended pointer on missing page descriptor.
132 * @ return 0 if success / return -1 if a dirty page cannot be updated on device.
133 ******************************************************************************************/
134error_t mapper_handle_miss( mapper_t * mapper,
135                            uint32_t   page_id,
136                            xptr_t   * page_xp );
137
138/*******************************************************************************************
139 * This function move data between a remote mapper, dentified by the <mapper_xp> argument,
140 * and a distributed user buffer. It can be called by a thread running in any cluster.
141 * It is called by the vfs_user_move() to implement sys_read() and sys_write() syscalls.
142 * If required, the data transfer is split in "fragments", where one fragment contains
143 * contiguous bytes in the same mapper page.
144 * It uses "hal_uspace" accesses to move a fragment to/from the user buffer.
145 * In case of write, the dirty bit is set for all pages written in the mapper.
146 * The mapper being an extendable cache, it is automatically extended when required.
147 * The "offset" field in the file descriptor, and the "size" field in inode descriptor
148 * are not modified by this function.
149 *******************************************************************************************
150 * @ mapper_xp    : extended pointer on mapper.
151 * @ to_buffer    : mapper -> buffer if true / buffer -> mapper if false.
152 * @ file_offset  : first byte to move in file.
153 * @ u_buf        : user space pointer on user buffer.
154 * @ size         : number of bytes to move.
155 * returns O if success / returns -1 if error.
156 ******************************************************************************************/
157error_t mapper_move_user( xptr_t     mappe_xp,
158                          bool_t     to_buffer,
159                          uint32_t   file_offset,
160                          void     * u_buf,
161                          uint32_t   size );
162
163/********************************************************************************************
164 * This function move data between a remote mapper and a remote kernel buffer.
165 * It can be called by a thread running any cluster.
166 * If required, the data transfer is split in "fragments", where one fragment contains
167 * contiguous bytes in the same mapper page.
168 * It uses a "remote_memcpy" to move a fragment to/from the kernel buffer.
169 * In case of write, the dirty bit is set for all pages written in the mapper.
170 *******************************************************************************************
171 * @ mapper_xp    : extended pointer on mapper.
172 * @ to_buffer    : mapper -> buffer if true / buffer -> mapper if false.
173 * @ file_offset  : first byte to move in file.
174 * @ buffer_xp    : extended pointer on kernel buffer.
175 * @ size         : number of bytes to move.
176 * returns O if success / returns -1 if error.
177 ******************************************************************************************/
178error_t mapper_move_kernel( xptr_t     mapper_xp,
179                            bool_t     to_buffer,
180                            uint32_t   file_offset,
181                            xptr_t     buffer_xp,
182                            uint32_t   size );
183
184/*******************************************************************************************
185 * This function removes a physical page from the mapper, and releases
186 * the page to the local PPM. It is called by the mapper_destroy() function.
187 * It must be executed by a thread running in the cluster containing the mapper.
188 * It takes the mapper lock in WRITE_MODE to update the mapper.
189 *******************************************************************************************
190 * @ mapper     : local pointer on the mapper.
191 * @ page       : pointer on page to remove.
192 ******************************************************************************************/
193void mapper_release_page( mapper_t      * mapper,
194                          struct page_s * page );
195
196/*******************************************************************************************
197 * This function returns an extended pointer on a page descriptor.
198 * The - possibly remote - mapper is identified by the <mapper_xp> argument.
199 * The page is identified by <page_id> argument (page index in the file).
200 * It can be executed by a thread running in any cluster, as it uses remote
201 * access primitives to scan the mapper.
202 * In case of miss, this function takes the mapper lock in WRITE_MODE, and call the
203 * mapper_handle_miss() to load the missing page from device to mapper, using an RPC
204 * when the mapper is remote.
205 *******************************************************************************************
206 * @ mapper_xp  : extended pointer on the mapper.
207 * @ page_id    : page index in file
208 * @ returns extended pointer on page descriptor if success / return XPTR_NULL if error.
209 ******************************************************************************************/
210xptr_t mapper_remote_get_page( xptr_t    mapper_xp,
211                               uint32_t  page_id );
212
213/*******************************************************************************************
214 * This function allows to read a single word in a mapper seen as and array of uint32_t.
215 * It has bee designed to support remote access to the FAT mapper of the FATFS.
216 * It can be called by any thread running in any cluster.
217 * In case of miss, it takes the mapper lock in WRITE_MODE, load the missing
218 * page from device to mapper, and release the mapper lock.
219 *******************************************************************************************
220 * @ mapper_xp  : [in]  extended pointer on the mapper.
221 * @ word_id    : [in]  32 bits word index in file.
222 * @ p_value    : [out] local pointer on destination buffer.
223 * @ returns 0 if success / return -1 if error.
224 ******************************************************************************************/
225error_t mapper_remote_get_32( xptr_t     mapper_xp,
226                              uint32_t   word_id,
227                              uint32_t * p_value );
228
229/*******************************************************************************************
230 * This function allows to write a single word to a mapper seen as and array of uint32_t.
231 * It has bee designed to support remote access tho the FAT mapper of the FATFS.
232 * It can be called by any thread running in any cluster.
233 * In case of miss, it takes the mapper lock in WRITE_MODE, load the missing
234 * page from device to mapper, and release the mapper lock.
235 *******************************************************************************************
236 * @ mapper_xp  : [in]  extended pointer on the mapper.
237 * @ word_id    : [in]  32 bits word index in file.
238 * @ value      : [in]  value to be written.
239 * @ returns 0 if success / return -1 if error.
240 ******************************************************************************************/
241error_t mapper_remote_set_32( xptr_t     mapper_xp,
242                              uint32_t   word_id,
243                              uint32_t   value );
244
245/*******************************************************************************************
246 * This debug function displays the content of a given page of a given mapper.
247 * - the mapper is identified by the <mapper_xp> argument.
248 * - the page is identified by the <page_id> argument.
249 * - the number of bytes to display in page is defined by the <nbytes> argument.
250 * The format is eigth (32 bits) words per line in hexadecimal.
251 * It can be called by any thread running in any cluster.
252 * In case of miss in mapper, it load the missing page from device to mapper.
253 *******************************************************************************************
254 * @ mapper_xp  : [in]  extended pointer on the mapper.
255 * @ page_id    : [in]  page index in file.
256 * @ nbytes     : [in]  value to be written.
257 * @ string     : [in]  string printed in header.
258 * @ returns 0 if success / return -1 if error.
259 ******************************************************************************************/
260error_t mapper_display_page( xptr_t     mapper_xp,
261                             uint32_t   page_id,
262                             uint32_t   nbytes,
263                             char     * string );
264
265
266#endif /* _MAPPER_H_ */
Note: See TracBrowser for help on using the repository browser.