source: trunk/kernel/fs/devfs.h @ 624

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

Fix several bugs in vfs.c, fatfs.c, and devfs.c to support
the <.> and <..> directory entries.

File size: 9.2 KB
Line 
1/*
2 * devfs.h - DEVFS File System API definition                               
3 *
4 * Authors       Mohamed Lamine Karaoui (2014,2015)
5 *               Alain Greiner (2016,2017)
6 *
7 * Copyright (c) 2011,2012 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 _DEVFS_H_
26#define _DEVFS_H_
27
28//////////////////////////////////////////////////////////////////////////////////////////
29// The DEVFS File System contains inodes and dentries associated to all chdev descriptors
30// availables in the architecture.
31//
32// It is structured as a three levels tree structure :
33// - The "dev" directory inode is stored in cluster_IO. It is the root of the DEVFS
34//   file system. The parent inode is the "/" VFS root.
35// - There is one "internal_cxy" directory inode per cluster, that is the parent of
36//   the local children inodes associated to the local, internal chdev descriptors.
37//   The parent dentry is stored in cluster_IO.
38// - The I/O cluster contains one "external" directory inode, that is the parent of
39//   the remote children inodes associated to the remote external chdev descriptors.
40//   The parent dentry is stored in cluster_IO.
41//
42// The DEVFS extensions to the generic VFS are the following:
43// 1) The vfs_ctx_t "extend" void* field is pointing on the devfs_ctx_t structure.
44//    This structure contains two extended pointers on the DEVFS "dev" directory inode,
45//    and on the "external" directory inode.
46// 2) The vfs_inode_t "extend" void* field is pointing on the chdev descriptor.
47//////////////////////////////////////////////////////////////////////////////////////////
48
49/*****************************************************************************************
50 * This structure defines the DEVFS context extension.
51 ****************************************************************************************/
52
53typedef struct devfs_ctx_s
54{
55    xptr_t   dev_inode_xp;               /*! extended pointer on DEVFS root inode       */ 
56    xptr_t   external_inode_xp;          /*! extended pointer on DEVFS external inode   */ 
57}
58devfs_ctx_t;
59
60
61/*****************************************************************************************
62 * This fuction allocates memory from local cluster for a DEVFS context descriptor.
63 *****************************************************************************************
64 * @ return a pointer on the created context / return NULL if failure.
65 ****************************************************************************************/
66devfs_ctx_t * devfs_ctx_alloc( void );
67
68/*****************************************************************************************
69 * This function initialises the DEVFS context from arguments values, and link it
70 * to the relevant VFS context in the local cluster.
71 *****************************************************************************************
72 * @ devfs_ctx               : local pointer on DEVFS context.
73 * @ devfs_dev_inode_xp      : [out] extended pointer on  <dev> inode.
74 * @ devfs_external_inode_xp : [out] extended pointer on  <external> inode.
75 ****************************************************************************************/
76void devfs_ctx_init( devfs_ctx_t * devfs_ctx,
77                     xptr_t        devfs_dev_inode_xp,
78                     xptr_t        devfs_external_inode_xp );
79
80/*****************************************************************************************
81 * This function releases memory dynamically allocated for the DEVFS context.
82 *****************************************************************************************
83 * @ devfs_ctx   : local pointer on DEVFS context.
84 ****************************************************************************************/
85void devfs_ctx_destroy( devfs_ctx_t * devfs_ctx );
86
87/*****************************************************************************************
88 * This function start to create the DEVFS subtree.
89 * This function should be called once in the cluster containing the VFS parent inode.
90 * More precisely, it creates in cluster 0 the "dev" and "external" DEVFS directories.
91 * For each one, it creates the inode and link the associated dentry to parent inode.
92 * The DEVFS root inode is linked to the VFS parent inode identified by <parent_inode_xp>.
93 *****************************************************************************************
94 * @ parent_inode_xp         : extended pointer on the parent VFS inode.
95 * @ devfs_dev_inode_xp      : [out] extended pointer on created <dev> inode.
96 * @ devfs_external_inode_xp : [out] extended pointer on created <external> inode.
97 ****************************************************************************************/
98void devfs_global_init( xptr_t   parent_inode_xp,
99                        xptr_t * devfs_dev_inode_xp,
100                        xptr_t * devfs_external_inode_xp );
101
102/*****************************************************************************************
103 * This function completes the initialisation of the DEVFS subtree.
104 * It should be called once in each cluster.
105 * 1. In each cluster (i), it creates the "internal" directory,
106 *    linked to the DEVFS "dev" parent directory.
107 * 2. In each cluster (i), it creates - for each external chdev in cluster (i) -
108 *    a pseudo-file, linked to the DEVFS "external" parent directory.
109 * 3. In each cluster (i), it creates - for each internal chdev in cluster (i) -
110 *    a pseudo-file, linked to the DEVFS "internal" parent directory.
111 *****************************************************************************************
112 * @ devfs_dev_inode_xp      : extended pointer on DEVFS root inode.
113 * @ devfs_external_inode_xp : extended pointer on DEVFS external inode.
114 * @ devfs_internal_inode_xp : [out] extended pointer on created <internal> inode.
115 ****************************************************************************************/
116void devfs_local_init( xptr_t   devfs_dev_inode_xp,
117                       xptr_t   devfs_external_inode_xp,
118                       xptr_t * devfs_internal_inode_xp );
119                       
120/******************************************************************************************
121 * This function is called by the sys_read() and sys_write() functions.
122 * It moves <size> bytes between a TXT device, and an user space <u_buf> buffer.
123 * It uses the <file_xp> and <to_buffer> arguments, to call the relevant device function.
124 * It uses a kernel buffer allocated in the calling thread kernel stack.
125 * If the <size> argument is larger than CONFIG_TXT_KBUF_SIZE, the user buffer is split
126 * in smaller chunks to be copied from the user buffer to this kernel buffer.
127 ******************************************************************************************
128 * @ to_buffer : device -> buffer if true / buffer -> device if false.
129 * @ file_xp   : extended pointer on the remote file descriptor.
130 * @ u_buf     : user space buffer (virtual address).
131 * @ size      : requested number of bytes from offset.
132 * @ returns number of bytes actually moved if success / -1 if error.
133 *****************************************************************************************/
134int devfs_user_move( bool_t   to_buffer,
135                     xptr_t   file_xp, 
136                     char   * u_buf,
137                     uint32_t size );
138
139/******************************************************************************************
140 * As the DEVFS is dynamically build in memory during kernel init, all relevant
141 * information is contained in the Inode Tree. Therefore, this function simply
142 * access the xhtab contained in the <inode> descriptor, to get the  dentries
143 * to be copied in the dirent <array>.
144 ******************************************************************************************
145 * @ inode      : [in]  local pointer on directory inode.
146 * @ array      : [in]  local pointer on array of dirents.
147 * @ max_dirent : [in]  max number of slots in dirent array.
148 * @ min_dentry : [in]  index of first dentry to be copied into array.
149 * @ detailed   : [in]  dynamic inode creation if true.
150 * @ entries    : [out] number of dentries actually copied into array.
151 * @ done       : [out] Boolean true when last entry found.
152 * @ return 0 if success / return -1 if failure.
153 *****************************************************************************************/
154error_t devfs_get_user_dir( struct vfs_inode_s * inode,
155                            struct dirent      * array,
156                            uint32_t             max_dirent,
157                            uint32_t             min_dentry,
158                            bool_t               detailed,
159                            uint32_t           * entries,
160                            bool_t             * done );
161
162
163#endif  /* _DEVFS_H_ */
Note: See TracBrowser for help on using the repository browser.