source: trunk/kernel/vfs/vfs.c @ 266

Last change on this file since 266 was 266, checked in by alain, 5 years ago

Implement vfs_lseek() function.

File size: 56.9 KB
Line 
1/*
2 * vfs.c - Virtual File System implementation.
3 *
4 * Author  Mohamed Lamine Karaoui (2015)
5 *         Alain Greiner (2016)
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
26#include <kernel_config.h>
27#include <hal_types.h>
28#include <hal_atomic.h>
29#include <hal_special.h>
30#include <readlock.h>
31#include <spinlock.h>
32#include <printk.h>
33#include <list.h>
34#include <xlist.h>
35#include <slist.h>
36#include <xhtab.h>
37#include <rpc.h>
38#include <errno.h>
39#include <kmem.h>
40#include <mapper.h>
41#include <thread.h>
42#include <process.h>
43#include <vfs.h>
44#include <fatfs.h>
45#include <ramfs.h>
46#include <devfs.h>
47#include <syscalls.h>
48
49
50//////////////////////////////////////////////////////////////////////////////////////////
51//           Extern variables         
52//////////////////////////////////////////////////////////////////////////////////////////
53
54extern vfs_ctx_t   fs_context[FS_TYPES_NR];    // allocated in kernel_init.c
55
56 
57//////////////////////////////////////////////////////////////////////////////////////////
58//           Context related functions
59//////////////////////////////////////////////////////////////////////////////////////////
60
61////////////////////////////////////////
62void vfs_ctx_init( vfs_fs_type_t   type,
63                   uint32_t        attr,
64                       uint32_t        total_clusters,
65                       uint32_t        cluster_size,
66                       xptr_t          vfs_root_xp,
67                   void          * extend )
68{
69    vfs_ctx_t * vfs_ctx = &fs_context[type];
70
71    vfs_ctx->type           = type;
72    vfs_ctx->attr           = attr;
73    vfs_ctx->total_clusters = total_clusters;
74    vfs_ctx->cluster_size   = cluster_size;
75    vfs_ctx->vfs_root_xp    = vfs_root_xp;
76    vfs_ctx->extend         = extend;
77
78    spinlock_init( &vfs_ctx->lock );
79
80    bitmap_init( vfs_ctx->bitmap , BITMAP_SIZE(CONFIG_VFS_MAX_INODES) ); 
81}
82
83////////////////////////////////////////////
84error_t vfs_ctx_inum_alloc( vfs_ctx_t * ctx,
85                            uint32_t  * inum )
86{
87    // get lock on inum allocator
88    spinlock_lock( &ctx->lock );
89
90    // get lid from local inum allocator
91    uint32_t lid = bitmap_ffc( ctx->bitmap , CONFIG_VFS_MAX_INODES );
92
93    if( lid == -1 )   // no more free slot => error
94    {
95        // release lock
96        spinlock_unlock( &ctx->lock );
97
98        // return error
99        return 1;
100    }
101    else              // found => return inum
102    {
103        // set slot allocated
104        bitmap_set( ctx->bitmap , lid );
105
106        // release lock
107        spinlock_unlock( &ctx->lock );
108
109        // return inum
110        *inum = (((uint32_t)local_cxy) << 16) | (lid & 0xFFFF);
111        return 0;
112    }
113}
114
115////////////////////////////////////////////
116void vfs_ctx_inum_release( vfs_ctx_t * ctx,
117                           uint32_t    inum )
118{
119    bitmap_clear( ctx->bitmap , inum & 0xFFFF ); 
120}
121
122//////////////////////////////////////////////////////////////////////////////////////////
123//           Inode related functions
124//////////////////////////////////////////////////////////////////////////////////////////
125
126char * vfs_inode_type_str( uint32_t type )
127{
128    if     ( type == INODE_TYPE_FILE ) return "FILE";
129    else if( type == INODE_TYPE_DIR  ) return "DIR ";
130    else if( type == INODE_TYPE_FIFO ) return "FIFO";
131    else if( type == INODE_TYPE_PIPE ) return "PIPE";
132    else if( type == INODE_TYPE_SOCK ) return "SOCK";
133    else if( type == INODE_TYPE_DEV  ) return "DEV ";
134    else if( type == INODE_TYPE_SYML ) return "SYML";
135    else                               return "undefined";
136}
137
138//////////////////////////////////////////////////////
139error_t vfs_inode_create( xptr_t            dentry_xp,
140                          vfs_fs_type_t     fs_type,
141                          vfs_inode_type_t  inode_type,
142                          void            * extend,
143                          uint32_t          attr,
144                          uint32_t          rights,
145                          uid_t             uid,
146                          gid_t             gid,
147                          xptr_t          * inode_xp )
148{
149    mapper_t         * mapper;     // associated mapper( to be allocated)
150    vfs_inode_t      * inode;      // inode descriptor (to be allocated)
151    uint32_t           inum;       // inode identifier (to be allocated)
152    vfs_ctx_t        * ctx;        // file system context
153        kmem_req_t         req;        // request to kernel memory allocator
154    error_t            error;
155
156    // check fs type and get pointer on context
157    if     ( fs_type == FS_TYPE_FATFS ) ctx = &fs_context[FS_TYPE_FATFS];
158    else if( fs_type == FS_TYPE_RAMFS ) ctx = &fs_context[FS_TYPE_RAMFS];
159    else if( fs_type == FS_TYPE_DEVFS ) ctx = &fs_context[FS_TYPE_DEVFS];
160    else
161    {
162        ctx = NULL;
163                printk("\n[PANIC] in %s : illegal file system type = %d\n", __FUNCTION__ , fs_type );
164        hal_core_sleep();
165    }
166
167    // allocate inum
168    error = vfs_ctx_inum_alloc( ctx , &inum );
169
170    if( error )
171    {
172        printk("\n[ERROR] in %s : cannot allocate inum\n", __FUNCTION__ );
173        return ENOMEM;
174    }
175
176    // allocate memory for mapper
177    mapper = mapper_create( fs_type );
178
179    if( mapper == NULL )
180    {
181        printk("\n[ERROR] in %s : cannot allocate mapper\n", __FUNCTION__ );
182        vfs_ctx_inum_release( ctx , inum );
183        return ENOMEM;
184    }
185
186    // allocate memory for VFS inode descriptor
187        req.type  = KMEM_VFS_INODE;
188        req.size  = sizeof(vfs_inode_t);
189    req.flags = AF_KERNEL | AF_ZERO;
190        inode     = (vfs_inode_t *)kmem_alloc( &req );
191
192    if( inode == NULL )
193    {
194        printk("\n[ERROR] in %s : cannot allocate inode descriptor\n", __FUNCTION__ );
195        vfs_ctx_inum_release( ctx , inum );
196        mapper_destroy( mapper );
197        return ENOMEM;
198    }
199
200    // initialize inode descriptor
201    inode->gc         = 0;
202    inode->type       = inode_type;
203    inode->inum       = inum;
204    inode->attr       = attr;
205    inode->rights     = rights;
206    inode->uid        = uid;
207    inode->gid        = gid;
208    inode->refcount   = 0;
209    inode->parent_xp  = dentry_xp;
210    inode->ctx        = ctx;
211    inode->mapper     = mapper;
212    inode->extend     = extend;
213
214    // initialise inode field in mapper
215    mapper->inode     = inode;
216 
217    // initialise threads waiting queue
218    xlist_root_init( XPTR( local_cxy , &inode->wait_root ) );
219
220    // initialize dentries hash table
221    xhtab_init( &inode->children , XHTAB_DENTRY_TYPE );
222
223    // initialize inode locks
224    remote_rwlock_init( XPTR( local_cxy , &inode->data_lock ) );
225    remote_spinlock_init( XPTR( local_cxy , &inode->main_lock ) );
226
227    // return extended pointer on inode
228    *inode_xp = XPTR( local_cxy , inode );
229    return 0;
230
231}  // end vfs_inode_create() 
232
233/////////////////////////////////////////////
234void vfs_inode_destroy( vfs_inode_t * inode )
235{
236    if( inode->refcount )
237    {
238        printk("\n[PANIC] in %s : inode refcount non zero\n", __FUNCTION__ );
239        hal_core_sleep(); 
240    }       
241
242    // release memory allocated for mapper
243    mapper_destroy( inode->mapper );
244
245    // release memory allocate for inode descriptor
246        kmem_req_t req;
247        req.ptr   = inode;
248        req.type  = KMEM_VFS_INODE;
249        kmem_free( &req );
250
251}  // end vfs_inode_destroy()
252
253/////////////////////////////////////////////
254error_t vfs_inode_load( vfs_inode_t * parent,
255                        char        * name,
256                        xptr_t        child_xp )
257{
258    vfs_dmsg("\n[INFO] %s : enter for child <%s>\n",
259             __FUNCTION__ , name );
260
261    error_t error = 0;
262
263    assert( (parent != NULL) , __FUNCTION__ , "parent pointer is NULL\n");
264
265    assert( (child_xp != XPTR_NULL) , __FUNCTION__ , "child pointer is NULL\n");
266
267    // get parent inode FS type
268    vfs_fs_type_t fs_type = parent->ctx->type;
269
270    // call relevant FS function
271    if( fs_type == FS_TYPE_FATFS )
272    {
273        error = fatfs_inode_load( parent , name , child_xp );
274    }
275    else if( fs_type == FS_TYPE_RAMFS )
276    {
277        assert( false , __FUNCTION__ , "should not be called for RAMFS\n" );
278    }
279    else if( fs_type == FS_TYPE_DEVFS )
280    {
281        assert( false , __FUNCTION__ , "should not be called for DEVFS\n" );
282    }
283    else
284    {
285        assert( false , __FUNCTION__ , "undefined file system type\n" );
286    }
287
288    vfs_dmsg("\n[INFO] %s : exit for child <%s>\n",
289             __FUNCTION__ , name );
290
291    return error;
292
293} // end vfs_load_inode()
294
295////////////////////////////////////////////
296void vfs_inode_remote_up( xptr_t  inode_xp )
297{
298    // get inode cluster and local pointer
299    cxy_t         inode_cxy = GET_CXY( inode_xp );
300    vfs_inode_t * inode_ptr = (vfs_inode_t *)GET_PTR( inode_xp );
301
302    hal_remote_atomic_add( XPTR( inode_cxy , &inode_ptr->refcount ) , 1 );   
303}
304
305//////////////////////////////////////////////
306void vfs_inode_remote_down( xptr_t  inode_xp )
307{
308    // get inode cluster and local pointer
309    cxy_t         inode_cxy = GET_CXY( inode_xp );
310    vfs_inode_t * inode_ptr = (vfs_inode_t *)GET_PTR( inode_xp );
311
312    hal_remote_atomic_add( XPTR( inode_cxy , &inode_ptr->refcount ) , -1 );   
313}
314
315//////////////////////////////////////////////
316uint32_t vfs_inode_get_size( xptr_t inode_xp )
317{
318    // get inode cluster and local pointer
319    cxy_t         cxy = GET_CXY( inode_xp );
320    vfs_inode_t * ptr = (vfs_inode_t *)GET_PTR( inode_xp );
321
322    // get size
323    remote_rwlock_rd_lock( XPTR( cxy , &ptr->data_lock ) );
324    uint32_t size = hal_remote_lw( XPTR( cxy , &ptr->size ) );
325    remote_rwlock_rd_unlock( XPTR( cxy , &ptr->data_lock ) );
326    return size;
327}
328
329////////////////////////////////////////////
330void vfs_inode_set_size( xptr_t    inode_xp,
331                              uint32_t  size )
332{
333    // get inode cluster and local pointer
334    cxy_t         cxy = GET_CXY( inode_xp );
335    vfs_inode_t * ptr = (vfs_inode_t *)GET_PTR( inode_xp );
336
337    // set size
338    remote_rwlock_wr_unlock( XPTR( cxy , &ptr->data_lock ) );
339    hal_remote_sw( XPTR( cxy , &ptr->size ) , size );
340    remote_rwlock_wr_unlock( XPTR( cxy , &ptr->data_lock ) );
341}
342
343////////////////////////////////////////
344void vfs_inode_unlock( xptr_t inode_xp )
345{
346    // get inode cluster and local pointer
347    cxy_t         cxy = GET_CXY( inode_xp );
348    vfs_inode_t * ptr = (vfs_inode_t *)GET_PTR( inode_xp );
349
350    // release the main lock
351    remote_spinlock_unlock( XPTR( cxy , &ptr->main_lock ) );
352}
353
354//////////////////////////////////////
355void vfs_inode_lock( xptr_t inode_xp )
356{
357    // get inode cluster and local pointer
358    cxy_t         cxy = GET_CXY( inode_xp );
359    vfs_inode_t * ptr = (vfs_inode_t *)GET_PTR( inode_xp );
360
361    // get the main lock
362    remote_spinlock_lock( XPTR( cxy , &ptr->main_lock ) );
363}
364
365/////////////////////////////////////////
366xptr_t vfs_inode_owner( xptr_t inode_xp )
367{
368    // get inode cluster and local pointer
369    cxy_t         cxy = GET_CXY( inode_xp );
370    vfs_inode_t * ptr = (vfs_inode_t *)GET_PTR( inode_xp );
371
372    // get the main lock
373    return remote_spinlock_owner( XPTR( cxy , &ptr->main_lock ) );
374}
375
376/////////////////////////////////////////
377void vfs_inode_display( xptr_t inode_xp )
378{
379    cxy_t          inode_cxy;
380    vfs_inode_t  * inode_ptr;
381    xptr_t         dentry_xp;
382    cxy_t          dentry_cxy;
383    vfs_dentry_t * dentry_ptr;
384   
385    char           name[CONFIG_VFS_MAX_NAME_LENGTH];
386
387    // get inode cluster and local pointer
388    inode_cxy = GET_CXY( inode_xp );
389    inode_ptr = (vfs_inode_t *)GET_PTR( inode_xp );
390
391    // get parent dentry
392    dentry_xp  = hal_remote_lwd( XPTR( inode_cxy , &inode_ptr->parent_xp ) );
393
394    // get local copy of name
395    if( dentry_xp == XPTR_NULL )  // it is the VFS root
396    {
397        strcpy( name , "/" );
398    }
399    else                          // not the VFS root
400    {
401        dentry_cxy = GET_CXY( dentry_xp );
402        dentry_ptr = (vfs_dentry_t *)GET_PTR( dentry_xp );
403
404        hal_remote_strcpy( XPTR( local_cxy  , name ) , 
405                           XPTR( dentry_cxy , &dentry_ptr->name ) );
406    }
407
408    // display inode header
409    printk("\n*** inode <%s> / inode_xp = %l / dentry_xp = %l ***\n",
410           name , inode_xp , dentry_xp );
411
412    // display children from xhtab
413    xhtab_display( XPTR( inode_cxy , &inode_ptr->children ) );
414
415}  // end vfs_inode_display()
416
417////////////////////////////////////////////////////////////////////////////////////////////
418//           Dentry related functions
419//////////////////////////////////////////////////////////////////////////////////////////
420
421///////////////////////////////////////////////////
422error_t vfs_dentry_create( vfs_fs_type_t   fs_type,
423                           char          * name,
424                           vfs_inode_t   * parent,
425                           xptr_t        * dentry_xp )
426{
427    vfs_ctx_t      * ctx;        // context descriptor
428    vfs_dentry_t   * dentry;     // dentry descriptor (to be allocated)
429        kmem_req_t       req;        // request to kernel memory allocator
430
431    // get pointer on context
432    if     ( fs_type == FS_TYPE_FATFS ) ctx = &fs_context[FS_TYPE_FATFS];
433    else if( fs_type == FS_TYPE_RAMFS ) ctx = &fs_context[FS_TYPE_RAMFS];
434    else if( fs_type == FS_TYPE_DEVFS ) ctx = &fs_context[FS_TYPE_DEVFS];
435    else
436    {
437        ctx = NULL;
438        printk("\n[PANIC] in %s : undefined file system type\n", __FUNCTION__ );
439        hal_core_sleep();
440    }
441
442    // get name length
443    uint32_t length = strlen( name );
444
445    if( length >= CONFIG_VFS_MAX_NAME_LENGTH )
446    {
447        printk("\n[ERROR] in %s : name too long\n", __FUNCTION__ );
448        return EINVAL;
449    }
450
451    // allocate memory for dentry descriptor
452        req.type  = KMEM_VFS_DENTRY;
453        req.size  = sizeof(vfs_dentry_t);
454    req.flags = AF_KERNEL | AF_ZERO;
455        dentry     = (vfs_dentry_t *)kmem_alloc( &req );
456
457    if( dentry == NULL )
458    {
459        printk("\n[ERROR] in %s : cannot allocate dentry descriptor\n", __FUNCTION__ );
460        return ENOMEM;
461    }
462
463    // initialize dentry descriptor
464
465    dentry->ctx     = ctx;
466    dentry->length  = length;
467    dentry->parent  = parent;
468    strcpy( dentry->name , name );
469
470    // register dentry in hash table rooted in parent inode
471    xhtab_insert( XPTR( local_cxy , &parent->children ),
472                  name, 
473                  XPTR( local_cxy , &dentry->list ) );
474
475    // return extended pointer on dentry
476    *dentry_xp = XPTR( local_cxy , dentry );
477
478    return 0;
479
480}  // end vfs_dentry_create()
481
482////////////////////////////////////////////////
483void vfs_dentry_destroy( vfs_dentry_t * dentry )
484{
485    if( dentry->refcount )
486    {
487        printk("\n[PANIC] in %s : dentry refcount non zero\n", __FUNCTION__ );
488        hal_core_sleep(); 
489    }       
490
491        kmem_req_t req;
492        req.ptr   = dentry;
493        req.type  = KMEM_VFS_DENTRY;
494        kmem_free( &req );
495}
496
497
498
499//////////////////////////////////////////////////////////////////////////////////////////
500//           File descriptor related functions
501//////////////////////////////////////////////////////////////////////////////////////////
502
503/////////////////////////////////////////////
504error_t vfs_file_create( vfs_inode_t * inode,
505                         uint32_t      attr,
506                         xptr_t      * file_xp )
507{
508    vfs_file_t  * file;
509        kmem_req_t    req;
510
511    // allocate memory for new file descriptor
512        req.type  = KMEM_VFS_FILE;
513        req.size  = sizeof(vfs_file_t);
514    req.flags = AF_KERNEL | AF_ZERO;
515        file      = (vfs_file_t *)kmem_alloc( &req );
516
517    if( file == NULL ) return ENOMEM;
518
519    // initializes new file descriptor
520    file->gc       = 0;
521    file->type     = inode->type;
522    file->attr     = attr;
523    file->offset   = 0;
524    file->refcount = 0;
525    file->inode    = inode;
526    file->ctx      = inode->ctx;
527    file->mapper   = inode->mapper;
528
529    remote_rwlock_init( XPTR( local_cxy , &file->lock ) );
530
531    *file_xp = XPTR( local_cxy , file );
532    return 0;
533
534}  // end vfs_file_create()
535
536///////////////////////////////////////////
537void vfs_file_destroy( vfs_file_t *  file )
538{
539    if( file->refcount )
540    {
541        printk("\n[PANIC] in %s : file refcount non zero\n", __FUNCTION__ );
542        hal_core_sleep(); 
543    }       
544
545        kmem_req_t req;
546        req.ptr   = file;
547        req.type  = KMEM_VFS_FILE;
548        kmem_free( &req );
549
550}  // end vfs_file_destroy()
551
552
553////////////////////////////////////////
554void vfs_file_count_up( xptr_t file_xp )
555{
556    // get file cluster and local pointer
557    cxy_t        file_cxy = GET_CXY( file_xp );
558    vfs_file_t * file_ptr = (vfs_file_t *)GET_PTR( file_xp ); 
559
560    // atomically increment count
561    hal_remote_atomic_add( XPTR( file_cxy , &file_ptr->refcount ) , 1 ); 
562}
563
564//////////////////////////////////////////
565void vfs_file_count_down( xptr_t file_xp )
566{
567    // get file cluster and local pointer
568    cxy_t        file_cxy = GET_CXY( file_xp );
569    vfs_file_t * file_ptr = (vfs_file_t *)GET_PTR( file_xp ); 
570
571    // atomically decrement count
572    hal_remote_atomic_add( XPTR( file_cxy , &file_ptr->refcount ) , -1 ); 
573}
574
575//////////////////////////////////////////////////////////////////////////////////////////
576//           File access related functions
577//////////////////////////////////////////////////////////////////////////////////////////
578
579////////////////////////////////////
580error_t vfs_open( xptr_t     cwd_xp,
581                          char     * path,
582                          uint32_t   flags,
583                  uint32_t   mode, 
584                          xptr_t   * new_file_xp,
585                  uint32_t * new_file_id )
586{
587    error_t       error;
588    xptr_t        inode_xp;     // extended pointer on target inode
589    cxy_t         inode_cxy;    // inode cluster identifier       
590    vfs_inode_t * inode_ptr;    // inode local pointer
591    uint32_t      file_attr;    // file descriptor attributes
592    uint32_t      lookup_mode;  // lookup working mode       
593    xptr_t        file_xp;      // extended pointer on created file descriptor
594    uint32_t      file_id;      // created file descriptor index in reference fd_array
595
596    vfs_dmsg("\n[INFO] %s : enters for <%s> at cycle %d\n",
597             __FUNCTION__ , path , (uint32_t)hal_time_stamp() );
598
599    // compute lookup working mode
600    lookup_mode = VFS_LOOKUP_OPEN;
601    if( (flags & O_DIR    )      )  lookup_mode |= VFS_LOOKUP_DIR;
602    if( (flags & O_CREAT  )      )  lookup_mode |= VFS_LOOKUP_CREATE;
603    if( (flags & O_EXCL   )      )  lookup_mode |= VFS_LOOKUP_EXCL;
604 
605    // compute attributes for the created file
606    file_attr = 0;
607    if( (flags & O_RDONLY ) == 0 )  file_attr |= FD_ATTR_READ_ENABLE;
608    if( (flags & O_WRONLY ) == 0 )  file_attr |= FD_ATTR_WRITE_ENABLE;
609    if( (flags & O_SYNC   )      )  file_attr |= FD_ATTR_SYNC;
610    if( (flags & O_APPEND )      )  file_attr |= FD_ATTR_APPEND;
611    if( (flags & O_CLOEXEC)      )  file_attr |= FD_ATTR_CLOSE_EXEC;
612
613    // get extended pointer on target inode
614    error = vfs_lookup( cwd_xp , path , lookup_mode , &inode_xp );
615
616    vfs_dmsg("\n[INFO] %s : get inode_xp = %l for <%s> at cycle %d\n",
617             __FUNCTION__ , inode_xp , path , hal_get_cycles() );
618
619    if( error ) return error;
620
621    // get target inode cluster and local pointer
622    inode_cxy = GET_CXY( inode_xp );
623    inode_ptr = (vfs_inode_t *)GET_PTR( inode_xp );
624   
625    // create a new file descriptor in cluster containing inode
626    if( inode_cxy == local_cxy )      // target cluster is local
627    {
628        error = vfs_file_create( inode_ptr , file_attr , &file_xp );
629    }
630    else                              // target cluster is remote
631    {
632        rpc_vfs_file_create_client( inode_cxy , inode_ptr , file_attr , &file_xp , &error );
633    }
634
635    if( error )  return error;
636
637    // allocate and register a new file descriptor index in reference cluster fd_array
638    error = process_fd_register( file_xp , &file_id );
639
640    if( error ) return error;
641
642    vfs_dmsg("\n[INFO] %s : exit for <%s> / file_id = %d / file_xp = %l / at cycle %d\n",
643             __FUNCTION__ , path , file_id , file_xp , hal_get_cycles() );
644
645    // success
646    *new_file_xp = file_xp;
647    *new_file_id = file_id;
648    return 0;
649
650}  // end vfs_open()
651
652/////////////////////////////////////
653error_t vfs_move( bool_t   to_buffer,
654                  bool_t   is_user,
655                  xptr_t   file_xp,
656                  void   * buffer,
657                  uint32_t size )
658{
659    assert( ( file_xp != XPTR_NULL ) , __FUNCTION__ , "file_xp == XPTR_NULL" );
660
661    cxy_t              file_cxy;     // remote file descriptor cluster
662    vfs_file_t       * file_ptr;     // remote file descriptor local pointer
663    vfs_inode_type_t   inode_type;
664    uint32_t           file_offset;  // current offset in file
665    mapper_t         * mapper;
666    error_t            error;
667
668    // get cluster and local pointer on remote file descriptor
669    file_cxy  = GET_CXY( file_xp );
670    file_ptr  = (vfs_file_t *)GET_PTR( file_xp );
671
672    // get inode type from remote file descriptor
673    inode_type = hal_remote_lw( XPTR( file_cxy , &file_ptr->type   ) );
674   
675    // action depends on inode type
676    if( inode_type == INODE_TYPE_FILE )
677    {
678        // get mapper pointer and file offset from file descriptor
679        file_offset = hal_remote_lw( XPTR( file_cxy , &file_ptr->offset ) );
680        mapper = (mapper_t *)hal_remote_lpt( XPTR( file_cxy , &file_ptr->mapper ) );
681
682        // move data between mapper and buffer
683        if( file_cxy == local_cxy )
684        {
685            error = mapper_move_buffer( mapper,
686                                        to_buffer,
687                                        is_user,
688                                        file_offset,
689                                        buffer,
690                                        size );
691        }
692        else
693        {
694            rpc_mapper_move_buffer_client( file_cxy,
695                                           mapper,
696                                           to_buffer,
697                                           is_user,
698                                           file_offset,
699                                           buffer,
700                                           size,
701                                           &error );
702        } 
703
704        if( error ) return -1;
705        else        return size;
706    }
707    else 
708    {
709        printk("\n[ERROR] in %s : inode is not a file", __FUNCTION__ );
710        return -1;
711    }
712}  // end vfs_move()
713
714//////////////////////////////////////
715error_t vfs_lseek( xptr_t     file_xp,
716                   uint32_t   offset,
717                   uint32_t   whence, 
718                   uint32_t * new_offset )
719{
720    xptr_t         offset_xp;
721    xptr_t         lock_xp;
722    cxy_t          file_cxy;
723    vfs_file_t  *  file_ptr;
724    vfs_inode_t *  inode_ptr;
725    uint32_t       new;
726
727    assert( (file_xp != XPTR_NULL) , __FUNCTION__ , "file_xp == XPTR_NULL" );
728
729    // get cluster and local pointer on remote file descriptor
730    file_cxy = GET_CXY( file_xp );
731    file_ptr = (vfs_file_t *)GET_PTR( file_xp );
732
733    // build extended pointers on lock and offset
734    offset_xp = XPTR( file_cxy , &file_ptr->offset );
735    lock_xp   = XPTR( file_cxy , &file_ptr->lock );
736
737    // take file descriptor lock
738    remote_rwlock_wr_lock( lock_xp );
739
740    if      ( whence == SEEK_CUR )   // new = current + offset
741    {
742        new = hal_remote_lw( offset_xp ) + offset;
743    }
744    else if ( whence == SEEK_SET )   // new = offset
745    {
746        new = offset;
747    }
748    else if ( whence == SEEK_END )   // new = size + offset
749    { 
750        // get local pointer on remote inode
751        inode_ptr = (vfs_inode_t *)hal_remote_lpt( XPTR( file_cxy , &file_ptr->inode ) );
752
753        new = hal_remote_lw( XPTR( file_cxy , &inode_ptr->size ) ) + offset;
754    }
755    else
756    {
757        printk("\n[ERROR] in %s : illegal whence value\n", __FUNCTION__ );
758        remote_rwlock_wr_unlock( lock_xp );
759        return -1;
760    }
761
762    // set new offset
763    hal_remote_sw( offset_xp , new );
764
765    // release file descriptor lock
766    remote_rwlock_wr_unlock( lock_xp );
767
768    // success
769    *new_offset = new;
770    return 0;
771
772}  // vfs_lseek()
773
774///////////////////////////////////
775error_t vfs_close( xptr_t   file_xp,
776                   uint32_t file_id )
777{
778    assert( (file_xp != XPTR_NULL) , __FUNCTION__ , "file_xp == XPTR_NULL" );
779
780    assert( (file_id < CONFIG_PROCESS_FILE_MAX_NR) , __FUNCTION__ , "illegal file_id" );
781
782    thread_t  * this    = CURRENT_THREAD;
783    process_t * process = this->process;
784
785    // get cluster and local pointer on remote file descriptor
786    cxy_t        file_cxy = GET_CXY( file_xp );
787    vfs_file_t * file_ptr = (vfs_file_t *)GET_PTR( file_xp );
788
789    // get local pointer on local cluster manager
790    cluster_t * cluster = LOCAL_CLUSTER;
791
792    // get owner process cluster and lpid
793    cxy_t   owner_cxy  = CXY_FROM_PID( process->pid );
794    lpid_t  lpid       = LPID_FROM_PID( process->pid );
795
796    // get extended pointers on copies root and lock
797    xptr_t root_xp = XPTR( owner_cxy , &cluster->pmgr.copies_root[lpid] );
798    xptr_t lock_xp = XPTR( owner_cxy , &cluster->pmgr.copies_lock[lpid] );
799
800    // take the lock protecting the copies
801    remote_spinlock_lock( lock_xp );
802
803    // 1) loop on the process descriptor copies to cancel all fd_array[file_id] entries
804    xptr_t  iter_xp;
805    XLIST_FOREACH( root_xp , iter_xp )
806    {
807        xptr_t      process_xp  = XLIST_ELEMENT( iter_xp , process_t , copies_list );
808        cxy_t       process_cxy = GET_CXY( process_xp );
809        process_t * process_ptr = (process_t *)GET_PTR( process_xp );
810
811        xptr_t lock_xp  = XPTR( process_cxy , &process_ptr->fd_array.lock );
812        xptr_t entry_xp = XPTR( process_cxy , &process_ptr->fd_array.array[file_id] );
813
814        // lock is required for atomic write of a 64 bits word
815        remote_rwlock_wr_lock( lock_xp );
816        hal_remote_swd( entry_xp , XPTR_NULL );
817        remote_rwlock_wr_unlock( lock_xp );
818
819        hal_fence();
820    }   
821
822    // 2) release memory allocated to file descriptor in remote cluster
823    if( file_cxy == local_cxy )             // file cluster is local
824    {
825        vfs_file_destroy( file_ptr );
826    }
827    else                                    // file cluster is local
828    {
829        rpc_vfs_file_destroy_client( file_cxy , file_ptr );
830    }
831
832    return 0;
833
834}  // end vfs_close()
835
836////////////////////////////////////
837error_t vfs_unlink( xptr_t   cwd_xp,
838                    char   * path )
839{
840    printk("\n[PANIC] %s non implemented\n", __FUNCTION__ );
841    hal_core_sleep();
842    return 0;
843}  // vfs_unlink()
844
845///////////////////////////////////////
846error_t vfs_stat( xptr_t       file_xp,
847                  vfs_stat_t * k_stat )
848{
849    printk("\n[PANIC] %s non implemented\n", __FUNCTION__ );
850    hal_core_sleep();
851    return 0;
852}
853
854////////////////////////////////////////////
855error_t vfs_readdir( xptr_t         file_xp,
856                     vfs_dirent_t * k_dirent )
857{
858    printk("\n[PANIC] %s non implemented\n", __FUNCTION__ );
859    hal_core_sleep();
860    return 0;
861}
862
863//////////////////////////////////////
864error_t vfs_mkdir( xptr_t     file_xp,
865                   char     * path,
866                   uint32_t   mode )
867{
868    printk("\n[PANIC] %s non implemented\n", __FUNCTION__ );
869    hal_core_sleep();
870    return 0;
871}
872
873////////////////////////////////////
874error_t vfs_rmdir( xptr_t   file_xp,
875                   char   * path )
876{
877    printk("\n[PANIC] %s non implemented\n", __FUNCTION__ );
878    hal_core_sleep();
879    return 0;
880}
881
882///////////////////////////////////
883error_t vfs_chdir( xptr_t   cwd_xp,
884                   char   * path )
885{
886    error_t           error;
887    xptr_t            inode_xp;     // extended pointer on target inode
888    cxy_t             inode_cxy;    // target inode cluster identifier       
889    vfs_inode_t     * inode_ptr;    // target inode local pointer
890    uint32_t          mode;         // lookup working mode       
891    vfs_inode_type_t  inode_type;   // target inode type
892
893    // set lookup working mode
894    mode = 0;
895
896    // get extended pointer on target inode
897    error = vfs_lookup( cwd_xp , path , mode , &inode_xp );
898
899    if( error ) return error;
900
901    // get inode cluster and local pointer
902    inode_cxy = GET_CXY( inode_xp );
903    inode_ptr = (vfs_inode_t *)GET_PTR( inode_xp );
904
905    // get inode type from remote file
906    inode_type = hal_remote_lw( XPTR( inode_cxy , &inode_ptr->type ) );
907
908    if( inode_type != INODE_TYPE_DIR )
909    {
910        CURRENT_THREAD->errno = ENOTDIR;
911        return -1;
912    }
913
914    printk("\n[PANIC] %s non fully implemented\n", __FUNCTION__ );
915    hal_core_sleep();
916    return 0;
917}
918
919///////////////////////////////////
920error_t vfs_chmod( xptr_t   cwd_xp,
921                   char   * path,
922                   uint32_t rights )
923{
924    error_t           error;
925    xptr_t            inode_xp;     // extended pointer on target inode
926    cxy_t             inode_cxy;    // inode cluster identifier       
927    vfs_inode_t     * inode_ptr;    // inode local pointer
928    uint32_t          mode;         // lookup working mode
929    vfs_inode_type_t  inode_type;   // target inode type
930
931    // set lookup working mode
932    mode = 0;
933 
934    // get extended pointer on target inode
935    error = vfs_lookup( cwd_xp , path , mode , &inode_xp );
936
937    if( error ) return error;
938
939    // get inode cluster and local pointer
940    inode_cxy = GET_CXY( inode_xp );
941    inode_ptr = (vfs_inode_t *)GET_PTR( inode_xp );
942   
943    // get inode type from remote inode
944    inode_type = hal_remote_lw( XPTR( inode_cxy , &inode_ptr->type ) );
945
946   
947    printk("\n[PANIC] %s non fully implemented\n", __FUNCTION__ );
948    hal_core_sleep();
949    return 0;
950}
951
952///////////////////////////////////
953error_t vfs_mkfifo( xptr_t   cwd_xp,
954                    char   * path,
955                    uint32_t rights )
956{
957    printk("\n[PANIC] in %s : not implemented yet\n", __FUNCTION__ );
958    hal_core_sleep(); 
959    return 0;
960}
961
962
963
964//////////////////////////////////////////////////////////////////////////////////////////
965//            Inode Tree functions
966//////////////////////////////////////////////////////////////////////////////////////////
967
968/////////////////////////////////
969cxy_t vfs_cluster_random_select()
970{
971    uint32_t  x_size    = LOCAL_CLUSTER->x_size;
972    uint32_t  y_size    = LOCAL_CLUSTER->y_size;
973    uint32_t  y_width   = LOCAL_CLUSTER->y_width;
974    uint32_t  index     = ( hal_get_cycles() + hal_get_gid() ) % (x_size * y_size);
975    uint32_t  x         = index / y_size;   
976    uint32_t  y         = index % y_size;
977
978    return (x<<y_width) + y;
979}
980
981
982//////////////////////////////////////////////////////////////////////////
983// This static function is called by the vfs_display() function.
984//////////////////////////////////////////////////////////////////////////
985static void vfs_recursive_display( xptr_t   inode_xp,
986                                   xptr_t   name_xp,
987                                   xptr_t   dentry_xp,
988                                   uint32_t indent )
989{
990    cxy_t              inode_cxy;
991    vfs_inode_t      * inode_ptr;
992    vfs_inode_type_t   inode_type;
993    xptr_t             children_xp;    // extended pointer on children xhtab
994
995    xptr_t             child_dentry_xp;
996    cxy_t              child_dentry_cxy;
997    vfs_dentry_t     * child_dentry_ptr;
998    xptr_t             child_inode_xp;
999    xptr_t             child_dentry_name_xp;
1000
1001    char               name[CONFIG_VFS_MAX_NAME_LENGTH];
1002
1003    char *             indent_str[] = { "",                                  // level 0
1004                                        "  ",                                // level 1
1005                                        "    ",                              // level 2
1006                                        "      ",                            // level 3
1007                                        "        ",                          // level 4
1008                                        "          ",                        // level 5
1009                                        "            ",                      // level 6
1010                                        "              ",                    // level 7
1011                                        "                ",                  // level 8
1012                                        "                  ",                // level 9
1013                                        "                    ",              // level 10
1014                                        "                      ",            // level 11
1015                                        "                        ",          // level 12
1016                                        "                          ",        // level 13
1017                                        "                            ",      // level 14
1018                                        "                              " };  // level 15
1019
1020    assert( (inode_xp != XPTR_NULL) , __FUNCTION__ , "inode_xp cannot be NULL\n" );
1021    assert( (name_xp  != XPTR_NULL) , __FUNCTION__ , "name_xp cannot be NULL\n" );
1022    assert( (indent < 16)           , __FUNCTION__ , "depth cannot be larger than 15\n" );
1023   
1024    // get inode cluster and local pointer
1025    inode_cxy = GET_CXY( inode_xp );
1026    inode_ptr = (vfs_inode_t *)GET_PTR( inode_xp );
1027
1028    // get inode type
1029    inode_type = hal_remote_lw( XPTR( inode_cxy , &inode_ptr->type ) );
1030
1031    // make a local copy of node name
1032    hal_remote_strcpy( XPTR( local_cxy , name ) , name_xp );
1033
1034    // display inode
1035    printk("%s%s <%s> inode_xp = %l / dentry_xp = %l\n",
1036           indent_str[indent], vfs_inode_type_str( inode_type ), 
1037           name , inode_xp , dentry_xp );
1038
1039    // scan directory entries 
1040    if( inode_type == INODE_TYPE_DIR )
1041    {
1042        // get extended pointer on directory entries xhtab
1043        children_xp =  XPTR( inode_cxy , &inode_ptr->children );
1044
1045        // get xhtab lock
1046        xhtab_read_lock( children_xp );
1047
1048        // get first dentry from xhtab
1049        child_dentry_xp = xhtab_get_first( children_xp );
1050
1051        while( child_dentry_xp != XPTR_NULL )
1052        {
1053            // get dentry cluster and local pointer
1054            child_dentry_cxy = GET_CXY( child_dentry_xp );
1055            child_dentry_ptr = (vfs_dentry_t *)GET_PTR( child_dentry_xp );
1056
1057            // get extended pointer on child inode
1058            child_inode_xp = hal_remote_lwd( XPTR( child_dentry_cxy,
1059                                                   &child_dentry_ptr->child_xp ) );
1060
1061            // get extended pointer on dentry name
1062            child_dentry_name_xp = XPTR( child_dentry_cxy , &child_dentry_ptr->name );
1063
1064            // recursive call on child inode
1065            vfs_recursive_display( child_inode_xp,
1066                                   child_dentry_name_xp,
1067                                   child_dentry_xp,
1068                                   indent+1 );
1069
1070            // get next dentry
1071            child_dentry_xp = xhtab_get_next( children_xp );
1072        }
1073
1074        // release xhtab lock
1075        xhtab_read_unlock( children_xp );
1076    }
1077}  // end vfs_recursive_display()
1078
1079///////////////////////////////////
1080void vfs_display( xptr_t inode_xp )
1081{
1082    xptr_t         name_xp;
1083    xptr_t         dentry_xp; 
1084    cxy_t          dentry_cxy;
1085    vfs_dentry_t * dentry_ptr;
1086
1087    // get target inode cluster and local pointer
1088    cxy_t         inode_cxy = GET_CXY( inode_xp );
1089    vfs_inode_t * inode_ptr = (vfs_inode_t *)GET_PTR( inode_xp );
1090
1091    // get extended pointer on associated dentry
1092    dentry_xp = hal_remote_lwd( XPTR( inode_cxy , &inode_ptr->parent_xp ) );
1093
1094    // check if target inode is the File System root
1095    if( dentry_xp == XPTR_NULL )
1096    {
1097        // build extended pointer on root name
1098        name_xp = XPTR( local_cxy , "/" );
1099    }
1100    else
1101    {
1102        // get dentry cluster and local pointer
1103        dentry_cxy = GET_CXY( dentry_xp );
1104        dentry_ptr = (vfs_dentry_t *)GET_PTR( dentry_xp );
1105
1106        // get extended pointer on dentry name
1107        name_xp = XPTR( dentry_cxy , &dentry_ptr->name );
1108    }
1109
1110    // print header
1111    printk("\n*** VFS ***\n");
1112
1113    // call recursive function
1114    vfs_recursive_display( inode_xp , name_xp , dentry_xp , 0 );
1115
1116}  // end vfs_display()
1117
1118//////////////////////////////////////////////////////////////////////////////////////////
1119// This function is used by the vfs_lookup() function.
1120// It takes an extended pointer on a remote inode (parent directory inode),
1121// and check access_rights violation for the calling thread.
1122// It can be used by any thread running in any cluster.
1123//////////////////////////////////////////////////////////////////////////////////////////
1124// @ inode_xp    : extended pointer on inode.
1125// @ client_uid  : client thread user ID
1126// @ client_gid  : client thread group ID
1127// @ return true if access rights are violated.
1128//////////////////////////////////////////////////////////////////////////////////////////
1129bool_t vfs_access_denied( xptr_t   inode_xp,
1130                          uint32_t client_uid,
1131                          uint32_t client_gid )
1132{
1133    // get found inode cluster and local pointer
1134    cxy_t         inode_cxy = GET_CXY( inode_xp );
1135    vfs_inode_t * inode_ptr = (vfs_inode_t *)GET_PTR( inode_xp );
1136
1137    // get inode access mode, UID, and GID
1138    // TODO uint32_t  mode = hal_remote_lw( XPTR( inode_cxy , &inode_ptr->mode ) );
1139    uid_t     uid  = hal_remote_lw( XPTR( inode_cxy , &inode_ptr->uid  ) );
1140    gid_t     gid  = hal_remote_lw( XPTR( inode_cxy , &inode_ptr->gid  ) );
1141
1142    // FIXME : me must use mode
1143    if( (uid == client_uid) || (gid == client_gid) ) return false;
1144    else                                             return true;
1145}
1146
1147//////////////////////////////////////////////////////////////////////////////////////////
1148// This static function is used by the vfs_lookup() function.
1149// It takes an extended pointer on a remote parent directory inode, a directory
1150// entry name, and returns an extended pointer on the child inode.
1151// It can be used by any thread running in any cluster.
1152//////////////////////////////////////////////////////////////////////////////////////////
1153// @ parent_xp   : extended pointer on parent inode in remote cluster.
1154// @ name        : dentry name
1155// @ child_xp    : [out] buffer for extended pointer on child inode.
1156// @ return true if success / return false if not found.
1157//////////////////////////////////////////////////////////////////////////////////////////
1158static bool_t vfs_get_child( xptr_t   parent_xp,
1159                             char   * name,
1160                             xptr_t * child_xp )
1161{
1162    xptr_t  xhtab_xp;    // extended pointer on hash table containing children dentries
1163    xptr_t  dentry_xp;   // extended pointer on children dentry
1164
1165    // get parent inode cluster and local pointer
1166    cxy_t         parent_cxy = GET_CXY( parent_xp );
1167    vfs_inode_t * parent_ptr = (vfs_inode_t *)GET_PTR( parent_xp );
1168
1169    // get extended pointer on hash table of children directory entries
1170    xhtab_xp = XPTR( parent_cxy , &parent_ptr->children );
1171
1172    // search extended pointer on matching dentry
1173    dentry_xp = xhtab_lookup( xhtab_xp , name );
1174
1175    if( dentry_xp == XPTR_NULL ) return false;
1176
1177    // get dentry cluster and local pointer
1178    cxy_t          dentry_cxy = GET_CXY( dentry_xp );
1179    vfs_dentry_t * dentry_ptr = (vfs_dentry_t *)GET_PTR( dentry_xp );
1180
1181    // return child inode
1182    *child_xp = (xptr_t)hal_remote_lwd( XPTR( dentry_cxy , &dentry_ptr->child_xp ) );
1183    return true;
1184
1185}  // end vfs_get_child()
1186
1187//////////////////////////////////////////////////////////////////////////////////////////
1188// This static function is used by the vfs_lookup() function.
1189// It takes the <current> pointer on a buffer containing a complete pathname, and return
1190// in the <name> buffer, allocated by the caller, a single name in the path.
1191// It return also in the <next> pointer the next character to analyse in the path.
1192// Finally it returns a <last> boolean, that is true when the returned <name> is the
1193// last name in the path. The names are supposed to be separated by one or several '/'
1194// characters, that are not written in  the <name> buffer.
1195//////////////////////////////////////////////////////////////////////////////////////////
1196// @ current   : pointer on first character to analyse in buffer containing the path.
1197// @ name      : [out] pointer on buffer allocated by the caller for the returned name.
1198// @ next      : [out] pointer on next character to analyse in buffer containing the path.
1199// @ last      : [out] true if the returned name is the last (NUL character found).
1200// @ return 0 if success / return EINVAL if string empty (first chracter is NUL).
1201//////////////////////////////////////////////////////////////////////////////////////////
1202static error_t vfs_get_name_from_path( char     * current,
1203                                       char     * name,
1204                                       char    ** next,
1205                                       bool_t   * last )
1206{
1207    char * ptr = current;
1208
1209    // skip leading '/' characters
1210    while( *ptr == '/' ) ptr++;
1211
1212    // return EINVAL if string empty
1213    if( *ptr == 0 ) return EINVAL;
1214
1215    // copy all characters in name until NUL or '/'
1216    while( (*ptr != 0) && (*ptr !='/') )  *(name++) = *(ptr++);
1217
1218    // set NUL terminating character in name buffer
1219    *(name++) = 0;
1220
1221    // return last an next
1222    if( *ptr == 0 )             // last found character is NUL => last name in path
1223    {
1224        *last = true;
1225    }
1226    else                        // last found character is '/' => skip it
1227    {
1228        *last = false;
1229        *next = ptr + 1;
1230    }
1231
1232    return 0;
1233
1234}  // end vfs_get name_from_path()
1235   
1236//////////////////////////////////////////////
1237error_t vfs_lookup( xptr_t             cwd_xp,
1238                    char             * pathname,
1239                    uint32_t           mode,
1240                                        xptr_t           * inode_xp )
1241{
1242    char               name[CONFIG_VFS_MAX_NAME_LENGTH];   // one name in path
1243
1244    xptr_t             parent_xp;    // extended pointer on parent inode
1245    cxy_t              parent_cxy;   // cluster for parent inode
1246    vfs_inode_t      * parent_ptr;   // local pointer on parent inode 
1247    xptr_t             child_xp;     // extended pointer on child inode
1248    cxy_t              child_cxy;    // cluster for child inode
1249    vfs_inode_t      * child_ptr;    // local pointer on child inode 
1250    vfs_inode_type_t   child_type;   // child inode type
1251    vfs_fs_type_t      fs_type;      // File system type
1252    vfs_ctx_t        * ctx_ptr;      // local pointer on FS context
1253    char             * current;      // current pointer on path
1254    char             * next;         // next value for current pointer   
1255    bool_t             last;         // true when the name is the last in path
1256    bool_t             found;        // true when a child has been found
1257    thread_t         * this;         // pointer on calling thread descriptor
1258    process_t        * process;      // pointer on calling process descriptor
1259    error_t            error;
1260
1261    vfs_dmsg("\n[INFO] %s : enters for <%s> at cycle %d\n",
1262             __FUNCTION__ , pathname , (uint32_t)hal_time_stamp() );
1263
1264    this    = CURRENT_THREAD;
1265    process = this->process;
1266
1267    // get extended pointer on first inode to search
1268    if( pathname[0] == '/' ) parent_xp = process->vfs_root_xp;
1269    else                     parent_xp = cwd_xp;
1270
1271    // initialise other loop variables
1272    current  = pathname;
1273    next     = NULL;
1274    last     = false;
1275    child_xp = XPTR_NULL;
1276
1277    // take lock on parent inode
1278    vfs_inode_lock( parent_xp );
1279
1280    // load from device if one intermediate node not found
1281    // exit while loop when last name found (i.e. last == true)
1282    do
1283    {
1284        // get one name from path, and the "last" flag
1285        vfs_get_name_from_path( current , name , &next , &last );
1286
1287        vfs_dmsg("\n[INFO] %s : looking for <%s> / last = %d\n",
1288                 __FUNCTION__ , name , last );
1289
1290        // search a child dentry matching name in parent inode
1291        found = vfs_get_child( parent_xp,
1292                               name,
1293                               &child_xp );
1294
1295        // if a child inode is not found in the inode tree:
1296        // - we create the missing inode/dentry couple in the inode tree,
1297        // - we scan the parent mapper to complete the child inode (type and extension),
1298        // - we return an error if child not found on device.
1299        // - if the missing child is a directory, we load the child mapper from device
1300
1301        // for the last name, the behaviour depends on the "mode" argument:
1302
1303        if (found == false ) // child node not found in inode tree
1304        {
1305            vfs_dmsg("\n[INFO] %s : <%s> not found, try to load it\n",
1306                     __FUNCTION__ , name );
1307
1308            // release lock on parent inode
1309            vfs_inode_unlock( parent_xp );
1310
1311            // get parent inode FS type
1312            parent_cxy = GET_CXY( parent_xp );
1313            parent_ptr = (vfs_inode_t *)GET_PTR( parent_xp );
1314
1315            ctx_ptr    = (vfs_ctx_t *)hal_remote_lpt( XPTR( parent_cxy ,
1316                                                            &parent_ptr->ctx ) );
1317            fs_type    = hal_remote_lw( XPTR( parent_cxy , &ctx_ptr->type ) );
1318
1319            // select a cluster for missing inode
1320            child_cxy = vfs_cluster_random_select();
1321                     
1322            // insert a new child dentry/inode in parent inode
1323            error = vfs_add_child_in_parent( child_cxy,
1324                                             INODE_TYPE_DIR,
1325                                             fs_type, 
1326                                             parent_xp, 
1327                                             name, 
1328                                             NULL,     // fs_type_specific inode extend
1329                                             &child_xp );
1330            if( error )
1331            {
1332                printk("\n[ERROR] in %s : no memory for inode %s in path %s\n",
1333                       __FUNCTION__ , name , pathname );
1334                return ENOMEM;
1335            }
1336
1337            // scan parent mapper to complete the missing inode
1338            if( parent_cxy == local_cxy )
1339            {
1340                error = vfs_inode_load( parent_ptr,
1341                                        name,
1342                                        child_xp );
1343            }
1344            else
1345            {
1346                rpc_vfs_inode_load_client( parent_cxy,
1347                                           parent_ptr,
1348                                           name,
1349                                           child_xp,
1350                                           &error );
1351            }
1352
1353            if ( error )
1354            {
1355                printk("\n[ERROR] in %s : node %s not found in path %s\n",
1356                       __FUNCTION__ , name , pathname );
1357                return ENOENT;
1358            }
1359
1360            // get child inode type
1361            child_ptr  = (vfs_inode_t *)GET_PTR( child_xp );
1362            child_type = hal_remote_lw( XPTR( child_cxy , &child_ptr->type ) );
1363
1364            // load child mapper from device if it is a directory
1365            if( child_type == INODE_TYPE_DIR )
1366            {
1367                if( child_cxy == local_cxy )
1368                {
1369                    error = vfs_mapper_load_all( child_ptr );
1370                }
1371                else
1372                {
1373                    rpc_vfs_mapper_load_all_client( child_cxy,
1374                                                    child_ptr,
1375                                                    &error );
1376                }
1377
1378                if ( error )
1379                {
1380                    printk("\n[ERROR] in %s : cannot access device for node %s in path %s\n",
1381                           __FUNCTION__ , name , pathname );
1382                    return EIO;
1383                }
1384            }
1385
1386            // TODO handle lookup mode here [AG]
1387
1388            // take lock on parent inode
1389            vfs_inode_lock( parent_xp );
1390        }
1391
1392        vfs_dmsg("\n[INFO] %s : found <%s> / parent = %l / child = %l / last = %d\n",
1393                     __FUNCTION__ , name , parent_xp , child_xp , last );
1394
1395        // TODO check access rights
1396        // error = vfs_access_denied( child_xp,
1397        //                            client_uid,
1398        //                            client_gid );
1399        // if( error )
1400        // {
1401        //     printk("\n[ERROR] in %s : permission denied for %s\n", __FUNCTION__ , name );
1402        //     return EACCES;
1403        // }
1404
1405        // take lock on child inode and release lock on parent
1406        vfs_inode_lock( child_xp );
1407        vfs_inode_unlock( parent_xp );
1408
1409        // update loop variables
1410        parent_xp = child_xp;
1411        current   = next;
1412    }
1413    while( last == false );
1414
1415    // release lock
1416    vfs_inode_unlock( parent_xp );
1417
1418    vfs_dmsg("\n[INFO] in %s : exit <%s> found / inode = %l\n",
1419                 __FUNCTION__ , pathname , child_xp );
1420
1421    // return searched pointer
1422    *inode_xp = child_xp;
1423
1424    return 0;
1425
1426}  // end vfs_lookup()
1427
1428////////////////////////////////////////////
1429error_t vfs_get_path( xptr_t    searched_xp,
1430                      char    * buffer,
1431                      uint32_t  max_size )
1432{
1433        xptr_t       dentry_xp;   // extended pointer on current dentry
1434    char       * name;        // local pointer on current dentry name
1435        uint32_t     length;      // length of current dentry name
1436        uint32_t     count;       // number of characters written in buffer
1437        uint32_t     index;       // slot index in buffer
1438    xptr_t       inode_xp;    // extended pointer on   
1439
1440    // implementation note:
1441    // we use two variables "index" and "count" because the buffer
1442    // is actually written in decreasing index order (from leaf to root)
1443    // TODO : handle conflict with a concurrent rename
1444    // FIXME : handle synchro in the loop ... [AG]
1445
1446        // set the NUL character in buffer / initialise buffer index and count
1447        buffer[max_size - 1] = 0;
1448        count    = 1;
1449    index    = max_size - 2;
1450
1451    // initialize current inode
1452    inode_xp  = searched_xp;
1453
1454    // exit when root inode found (i.e. dentry_xp == XPTR_NULL)
1455        do
1456    {
1457        // get inode cluster and local pointer
1458        cxy_t         inode_cxy = GET_CXY( inode_xp );
1459        vfs_inode_t * inode_ptr = (vfs_inode_t *)GET_PTR( inode_xp );
1460
1461        // get extended pointer on parent dentry               
1462        dentry_xp = (xptr_t)hal_remote_lwd( XPTR( inode_cxy , inode_ptr->parent_xp ) );
1463
1464        // get dentry cluster and local pointer
1465        cxy_t          dentry_cxy = GET_CXY( dentry_xp );
1466        vfs_dentry_t * dentry_ptr = (vfs_dentry_t *)GET_PTR( dentry_xp );
1467
1468        // get dentry name length and pointer
1469        length =  hal_remote_lw( XPTR( dentry_cxy , &dentry_ptr->length ) );
1470        name   = (char *)hal_remote_lpt( XPTR( dentry_cxy , &dentry_ptr->name ) );
1471
1472        // update index and count
1473        index -= (length + 1); 
1474        count += (length + 1);
1475
1476        // check buffer overflow
1477        if( count >= max_size )
1478        {
1479            printk("\n[ERROR] in %s : kernel buffer too small\n", __FUNCTION__ );
1480            return EINVAL;
1481        }
1482
1483        // update pathname
1484        hal_remote_memcpy( XPTR( local_cxy , &buffer[index + 1] ) ,
1485                           XPTR( dentry_cxy , name ) , length );
1486                buffer[index] = '/';
1487
1488                // get extended pointer on next inode
1489        inode_xp = (xptr_t)hal_remote_lwd( XPTR( dentry_cxy , dentry_ptr->parent ) );
1490    }
1491    while( (dentry_xp != XPTR_NULL) );
1492
1493        return 0;
1494
1495}  // end vfs_get_path()
1496
1497     
1498//////////////////////////////////////////////////////////////
1499error_t vfs_add_child_in_parent( cxy_t              child_cxy,
1500                                 vfs_inode_type_t   inode_type,
1501                                 vfs_fs_type_t      fs_type,
1502                                 xptr_t             parent_xp,
1503                                 char             * name,
1504                                 void             * extend,
1505                                 xptr_t           * child_xp )
1506{
1507    error_t         error;
1508    xptr_t          dentry_xp;   // extended pointer on created dentry
1509    xptr_t          inode_xp;    // extended pointer on created inode
1510    cxy_t           parent_cxy;  // parent inode cluster identifier
1511    vfs_inode_t   * parent_ptr;  // parent inode local pointer
1512
1513    // get parent inode cluster and local pointer
1514    parent_cxy = GET_CXY( parent_xp );
1515    parent_ptr = (vfs_inode_t *)GET_PTR( parent_xp );
1516
1517    // 1. create dentry
1518    if( parent_cxy == local_cxy )      // parent cluster is the local cluster
1519    {
1520        error = vfs_dentry_create( fs_type,
1521                                   name,
1522                                   parent_ptr,
1523                                   &dentry_xp );
1524    }
1525    else                               // parent cluster is remote
1526    {
1527        rpc_vfs_dentry_create_client( parent_cxy,
1528                                      fs_type,
1529                                      name,
1530                                      parent_ptr,
1531                                      &dentry_xp,
1532                                      &error );
1533    }
1534                                     
1535    if( error )
1536    {
1537        printk("\n[ERROR] in %s : cannot create dentry in cluster %x\n",
1538               __FUNCTION__ , parent_cxy );
1539        return ENOMEM;
1540    }
1541
1542    // 2. create child inode TODO : define attr / mode / uid / gid
1543    uint32_t attr = 0;
1544    uint32_t mode = 0;
1545    uint32_t uid  = 0;
1546    uint32_t gid  = 0;
1547   
1548    if( child_cxy == local_cxy )      // child cluster is the local cluster
1549    {
1550        error = vfs_inode_create( dentry_xp,
1551                                  fs_type,
1552                                  inode_type,
1553                                  extend,
1554                                  attr,
1555                                  mode,
1556                                  uid,
1557                                  gid,
1558                                  &inode_xp );
1559    }
1560    else                              // child cluster is remote
1561    {
1562        rpc_vfs_inode_create_client( child_cxy,
1563                                     dentry_xp,
1564                                     fs_type,
1565                                     inode_type,
1566                                     extend,
1567                                     attr,
1568                                     mode,
1569                                     uid,
1570                                     gid,
1571                                     &inode_xp,
1572                                     &error );
1573    }
1574                                     
1575    if( error )
1576    {
1577        printk("\n[ERROR] in %s : cannot create inode in cluster %x\n",
1578               __FUNCTION__ , child_cxy );
1579 
1580        vfs_dentry_t * dentry = (vfs_dentry_t *)GET_PTR( dentry_xp );
1581        if( parent_cxy == local_cxy ) vfs_dentry_destroy( dentry );
1582        else rpc_vfs_dentry_destroy_client( parent_cxy , dentry );
1583        return ENOMEM;
1584    }
1585
1586    // 3. update extended pointer on inode in dentry
1587    cxy_t          dentry_cxy = GET_CXY( dentry_xp );
1588    vfs_dentry_t * dentry_ptr = (vfs_dentry_t *)GET_PTR( dentry_xp );
1589    hal_remote_swd( XPTR( dentry_cxy , &dentry_ptr->child_xp ) , inode_xp );
1590
1591    // success : return extended pointer on child inode
1592    *child_xp = inode_xp;
1593    return 0;
1594
1595}  // end vfs_add_child_in_parent()
1596
1597//////////////////////////////////////////////////////////////////////////////////////////
1598//            Mapper related functions
1599//////////////////////////////////////////////////////////////////////////////////////////
1600
1601////////////////////////////////////////////
1602error_t vfs_mapper_move_page( page_t * page,
1603                              bool_t   to_mapper )
1604{
1605    error_t error = 0;
1606
1607    assert( (page != NULL) , __FUNCTION__ , "page pointer is NULL\n" );
1608
1609    mapper_t    * mapper = page->mapper;
1610
1611
1612    assert( (mapper != NULL) , __FUNCTION__ , "no mapper for page\n" );
1613
1614    vfs_dmsg("\n[INFO] %s : enters for page = %d in mapper = %x\n",
1615             __FUNCTION__ , page->index , mapper );
1616
1617    // get FS type
1618    vfs_fs_type_t fs_type = mapper->type;
1619
1620    // call relevant FS function
1621    if( fs_type == FS_TYPE_FATFS )
1622    {
1623        rwlock_wr_lock( &mapper->lock );
1624        error = fatfs_mapper_move_page( page , to_mapper ); 
1625        rwlock_wr_unlock( &mapper->lock );
1626    }
1627    else if( fs_type == FS_TYPE_RAMFS )
1628    {
1629        assert( false , __FUNCTION__ , "should not be called for RAMFS\n" );
1630    }
1631    else if( fs_type == FS_TYPE_DEVFS )
1632    {
1633        assert( false , __FUNCTION__ , "should not be called for DEVFS\n" );
1634    }
1635    else
1636    {
1637        assert( false , __FUNCTION__ , "undefined file system type\n" );
1638    }
1639
1640    vfs_dmsg("\n[INFO] %s : exit for page = %d in mapper = %x\n",
1641             __FUNCTION__ , page->index , mapper );
1642
1643    return error;
1644
1645}  // end vfs_move_page()
1646
1647//////////////////////////////////////////////////
1648error_t vfs_mapper_load_all( vfs_inode_t * inode )
1649{
1650    assert( (inode != NULL) , __FUNCTION__ , "inode pointer is NULL\n" );
1651
1652    uint32_t   index;
1653    page_t   * page;
1654
1655    mapper_t * mapper = inode->mapper;
1656    uint32_t   size   = inode->size;
1657
1658    assert( (mapper != NULL) , __FUNCTION__ , "mapper pointer is NULL\n" );
1659
1660    uint32_t npages = size >> CONFIG_PPM_PAGE_SHIFT;
1661    if( (size & CONFIG_PPM_PAGE_MASK) || (size == 0) ) npages++;
1662
1663    // loop on pages
1664    for( index = 0 ; index < npages ; index ++ )
1665    {
1666        // this function allocates the missing page in mapper,
1667        // and call the vfs_mapper_move_page() to load the page from device
1668        page = mapper_get_page( mapper , index );
1669
1670        if( page == NULL ) return EIO;
1671    }
1672
1673    return 0;
1674
1675}  // end vfs_mapper_load_all()
1676
Note: See TracBrowser for help on using the repository browser.