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

Last change on this file since 626 was 626, checked in by alain, 6 years ago

This version has been tested on the sort multithreaded application
for TSAR_IOB architectures ranging from 1 to 8 clusters.
It fixes three bigs bugs:
1) the dev_ioc device API has been modified: the dev_ioc_sync_read()
and dev_ioc_sync_write() function use now extended pointers on the
kernel buffer to access a mapper stored in any cluster.
2) the hal_uspace API has been modified: the hal_copy_to_uspace()
and hal_copy_from_uspace() functions use now a (cxy,ptr) couple
to identify the target buffer (equivalent to an extended pointer.
3) an implementation bug has been fixed in the assembly code contained
in the hal_copy_to_uspace() and hal_copy_from_uspace() functions.
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,2019)
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 * This mapper_t object implements the kernel cache for a given VFS 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 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_fs_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 * TODO (1) the mapper being only used to implement the VFS cache(s), the mapper.c
65 *          and mapper.h file should be trandfered to the fs directory.
66 * TODO (2) the "type" field is probably unused...
67 ******************************************************************************************/
68
69
70/*******************************************************************************************
71 * This structure defines the mapper descriptor.
72 ******************************************************************************************/
73
74typedef struct mapper_s
75{
76        struct vfs_inode_s * inode;           /*! owner inode                                     */
77    uint32_t             type;        /*! file system type                                */
78        grdxt_t              rt;              /*! embedded pages cache descriptor (radix tree)    */
79        remote_rwlock_t      lock;        /*! several readers / only one writer               */
80        uint32_t                 refcount;    /*! several vsegs can refer the same file           */
81        xlist_entry_t        vsegs_root;  /*! root of list of vsegs refering this mapper      */
82        xlist_entry_t        wait_root;   /*! root of list of threads waiting on mapper       */
83    list_entry_t         dirty_root;  /*! root of list of dirty pages                     */
84}
85mapper_t;
86
87/*******************************************************************************************
88 * This function allocates physical memory for a mapper descriptor, and initializes it
89 * (refcount <= 0) / inode <= NULL).
90 * It must be executed by a thread running in the cluster containing the mapper.
91 *******************************************************************************************
92 * @ type   : type of the mapper to create.
93 * @ return : pointer on created mapper if success / return NULL if no memory
94 ******************************************************************************************/
95mapper_t * mapper_create( vfs_fs_type_t type );
96
97/*******************************************************************************************
98 * This function releases all physical memory allocated for a mapper.
99 * Both the mapper descriptor and the radix tree are released.
100 * It does NOT synchronize dirty pages. Use the vfs_sync_inode() function if required.
101 * It must be executed by a thread running in the cluster containing the mapper.
102 *******************************************************************************************
103 * @ mapper      : target mapper.
104 ******************************************************************************************/
105void mapper_destroy( mapper_t * mapper );
106
107/*******************************************************************************************
108 * This function load from device a missing page identified by the <page_id> argument
109 * into the mapper identified by the <mapper> local pointer.
110 * It allocates a physical page from the local cluster, initialise by accessing device,
111 * and register the page in the mapper radix tree.
112 * It must be executed by a thread running in the cluster containing the mapper.
113 * WARNING : the calling function mapper_remote_get_page() is supposed to take and release
114 * the lock protecting the mapper in WRITE_MODE.
115 *******************************************************************************************
116 * @ mapper      : [in]  target mapper.
117 * @ page_id : [in]  missing page index in file.
118 * @ page_xp : [out] buffer for extended pointer on missing page descriptor.
119 * @ return 0 if success / return -1 if a dirty page cannot be updated on device.
120 ******************************************************************************************/
121error_t mapper_handle_miss( mapper_t * mapper,
122                            uint32_t   page_id,
123                            xptr_t   * page_xp );
124
125/*******************************************************************************************
126 * This function move data between a remote mapper, identified by the <mapper_xp> argument,
127 * and a distributed user buffer. It can be called by a thread running in any cluster.
128 * It is called by the vfs_user_move() to implement sys_read() and sys_write() syscalls.
129 * If required, the data transfer is split in "fragments", where one fragment contains
130 * contiguous bytes in the same mapper page.
131 * It uses "hal_uspace" accesses to move a fragment to/from the user buffer.
132 * In case of write, the dirty bit is set for all pages written in the mapper.
133 * The mapper being an extendable cache, it is automatically extended when required.
134 * The "offset" field in the file descriptor, and the "size" field in inode descriptor
135 * are not modified by this function.
136 *******************************************************************************************
137 * @ mapper_xp    : extended pointer on mapper.
138 * @ to_buffer    : mapper -> buffer if true / buffer -> mapper if false.
139 * @ file_offset  : first byte to move in file.
140 * @ u_buf        : user space pointer on user buffer.
141 * @ size         : number of bytes to move.
142 * returns O if success / returns -1 if error.
143 ******************************************************************************************/
144error_t mapper_move_user( xptr_t     mapper_xp,
145                          bool_t     to_buffer,
146                          uint32_t   file_offset,
147                          void     * u_buf,
148                          uint32_t   size );
149
150/********************************************************************************************
151 * This function move data between a remote mapper, identified by the <mapper_xp> argument,
152 * and a localised remote kernel buffer. It can be called by a thread running any cluster.
153 * If required, the data transfer is split in "fragments", where one fragment contains
154 * contiguous bytes in the same mapper page.
155 * It uses a "remote_memcpy" to move a fragment to/from the kernel buffer.
156 * In case of write, the dirty bit is set for all pages written in the mapper.
157 *******************************************************************************************
158 * @ mapper_xp    : extended pointer on mapper.
159 * @ to_buffer    : mapper -> buffer if true / buffer -> mapper if false.
160 * @ file_offset  : first byte to move in file.
161 * @ buffer_xp    : extended pointer on kernel buffer.
162 * @ size         : number of bytes to move.
163 * returns O if success / returns -1 if error.
164 ******************************************************************************************/
165error_t mapper_move_kernel( xptr_t     mapper_xp,
166                            bool_t     to_buffer,
167                            uint32_t   file_offset,
168                            xptr_t     buffer_xp,
169                            uint32_t   size );
170
171/*******************************************************************************************
172 * This function removes a physical page from the mapper, and releases
173 * the page to the local PPM. It is called by the mapper_destroy() function.
174 * It must be executed by a thread running in the cluster containing the mapper.
175 * It takes the mapper lock in WRITE_MODE to update the mapper.
176 *******************************************************************************************
177 * @ mapper     : local pointer on the mapper.
178 * @ page       : pointer on page to remove.
179 ******************************************************************************************/
180void mapper_release_page( mapper_t      * mapper,
181                          struct page_s * page );
182
183/*******************************************************************************************
184 * This function returns an extended pointer on a page descriptor.
185 * The - possibly remote - mapper is identified by the <mapper_xp> argument.
186 * The page is identified by <page_id> argument (page index in the file).
187 * It can be executed by a thread running in any cluster, as it uses remote
188 * access primitives to scan the mapper.
189 * In case of miss, this function takes the mapper lock in WRITE_MODE, and call the
190 * mapper_handle_miss() to load the missing page from device to mapper, using an RPC
191 * when the mapper is remote.
192 *******************************************************************************************
193 * @ mapper_xp  : extended pointer on the mapper.
194 * @ page_id    : page index in file
195 * @ returns extended pointer on page descriptor if success / return XPTR_NULL if error.
196 ******************************************************************************************/
197xptr_t mapper_remote_get_page( xptr_t    mapper_xp,
198                               uint32_t  page_id );
199
200/*******************************************************************************************
201 * This function allows to read a single word in a mapper seen as and array of uint32_t.
202 * It has bee designed to support remote access to the FAT mapper of the FATFS.
203 * It can be called by any thread running in any cluster.
204 * In case of miss, it takes the mapper lock in WRITE_MODE, load the missing
205 * page from device to mapper, and release the mapper lock.
206 *******************************************************************************************
207 * @ mapper_xp  : [in]  extended pointer on the mapper.
208 * @ word_id    : [in]  32 bits word index in file.
209 * @ p_value    : [out] local pointer on destination buffer.
210 * @ returns 0 if success / return -1 if error.
211 ******************************************************************************************/
212error_t mapper_remote_get_32( xptr_t     mapper_xp,
213                              uint32_t   word_id,
214                              uint32_t * p_value );
215
216/*******************************************************************************************
217 * This function allows to write a single word to a mapper seen as and array of uint32_t.
218 * It has been designed to support remote access to the FAT mapper of the FATFS.
219 * It can be called by any thread running in any cluster.
220 * In case of miss, it takes the mapper lock in WRITE_MODE, load the missing
221 * page from device to mapper, and release the mapper lock.
222 *******************************************************************************************
223 * @ mapper_xp  : [in]  extended pointer on the mapper.
224 * @ word_id    : [in]  32 bits word index in file.
225 * @ value      : [in]  value to be written.
226 * @ returns 0 if success / return -1 if error.
227 ******************************************************************************************/
228error_t mapper_remote_set_32( xptr_t     mapper_xp,
229                              uint32_t   word_id,
230                              uint32_t   value );
231
232/*******************************************************************************************
233 * This function scan all pages present in the mapper identified by the <mapper> argument,
234 * and synchronize all pages maked as dirty" on disk.
235 * These pages are unmarked and removed from the local PPM dirty_list.
236 * This function must be called by a local thread running in same cluster as the mapper.
237 * A remote thread must call the RPC_MAPPER_SYNC function.
238 *******************************************************************************************
239 * @ mapper     : [in]  local pointer on local mapper.
240 * @ returns 0 if success / return -1 if error.
241 ******************************************************************************************/
242error_t mapper_sync( mapper_t *  mapper );
243
244/*******************************************************************************************
245 * This debug function displays the content of a given page of a given mapper.
246 * - the mapper is identified by the <mapper_xp> argument.
247 * - the page is identified by the <page_id> argument.
248 * - the number of bytes to display in page is defined by the <nbytes> argument.
249 * The format is eigth (32 bits) words per line in hexadecimal.
250 * It can be called by any thread running in any cluster.
251 * In case of miss in mapper, it load the missing page from device to mapper.
252 *******************************************************************************************
253 * @ mapper_xp  : [in]  extended pointer on the mapper.
254 * @ page_id    : [in]  page index in file.
255 * @ nbytes     : [in]  value to be written.
256 * @ returns 0 if success / return -1 if error.
257 ******************************************************************************************/
258error_t mapper_display_page( xptr_t     mapper_xp,
259                             uint32_t   page_id,
260                             uint32_t   nbytes );
261
262
263#endif /* _MAPPER_H_ */
Note: See TracBrowser for help on using the repository browser.