source: soft/giet_vm/giet_fat32/fat32.c @ 652

Last change on this file since 652 was 652, checked in by guerin, 9 years ago

fat32: create Inode-Tree root using _allocate_one_inode()

No need to duplicate the code.

  • Property svn:executable set to *
File size: 160.4 KB
Line 
1//////////////////////////////////////////////////////////////////////////////////
2// Date     : 01/06/2015
3// Authors  : Alain Greiner
4// Copyright (c) UPMC-LIP6
5//////////////////////////////////////////////////////////////////////////////////
6// The fat32.h and fat32.c files define a library of access functions
7// to a FAT32 disk on a block device. It is intended to be used by both
8// the boot code and the kernel code.
9//////////////////////////////////////////////////////////////////////////////////
10// Implementation notes:
11// 1. the "lba" (Logical Block Address) is the physical sector index on
12//    the block device. The physical sector size is supposed to be 512 bytes.
13// 2. the "cluster" variable is actually a cluster index. A cluster contains
14//    8 sectors (4K bytes) and the cluster index is a 32 bits word.
15// 3. Each file or directory referenced by the software is represented
16//    by an "inode". The set of "inodes" is organised as a tree, that is
17//    a sub-tree of the complete file system existing on the block device.
18// 4. A given file can be referenced by several software tasks, and each task
19//    will use a private handler, called a "file descriptor", allocated by the OS
20//    when the task open the file, that is organised as an indexed array.
21// 5. This FAT32 library implements (N+1) caches : one private "File_ Cache"
22//    for each referenced file or directory, and a specific "Fat_Cache" for
23//    the FAT itself. Each cache contain a variable number of clusters that are
24//    dynamically allocated when they are accessed, and organised as a 64-Tree.
25//////////////////////////////////////////////////////////////////////////////////
26// General Debug Policy:
27// The global variable GIET_DEBUG_FAT is defined in the giet_config.h file.
28// The debug is activated if (proctime > GIET_DEBUG_FAT) && (GIET_DEBUG_FAT != 0)
29// The GIET_DEBUG_FAT bit 0 defines the level of debug:
30//    if   (GIET_DEBUG_FAT & 0x1)    => detailed debug
31//    else                           => external functions only
32//////////////////////////////////////////////////////////////////////////////////
33
34#include <giet_config.h>
35#include <hard_config.h>
36#include <fat32.h>
37#include <utils.h>
38#include <vmem.h>
39#include <kernel_malloc.h>
40#include <bdv_driver.h>
41#include <hba_driver.h>
42#include <sdc_driver.h>
43#include <rdk_driver.h>
44#include <mmc_driver.h>
45#include <tty0.h>
46
47//////////////////////////////////////////////////////////////////////////////////
48//               Global variables
49//////////////////////////////////////////////////////////////////////////////////
50
51// Fat-Descriptor
52__attribute__((section(".kdata")))
53fat_desc_t _fat __attribute__((aligned(64))); 
54
55// buffer used by boot code as a simple cache when scanning FAT
56__attribute__((section(".kdata")))
57unsigned char  _fat_buffer_fat[4096] __attribute__((aligned(64)));
58
59// buffer used by boot code as a simple cache when scanning a directory in DATA region
60__attribute__((section(".kdata")))
61unsigned char  _fat_buffer_data[4096] __attribute__((aligned(64)));
62
63// lba of cluster in fat_buffer_fat
64__attribute__((section(".kdata")))
65unsigned int   _fat_buffer_fat_lba;
66
67// lba of cluster in fat_buffer_data
68__attribute__((section(".kdata")))
69unsigned int   _fat_buffer_data_lba;
70
71//////////////////////////////////////////////////////////////////////////////////
72//////////////////////////////////////////////////////////////////////////////////
73//                  Static functions declaration
74//////////////////////////////////////////////////////////////////////////////////
75//////////////////////////////////////////////////////////////////////////////////
76
77
78///////////////////////////////////////////////////////////////////////////////////
79// This debug function displays the content of a 512 bytes buffer "buf",
80// with an identifier defined by the "string" and "block_id" arguments.
81///////////////////////////////////////////////////////////////////////////////////
82
83#if GIET_DEBUG_FAT
84static void _display_one_block( unsigned char* buf,
85                                char*          string,
86                                unsigned int   block_id );
87#endif
88
89//////////////////////////////////////////////////////////////////////////////////
90// This debug function displays the FAT descriptor.
91//////////////////////////////////////////////////////////////////////////////////
92
93#if GIET_DEBUG_FAT
94static void _display_fat_descriptor();
95#endif
96
97/////////////////////////////////////////////////////////////////////////////////
98// This debug function displays the sequence of clusters allocated to a
99// file (or directory) identified by the "inode" argument.
100/////////////////////////////////////////////////////////////////////////////////
101
102#if GIET_DEBUG_FAT
103static void _display_clusters_list( fat_inode_t* inode );
104#endif
105
106/////////////////////////////////////////////////////////////////////////////////
107// The following function transfers one or several blocks between the device
108// and a memory buffer identified by a virtual address.
109// It computes the memory buffer physical address, and calls the proper
110// IOC driver depending on the subtype (BDV / HBA / SDC / SPI / RDK).
111// The use_irq argument allows to activate the descheduling mode,
112// if it supported by the IOC driver subtype
113// It returns O  in case of success.
114// It returns -1 in case of error.
115/////////////////////////////////////////////////////////////////////////////////
116
117static int _fat_ioc_access( unsigned int use_irq,
118                            unsigned int to_mem,
119                            unsigned int lba,
120                            unsigned int buf_vaddr,
121                            unsigned int count );
122
123//////////////////////////////////////////////////////////////////////////////////
124// The following function returns in the "desc" argument a pointer on a buffer
125// descriptor contained in a File_Cache, or in the Fat_Cache.
126// The searched buffer is idenfified by the "inode" and "cluster_id" arguments.
127// If the "inode" pointer is not NULL, the searched cache is a File-Cache.
128// If the "inode" pointer is NULL, the searched cache is the Fat-Cache,
129// The "cluster_id" argument is the buffer index in the file (or in the FAT).
130// In case of miss, it allocate a 4 Kbytes buffer and a cluster descriptor
131// from the local kernel heap, and calls the _fat_ioc_access() function to load
132// the missing cluster from the block device.
133// It returns O  in case of success.
134// It returns 1 in case of error.
135//////////////////////////////////////////////////////////////////////////////////
136
137static unsigned int _get_buffer_from_cache( fat_inode_t*        inode,
138                                            unsigned int        cluster_id,
139                                            fat_cache_desc_t**  desc );
140
141////////////////////////////////////////////////////////////////////////////////
142// This function extract a (partial) name from a LFN directory entry.
143////////////////////////////////////////////////////////////////////////////////
144
145static void _get_name_from_long( unsigned char* buffer, 
146                                 char*          name );
147
148////////////////////////////////////////////////////////////////////////////////
149// The following function extract a name from a NORMAL directory entry.
150////////////////////////////////////////////////////////////////////////////////
151
152static void _get_name_from_short( unsigned char* buffer,
153                                  char*          name );
154
155//////////////////////////////////////////////////////////////////////////////////
156// This function returns the number of levels of a File-Cache (or Fat-Cache)
157// from the size of the file (or FAT).
158//////////////////////////////////////////////////////////////////////////////////
159
160static inline unsigned int _get_levels_from_size( unsigned int size );
161
162///////////////////////////////////////////////////////////////////////////////////
163// The following function analyses the "pathname" argument, from the character
164// defined by the "nb_read" argument.
165// It copies the found name in the "name" buffer (without '/'),
166// and updates the "nb_read" argument.
167// It returns 0 if success.
168// It returns 1 if one name length > NAME_MAX_SIZE characters
169///////////////////////////////////////////////////////////////////////////////////
170
171static unsigned int _get_name_from_path( char*          pathname,
172                                         char*          name,
173                                         unsigned int*  nb_read );
174
175////////////////////////////////////////////////////////////////////////////////
176// The following function scan the "pathname" argument, and copies in the
177// "name" buffer the last name in path (leaf name).
178// It returns 0 if success.
179// It returns 1 if one name length > NAME_MAX_SIZE characters
180////////////////////////////////////////////////////////////////////////////////
181static unsigned int _get_last_name( char*   pathname,
182                                    char*   name );
183
184//////////////////////////////////////////////////////////////////////////////////
185// The following function access the Fat-Cache and returns in the "value"
186// argument the content of the FAT slot identified by the "cluster" argument.
187// It loads the missing cluster from block device into cache in case of miss.
188// It returns 0 if success.
189// It returns 1 if error.
190//////////////////////////////////////////////////////////////////////////////////
191
192static unsigned int _get_fat_entry( unsigned int  cluster,
193                                    unsigned int* value );
194
195//////////////////////////////////////////////////////////////////////////////////
196// The following function writes a new "value" in the Fat-Cache, in the slot
197// identified by the "cluster" argument. 
198// It loads the missing cluster from block device into cache in case of miss.
199// It returns 0 if success,
200// It returns 1 if error.
201//////////////////////////////////////////////////////////////////////////////////
202
203static unsigned int _set_fat_entry( unsigned int  cluster,
204                                    unsigned int  value );
205
206//////////////////////////////////////////////////////////////////////////////////
207// The following function introduces the inode identified by the "child" argument,
208// as a new child of the "parent" inode in the Inode-Tree.
209// All checking are supposed to be done by the caller.
210// Nor the File-Cache, neither the block device are modified.
211//////////////////////////////////////////////////////////////////////////////////
212
213static void _add_inode_in_tree( fat_inode_t*  child,
214                                fat_inode_t*  parent );
215
216//////////////////////////////////////////////////////////////////////////////////
217// The following function removes one inode identified by the "inode" argument
218// from the Inode-Tree. All checking are supposed to be done by the caller.
219// Nor the File-Cache, neither the block device are modified.
220//////////////////////////////////////////////////////////////////////////////////
221
222static void _remove_inode_from_tree( fat_inode_t* inode );
223
224//////////////////////////////////////////////////////////////////////////////////
225// This recursive function scan one File-Cache (or Fat-Cache) from root to leaves,
226// to writes all dirty clusters to block device, and reset the dirty bits.
227// The cache is identified by the "root" an "levels" arguments.
228// The "string" argument is only used for debug : inode name or Fat.
229// It returns 0 if success.
230// It returns 1 if error.
231//////////////////////////////////////////////////////////////////////////////////
232
233static unsigned int _update_device_from_cache( unsigned int      levels,
234                                               fat_cache_node_t* root,
235                                               char*             string );
236
237//////////////////////////////////////////////////////////////////////////////////
238// The following function access directly the FS_INFO block on the block device,
239// to update the "first_free_cluster" and "free_clusters_number" values,
240// using only the Fat-Descriptor single block buffer.
241// It return 0 in case of success.
242// It return 1 in case of error.
243//////////////////////////////////////////////////////////////////////////////////
244
245static unsigned int _update_fs_info();
246
247//////////////////////////////////////////////////////////////////////////////
248// The following function read a data field (from one to four bytes)
249// from an unsigned char[] buffer, taking endianness into account.
250// The analysed field is defined by the "offset" and "size" arguments.
251//////////////////////////////////////////////////////////////////////////////
252
253static unsigned int _read_entry( unsigned int    offset,
254                                 unsigned int    size,
255                                 unsigned char*  buffer,
256                                 unsigned int    little_indian );
257
258//////////////////////////////////////////////////////////////////////////////////
259// The following function returns the lba of first sector in DATA region
260// from the cluster index. The cluster index must be larger than 2.
261//////////////////////////////////////////////////////////////////////////////////
262
263static unsigned int _cluster_to_lba( unsigned int cluster );
264
265//////////////////////////////////////////////////////////////////////////////////
266// The following function returns in the "nb_entries" argument the number of files
267// (or directories) contained in a directory identified by the "inode " pointer.
268// It returns  0 if success.
269// It returns  1 if error.
270//////////////////////////////////////////////////////////////////////////////////
271
272static unsigned int _get_nb_entries( fat_inode_t*   inode,
273                                     unsigned int*  nb_entries );
274
275//////////////////////////////////////////////////////////////////////////////////
276// The following function search in the directory identified by the "parent"
277// inode pointer a child (file or directory) identified by its "name".
278// It returns in the "inode" argument the searched child inode pointer.
279// If the searched name is not found in the Inode-Tree, the function access
280// the "file_cache" associated to the parent directory.
281// If the child exist on block device, the Inode-Tree is updated, and
282// a success code is returned.
283// If the file/dir does not exist on block device, a error code is returned.
284// It returns 0 if inode found.
285// It returns 1 if inode not found.
286// It returns 2 if error in cache access.
287//////////////////////////////////////////////////////////////////////////////////
288
289static unsigned int _get_child_from_parent( fat_inode_t*   parent,
290                                            char*          name,
291                                            fat_inode_t**  inode ); 
292
293/////////////////////////////////////////////////////////////////////////////////
294// For a file (or a directory) identified by the "pathname" argument, the
295// following function returns in the "inode" argument the inode pointer
296// associated to the searched file (or directory), with code (0).
297// If the searched file (or directory) is not found, but the parent directory
298// is found, it returns in the "inode" argument the pointer on the parent inode,
299// with code (1).  Finally, code (2) and code (3) are error codes.
300// Both the Inode-Tree and the involved Cache-Files are updated from the block
301// device in case of miss on one inode during the search in path.
302// Neither the Fat-Cache, nor the block device are updated.
303// It returns 0 if searched inode found
304// It returns 1 if searched inode not found but parent directory found
305// It returns 2 if searched inode not found and parent directory not found
306// It returns 3 if one name too long
307/////////////////////////////////////////////////////////////////////////////////
308
309static unsigned int _get_inode_from_path( char*          pathname,
310                                          fat_inode_t**  inode );
311
312//////////////////////////////////////////////////////////////////////////////////
313// The following function checks if node "a" is an ancestor of inode "b".
314// It returns 0 on failure.
315// It returns 1 otherwise.
316//////////////////////////////////////////////////////////////////////////////////
317
318static unsigned int _is_ancestor( fat_inode_t* a,
319                                  fat_inode_t* b);
320
321//////////////////////////////////////////////////////////////////////////////////
322// This function computes the length and the number of LFN entries required
323// to store a node name in the "length" and "nb_lfn" arguments.
324// Short name (less than 13 characters) require 1 LFN entry.
325// Medium names (from 14 to 26 characters require 2 LFN entries.
326// Large names (up to 31 characters) require 3 LFN entries.
327// It returns 0 if success.
328// It returns 1 if length larger than 31 characters.
329//////////////////////////////////////////////////////////////////////////////////
330
331static unsigned int _check_name_length( char* name,
332                                        unsigned int* length,
333                                        unsigned int* nb_lfn );
334
335//////////////////////////////////////////////////////////////////////////////////
336// For a node identified by the "inode" argument, this function updates the
337// "size" and "cluster" values in the entry of the parent directory File-Cache.
338// It set the dirty bit in the modified buffer of the parent directory File-Cache.
339//////////////////////////////////////////////////////////////////////////////////
340
341static unsigned int _update_dir_entry( fat_inode_t*  inode );
342
343//////////////////////////////////////////////////////////////////////////////////
344// The following function add new "child" in Cache-File of "parent" directory.
345// It access the File_Cache associated to the parent directory, and scan the
346// clusters allocated to this directory to find the NO_MORE entry.
347// This entry will be the first modified entry in the directory.
348// Regarding the name storage, it uses LFN entries for all names.
349// Therefore, it writes 1, 2, or 3 LFN entries (depending on the child name
350// actual length, it writes one NORMAL entry, and writes the new NOMORE entry.
351// It updates the dentry field in the child inode.
352// It set the dirty bit for all modified File-Cache buffers.
353// The block device is not modified by this function.
354//////////////////////////////////////////////////////////////////////////////////
355
356static unsigned int _add_dir_entry( fat_inode_t* child,
357                                    fat_inode_t* parent );
358
359//////////////////////////////////////////////////////////////////////////////////
360// The following function invalidates all dir_entries associated to the "inode"
361// argument from its parent directory.
362// It set the dirty bit for all modified buffers in parent directory Cache-File.
363// The inode itself is not modified by this function.
364// The block device is not modified by this function.
365//////////////////////////////////////////////////////////////////////////////////
366
367static unsigned int _remove_dir_entry( fat_inode_t*  inode );
368
369//////////////////////////////////////////////////////////////////////////////////
370// The following function add the special entries "." and ".." in the File-Cache
371// of the directory identified by the "child" argument.
372// The parent directory is defined by the "parent" argument.
373// The child directory File-Cache is supposed to be empty.
374// We use two NORMAL entries for these "." and ".." entries.
375// The block device is not modified by this function.
376//////////////////////////////////////////////////////////////////////////////////
377
378static void _add_special_directories( fat_inode_t* child,
379                                      fat_inode_t* parent );
380
381//////////////////////////////////////////////////////////////////////////////////
382// The following function releases all clusters allocated to a file or directory,
383// from the cluster index defined by the "cluster" argument, until the end
384// of the FAT linked list.
385// It calls _get_fat_entry() and _set_fat_entry() functions to scan the FAT,
386// and to update the clusters chaining.
387// The FAT region on block device is updated.
388// It returns 0 if success.
389// It returns 1 if error.
390//////////////////////////////////////////////////////////////////////////////////
391
392static unsigned int _clusters_release( unsigned int cluster );
393
394//////////////////////////////////////////////////////////////////////////////////
395// This function allocate "nb_clusters_more" new clusters to a file (or directory)
396// identified by the "inode" pointer. It allocates also the associated buffers
397// and buffer descriptors in the Cache-File.
398// It calls _get_fat_entry() and _set_fat_entry() functions to update the
399// clusters chaining in the Cache-Fat. The FAT region on block device is updated.
400// It returns 0 if success.
401// It returns 1 if error.
402//////////////////////////////////////////////////////////////////////////////////
403
404static unsigned int _clusters_allocate( fat_inode_t* inode, 
405                                        unsigned int nb_clusters_current,
406                                        unsigned int nb_clusters_more );
407
408//////////////////////////////////////////////////////////////////////////////////
409// This recursive function scans one File-Cache (or Fat-Cache) from root to
410// leaves. All memory allocated for 4KB buffers, and buffer descriptors (in
411// leaves) is released, along with the 64-Tree structure (root node is kept).
412// The cache is identified by the "root" and "levels" arguments.
413// It should not contain any dirty clusters.
414//////////////////////////////////////////////////////////////////////////////////
415
416static void _release_cache_memory( fat_cache_node_t*  root,
417                                   unsigned int       levels );
418
419//////////////////////////////////////////////////////////////////////////////////
420// The following function allocates and initializes a new Fat-Cache node.
421// Its first child can be specified (used when adding a cache level).
422// The Fat-Cache is initialized as empty: all children set to NULL.
423// It returns a pointer to a new Fat-Cache node.
424//////////////////////////////////////////////////////////////////////////////////
425
426static fat_cache_node_t* _allocate_one_cache_node( fat_cache_node_t* first_child );
427
428//////////////////////////////////////////////////////////////////////////////////
429// The following function allocates and initializes a new inode,
430// using the values defined by the arguments.
431// If the "cache_allocate" argument is true ans empty cache is allocated.
432// It returns a pointer on the new inode.
433//////////////////////////////////////////////////////////////////////////////////
434
435static fat_inode_t* _allocate_one_inode( char*        name,
436                                         unsigned int is_dir,
437                                         unsigned int cluster,
438                                         unsigned int size,
439                                         unsigned int count,
440                                         unsigned int dentry,
441                                         unsigned int cache_allocate );
442
443//////////////////////////////////////////////////////////////////////////////////
444// The following function allocates one 4 Kbytes buffer and associated cluster
445// descriptor for the file (or directory) identified by the "inode" argument,
446// and updates the Cache_File slot identified by the "cluster_id" argument.
447// The File-Cache slot must be empty.
448// It updates the cluster descriptor, using the "cluster" argument, that is
449// the cluster index in FAT.  The cluster descriptor dirty field is set.
450// It traverse the 64-tree Cache-file from top to bottom to find the last level.
451//////////////////////////////////////////////////////////////////////////////////
452
453static void _allocate_one_buffer( fat_inode_t*    inode,
454                                  unsigned int    cluster_id,
455                                  unsigned int    cluster );
456
457//////////////////////////////////////////////////////////////////////////////////
458// The following function allocates one free cluster from the FAT "heap" of free
459// clusters, and returns the cluster index in the "cluster" argument.
460// It updates the FAT slot, and the two FAT global variables: first_free_cluster,
461// and free_clusters_number.
462// It returns O if success.
463// It returns 1 if error.
464//////////////////////////////////////////////////////////////////////////////////
465
466static unsigned int _allocate_one_cluster( unsigned int*  cluster );
467
468/////////////////////////////////////////////////////////////////////////////
469// This function remove from the file system a file or a directory
470// identified by the "inode" argument.
471// The remove condition must be checked by the caller.
472// The relevant lock(s) must have been taken by te caller.
473// It returns O if success.
474// It returns 1 if error.
475/////////////////////////////////////////////////////////////////////////////
476
477static unsigned int _remove_node_from_fs( fat_inode_t* inode );
478
479/////////////////////////////////////////////////////////////////////////////
480// This function return the cluster index and the size for a file
481// identified by the "pathname" argument, scanning directly the block
482// device DATA region.
483// It is intended to be called only by the _fat_load_no_cache() function,
484// it does not use the dynamically allocated File Caches, but uses only
485// the 4 Kbytes _fat_buffer_data.
486// It returns 0 if success.
487// It returns 1 if error.
488/////////////////////////////////////////////////////////////////////////////
489
490static unsigned int _file_info_no_cache( char*          pathname,
491                                         unsigned int*  file_cluster,
492                                         unsigned int*  file_size );
493
494/////////////////////////////////////////////////////////////////////////////
495// This function scan directly the FAT region on the block device,
496// and returns in the "next" argument the value stored in the fat slot
497// identified by the "cluster" argument.
498// It is intended to be called only by the _fat_load_no_cache() function,
499// as it does not use the dynamically allocated Fat-Cache, but uses only
500// the 4 Kbytes _fat_buffer_fat.
501// It returns 0 if success.
502// It returns 1 if error.
503/////////////////////////////////////////////////////////////////////////////
504
505static unsigned int _next_cluster_no_cache( unsigned int   cluster,
506                                            unsigned int*  next );
507
508
509//////////////////////////////////////////////////////////////////////////////////
510// The following functions return the length or the size of a FAT field,
511// identified by an (offset,length) mnemonic defined in the fat32.h file.
512//////////////////////////////////////////////////////////////////////////////////
513
514static inline int get_length( int offset , int length ) { return length; }
515
516static inline int get_offset( int offset , int length ) { return offset; }
517
518
519
520
521
522//////////////////////////////////////////////////////////////////////////////////
523//////////////////////////////////////////////////////////////////////////////////
524//                  Static functions definition
525//////////////////////////////////////////////////////////////////////////////////
526//////////////////////////////////////////////////////////////////////////////////
527
528#if GIET_DEBUG_FAT
529///////////////////////////////////////////////////
530static void _display_one_block( unsigned char* buf,
531                                char*          string,
532                                unsigned int   block_id )
533{
534    unsigned int line;
535    unsigned int word;
536
537    _printf("\n***  <%s>  block %x  ***********************************\n",
538            string , block_id );
539
540    for ( line = 0 ; line < 16 ; line++ )
541    {
542        // display line index
543        _printf("%x : ", line );
544
545        // display 8*4 bytes hexa
546        for ( word=0 ; word<8 ; word++ )
547        {
548            unsigned int byte  = (line<<5) + (word<<2);
549            unsigned int hexa  = (buf[byte  ]<<24) |
550                                 (buf[byte+1]<<16) |
551                                 (buf[byte+2]<< 8) |
552                                 (buf[byte+3]      );
553            _printf(" %X |", hexa );
554        }
555        _printf("\n");
556    }
557    _printf("*******************************************************************\n"); 
558} // end _display_one_block() 
559#endif
560
561
562
563#if GIET_DEBUG_FAT
564/////////////////////////////////////
565static void _display_fat_descriptor()
566{
567    _printf("\n###############  FAT DESCRIPTOR  ################################" 
568            "\nFAT initialised                  %x"
569            "\nBlock Size  (bytes)              %x"
570            "\nCluster Size  (bytes)            %x"
571            "\nFAT region first lba             %x"
572            "\nFAT region size (blocks)         %x"
573            "\nDATA region first lba            %x"
574            "\nDATA region size (blocks)        %x"
575            "\nNumber of free clusters          %x"
576            "\nFirst free cluster index         %x" 
577            "\nFat_cache_levels                 %d" 
578            "\n#################################################################\n",
579            _fat.initialised,
580            _fat.sector_size,
581            _fat.cluster_size,
582            _fat.fat_lba,
583            _fat.fat_sectors,
584            _fat.data_lba,
585            _fat.data_sectors,
586            _fat.free_clusters_number,
587            _fat.first_free_cluster,
588            _fat.fat_cache_levels );
589
590} // end _display_fat_descriptor()
591#endif
592
593
594
595#if GIET_DEBUG_FAT
596////////////////////////////////////////////////////////
597static void _display_clusters_list( fat_inode_t* inode )
598{
599    _printf("\n**************** clusters for <%s> ***********************\n", inode->name );
600    unsigned int next;
601    unsigned int n       = 0;
602    unsigned int current = inode->cluster;
603    while( (current < END_OF_CHAIN_CLUSTER_MIN) && (n < 1024) )
604    {
605        _get_fat_entry( current , &next );
606        _printf(" > %X", current );
607        n++;
608        if ( (n & 0x7) == 0 ) _printf("\n");
609        current = next;
610    }
611    _printf("\n");
612}  // end _display_clusters_list()
613#endif
614
615
616
617/////////////////////////////////////////////////////////////////////////////////
618static int _fat_ioc_access( unsigned int use_irq,       // descheduling if non zero
619                            unsigned int to_mem,        // read / write
620                            unsigned int lba,           // first sector on device
621                            unsigned int buf_vaddr,     // memory buffer vaddr
622                            unsigned int count )        // number of sectors
623{
624    // compute memory buffer physical address
625    unsigned int       flags;         // for _v2p_translate
626    unsigned long long buf_paddr;     // buffer physical address
627
628    if ( ((_get_mmu_mode() & 0x4) == 0 ) || USE_IOC_RDK )  // identity
629    { 
630        buf_paddr = (unsigned long long)buf_vaddr;
631    }
632    else                                // V2P translation required
633    {
634        buf_paddr = _v2p_translate( buf_vaddr , &flags );
635    }
636
637#if (GIET_DEBUG_FAT & 1)
638if ( _get_proctime() > GIET_DEBUG_FAT )
639_printf("\n[DEBUG FAT] _fat_ioc_access() : enters at cycle %d\n"
640        "  to_mem = %d / vaddr = %x / paddr = %l / sectors = %d / lba = %x\n",
641        _get_proctime(), to_mem, buf_vaddr, buf_paddr, count, lba );
642#endif
643
644
645#if GIET_NO_HARD_CC     // L1 cache inval (virtual addresses)
646    if ( to_mem ) _dcache_buf_invalidate( buf_vaddr, count<<9 );
647#endif
648
649
650#if   ( USE_IOC_BDV )   // call the proper driver
651    return( _bdv_access( use_irq , to_mem , lba , buf_paddr , count ) ); 
652#elif ( USE_IOC_HBA )
653    return( _hba_access( use_irq , to_mem , lba , buf_paddr , count ) );
654#elif ( USE_IOC_SDC )
655    return( _sdc_access( use_irq , to_mem , lba , buf_paddr , count ) );
656#elif ( USE_IOC_SPI )
657    return( _spi_access( use_irq , to_mem , lba , buf_paddr , count ) );
658#elif ( USE_IOC_RDK )
659    return( _rdk_access( use_irq , to_mem , lba , buf_paddr , count ) );
660#else
661    _printf("\n[FAT ERROR] in _fat_ioc_access() : no IOC driver\n");
662    _exit();
663#endif
664
665}  // end _fat_ioc_access()
666
667
668
669
670/////////////////////////////////////////////////////////////////////
671static inline unsigned int _get_levels_from_size( unsigned int size )
672{ 
673    if      ( size <= (1<<18) ) return 1;     // 64 clusters == 256 Kbytes
674    else if ( size <= (1<<24) ) return 2;     // 64 * 64 clusters => 16 Mbytes
675    else if ( size <= (1<<30) ) return 3;     // 64 * 64 * 64 cluster => 1 Gbytes
676    else                        return 4;     // 64 * 64 * 64 * 64 clusters
677}
678
679
680
681////////////////////////////////////////////////////////
682static unsigned int _read_entry( unsigned int    offset,
683                                 unsigned int    size,
684                                 unsigned char*  buffer,
685                                 unsigned int    little_endian )
686{
687    unsigned int n;
688    unsigned int res  = 0;
689
690    if ( little_endian)
691    {
692        for( n = size ; n > 0 ; n-- ) res = (res<<8) | buffer[offset+n-1];
693    }
694    else
695    {
696        for( n = 0 ; n < size ; n++ ) res = (res<<8) | buffer[offset+n];
697    }
698    return res;
699
700}  // end _read_entry
701
702
703
704//////////////////////////////////////////////////////////////////
705static inline unsigned int _cluster_to_lba( unsigned int cluster )       
706{
707    if ( cluster < 2 )
708    { 
709        _printf("\n[FAT ERROR] in _cluster_to_lba() cluster smaller than 2\n"); 
710        _exit();
711    }
712
713   return  ((cluster - 2) << 3) + _fat.data_lba;
714}
715
716
717//////////////////////////////////////////////////////
718static inline unsigned char _to_lower(unsigned char c)
719{
720   if (c >= 'A' && c <= 'Z') return (c | 0x20);
721   else                      return c;
722}
723
724
725//////////////////////////////////////////////////////
726static inline unsigned char _to_upper(unsigned char c)
727{
728   if (c >= 'a' && c <= 'z') return (c & ~(0x20));
729   else                      return c;
730}
731
732
733
734///////////////////////////////////////////////////////////////////////////
735static unsigned int _get_name_from_path( char*          pathname,  // input
736                                         char*          name,      // output
737                                         unsigned int*  nb_read )  // input & output   
738{
739    // skip leading "/" character
740    if ( pathname[*nb_read] == '/' ) *nb_read = *nb_read + 1;
741
742    // initialises current indexes
743    unsigned int i = *nb_read;
744    unsigned int j = 0;
745   
746    while ( (pathname[i] != '/') && (pathname[i] != 0) )
747    {
748        name[j++] = pathname[i++];   
749        if ( j > NAME_MAX_SIZE ) return 1;
750    }
751
752    // set end of string
753    name[j] = 0;
754
755    // skip trailing "/" character
756    if ( pathname[i] == '/' ) *nb_read += j+1;
757    else                      *nb_read += j;
758
759    return 0;
760}
761
762
763
764////////////////////////////////////////////////////////////////////
765static unsigned int _get_last_name( char*   pathname,       // input
766                                    char*   name )          // output
767{
768    unsigned int nb_read = 0;     
769    while ( pathname[nb_read] != 0 )
770    {
771        if ( _get_name_from_path( pathname, name, &nb_read ) ) return 1;
772    }
773
774    return 0;
775}   // end _get_last_name()
776
777
778
779////////////////////////////////////////////////////////////////////////////////
780static void _get_name_from_short( unsigned char* buffer,  // input:  SFN dir_entry
781                                  char*          name )   // output: name
782{
783    unsigned int i;
784    unsigned int j = 0;
785
786    // get name
787    for ( i = 0; i < 8 && buffer[i] != ' '; i++ )
788    {
789        name[j] = _to_lower( buffer[i] );
790        j++;
791    }
792
793    // get extension
794    for ( i = 8; i < 8 + 3 && buffer[i] != ' '; i++ )
795    {
796        // we entered the loop so there is an extension. add the dot
797        if ( i == 8 )
798        {
799            name[j] = '.';
800            j++;
801        }
802
803        name[j] = _to_lower( buffer[i] );
804        j++;
805    }
806
807    name[j] = '\0';
808}
809
810///////////////////////////////////////////////////////////////////////////////
811static void _get_name_from_long( unsigned char*  buffer, // input : LFN dir_entry
812                                 char*           name )  // output : name
813{
814    unsigned int   name_offset         = 0;
815    unsigned int   buffer_offset       = get_length(LDIR_ORD);
816    unsigned int   l_name_1            = get_length(LDIR_NAME_1);
817    unsigned int   l_name_2            = get_length(LDIR_NAME_2);
818    unsigned int   l_name_3            = get_length(LDIR_NAME_3);
819    unsigned int   l_attr              = get_length(LDIR_ATTR);
820    unsigned int   l_type              = get_length(LDIR_TYPE);
821    unsigned int   l_chksum            = get_length(LDIR_CHKSUM);
822    unsigned int   l_rsvd              = get_length(LDIR_RSVD);
823
824    unsigned int j            = 0;
825    unsigned int eof          = 0;
826
827    while ( (buffer_offset != DIR_ENTRY_SIZE)  && (!eof) )
828    {
829        while (j != l_name_1 && !eof )
830        {
831            if ( (buffer[buffer_offset] == 0x00) || 
832                 (buffer[buffer_offset] == 0xFF) )
833            {
834                eof = 1;
835                continue;
836            }
837            name[name_offset] = buffer[buffer_offset];
838            buffer_offset += 2;
839            j += 2;
840            name_offset++;
841        }
842
843        buffer_offset += (l_attr + l_type + l_chksum);
844        j = 0;
845
846        while (j != l_name_2 && !eof )
847        {
848            if ( (buffer[buffer_offset] == 0x00) || 
849                 (buffer[buffer_offset] == 0xFF) )
850            {
851                eof = 1;
852                continue;
853            }
854            name[name_offset] = buffer[buffer_offset];
855            buffer_offset += 2;
856            j += 2;
857            name_offset++;
858        }
859
860        buffer_offset += l_rsvd;
861        j = 0;
862
863        while (j != l_name_3 && !eof )
864        {
865            if ( (buffer[buffer_offset] == 0x00) || 
866                 (buffer[buffer_offset] == 0xFF) )
867            {
868                eof = 1;
869                continue;
870            }
871            name[name_offset] = buffer[buffer_offset];
872            buffer_offset += 2;
873            j += 2;
874            name_offset++;
875        }
876    }
877    name[name_offset] = 0;
878} // end get_name_from_long()
879
880
881
882////////////////////////////////////////////////////////////
883static fat_cache_node_t* _allocate_one_cache_node( fat_cache_node_t* first_child )
884{
885    fat_cache_node_t* cnode;
886    unsigned int i;
887
888    cnode = _malloc( sizeof(fat_cache_node_t) );
889
890    cnode->children[0] = first_child;
891    for ( i = 1 ; i < 64 ; i++ )
892        cnode->children[i] = NULL;
893
894    return cnode;
895}   // end _allocate_one_cache_node()
896
897
898
899////////////////////////////////////////////////////////////
900static fat_inode_t* _allocate_one_inode( char*        name,
901                                         unsigned int is_dir,
902                                         unsigned int cluster,
903                                         unsigned int size, 
904                                         unsigned int count,
905                                         unsigned int dentry,
906                                         unsigned int cache_allocate )
907{
908    fat_inode_t* new_inode  = _malloc( sizeof(fat_inode_t) );
909
910    new_inode->parent   = NULL;                 // set by _add_inode_in_tree()
911    new_inode->next     = NULL;                 // set by _add_inode_in_tree()
912    new_inode->child    = NULL;                 // set by _add_inode_in_tree()
913    new_inode->cluster  = cluster;
914    new_inode->size     = size; 
915    new_inode->cache    = NULL;
916    new_inode->levels   = 0;
917    new_inode->count    = count;
918    new_inode->is_dir   = (is_dir != 0);
919    new_inode->dentry   = dentry;             
920
921    _strcpy( new_inode->name , name ); 
922
923    if ( cache_allocate )
924    {
925        new_inode->cache    = _allocate_one_cache_node( NULL );
926        new_inode->levels   = _get_levels_from_size( size );
927    }
928
929    return new_inode;
930}   // end _allocate_one_inode()
931
932
933
934
935////////////////////////////////////////////////////
936static void _add_inode_in_tree( fat_inode_t*  child,
937                                fat_inode_t*  parent )
938{
939    child->parent = parent;
940    child->next   = parent->child;
941    parent->child = child;
942}   // end _add_inode-in_tree()
943
944
945
946
947//////////////////////////////////////////////////////////
948static void _remove_inode_from_tree( fat_inode_t*  inode )
949{
950    fat_inode_t*  current;
951    fat_inode_t*  prev = inode->parent->child;
952
953    if ( inode == prev )  // removed inode is first in its linked list
954    {
955        inode->parent->child = inode->next;
956    }
957    else                  // removed inode is not the first
958    {
959        for( current = prev->next ; current ; current = current->next )
960        {
961            if ( current == inode )
962            {
963                prev->next = current->next;
964            }
965            prev = current;
966        }   
967    }   
968}  // end _delete_one_inode()
969
970
971
972
973//////////////////////////////////////////////////////////////////////
974static unsigned int _get_buffer_from_cache( fat_inode_t*        inode,
975                                            unsigned int        cluster_id,
976                                            fat_cache_desc_t**  desc )
977{
978    // get cache pointer and levels
979    fat_cache_node_t*   node;         // pointer on a 64-tree node
980    unsigned int        level;        // cache level
981
982    if ( inode == NULL )   // searched cache is the Fat-Cache
983    {
984        node   = _fat.fat_cache_root;
985        level  = _fat.fat_cache_levels;
986
987#if (GIET_DEBUG_FAT & 1)
988if ( _get_proctime() > GIET_DEBUG_FAT )
989_printf("\n[DEBUG FAT] _get_buffer_from_cache() : enters in FAT-Cache"
990        " for cluster_id = %d\n", cluster_id );
991#endif
992
993    }
994    else                   // searched cache is a File-Cache
995    {
996        node   = inode->cache;
997        level  = inode->levels;
998
999#if (GIET_DEBUG_FAT & 1)
1000if ( _get_proctime() > GIET_DEBUG_FAT )
1001_printf("\n[DEBUG FAT] _get_buffer_from_cache() : enters in File-Cache <%s>"
1002        " for cluster_id = %d\n", inode->name , cluster_id );
1003#endif
1004
1005    }
1006
1007    // search the 64-tree cache from top to bottom
1008    while ( level )
1009    {
1010        // compute child index at each level
1011        unsigned int index = (cluster_id >> (6*(level-1))) & 0x3F;
1012
1013        if ( level == 1 )        // last level => children are cluster descriptors
1014        {
1015            fat_cache_desc_t* pdesc = (fat_cache_desc_t*)node->children[index];
1016
1017            if ( pdesc == NULL )      // miss
1018            {
1019                // allocate one cluster descriptor and one 4K buffer
1020                unsigned char* buf = _malloc( 4096 );
1021                pdesc              = _malloc( sizeof(fat_cache_desc_t) );
1022
1023                // get missing cluster index lba
1024                unsigned int lba;
1025                unsigned int next;
1026                unsigned int current = inode->cluster;
1027                unsigned int count   = cluster_id;
1028
1029                if ( inode == NULL )      // searched cache is the Fat-Cache
1030                {
1031
1032#if (GIET_DEBUG_FAT & 1)
1033if ( _get_proctime() > GIET_DEBUG_FAT )
1034_printf("\n[DEBUG FAT] _get_buffer_from_cache() : miss in FAT-Cache for cluster_id %d\n",
1035        cluster_id );
1036#endif
1037                    lba = _fat.fat_lba + (cluster_id << 3);
1038                }
1039                else                      // searched cache is a File-Cache
1040                {
1041
1042#if (GIET_DEBUG_FAT & 1)
1043if ( _get_proctime() > GIET_DEBUG_FAT )
1044_printf("\n[DEBUG FAT] _get_buffer_from_cache() : miss in File-Cache <%s> "
1045        "for cluster_id %d\n", inode->name, cluster_id );
1046#endif
1047                    while ( count )
1048                    { 
1049                        if ( _get_fat_entry( current , &next ) ) return 1;
1050                        current = next;
1051                        count--;
1052                    }
1053                    lba = _cluster_to_lba( current );
1054                }
1055
1056                // load one cluster (8 blocks) from block device
1057                if ( _fat_ioc_access( 1,         // descheduling
1058                                      1,         // to memory
1059                                      lba,
1060                                      (unsigned int)buf,
1061                                      8 ) )
1062                {
1063                    _printf("\n[FAT ERROR] in _get_buffer_from_cache()"
1064                            " : cannot access block device for lba = %x\n", lba );
1065                    return 1;
1066                }
1067
1068                // update cache and buffer descriptor
1069                node->children[index] = pdesc;
1070                pdesc->lba     = lba;
1071                pdesc->buffer  = buf;
1072                pdesc->dirty   = 0;
1073
1074#if (GIET_DEBUG_FAT & 1)
1075if ( _get_proctime() > GIET_DEBUG_FAT )
1076_printf("\n[DEBUG FAT] _get_buffer_from_cache() : buffer loaded from device"
1077        " at vaddr = %x\n", (unsigned int)buf );
1078#endif
1079            }
1080
1081            // return pdesc pointer
1082            *desc = pdesc;
1083
1084            // prepare next iteration
1085            level--;
1086        }
1087        else                      // not last level => children are 64-tree nodes
1088        {
1089            fat_cache_node_t* child = (fat_cache_node_t*)node->children[index];
1090            if ( child == NULL )  // miss
1091            {
1092                // allocate a cache node if miss
1093                child = _allocate_one_cache_node( NULL );
1094                node->children[index] = child;   
1095            }
1096
1097            // prepare next iteration
1098            node = child;
1099            level--;
1100        }
1101    } // end while
1102
1103    return 0;
1104}  // end _get_buffer_from_cache()
1105
1106
1107
1108
1109/////////////////////////////////////
1110static unsigned int _update_fs_info()
1111{
1112    // update buffer if miss
1113    if ( _fat.fs_info_lba != _fat.block_buffer_lba )
1114    {
1115        if ( _fat_ioc_access( 1,                 // descheduling
1116                              1,                 // read
1117                              _fat.fs_info_lba, 
1118                              (unsigned int)_fat.block_buffer, 
1119                              1 ) )              // one block
1120        {
1121            _printf("\n[FAT_ERROR] in _update_fs_info() cannot read block\n");
1122            return 1;
1123        }
1124        _fat.block_buffer_lba = _fat.fs_info_lba;
1125    }
1126
1127    // update FAT buffer
1128    unsigned int* ptr;
1129    ptr  = (unsigned int*)(_fat.block_buffer + get_offset(FS_FREE_CLUSTERS) );
1130    *ptr = _fat.free_clusters_number;
1131
1132    ptr  = (unsigned int*)(_fat.block_buffer + get_offset(FS_FREE_CLUSTER_HINT) );
1133    *ptr = _fat.first_free_cluster;
1134   
1135    // write bloc to FAT
1136    if ( _fat_ioc_access( 1,                // descheduling
1137                          0,                // write
1138                          _fat.fs_info_lba,
1139                          (unsigned int)_fat.block_buffer, 
1140                          1 ) )             // one block
1141    {
1142        _printf("\n[FAT_ERROR] in _update_fs_info() cannot write block\n");
1143        return 1;
1144    }
1145
1146#if (GIET_DEBUG_FAT & 1)
1147if ( _get_proctime() > GIET_DEBUG_FAT )
1148_printf("\n[DEBUG FAT] _update_fs_info() : nb_free = %x / first_free = %x\n",
1149        _fat.free_clusters_number , _fat.first_free_cluster );
1150#endif
1151
1152    return 0;
1153}  // end _update_fs_info()
1154
1155
1156
1157/////////////////////////////////////////////////////////////////
1158static inline unsigned int _get_fat_entry( unsigned int  cluster,
1159                                           unsigned int* value )
1160{
1161    // compute cluster_id & entry_id in FAT
1162    // a FAT cluster is an array of 1024 unsigned int entries
1163    unsigned int       cluster_id = cluster >> 10;       
1164    unsigned int       entry_id   = cluster & 0x3FF;
1165
1166    // get pointer on the relevant cluster descriptor in FAT cache
1167    fat_cache_desc_t*  pdesc;
1168    unsigned int*      buffer;
1169    if ( _get_buffer_from_cache( NULL,               // Fat-Cache
1170                                 cluster_id,
1171                                 &pdesc ) ) return 1;
1172
1173    // get value from FAT slot
1174    buffer = (unsigned int*)pdesc->buffer;
1175    *value = buffer[entry_id];
1176
1177    return 0;
1178}  // end _get_fat_entry()
1179
1180
1181
1182////////////////////////////////////////////////////////////////
1183static inline unsigned int _set_fat_entry( unsigned int cluster, 
1184                                           unsigned int value  )
1185{
1186    // compute cluster_id & entry_id in FAT
1187    // a FAT cluster is an array of 1024 unsigned int entries
1188    unsigned int cluster_id = cluster >> 10;
1189    unsigned int entry_id   = cluster & 0x3FF;
1190
1191    // get pointer on the relevant cluster descriptor in FAT cache
1192    fat_cache_desc_t*  pdesc;
1193    unsigned int*      buffer; 
1194    if ( _get_buffer_from_cache( NULL,               // Fat-Cache
1195                                 cluster_id,
1196                                 &pdesc ) )  return 1;           
1197
1198    // set value into FAT slot
1199    buffer           = (unsigned int*)pdesc->buffer;
1200    buffer[entry_id] = value;
1201    pdesc->dirty     = 1;
1202
1203    return 0;
1204} // end _set_fat_entry()
1205
1206
1207
1208//////////////////////////////////////////////////////
1209static void _allocate_one_buffer( fat_inode_t*  inode,
1210                                  unsigned int  cluster_id,
1211                                  unsigned int  cluster )
1212{
1213    // add cache levels if needed
1214    while ( _get_levels_from_size( (cluster_id + 1) * 4096 ) > inode->levels )
1215    {
1216#if (GIET_DEBUG_FAT & 1)
1217if ( _get_proctime() > GIET_DEBUG_FAT )
1218_printf("\n[DEBUG FAT] _allocate_one_buffer() : adding a cache level\n" );
1219#endif
1220
1221        inode->cache = _allocate_one_cache_node( inode->cache );
1222        inode->levels++;
1223    }
1224
1225    // search the 64-tree cache from top to bottom
1226    fat_cache_node_t*  node   = inode->cache;
1227    unsigned int       level  = inode->levels;
1228
1229    while ( level )
1230    {
1231        // compute child index
1232        unsigned int index = (cluster_id >> (6*(level-1))) & 0x3F;
1233
1234        if ( level == 1 )        // last level => children are cluster descriptors
1235        {
1236            fat_cache_desc_t* pdesc = (fat_cache_desc_t*)node->children[index];
1237            if ( pdesc != NULL )      // slot not empty!!!
1238            {
1239                _printf("\n[FAT ERROR] in allocate_one buffer() : slot not empty "
1240                        "in File-Cache <%s> / cluster_id = %d\n", inode->name , cluster_id );
1241                _exit();
1242            }
1243 
1244            // allocate a cluster descriptor and a 4K buffer
1245            pdesc = _malloc( sizeof(fat_cache_desc_t) );
1246            unsigned char* buffer = _malloc( 4096 );
1247
1248#if (GIET_DEBUG_FAT & 1)
1249if ( _get_proctime() > GIET_DEBUG_FAT )
1250_printf("\n[DEBUG FAT] _allocate_one_buffer() : buffer allocated to <%s> for cluster_id %d\n",
1251        inode->name, cluster_id );
1252#endif
1253
1254            // update cache and pdesc
1255            node->children[index] = pdesc;
1256            pdesc->lba     = _cluster_to_lba( cluster );
1257            pdesc->buffer  = buffer;
1258            pdesc->dirty   = 1;
1259
1260            // prepare next iteration
1261            level--;
1262        }
1263        else                      // not last level => children are 64-tree nodes
1264        {
1265            fat_cache_node_t* child = (fat_cache_node_t*)node->children[index];
1266            if ( child == NULL )  // miss
1267            {
1268                // allocate a cache node if miss
1269                child = _allocate_one_cache_node( NULL );
1270                node->children[index] = child;   
1271            }
1272
1273            // prepare next iteration
1274            node  = child;
1275            level--;
1276        }
1277    } // end while
1278} // end _allocate_one_buffer
1279
1280
1281
1282
1283///////////////////////////////////////////////////////////////////
1284static unsigned int _allocate_one_cluster( unsigned int*  cluster ) 
1285{
1286    unsigned int nb_free = _fat.free_clusters_number;
1287    unsigned int free    = _fat.first_free_cluster;
1288
1289    // scan FAT to get next free cluster index
1290    unsigned int current = free;
1291    unsigned int found   = 0;
1292    unsigned int max     = (_fat.data_sectors >> 3);
1293    unsigned int value;
1294    do
1295    {
1296        // increment current
1297        current++;
1298
1299        // get FAT entry indexed by current
1300        if ( _get_fat_entry( current , &value ) ) return 1;
1301        // test if free
1302        if ( value == FREE_CLUSTER ) found = 1;
1303    }
1304    while ( (current < max) && (found == 0) );
1305       
1306    // check found 
1307    if ( found == 0 )
1308    {
1309        _printf("\n[FAT_ERROR] in _allocate_one_cluster() : unconsistent FAT state");
1310        return 1;
1311    }
1312
1313    // update allocated FAT slot
1314    if ( _set_fat_entry( free , END_OF_CHAIN_CLUSTER_MAX ) ) return 1;
1315
1316    // update FAT descriptor global variables
1317    _fat.free_clusters_number = nb_free - 1;
1318    _fat.first_free_cluster   = current;
1319
1320#if (GIET_DEBUG_FAT & 1)
1321if ( _get_proctime() > GIET_DEBUG_FAT )
1322_printf("\n[DEBUG FAT] _allocate_one_cluster() : cluster = %x / first_free = %x\n",
1323        free , current );
1324#endif
1325
1326    // returns free cluster index
1327    *cluster = free;
1328    return 0;
1329
1330}  // end _allocate_one_cluster()
1331
1332
1333
1334
1335//////////////////////////////////////////////////////////////////////////
1336static unsigned int _update_device_from_cache( unsigned int        levels,
1337                                               fat_cache_node_t*   root,
1338                                               char*               string )
1339{
1340    unsigned int index;
1341    unsigned int ret = 0;
1342
1343    if ( levels == 1 )  // last level => children are cluster descriptors
1344    {
1345        for( index = 0 ; index < 64 ; index++ )
1346        { 
1347            fat_cache_desc_t* pdesc = root->children[index];
1348            if ( pdesc != NULL )
1349            { 
1350                // update cluster on device if dirty
1351                if ( pdesc->dirty )
1352                {
1353                    if ( _fat_ioc_access( 1,           // descheduling
1354                                          0,           // to block device
1355                                          pdesc->lba,
1356                                          (unsigned int)pdesc->buffer,
1357                                          8 ) )
1358                    {
1359                        _printf("\n[FAT_ERROR] in _update_device from_cache() : "
1360                                " cannot access lba = %x\n", pdesc->lba );
1361                        ret = 1;
1362                    }
1363                    else
1364                    {
1365                        pdesc->dirty = 0;
1366
1367#if (GIET_DEBUG_FAT & 1)
1368if ( _get_proctime() > GIET_DEBUG_FAT )
1369_printf("\n[DEBUG FAT] _update_device_from_cache() : cluster_id = %d for <%s>\n",
1370        index , string );
1371#endif
1372
1373                    }
1374                }
1375            }
1376        }
1377    }
1378    else               // not the last level = recursive call on each children
1379    {
1380        for( index = 0 ; index < 64 ; index++ )
1381        { 
1382            fat_cache_node_t* pnode = root->children[index];
1383            if ( pnode != NULL )
1384            {
1385                if ( _update_device_from_cache( levels - 1,
1386                                                root->children[index],
1387                                                string ) ) ret = 1;
1388            }   
1389        }
1390    }
1391    return ret;
1392}  // end _update_device_from_cache()
1393
1394
1395
1396///////////////////////////////////////////////////////////////////
1397static void _release_cache_memory( fat_cache_node_t*  root,
1398                                   unsigned int       levels )
1399{
1400    unsigned int i;
1401
1402    if ( levels == 1 )  // last level => children are cluster descriptors
1403    {
1404        for( i = 0 ; i < 64 ; i++ )
1405        { 
1406            fat_cache_desc_t* pdesc = root->children[i];
1407
1408            if ( pdesc != NULL )
1409            { 
1410                // check dirty
1411                if ( pdesc->dirty )
1412                    _printf("\n[FAT ERROR] in _release_cache_memory() : dirty cluster\n");
1413
1414                _free( pdesc->buffer );
1415                _free( pdesc );
1416                root->children[i] = NULL;
1417            }
1418        }
1419    }
1420    else               // not the last level = recursive call on each children
1421    {
1422        for( i = 0 ; i < 64 ; i++ )
1423        { 
1424            fat_cache_node_t* cnode = root->children[i];
1425
1426            if ( cnode != NULL )
1427            {
1428                _release_cache_memory( cnode, levels - 1 );
1429                _free( cnode );
1430                root->children[i] = NULL;
1431            }
1432        }
1433    }
1434}  // end _release_cache_memory()
1435
1436
1437
1438
1439
1440/////////////////////////////////////////////////////////////
1441static unsigned int _clusters_allocate( fat_inode_t* inode, 
1442                                        unsigned int nb_current_clusters,
1443                                        unsigned int nb_required_clusters )
1444{
1445    // Check if FAT contains enough free clusters
1446    if ( nb_required_clusters > _fat.free_clusters_number )
1447    {
1448        _printf("\n[FAT ERROR] in _clusters_allocate() : required_clusters = %d"
1449                " / free_clusters = %d\n", nb_required_clusters , _fat.free_clusters_number );
1450        return 1;
1451    }
1452
1453#if (GIET_DEBUG_FAT & 1)
1454if ( _get_proctime() > GIET_DEBUG_FAT )
1455_printf("\n[DEBUG FAT] _clusters_allocate() : enters for <%s> / nb_current_clusters = %d "
1456        "/ nb_required_clusters = %d\n", 
1457        inode->name , nb_current_clusters , nb_required_clusters );
1458#endif
1459 
1460    // compute last allocated cluster index when (nb_current_clusters > 0)
1461    unsigned int current = inode->cluster;
1462    unsigned int next;
1463    unsigned int last;
1464    if ( nb_current_clusters )   // clusters allocated => search last
1465    {   
1466        while ( current < END_OF_CHAIN_CLUSTER_MIN )
1467        {
1468            // get next cluster
1469            if ( _get_fat_entry( current , &next ) )  return 1;
1470            last    = current;
1471            current = next;
1472        }
1473    } 
1474
1475    // Loop on the new clusters to be allocated
1476    // if (nb_current_clusters == 0) the first new cluster index must
1477    //                               be written in inode->cluster field
1478    // if (nb_current_clusters >  0) the first new cluster index must
1479    //                               be written in FAT[last]
1480    unsigned int      cluster_id;
1481    unsigned int      new;
1482    for ( cluster_id = nb_current_clusters ; 
1483          cluster_id < (nb_current_clusters + nb_required_clusters) ; 
1484          cluster_id ++ )
1485    {
1486        // allocate one cluster on block device
1487        if ( _allocate_one_cluster( &new ) ) return 1;
1488
1489        // allocate one 4K buffer to File-Cache
1490        _allocate_one_buffer( inode,
1491                              cluster_id,
1492                              new );
1493
1494        if ( cluster_id == 0 )  // update inode
1495        {
1496            inode->cluster = new;
1497        }
1498        else                    // update FAT
1499        {
1500            if ( _set_fat_entry( last , new ) ) return 1;
1501        }
1502
1503#if (GIET_DEBUG_FAT & 1)
1504if ( _get_proctime() > GIET_DEBUG_FAT )
1505_printf("\n[DEBUG FAT] _clusters_allocate() : done for cluster_id = %d / cluster = %x\n",
1506        cluster_id , new );
1507#endif
1508
1509        // update loop variables
1510        last = new;
1511
1512    } // end for loop
1513
1514    // update FAT : last slot should contain END_OF_CHAIN_CLUSTER_MAX
1515    if ( _set_fat_entry( last , END_OF_CHAIN_CLUSTER_MAX ) )  return 1;
1516
1517    // update the FAT on block device
1518    if ( _update_device_from_cache( _fat.fat_cache_levels,
1519                                    _fat.fat_cache_root,
1520                                    "FAT" ) )              return 1;
1521    return 0;
1522}  // end _clusters_allocate()
1523
1524
1525
1526//////////////////////////////////////////////////////////////
1527static unsigned int _clusters_release( unsigned int cluster )
1528{
1529    // scan the FAT
1530    unsigned int current = cluster;
1531    unsigned int next;
1532    do
1533    { 
1534        // get next_cluster index
1535        if ( _get_fat_entry( current , &next ) )  return 1;
1536
1537        // release current_cluster
1538        if ( _set_fat_entry( current , FREE_CLUSTER ) )   return 1;
1539
1540        // update first_free_cluster and free_clusters_number in FAT descriptor
1541        _fat.free_clusters_number = _fat.free_clusters_number + 1;
1542        if ( _fat.first_free_cluster > current ) _fat.first_free_cluster = current;
1543
1544        // update loop variable
1545        current = next;
1546    }
1547    while ( next < END_OF_CHAIN_CLUSTER_MIN );
1548
1549    // update the FAT on block device
1550    if ( _update_device_from_cache( _fat.fat_cache_levels,
1551                                    _fat.fat_cache_root,
1552                                    "FAT" ) )                return 1;
1553    return 0;
1554}  // end _clusters_release()
1555
1556
1557
1558///////////////////////////////////////////////////////////
1559static void _add_special_directories( fat_inode_t*  child, 
1560                                      fat_inode_t*  parent )
1561{
1562    // get first File-Cache buffer for child
1563    fat_cache_desc_t*   pdesc  = (fat_cache_desc_t*)child->cache->children[0];
1564    unsigned char*      entry;
1565
1566    unsigned int i;
1567    unsigned int cluster;
1568    unsigned int size;
1569
1570    // set "." entry (32 bytes)
1571    cluster = child->cluster;
1572    size    = child->size;
1573    entry   = pdesc->buffer;
1574   
1575    for ( i = 0 ; i < 32 ; i++ )
1576    {
1577        if      (i == 0 )     entry[i] = 0x2E;          // SFN
1578        else if (i <  11)     entry[i] = 0x20;          // SFN
1579        else if (i == 11)     entry[i] = 0x10;          // ATTR == dir
1580        else if (i == 20)     entry[i] = cluster>>16;   // cluster.B2
1581        else if (i == 21)     entry[i] = cluster>>24;   // cluster.B3
1582        else if (i == 26)     entry[i] = cluster>>0;    // cluster.B0
1583        else if (i == 27)     entry[i] = cluster>>8;    // cluster.B1
1584        else if (i == 28)     entry[i] = size>>0;       // size.B0
1585        else if (i == 29)     entry[i] = size>>8;       // size.B1
1586        else if (i == 30)     entry[i] = size>>16;      // size.B2
1587        else if (i == 31)     entry[i] = size>>24;      // size.B3
1588        else                  entry[i] = 0x00;
1589    }
1590
1591    // set ".." entry (32 bytes)
1592    cluster = parent->cluster;
1593    size    = parent->size;
1594    entry   = pdesc->buffer + 32;
1595
1596    for ( i = 0 ; i < 32 ; i++ )
1597    {
1598        if      (i <  2 )     entry[i] = 0x2E;          // SFN
1599        else if (i <  11)     entry[i] = 0x20;          // SFN
1600        else if (i == 11)     entry[i] = 0x10;          // ATTR == dir
1601        else if (i == 20)     entry[i] = cluster>>16;   // cluster.B2
1602        else if (i == 21)     entry[i] = cluster>>24;   // cluster.B3
1603        else if (i == 26)     entry[i] = cluster>>0;    // cluster.B0
1604        else if (i == 27)     entry[i] = cluster>>8;    // cluster.B1
1605        else if (i == 28)     entry[i] = size>>0;       // size.B0
1606        else if (i == 29)     entry[i] = size>>8;       // size.B1
1607        else if (i == 30)     entry[i] = size>>16;      // size.B2
1608        else if (i == 31)     entry[i] = size>>24;      // size.B3
1609        else                  entry[i] = 0x00;
1610    }
1611}  // end _add_special_directories
1612
1613
1614
1615////////////////////////////////////////////////////////////
1616static unsigned int _is_ancestor( fat_inode_t* a,
1617                                  fat_inode_t* b )
1618{
1619    while ( b )
1620    {
1621        if ( a == b )
1622            return 1;
1623
1624        b = b->parent;
1625    }
1626
1627    return 0;
1628} // _is_ancestor()
1629
1630
1631
1632////////////////////////////////////////////////////////////
1633static unsigned int _check_name_length( char* name,
1634                                        unsigned int* length,
1635                                        unsigned int* nb_lfn )
1636{
1637    unsigned int len = _strlen( name );
1638    if      ( len <= 13 )
1639    {
1640        *length  = len;
1641        *nb_lfn  = 1;
1642        return 0;
1643    }
1644    else if ( len <= 26 )
1645    {
1646        *length  = len;
1647        *nb_lfn  = 2;
1648        return 0;
1649    }
1650    else if ( len <= 31 )
1651    {
1652        *length  = len;
1653        *nb_lfn  = 3;
1654        return 0;
1655    }
1656    else
1657    {
1658        return 1;
1659    }
1660}  // _check_name_length()
1661
1662
1663
1664
1665///////////////////////////////////////////////////////////
1666static unsigned int _get_nb_entries( fat_inode_t*   inode,
1667                                     unsigned int*  nb_entries )
1668{
1669    // scan directory until "end of directory" with two embedded loops:
1670    // - scan the clusters allocated to this directory
1671    // - scan the entries to find NO_MORE_ENTRY
1672    fat_cache_desc_t*  pdesc;                      // pointer on buffer descriptor
1673    unsigned char*     buffer;                     // 4 Kbytes buffer (one cluster)
1674    unsigned int       ord;                        // ORD field in directory entry
1675    unsigned int       attr;                       // ATTR field in directory entry
1676    unsigned int       cluster_id = 0;             // cluster index in directory
1677    unsigned int       offset     = 0;             // position in scanned buffer
1678    unsigned int       found      = 0;             // NO_MORE_ENTRY found
1679    unsigned int       count      = 0;             // number of valid NORMAL entries
1680
1681    // loop on clusters allocated to directory
1682    while ( found == 0 )
1683    {
1684        // get one 4 Kytes buffer from File_Cache 
1685        if ( _get_buffer_from_cache( inode,
1686                                     cluster_id,
1687                                     &pdesc ) )   return 1;
1688        buffer = pdesc->buffer;
1689       
1690        // loop on directory entries in buffer
1691        while ( (offset < 4096) && (found == 0) )
1692        {
1693            attr = _read_entry( DIR_ATTR , buffer + offset , 0 );   
1694            ord  = _read_entry( LDIR_ORD , buffer + offset , 0 );
1695
1696            if ( ord == NO_MORE_ENTRY )
1697            {
1698                found = 1;
1699            } 
1700            else if ( ord == FREE_ENTRY )             // free entry => skip
1701            {
1702                offset = offset + 32;
1703            }
1704            else if ( attr == ATTR_LONG_NAME_MASK )   // LFN entry => skip
1705            {
1706                offset = offset + 32;
1707            }
1708            else                                      // NORMAL entry
1709            {
1710                offset = offset + 32;
1711                count++;
1712            }
1713        }  // end loop on directory entries
1714
1715        cluster_id++;
1716        offset = 0;
1717
1718    }  // end loop on clusters
1719
1720    // return nb_entries
1721    *nb_entries = count;
1722   
1723    return 0;
1724}  // end dir_not_empty()
1725
1726
1727
1728///////////////////////////////////////////////////////////
1729static unsigned int _add_dir_entry( fat_inode_t*   child,
1730                                    fat_inode_t*   parent )
1731{
1732    // get child attributes
1733    unsigned int      is_dir  = child->is_dir;     
1734    unsigned int      size    = child->size;
1735    unsigned int      cluster = child->cluster;
1736
1737    // compute number of required entries to store child->name
1738    // - Short name (less than 13 characters) require 3 entries:
1739    //   one LFN entry / one NORMAL entry / one NO_MORE_ENTRY entry.
1740    // - Longer names (up to 31 characters) can require 4 or 5 entries:
1741    //   2 or 3 LFN entries / one NORMAL entry / one NO_MORE entry.
1742    unsigned int length;
1743    unsigned int nb_lfn;
1744    if ( _check_name_length( child->name, 
1745                             &length,
1746                             &nb_lfn ) )  return 1;
1747
1748#if (GIET_DEBUG_FAT & 1)
1749if ( _get_proctime() > GIET_DEBUG_FAT )
1750_printf("\n[DEBUG FAT] _add_dir_entry() : try to add <%s> in <%s> / nb_lfn = %d\n", 
1751        child->name , parent->name, nb_lfn );
1752#endif
1753
1754    // Find end of directory : two embedded loops:
1755    // - scan the clusters allocated to this directory
1756    // - scan the entries to find NO_MORE_ENTRY
1757    fat_cache_desc_t*  pdesc;                      // pointer on buffer descriptor
1758    unsigned char*     buffer;                     // 4 Kbytes buffer (one cluster)
1759    unsigned int       cluster_id = 0;             // cluster index in directory
1760    unsigned int       offset     = 0;             // position in scanned buffer
1761    unsigned int       found      = 0;             // NO_MORE_ENTRY found
1762
1763    // loop on clusters allocated to directory
1764    while ( found == 0 )
1765    {
1766        // get one 4 Kytes buffer from File_Cache 
1767        if ( _get_buffer_from_cache( parent,
1768                                     cluster_id,
1769                                     &pdesc ) )   return 1;
1770
1771        buffer = pdesc->buffer;
1772       
1773        // loop on directory entries in buffer
1774        while ( (offset < 4096) && (found == 0) )
1775        {
1776            if ( _read_entry( LDIR_ORD , buffer + offset , 0 ) == NO_MORE_ENTRY )
1777            {
1778                found        = 1;
1779                pdesc->dirty = 1;
1780            } 
1781            else
1782            {
1783                offset = offset + 32;
1784            }
1785        }  // end loop on entries
1786        if ( found == 0 )
1787        {
1788            cluster_id++;
1789            offset = 0;
1790        }
1791    }  // end loop on clusters
1792
1793#if (GIET_DEBUG_FAT & 1)
1794if ( _get_proctime() > GIET_DEBUG_FAT )
1795_printf("\n[DEBUG FAT] _add_dir_entry() : get NO_MORE directory entry : "
1796        " buffer = %x / offset = %x / cluster_id = %d\n",
1797        (unsigned int)buffer , offset , cluster_id );
1798#endif
1799
1800    // enter FSM :
1801    // The new child requires to write 3, 4, or 5 directory entries.
1802    // To actually register the new child, we use a 5 steps FSM
1803    // (one state per entry to be written), that is traversed as:
1804    //    LFN3 -> LFN2 -> LFN1 -> NORMAL -> NOMORE
1805    // The buffer and first directory entry to be  written are identified
1806    // by the variables : buffer / cluster_id / offset
1807
1808    unsigned char* name  = (unsigned char*)child->name;
1809
1810    unsigned int step;          // FSM state
1811
1812    if      ( nb_lfn == 1 ) step = 3;
1813    else if ( nb_lfn == 2 ) step = 4;
1814    else if ( nb_lfn == 3 ) step = 5;
1815   
1816    unsigned int   i;           // byte index in 32 bytes directory
1817    unsigned int   c;           // character index in name
1818    unsigned char* entry;       // buffer + offset;
1819
1820    while ( step )   
1821    {
1822        // get another buffer if required
1823        if ( offset >= 4096 )  // new buffer required
1824        {
1825            if ( cluster_id == 63 )   // we need to increase depth of File-Cache
1826            {
1827                _printf("\n[FAT ERROR] in add_dir_entry() File Cache depth extension "
1828                        " not implemented\n" );
1829                _exit();  // TODO   
1830            }
1831            else
1832            {
1833                if ( _get_buffer_from_cache( parent,
1834                                             cluster_id + 1,
1835                                             &pdesc ) )      return 1;       
1836                buffer       = pdesc->buffer;
1837                pdesc->dirty = 1;
1838                offset       = 0;
1839            }
1840        }
1841
1842        // compute directory entry address
1843        entry = buffer + offset;
1844
1845#if (GIET_DEBUG_FAT & 1)
1846if ( _get_proctime() > GIET_DEBUG_FAT )
1847_printf("\n[DEBUG FAT] _add_dir_entry() : FSM step = %d /"
1848        " offset = %x / nb_lfn = %d\n", step, offset, nb_lfn );
1849#endif
1850
1851        // write one 32 bytes directory entry per iteration
1852        switch ( step )
1853        {
1854            case 5:   // write LFN3 entry
1855            {
1856                c = 26;
1857                // scan the 32 bytes in dir_entry
1858                for ( i = 0 ; i < 32 ; i++ )
1859                {
1860                    if (i == 0)
1861                    {
1862                        if ( nb_lfn == 3) entry[i] = 0x43;
1863                        else              entry[i] = 0x03;
1864                    }
1865                    else if ( ( ((i >= 1 ) && (i<=10) && ((i&1)==1))   ||
1866                                ((i >= 14) && (i<=25) && ((i&1)==0))   ||
1867                                ((i >= 28) && (i<=31) && ((i&1)==0)) ) &&
1868                              ( c < length ) )
1869                    {
1870                                          entry[i] = name[c];
1871                                          c++;
1872                    }
1873                    else if (i == 11)     entry[i] = 0x0F;
1874                    else if (i == 12)     entry[i] = 0xCA;
1875                    else                  entry[i] = 0x00;
1876                }
1877                step--;
1878                break;
1879            }
1880            case 4:   // write LFN2 entry 
1881            {
1882                c = 13;
1883                // scan the 32 bytes in dir_entry
1884                for ( i = 0 ; i < 32 ; i++ )
1885                {
1886                    if (i == 0)
1887                    {
1888                        if ( nb_lfn == 2) entry[i] = 0x42;
1889                        else              entry[i] = 0x02;
1890                    }
1891                    else if ( ( ((i >= 1 ) && (i<=10) && ((i&1)==1))   ||
1892                                ((i >= 14) && (i<=25) && ((i&1)==0))   ||
1893                                ((i >= 28) && (i<=31) && ((i&1)==0)) ) &&
1894                              ( c < length ) )
1895                    {
1896                                          entry[i] = name[c];
1897                                          c++;
1898                    }
1899                    else if (i == 11)     entry[i] = 0x0F;
1900                    else if (i == 12)     entry[i] = 0xCA;
1901                    else                  entry[i] = 0x00;
1902                }
1903                step--;
1904                break;
1905            }
1906            case 3:   // Write LFN1 entry   
1907            {
1908                c = 0;
1909                // scan the 32 bytes in dir_entry
1910                for ( i = 0 ; i < 32 ; i++ )
1911                {
1912                    if (i == 0)
1913                    {
1914                        if ( nb_lfn == 1) entry[i] = 0x41;
1915                        else              entry[i] = 0x01;
1916                    }
1917                    else if ( ( ((i >= 1 ) && (i<=10) && ((i&1)==1))   ||
1918                                ((i >= 14) && (i<=25) && ((i&1)==0))   ||
1919                                ((i >= 28) && (i<=31) && ((i&1)==0)) ) &&
1920                              ( c < length ) )
1921                    {
1922                                          entry[i] = name[c];
1923                                          c++;
1924                    }
1925                    else if (i == 11)     entry[i] = 0x0F;
1926                    else if (i == 12)     entry[i] = 0xCA;
1927                    else                  entry[i] = 0x00;
1928                }
1929                step--;
1930                break;
1931            }
1932            case 2:   // write NORMAL entry     
1933            {
1934                c = 0;
1935                // scan the 32 bytes in dir_entry
1936                for ( i = 0 ; i < 32 ; i++ )
1937                {
1938                    if      ( (i < 8) && (c < length) )             // SFN
1939                    {
1940                                          entry[i] = _to_upper( name[c] );
1941                                          c++;
1942                    }
1943                    else if (i <  11)     entry[i] = 0x20;          // EXT
1944                    else if (i == 11)                               // ATTR
1945                    {
1946                        if (is_dir)       entry[i] = 0x10;
1947                        else              entry[i] = 0x20;
1948                    }
1949                    else if (i == 20)     entry[i] = cluster>>16;   // cluster.B2
1950                    else if (i == 21)     entry[i] = cluster>>24;   // cluster.B3
1951                    else if (i == 26)     entry[i] = cluster>>0;    // cluster.B0
1952                    else if (i == 27)     entry[i] = cluster>>8;    // cluster.B1
1953                    else if (i == 28)     entry[i] = size>>0;       // size.B0
1954                    else if (i == 29)     entry[i] = size>>8;       // size.B1
1955                    else if (i == 30)     entry[i] = size>>16;      // size.B2
1956                    else if (i == 31)     entry[i] = size>>24;      // size.B3
1957                    else                  entry[i] = 0x00;
1958                }
1959
1960                // update the dentry field in child inode
1961                child->dentry = ((cluster_id<<12) + offset)>>5;
1962
1963                step--;
1964                break;
1965            }
1966            case 1:   // write NOMORE entry 
1967            {
1968                step--;
1969                entry [0] = 0x00;
1970                break;
1971            }
1972        } // end switch step
1973        offset += 32;
1974    } // exit while => exit FSM   
1975
1976#if (GIET_DEBUG_FAT & 1)
1977if ( _get_proctime() > GIET_DEBUG_FAT )
1978{
1979    _printf("\n[DEBUG FAT] _add_dir_entry() : <%s> successfully added in <%s>\n",
1980            child->name , parent->name );
1981}
1982#endif
1983
1984    return 0;       
1985} // end _add_dir_entry
1986
1987
1988
1989////////////////////////////////////////////////////////////
1990static unsigned int _remove_dir_entry( fat_inode_t*  inode )
1991{
1992    // compute number of LFN entries
1993    unsigned int length;
1994    unsigned int nb_lfn;
1995    if ( _check_name_length( inode->name, 
1996                             &length,
1997                             &nb_lfn ) )  return 1;
1998
1999    // get cluster_id and offset in parent directory cache
2000    unsigned int  dentry     = inode->dentry;
2001    unsigned int  cluster_id = dentry >> 7;
2002    unsigned int  offset     = (dentry & 0x7F)<<5;
2003
2004    // get buffer from parent directory cache
2005    unsigned char*     buffer;
2006    fat_cache_desc_t*  pdesc;
2007
2008    if ( _get_buffer_from_cache( inode->parent,
2009                                 cluster_id,
2010                                 &pdesc ) ) return 1;
2011    buffer       = pdesc->buffer;
2012    pdesc->dirty = 1;
2013
2014    // invalidate NORMAL entry in directory cache
2015    buffer[offset] = 0xE5;
2016
2017    // invalidate LFN entries
2018    while ( nb_lfn )
2019    {
2020        if (offset == 0)  // we must load buffer for (cluster_id - 1)
2021        {
2022            if ( cluster_id == 0 )
2023                break;
2024
2025            if ( _get_buffer_from_cache( inode->parent,
2026                                         cluster_id - 1,
2027                                         &pdesc ) )   return 1;
2028            buffer       = pdesc->buffer;
2029            pdesc->dirty = 1;
2030            offset       = 4096;
2031        }
2032
2033        offset = offset - 32;
2034
2035        // check for LFN entry
2036        if ( _read_entry( DIR_ATTR , buffer + offset , 0 ) != ATTR_LONG_NAME_MASK )
2037            break;
2038
2039        // invalidate LFN entry
2040        buffer[offset] = 0xE5;
2041
2042        nb_lfn--;
2043    }     
2044         
2045    return 0;
2046}  // end _remove_dir_entry
2047
2048
2049
2050
2051////////////////////////////////////////////////////////////
2052static unsigned int _update_dir_entry( fat_inode_t*  inode )
2053{ 
2054    // get Cache-File buffer containing the parent directory entry
2055    // 128 directories entries in one 4 Kbytes buffer
2056    fat_cache_desc_t*  pdesc;
2057    unsigned char*     buffer;   
2058    unsigned int       cluster_id = inode->dentry>>7;
2059    unsigned int       offset     = (inode->dentry & 0x7F)<<5;
2060
2061    if ( _get_buffer_from_cache( inode->parent,
2062                                 cluster_id,
2063                                 &pdesc ) )    return 1;
2064    buffer       = pdesc->buffer;
2065    pdesc->dirty = 1;
2066
2067    // update size field
2068    buffer[offset + 28] = inode->size>>0;       // size.B0
2069    buffer[offset + 29] = inode->size>>8;       // size.B1
2070    buffer[offset + 30] = inode->size>>16;      // size.B2
2071    buffer[offset + 31] = inode->size>>24;      // size.B3
2072
2073    // update cluster field
2074    buffer[offset + 26] = inode->cluster>>0;    // cluster.B0
2075    buffer[offset + 27] = inode->cluster>>8;    // cluster.B1
2076    buffer[offset + 20] = inode->cluster>>16;   // cluster.B2
2077    buffer[offset + 21] = inode->cluster>>24;   // cluster.B3
2078   
2079    return 0;
2080} // end _update_dir_entry()
2081
2082
2083
2084
2085//////////////////////////////////////////////////////////////////
2086static unsigned int _get_child_from_parent( fat_inode_t*   parent,
2087                                            char*          name, 
2088                                            fat_inode_t**  inode )
2089{
2090    fat_inode_t*   current;
2091
2092#if (GIET_DEBUG_FAT & 1)
2093if ( _get_proctime() > GIET_DEBUG_FAT )
2094_printf("\n[DEBUG FAT] _get_child_from_parent() : search <%s> in directory <%s>\n",
2095        name , parent->name );
2096#endif
2097   
2098    // scan inodes in the parent directory
2099    for ( current = parent->child ; current ; current = current->next )
2100    {
2101        if ( _strcmp( name , current->name ) == 0 )
2102        {
2103
2104#if (GIET_DEBUG_FAT & 1)
2105if ( _get_proctime() > GIET_DEBUG_FAT )
2106_printf("\n[DEBUG FAT] _get_child_from_parent() : found inode <%s> in directory <%s>\n", 
2107        name , parent->name );
2108#endif
2109            *inode = current;
2110            return 0;           // name found
2111        }
2112    }
2113
2114    // not found in Inode-Tree => access the parent directory
2115    // file_cache.  Two embedded loops:
2116    // - scan the clusters allocated to this directory
2117    // - scan the directory entries in each 4 Kbytes buffer
2118
2119    unsigned char*    buffer;           // pointer on one cache buffer
2120    char              cname[32];        // buffer for one full entry name
2121    char              lfn1[16];         // buffer for one partial name
2122    char              lfn2[16];         // buffer for one partial name
2123    char              lfn3[16];         // buffer for one partial name
2124    unsigned int      size;             // searched file/dir size (bytes)
2125    unsigned int      cluster;          // searched file/dir cluster index
2126    unsigned int      is_dir;           // searched file/dir type
2127    unsigned int      attr;             // directory entry ATTR field
2128    unsigned int      ord;              // directory entry ORD field
2129    unsigned int      lfn = 0;          // LFN entries number
2130    unsigned int      dentry;           // directory entry index
2131    unsigned int      offset     = 0;   // byte offset in buffer
2132    unsigned int      cluster_id = 0;   // cluster index in directory
2133    int               found      = 0;   // not found (0) / name found (1) / end of dir (-1)
2134
2135#if (GIET_DEBUG_FAT & 1)
2136if ( _get_proctime() > GIET_DEBUG_FAT )
2137_printf("\n[DEBUG FAT] _get_child_from_parent() : does not found inode <%s>"
2138        " in directory <%s> => search in cache\n", name , parent->name );
2139#endif
2140
2141    // scan the clusters allocated to parent directory
2142    while ( found == 0 )
2143    {
2144        // get one 4 Kytes buffer from parent File_Cache 
2145        fat_cache_desc_t*  pdesc;
2146        if ( _get_buffer_from_cache( parent,
2147                                     cluster_id,
2148                                     &pdesc ) )    return 2;
2149        buffer = pdesc->buffer;
2150
2151        // scan this buffer until end of directory, end of buffer, or name found
2152        while( (offset < 4096) && (found == 0) )
2153        {
2154
2155#if (GIET_DEBUG_FAT & 1)
2156if ( _get_proctime() > GIET_DEBUG_FAT )
2157_printf("\n[DEBUG FAT] _get_child_from_parent() : scan buffer %d for <%s>\n",
2158        cluster_id , name );
2159#endif
2160            attr = _read_entry( DIR_ATTR , buffer + offset , 0 );   
2161            ord  = _read_entry( LDIR_ORD , buffer + offset , 0 );
2162
2163            if (ord == NO_MORE_ENTRY)                 // no more entry in directory => break
2164            {
2165                found = -1;
2166            }
2167            else if ( ord == FREE_ENTRY )             // free entry => skip
2168            {
2169                offset = offset + 32;
2170            }
2171            else if ( attr == ATTR_LONG_NAME_MASK )   // LFN entry => get partial name
2172            {
2173                unsigned int seq = ord & 0x3;
2174                lfn = (seq > lfn) ? seq : lfn;   
2175                if      ( seq == 1 ) _get_name_from_long( buffer + offset, lfn1 );
2176                else if ( seq == 2 ) _get_name_from_long( buffer + offset, lfn2 );
2177                else if ( seq == 3 ) _get_name_from_long( buffer + offset, lfn3 );
2178                offset = offset + 32;
2179            }
2180            else                                 // NORMAL entry
2181            {
2182                // build the extracted name
2183                if      ( lfn == 0 )
2184                {
2185                    _get_name_from_short( buffer + offset , cname );
2186                }
2187                else if ( lfn == 1 )
2188                {
2189                    _strcpy( cname      , lfn1 );
2190                }   
2191                else if ( lfn == 2 ) 
2192                {
2193                    _strcpy( cname      , lfn1 );
2194                    _strcpy( cname + 13 , lfn2 );
2195                }
2196                else if ( lfn == 3 ) 
2197                {
2198                    _strcpy( cname      , lfn1 );
2199                    _strcpy( cname + 13 , lfn2 );
2200                    _strcpy( cname + 26 , lfn3 );
2201                }
2202                   
2203                // test if extracted name == searched name
2204                if ( _strcmp( name , cname ) == 0 )
2205                {
2206                    cluster = (_read_entry( DIR_FST_CLUS_HI , buffer + offset , 1 ) << 16) |
2207                              (_read_entry( DIR_FST_CLUS_LO , buffer + offset , 1 )      ) ;
2208                    dentry  = ((cluster_id<<12) + offset)>>5;
2209                    is_dir  = ((attr & ATTR_DIRECTORY) == ATTR_DIRECTORY);
2210                    size    = _read_entry( DIR_FILE_SIZE , buffer + offset , 1 );
2211                    found   = 1;
2212                }
2213                offset = offset + 32;
2214                lfn    = 0;
2215            }
2216        }  // end loop on directory entries
2217        cluster_id++;
2218        offset = 0;
2219    }  // end loop on buffers
2220
2221    if ( found == -1 )  // found end of directory in parent directory
2222    {
2223
2224#if (GIET_DEBUG_FAT & 1)
2225if ( _get_proctime() > GIET_DEBUG_FAT )
2226_printf("\n[DEBUG FAT] _get_child_from_parent() : found end of directory in <%s>\n",
2227        parent->name );
2228#endif
2229        *inode = NULL;
2230        return 1;
2231    }
2232    else               // found searched name in parent directory
2233    {
2234        // allocate a new inode and an empty Cache-File
2235        *inode = _allocate_one_inode( name,
2236                                      is_dir,
2237                                      cluster,
2238                                      size,
2239                                      0,             // count
2240                                      dentry,
2241                                      1 );           // cache_allocate
2242
2243        // introduce it in Inode-Tree
2244        _add_inode_in_tree( *inode , parent );
2245
2246#if (GIET_DEBUG_FAT & 1)
2247if ( _get_proctime() > GIET_DEBUG_FAT )
2248_printf("\n[DEBUG FAT] _get_child_from_parent() : found <%s> on device\n", name );
2249#endif
2250        return 0;
2251    }
2252}  // end _get_child_from_parent()
2253
2254
2255
2256
2257//////////////////////////////////////////////////////////////////
2258static unsigned int _get_inode_from_path( char*          pathname,
2259                                          fat_inode_t**  inode )
2260{
2261    char                 name[32];         // buffer for one name in pathname
2262    unsigned int         nb_read;              // number of characters written in name[]
2263    fat_inode_t*         parent;           // parent inode
2264    fat_inode_t*         child;            // child inode
2265    unsigned int         last;             // while exit condition
2266    unsigned int         code;             // return value
2267
2268#if (GIET_DEBUG_FAT & 1)
2269if ( _get_proctime() > GIET_DEBUG_FAT )
2270_printf("\n[DEBUG FAT] _get_inode_from_path() : enters for path <%s>\n", pathname );
2271#endif
2272
2273    // handle root directory case
2274    if ( _strcmp( pathname , "/" ) == 0 )
2275    {
2276
2277#if (GIET_DEBUG_FAT & 1)
2278if ( _get_proctime() > GIET_DEBUG_FAT )
2279_printf("\n[DEBUG FAT] _get_inode_from_path() : found root inode for <%s>\n", 
2280        pathname );
2281#endif
2282        *inode  = _fat.inode_tree_root;
2283        return 0;
2284    }
2285
2286    // If the pathname is not "/", we traverse the inode tree from the root.
2287    // We use _get_name_from_path() to scan pathname and extract inode names.
2288    // We use _get_child_from_parent() to scan each directory in the path.
2289
2290    last       = 0;
2291    nb_read    = 0;                      // number of characters analysed in path
2292    parent     = _fat.inode_tree_root;   // Inode-Tree root
2293   
2294    while ( !last )
2295    {
2296        // get searched file/dir name
2297        if ( _get_name_from_path( pathname, name, &nb_read ) )
2298        {
2299            return 3;   // error : name too long
2300        }
2301
2302        // compute last iteration condition
2303        last = (pathname[nb_read] == 0);
2304
2305#if (GIET_DEBUG_FAT & 1)
2306if ( _get_proctime() > GIET_DEBUG_FAT )
2307_printf("\n[DEBUG FAT] _get_inode_from_path() : got name <%s>\n", name );
2308#endif
2309
2310        if ( _strcmp( name, ".." ) == 0)
2311        {
2312            // found special name "..", try to go up
2313            code = 0;
2314            if ( parent->parent )
2315                child = parent->parent;
2316            else
2317                child = parent;
2318        }
2319        else if ( _strcmp( name, "." ) == 0 )
2320        {
2321            // found special name ".", stay on the same level
2322            code = 0;
2323            child = parent;
2324        }
2325        else
2326        {
2327            // get child inode from parent directory
2328            code = _get_child_from_parent( parent,
2329                                           name,
2330                                           &child );
2331
2332            // we need to find the child inode for all non terminal names
2333            if ( (code == 2) || ((code == 1 ) && !last) )
2334            {
2335
2336    #if (GIET_DEBUG_FAT & 1)
2337    if ( _get_proctime() > GIET_DEBUG_FAT )
2338    _printf("\n[DEBUG FAT] _get_inode_from_path() : neither parent, nor child found for <%s>\n",
2339            pathname );
2340    #endif
2341                return 2;  // error : parent inode not found
2342            }
2343        }
2344
2345        // update parent if not the last iteration
2346        if ( !last )
2347            parent = child;
2348    } // end while
2349
2350    // returns inode pointer
2351    if (code == 0 )
2352    {
2353
2354#if (GIET_DEBUG_FAT & 1)
2355if ( _get_proctime() > GIET_DEBUG_FAT )
2356_printf("\n[DEBUG FAT] _get_inode_from_path() : found inode for <%s>\n", 
2357        pathname );
2358#endif
2359        *inode  = child;
2360    }
2361    else
2362    {
2363
2364#if (GIET_DEBUG_FAT & 1)
2365if ( _get_proctime() > GIET_DEBUG_FAT )
2366_printf("\n[DEBUG FAT] _get_inode_from_path() : found only parent inode for <%s>\n",
2367        pathname );
2368#endif
2369        *inode  = parent;
2370    }
2371
2372    return code;                 // can be 0 (found) or 1 (not found)
2373
2374}  // end _get_inode_from_path()
2375
2376
2377
2378
2379//////////////////////////////////////////////////////////////
2380static unsigned int _remove_node_from_fs( fat_inode_t* inode )
2381{
2382    // check for root node
2383    if ( !inode->parent ) return 1;
2384
2385    // remove entry in parent directory
2386    if ( _remove_dir_entry( inode ) ) return 1;
2387
2388    // update parent directory on device
2389    if ( _update_device_from_cache( inode->parent->levels,
2390                                    inode->parent->cache,
2391                                    inode->parent->name ) ) return 1;
2392
2393    // release clusters allocated to file/dir in DATA region
2394    if ( _clusters_release( inode->cluster ) ) return 1;
2395
2396    // release File-Cache
2397    _release_cache_memory( inode->cache, inode->levels );
2398    _free ( inode->cache );
2399
2400    // remove inode from Inode-Tree
2401    _remove_inode_from_tree( inode );
2402
2403    // release inode
2404    _free ( inode );
2405
2406    return 0;
2407}  // end _remove_node_from_fs()
2408
2409
2410//////////////////////////////////////////////////////////////////
2411static unsigned int _next_cluster_no_cache( unsigned int   cluster,
2412                                            unsigned int*  next )
2413{
2414    // compute cluster_id and slot_id
2415    // each cluster contains 1024 slots (4 bytes per slot)
2416    unsigned int cluster_id  = cluster >> 10;
2417    unsigned int slot_id     = cluster & 0x3FF;
2418
2419    // compute lba of cluster identified by cluster_id
2420    unsigned int lba = _fat.fat_lba + (cluster_id << 3);
2421
2422    // get cluster containing the adressed FAT slot in FAT buffer
2423    if ( _fat_buffer_fat_lba != lba )
2424    {
2425        if ( _fat_ioc_access( 0,         // no descheduling
2426                              1,         // read
2427                              lba,
2428                              (unsigned int)_fat_buffer_fat,
2429                              8 ) )
2430        {
2431            _printf("\n[FAT ERROR] in _next_cluster_no_cache() : "
2432                    "cannot load lba = %x into fat_buffer\n", lba );
2433            return 1;
2434        }
2435
2436        _fat_buffer_fat_lba = lba;
2437    }
2438
2439    // return next cluster index
2440    unsigned int* buf = (unsigned int*)_fat_buffer_fat;
2441    *next = buf[slot_id];
2442    return 0;
2443   
2444}  // end _next_cluster_no_cache()
2445
2446
2447
2448
2449/////////////////////////////////////////////////////////////////
2450static unsigned int _file_info_no_cache( char*          pathname,
2451                                         unsigned int*  file_cluster,
2452                                         unsigned int*  file_size )
2453{
2454   
2455#if (GIET_DEBUG_FAT & 1)
2456if ( _get_proctime() > GIET_DEBUG_FAT )
2457_printf("\n[DEBUG FAT] _file_info_no_cache() : enters for path <%s>\n", pathname );
2458#endif
2459
2460    char            name[32];             // buffer for one name in the analysed pathname
2461    char            lfn1[16];             // buffer for a partial name in LFN entry
2462    char            lfn2[16];             // buffer for a partial name in LFN entry
2463    char            lfn3[16];             // buffer for a partial name in LFN entry
2464    char            cname[32];            // buffer for a full name in a directory entry
2465    unsigned int    nb_read;              // number of characters analysed in path
2466    unsigned int    parent_cluster;       // cluster index for the parent directory
2467    unsigned int    child_cluster = 0;    // cluster index for the searched file/dir
2468    unsigned int    child_size = 0;       // size of the searched file/dir
2469    unsigned int    child_is_dir;         // type of the searched file/dir
2470    unsigned int    offset;               // offset in a 4 Kbytes buffer
2471    unsigned int    ord;                  // ORD field in a directory entry
2472    unsigned int    attr;                 // ATTR field in a directory entry
2473    unsigned int    lfn = 0;              // number of lfn entries
2474    unsigned char*  buf;                  // pointer on a 4 Kbytes buffer
2475    unsigned int    found;                // name found in current directory entry
2476
2477    // Three embedded loops:
2478    // - scan pathname to extract file/dir names,
2479    // - for each name, scan the clusters of the parent directory
2480    // - for each cluster, scan the 4 Kbytes buffer to find the file/dir name
2481    // The starting point is the root directory (cluster 2)
2482
2483    nb_read        = 0;
2484    parent_cluster = 2; 
2485
2486    // scan pathname 
2487    while ( pathname[nb_read] != 0 )   
2488    {
2489        // get searched file/dir name
2490        if ( _get_name_from_path( pathname, name, &nb_read ) ) return 1;
2491
2492#if (GIET_DEBUG_FAT & 1)
2493if ( _get_proctime() > GIET_DEBUG_FAT )
2494_printf("\n[DEBUG FAT] _file_info_no_cache() : search name <%s>"
2495        " in cluster %x\n", name , parent_cluster );
2496#endif
2497        found  = 0;
2498
2499        // scan clusters containing the parent directory
2500        while ( found == 0 ) 
2501        {
2502            // compute lba
2503            unsigned int lba = _cluster_to_lba( parent_cluster );
2504
2505            // load one cluster of the parent directory into data_buffer
2506            if ( _fat_buffer_data_lba != lba )
2507            {
2508                if ( _fat_ioc_access( 0,         // no descheduling
2509                                      1,         // read
2510                                      lba,
2511                                      (unsigned int)_fat_buffer_data,
2512                                      8 ) )
2513                {
2514                    _printf("\n[FAT ERROR] in _file_info_no_cache() : "
2515                            "cannot load lba = %x into data_buffer\n", lba );
2516                    return 1;
2517                }
2518
2519                _fat_buffer_data_lba = lba;
2520            }
2521
2522            offset = 0;
2523
2524            // scan this 4 Kbytes buffer
2525            while ( (offset < 4096) && (found == 0) )
2526            {
2527                buf  = _fat_buffer_data + offset;
2528                attr = _read_entry( DIR_ATTR , buf , 0 );   
2529                ord  = _read_entry( LDIR_ORD , buf , 0 );
2530
2531                if (ord == NO_MORE_ENTRY)               // no more entry => break
2532                {
2533                    found = 2;
2534                }
2535                else if ( ord == FREE_ENTRY )           // free entry => skip
2536                {
2537                    offset = offset + 32;
2538                }
2539                else if ( attr == ATTR_LONG_NAME_MASK ) // LFN entry => get partial name
2540                {
2541                    unsigned int seq = ord & 0x3;
2542                    lfn = (seq > lfn) ? seq : lfn;   
2543                    if      ( seq == 1 ) _get_name_from_long( buf, lfn1 );
2544                    else if ( seq == 2 ) _get_name_from_long( buf, lfn2 );
2545                    else if ( seq == 3 ) _get_name_from_long( buf, lfn3 );
2546                    offset = offset + 32;
2547                }
2548                else                                    // NORMAL entry
2549                {
2550                    // build the full mame for current directory entry
2551                    if      ( lfn == 0 )
2552                    {
2553                        _get_name_from_short( buf , cname );
2554                    }
2555                    else if ( lfn == 1 )
2556                    {
2557                        _strcpy( cname      , lfn1 );
2558                    }   
2559                    else if ( lfn == 2 ) 
2560                    {
2561                        _strcpy( cname      , lfn1 );
2562                        _strcpy( cname + 13 , lfn2 );
2563                    }
2564                    else if ( lfn == 3 ) 
2565                    {
2566                        _strcpy( cname      , lfn1 );
2567                        _strcpy( cname + 13 , lfn2 );
2568                        _strcpy( cname + 26 , lfn3 );
2569                    }
2570                   
2571                    // test if extracted name == searched name
2572                    if ( _strcmp( name , cname ) == 0 )
2573                    {
2574                        child_cluster = (_read_entry( DIR_FST_CLUS_HI , buf , 1 ) << 16) |
2575                                        (_read_entry( DIR_FST_CLUS_LO , buf , 1 )      ) ;
2576                        child_is_dir  = ((attr & ATTR_DIRECTORY) == ATTR_DIRECTORY);
2577                        child_size    = _read_entry( DIR_FILE_SIZE , buf , 1 );
2578                        found         = 1;
2579                    }
2580                    offset = offset + 32;
2581                    lfn = 0;
2582                }
2583            }  // en loop on directory entries
2584           
2585            // compute next cluster index
2586            unsigned int next;
2587            if ( _next_cluster_no_cache ( parent_cluster , &next ) ) return 1;
2588            parent_cluster = next;
2589        } // end loop on clusters
2590
2591        if ( found == 2 )  // found end of directory => error
2592        { 
2593            _printf("\n[FAT ERROR] in _file_info_no_cache() : <%s> not found\n",
2594                    name );
2595            return 1;
2596        }
2597 
2598        // check type
2599        if ( ((pathname[nb_read] == 0) && (child_is_dir != 0)) ||
2600             ((pathname[nb_read] != 0) && (child_is_dir == 0)) )
2601        {
2602            _printf("\n[FAT ERROR] in _file_info_no_cache() : illegal type for <%s>\n", name );
2603            return 1;
2604        }
2605
2606        // update parent_cluster for next name
2607        parent_cluster = child_cluster;
2608
2609    }  // end loop on names
2610
2611#if (GIET_DEBUG_FAT & 1)
2612if ( _get_proctime() > GIET_DEBUG_FAT )
2613_printf("\n[DEBUG FAT] _file_info_no_cache() : success for <%s> / "
2614        "file_size = %x / file_cluster = %x\n", pathname, child_size, child_cluster );
2615#endif
2616
2617    // return file cluster and size
2618    *file_size    = child_size;
2619    *file_cluster = child_cluster;
2620    return 0;
2621
2622}  // end _file_info_no_cache()
2623
2624
2625
2626/////////////////////////////////////////////////////////////////////////////
2627/////////////////////////////////////////////////////////////////////////////
2628//             Extern functions                                               
2629/////////////////////////////////////////////////////////////////////////////
2630/////////////////////////////////////////////////////////////////////////////
2631
2632
2633/////////////////////////////////////////////////////////////////////////////
2634// This function initializes the FAT structures.
2635// - The Fat-Descriptor is always initialised.
2636// - The dynamically allocated structures (the Inode-Tre, the Fat_Cache,
2637//   and the File-Cache for the root directory) are only allocated
2638//   and initialised if the "kernel_mode" argument is set.
2639/////////////////////////////////////////////////////////////////////////////
2640// Implementation note:
2641// This function is called twice, by the boot-loader, and by the kernel_init.
2642// It does not use dynamic memory allocation from the distributed heap.
2643// It use informations found in the boot sector and FS-INFO sector.
2644// that are loaded in the Fat-Descriptor temporary block_buffer.
2645/////////////////////////////////////////////////////////////////////////////
2646// Returns 0 if success.
2647// Returns -1 if error.
2648/////////////////////////////////////////////////////////////////////////////
2649int _fat_init( unsigned int kernel_mode ) 
2650{
2651
2652#if GIET_DEBUG_FAT
2653if ( _get_proctime() > GIET_DEBUG_FAT )
2654_printf("\n[DEBUG FAT] _fat_init() : enters at cycle %d\n", _get_proctime() );
2655#endif
2656
2657    // FAT initialisation should be done only once
2658    if ( _fat.initialised == FAT_INITIALISED )
2659    {
2660        _printf("\n[FAT ERROR] in _fat_init() : FAT already initialised\n");
2661        return -1;
2662    }
2663
2664    // load Boot sector (VBR) into FAT buffer
2665    if ( _fat_ioc_access( 0,                                  // no descheduling
2666                          1,                                  // read
2667                          0,                                  // block index
2668                          (unsigned int)_fat.block_buffer,
2669                          1 ) )                               // one block
2670    {
2671        _printf("\n[FAT ERROR] in _fat_init() cannot load VBR\n");
2672        return -1;
2673    }
2674
2675    _fat.block_buffer_lba = 0;
2676   
2677#if GIET_DEBUG_FAT
2678if ( _get_proctime() > GIET_DEBUG_FAT )
2679{
2680    _printf("\n[DEBUG FAT] _fat_init() : Boot sector loaded\n");
2681    _display_one_block( _fat.block_buffer, "block device", _fat.block_buffer_lba );
2682}
2683#endif
2684
2685    // checking various FAT32 assuptions from boot sector
2686    if( _read_entry( BPB_BYTSPERSEC, _fat.block_buffer, 1 ) != 512 )
2687    {
2688        _printf("\n[FAT ERROR] The sector size must be 512 bytes\n");
2689        return -1;
2690    }
2691    if( _read_entry( BPB_SECPERCLUS, _fat.block_buffer, 1 ) != 8 )
2692    {
2693        _printf("\n[FAT ERROR] The cluster size must be 8 blocks\n");
2694        return -1;
2695    }
2696    if( _read_entry( BPB_NUMFATS, _fat.block_buffer, 1 ) != 1 )
2697    {
2698        _printf("\n[FAT ERROR] The number of FAT copies in FAT region must be 1\n");
2699        return -1;
2700    }
2701    if( (_read_entry( BPB_FAT32_FATSZ32, _fat.block_buffer, 1 ) & 0xF) != 0 )
2702    {
2703        _printf("\n[FAT ERROR] The FAT region must be multiple of 16 sectors\n");
2704        return -1;
2705    }
2706    if( _read_entry( BPB_FAT32_ROOTCLUS, _fat.block_buffer, 1 ) != 2 )
2707    {
2708        _printf("\n[FAT ERROR] The root directory must be at cluster 2\n");
2709        return -1;
2710    }
2711
2712    // initialise Fat-Descriptor from VBR
2713    _fat.sector_size         = 512;
2714    _fat.cluster_size        = 4096;
2715    _fat.fat_sectors         = _read_entry( BPB_FAT32_FATSZ32 , _fat.block_buffer , 1 );
2716    _fat.fat_lba             = _read_entry( BPB_RSVDSECCNT , _fat.block_buffer , 1 );
2717    _fat.data_sectors        = _fat.fat_sectors << 10;
2718    _fat.data_lba            = _fat.fat_lba + _fat.fat_sectors;
2719    _fat.fs_info_lba         = _read_entry( BPB_FAT32_FSINFO , _fat.block_buffer , 1 );
2720    _fat_buffer_fat_lba      = 0xFFFFFFFF;
2721    _fat_buffer_data_lba     = 0xFFFFFFFF;
2722    _fat.initialised         = FAT_INITIALISED;
2723
2724    // load FS_INFO sector into FAT buffer
2725    if ( _fat_ioc_access( 0,                                // no descheduling
2726                          1,                                // read
2727                          _fat.fs_info_lba,                 // lba
2728                          (unsigned int)_fat.block_buffer,
2729                          1 ) )                             // one block
2730    { 
2731        _printf("\n[FAT ERROR] in _fat_init() cannot load FS_INFO Sector\n"); 
2732        return -1;
2733    }
2734
2735    _fat.block_buffer_lba = _fat.fs_info_lba;
2736
2737#if GIET_DEBUG_FAT
2738if ( _get_proctime() > GIET_DEBUG_FAT )
2739{
2740    _printf("\n[DEBUG FAT] _fat_init() : FS-INFO sector loaded\n");
2741    _display_one_block( _fat.block_buffer, "block device", _fat.block_buffer_lba );
2742}
2743#endif
2744
2745    // initialise Fat-Descriptor from FS_INFO
2746    _fat.free_clusters_number   = _read_entry( FS_FREE_CLUSTERS    , _fat.block_buffer, 1);
2747    _fat.first_free_cluster     = _read_entry( FS_FREE_CLUSTER_HINT, _fat.block_buffer, 1);
2748
2749    // This is done only when the _fat_init() is called in kernel mode
2750
2751    if ( kernel_mode )
2752    {
2753        unsigned int i;
2754
2755        // create Inode-Tree root
2756        _fat.inode_tree_root = _allocate_one_inode("/", // dir name
2757                                                   1,   // directory
2758                                                   2,   // cluster id
2759                                                   0,   // no size
2760                                                   0,   // no children
2761                                                   0,   // no dentry
2762                                                   1);  // allocate cache
2763
2764        // initialize lock
2765        _spin_lock_init( &_fat.fat_lock );
2766
2767        // initialize File Descriptor Array
2768        for( i = 0 ; i < GIET_OPEN_FILES_MAX ; i++ ) _fat.fd[i].allocated = 0;
2769
2770        // initialize fat_cache root
2771        _fat.fat_cache_root   = _allocate_one_cache_node( NULL );
2772        _fat.fat_cache_levels = _get_levels_from_size( _fat.fat_sectors << 9 );
2773    }  // end if kernel_mode
2774
2775#if GIET_DEBUG_FAT
2776if ( _get_proctime() > GIET_DEBUG_FAT )
2777_display_fat_descriptor();
2778#endif
2779
2780    return 0;
2781}  // end _fat_init()
2782
2783
2784
2785
2786///////////////////////////////////////////////////////////////////////////////
2787// This function implements the giet_fat_open() system call.
2788// The semantic is similar to the UNIX open() function, but only the O_CREATE
2789// and O_RDONLY flags are supported. The UNIX access rights are not supported.
2790// If the file does not exist in the specified directory, it is created.
2791// If the specified directory does not exist, an error is returned.
2792// It allocates a file descriptor to the calling task, for the file identified
2793// by "pathname". If several tasks try to open the same file, each task 
2794// obtains a private file descriptor.
2795// A node name (file or directory) cannot be larger than 31 characters.
2796///////////////////////////////////////////////////////////////////////////////
2797// Returns file descriptor index if success
2798// Returns a negative value if error:
2799//   -1  :  "fat not initialised"
2800//   -2  :  "path to parent not found"
2801//   -3  :  "one name in path too long"
2802//   -4  :  "file not found"
2803//   -5  :  "Cannot update parent directory"
2804//   -6  :  "Cannot update DATA region"
2805//   -7  :  "Cannot update FAT region"
2806//   -8  :  "Cannot update FS_INFO sector"
2807//   -9  :  "file descriptor array full"
2808///////////////////////////////////////////////////////////////////////////////
2809int _fat_open( char*        pathname,     // absolute path from root
2810               unsigned int flags )       // O_CREATE and O_RDONLY
2811{
2812    unsigned int         fd_id;            // index in File-Descriptor-Array
2813    unsigned int         code;             // error code
2814    fat_inode_t*         inode;            // anonymous inode pointer
2815    fat_inode_t*         child;            // pointer on searched file inode
2816    fat_inode_t*         parent;           // pointer on parent directory inode
2817   
2818    // get flags
2819    unsigned int create    = ((flags & O_CREATE) != 0);
2820    unsigned int read_only = ((flags & O_RDONLY) != 0); 
2821
2822#if GIET_DEBUG_FAT
2823unsigned int procid  = _get_procid();
2824unsigned int x       = procid >> (Y_WIDTH + P_WIDTH);
2825unsigned int y       = (procid >> P_WIDTH) & ((1<<Y_WIDTH)-1);
2826unsigned int p       = procid & ((1<<P_WIDTH)-1);
2827if ( _get_proctime() > GIET_DEBUG_FAT )
2828_printf("\n[DEBUG FAT] _fat_open() : P[%d,%d,%d] enters for path <%s> / "
2829        " create = %d / read_only = %d\n",
2830        x, y, p, pathname , create , read_only );
2831#endif
2832
2833    // checking FAT initialised
2834    if( _fat.initialised != FAT_INITIALISED )
2835    {
2836        _printf("\n[FAT ERROR] in _fat_open() : FAT not initialised\n");
2837        return -1;
2838    }
2839
2840    // takes the lock
2841    _spin_lock_acquire( &_fat.fat_lock );
2842
2843    // get inode pointer
2844    code = _get_inode_from_path( pathname , &inode );
2845
2846    if ( code == 2 ) 
2847    {
2848        _spin_lock_release( &_fat.fat_lock );
2849        _printf("\n[FAT ERROR] in _fat_open() : path to parent not found"
2850                " for file <%s>\n", pathname );
2851        return -2;
2852    }
2853    else if ( code == 3 ) 
2854    {
2855        _spin_lock_release( &_fat.fat_lock );
2856        _printf("\n[FAT ERROR] in _fat_open() : one name in path too long"
2857                " for file <%s>\n", pathname );
2858        return -3;
2859    }
2860    else if ( (code == 1) && (create == 0) )   
2861    {
2862        _spin_lock_release( &_fat.fat_lock );
2863        _printf("\n[FAT ERROR] in _fat_open() : file not found"
2864                " for file <%s>\n", pathname );
2865        return -4;
2866    }
2867    else if ( (code == 1) && (create != 0) )   // file name not found => create
2868    {
2869        // set parent inode pointer
2870        parent = inode;
2871
2872#if GIET_DEBUG_FAT
2873if ( _get_proctime() > GIET_DEBUG_FAT )
2874_printf("\n[DEBUG FAT] _fat_open() : P[%d,%d,%d] create a new file <%s>\n",
2875        x , y , p , pathname );
2876#endif
2877
2878        // get new file name / error check already done by _get_inode_from_path()
2879        char name[32];       
2880        _get_last_name( pathname , name );
2881
2882        // allocate a new inode and an empty Cache-File
2883        child = _allocate_one_inode( name,
2884                                     0,                         // not a directory
2885                                     END_OF_CHAIN_CLUSTER_MAX,  // no cluster allocated
2886                                     0,                         // size : new file is empty
2887                                     0,                         // count incremented later
2888                                     0,                         // dentry set by add_dir_entry
2889                                     1 );                       // cache_allocate
2890
2891        // introduce inode into Inode-Tree
2892        _add_inode_in_tree( child , parent );
2893
2894        // add an entry in the parent directory Cache_file
2895        if ( _add_dir_entry( child , parent ) )
2896        {
2897            _spin_lock_release( &_fat.fat_lock );
2898            _printf("\n[FAT ERROR] in _fat_open() : cannot update parent directory"
2899                    " for file <%s>\n" , pathname );
2900            return -5;
2901        } 
2902
2903        // update DATA region on block device for parent directory
2904        if ( _update_device_from_cache( parent->levels,
2905                                        parent->cache,
2906                                        parent->name ) )
2907        {
2908            _spin_lock_release( &_fat.fat_lock );
2909            _printf("\n[FAT ERROR] in _fat_open() : cannot update DATA region "
2910                    " for parent of file <%s>\n", pathname );
2911            return -6;
2912        }
2913
2914        // update FAT region on block device
2915        if ( _update_device_from_cache( _fat.fat_cache_levels,
2916                                        _fat.fat_cache_root,
2917                                        "FAT" ) )
2918        {
2919            _spin_lock_release( &_fat.fat_lock );
2920            _printf("\n[FAT ERROR] in _fat_open() : cannot update FAT region"
2921                    " for file <%s>\n", pathname );
2922            return -7;
2923        }
2924
2925        // update FS_INFO sector
2926        if ( _update_fs_info() )
2927        {
2928            _spin_lock_release( &_fat.fat_lock );
2929            _printf("\n[FAT ERROR] in _fat_open() : cannot update FS-INFO"
2930                    " for file <%s>\n", pathname );
2931            return -8;
2932        }
2933    }
2934    else // code == 0
2935    {
2936        // set searched file inode pointer
2937        child = inode;
2938
2939#if GIET_DEBUG_FAT
2940if ( _get_proctime() > GIET_DEBUG_FAT )
2941_printf("\n[DEBUG FAT] _fat_open() : P[%d,%d,%d] found file <%s> on device : inode = %x\n",
2942        x , y , p , pathname , child );
2943#endif
2944
2945    }
2946
2947    // Search an empty slot in file descriptors array
2948    fd_id = 0;
2949    while ( (_fat.fd[fd_id].allocated) != 0 && (fd_id < GIET_OPEN_FILES_MAX) )
2950    {
2951        fd_id++;
2952    }
2953
2954    // set file descriptor if an empty slot has been found
2955    if ( fd_id < GIET_OPEN_FILES_MAX )
2956    {
2957        // update file descriptor
2958        _fat.fd[fd_id].allocated  = 1;
2959        _fat.fd[fd_id].seek       = 0;
2960        _fat.fd[fd_id].read_only  = read_only;
2961        _fat.fd[fd_id].inode      = child;
2962
2963        // increment the refcount
2964        child->count = child->count + 1;
2965
2966        // releases the lock
2967        _spin_lock_release( &_fat.fat_lock );
2968
2969#if GIET_DEBUG_FAT
2970if ( _get_proctime() > GIET_DEBUG_FAT )
2971_printf("\n[DEBUG FAT] _fat_open() : P[%d,%d,%d] got fd = %d for <%s> / "
2972        "read_only = %d\n",
2973        x , y , p , fd_id , pathname , read_only );
2974#endif
2975        return fd_id;
2976    }
2977    else
2978    {
2979        _spin_lock_release( &_fat.fat_lock );
2980        _printf("\n[FAT ERROR] in _fat_open() : File-Descriptors-Array full\n");
2981        return -9;
2982    }
2983} // end _fat_open()
2984
2985
2986
2987
2988/////////////////////////////////////////////////////////////////////////////////
2989// This function implements the "giet_fat_close()" system call.
2990// It decrements the inode reference count, and release the fd_id entry
2991// in the file descriptors array.
2992// If the reference count is zero, it writes all dirty clusters on block device,
2993// and releases the memory allocated to the File_Cache.
2994/////////////////////////////////////////////////////////////////////////////////
2995// Returns 0 on success.
2996// Returns negative value if error:
2997//  -1  : "FAT not initialised"
2998//  -2  : "Illegal file descriptor"
2999//  -3  : "File not open"
3000//  -4  : "Cannot update DATA regions"
3001/////////////////////////////////////////////////////////////////////////////////
3002int _fat_close( unsigned int fd_id )
3003{
3004    // checking FAT initialised
3005    if( _fat.initialised != FAT_INITIALISED )
3006    {
3007        _printf("\n[FAT ERROR] in _fat_close() : FAT not initialised\n");
3008        return -1;
3009    }
3010
3011    if( (fd_id >= GIET_OPEN_FILES_MAX) )
3012    {
3013        _printf("\n[FAT ERROR] in _fat_close() : illegal file descriptor index\n");
3014        return -2;
3015    } 
3016
3017    // takes lock
3018    _spin_lock_acquire( &_fat.fat_lock );
3019
3020    if( _fat.fd[fd_id].allocated == 0 )
3021    {
3022        _spin_lock_release( &_fat.fat_lock );
3023        _printf("\n[FAT ERROR] in _fat_close() : file not open\n");
3024        return -3;
3025    }
3026
3027    // get the inode pointer
3028    fat_inode_t*  inode = _fat.fd[fd_id].inode;
3029
3030    // decrement reference count
3031    inode->count = inode->count - 1;
3032   
3033#if GIET_DEBUG_FAT
3034if ( _get_proctime() > GIET_DEBUG_FAT )
3035_printf("\n[FAT DEBUG] _fat_close() for file <%s> : refcount = %d\n",
3036        inode->name , inode->count );
3037#endif
3038
3039    // update block device and release File-Cache if no more references
3040    if ( inode->count == 0 )
3041    {
3042        // update all dirty clusters for closed file
3043        if ( _update_device_from_cache( inode->levels, 
3044                                        inode->cache,
3045                                        inode->name ) ) 
3046        {
3047            _spin_lock_release( &_fat.fat_lock );
3048            _printf("\n[FAT ERROR] in _fat_close() : cannot write dirty clusters "
3049                    "for file <%s>\n", inode->name );
3050            return -4;
3051        }
3052
3053#if GIET_DEBUG_FAT
3054if ( _get_proctime() > GIET_DEBUG_FAT )
3055_printf("\n[FAT DEBUG] _fat_close() update device for file <%s>\n", inode->name );
3056#endif
3057
3058        // update directory dirty clusters for parent directory
3059        if ( inode->parent &&
3060             _update_device_from_cache( inode->parent->levels,
3061                                        inode->parent->cache,
3062                                        inode->parent->name ) )
3063        {
3064            _spin_lock_release( &_fat.fat_lock );
3065            _printf("\n[FAT ERROR] in _fat_close() : cannot write dirty clusters "
3066                    "for directory <%s>\n", inode->parent->name );
3067            return -4;
3068        }
3069
3070#if GIET_DEBUG_FAT
3071if ( _get_proctime() > GIET_DEBUG_FAT )
3072_printf("\n[FAT DEBUG] _fat_close() update device for parent directory <%s>\n",
3073        inode->parent->name );
3074#endif
3075
3076        // release memory allocated to File-Cache (keep cache root node)
3077        _release_cache_memory( inode->cache, inode->levels );
3078
3079#if GIET_DEBUG_FAT
3080if ( _get_proctime() > GIET_DEBUG_FAT )
3081_printf("\n[FAT DEBUG] _fat_close() release memory for File-Cache <%s>\n",
3082        inode->name );
3083#endif
3084
3085    }
3086
3087    // release fd_id entry in file descriptor array
3088    _fat.fd[fd_id].allocated = 0;
3089
3090    // release lock
3091    _spin_lock_release( &_fat.fat_lock );
3092
3093    return 0;
3094} // end fat_close()
3095
3096
3097
3098
3099/////////////////////////////////////////////////////////////////////////////////
3100// This function implements the giet_fat_file_info() system call.
3101// It returns the size, the current offset and the directory info for a file
3102// identified by the "fd_id" argument.
3103/////////////////////////////////////////////////////////////////////////////////
3104// Returns  0 if success.
3105// Returns negative value if error.
3106//  -1  : "FAT not initialised"
3107//  -2  : "Illegal file descriptor"
3108//  -3  : "File not open"
3109/////////////////////////////////////////////////////////////////////////////////
3110int _fat_file_info( unsigned int            fd_id,
3111                    struct fat_file_info_s* info )
3112{
3113    if ( _fat.initialised != FAT_INITIALISED )
3114    {
3115        _printf("\n[FAT ERROR] in _fat_file_info() : FAT not initialised\n");
3116        return -1;
3117    }
3118
3119    if ( fd_id >= GIET_OPEN_FILES_MAX )
3120    {
3121        _printf("\n[FAT ERROR] in _fat_file_info() : illegal file descriptor index\n");
3122        return -2;
3123    } 
3124
3125    if ( _fat.fd[fd_id].allocated == 0 )
3126    {
3127        _printf("\n[FAT ERROR] in _fat_file_info() : file not open\n");
3128        return -3;
3129    }
3130
3131    info->size   = _fat.fd[fd_id].inode->size;
3132    info->offset = _fat.fd[fd_id].seek;
3133    info->is_dir = _fat.fd[fd_id].inode->is_dir;
3134
3135    return 0;
3136} // end _fat_file_info()
3137
3138
3139
3140
3141/////////////////////////////////////////////////////////////////////////////////
3142// The following function implements the "giet_fat_read()" system call.
3143// It transfers "count" bytes from the File_Cache associated to the file
3144// identified by "fd_id", to the user "buffer", from the current file offset.
3145// In case of miss in the File_Cache, it loads all involved clusters into cache.
3146/////////////////////////////////////////////////////////////////////////////////
3147// Returns number of bytes actually transfered if success .
3148// Returns 0 if EOF encountered (offset + count > file_size).
3149// Returns a negative value if error:
3150//   -1 :  "fat not initialised"
3151//   -2 :  "illegal file descriptor"
3152//   -2 :  "file not open"
3153//   -3 :  "cannot load file from device"
3154/////////////////////////////////////////////////////////////////////////////////
3155int _fat_read( unsigned int fd_id,     // file descriptor index
3156               void*        buffer,    // destination buffer
3157               unsigned int count )    // number of bytes to read
3158{
3159    // checking FAT initialised
3160    if( _fat.initialised != FAT_INITIALISED )
3161    {
3162        _printf("\n[FAT ERROR] in _fat_write() : FAT not initialised\n");
3163        return -1;
3164    }
3165
3166    // check fd_id overflow
3167    if ( fd_id >= GIET_OPEN_FILES_MAX )
3168    {
3169        _printf("\n[FAT ERROR] in _fat_read() : illegal file descriptor\n");
3170        return -2;
3171    }
3172
3173    // check file is open
3174    if ( _fat.fd[fd_id].allocated == 0 )
3175    {
3176        _printf("\n[FAT ERROR] in _fat_read() : file not open\n");
3177        return -3;
3178    }
3179
3180    // takes lock
3181    _spin_lock_acquire( &_fat.fat_lock );
3182           
3183    // get file inode pointer and offset
3184    fat_inode_t* inode  = _fat.fd[fd_id].inode;
3185    unsigned int seek   = _fat.fd[fd_id].seek;
3186
3187    // check count & seek versus file size
3188    if ( count + seek > inode->size )
3189    {
3190        _spin_lock_release( &_fat.fat_lock );
3191        _printf("\n[FAT ERROR] in _fat_read() : file too small"
3192                " / seek = %x / count = %x / file_size = %x\n",
3193                seek , count , inode->size );
3194        return 0;
3195    }
3196
3197    // compute first_cluster_id and first_byte_to_move
3198    unsigned int first_cluster_id   = seek >> 12;
3199    unsigned int first_byte_to_move = seek & 0xFFF;   
3200
3201    // compute last_cluster and last_byte_to_move
3202    unsigned int last_cluster_id   = (seek + count - 1) >> 12;   
3203    unsigned int last_byte_to_move = (seek + count - 1) & 0xFFF;
3204
3205#if GIET_DEBUG_FAT
3206unsigned int procid  = _get_procid();
3207unsigned int x       = procid >> (Y_WIDTH + P_WIDTH);
3208unsigned int y       = (procid >> P_WIDTH) & ((1<<Y_WIDTH)-1);
3209unsigned int p       = procid & ((1<<P_WIDTH)-1);
3210if ( _get_proctime() > GIET_DEBUG_FAT )
3211_printf("\n[DEBUG FAT] _fat_read() : P[%d,%d,%d] enters for file <%s> "
3212        " / bytes = %x / offset = %x\n"
3213        "first_cluster_id = %x / first_byte_to_move = %x"
3214        " / last_cluster_id = %x / last_byte_to_move = %x\n",
3215        x , y , p , inode->name , count , seek ,
3216        first_cluster_id , first_byte_to_move , last_cluster_id , last_byte_to_move );
3217#endif
3218
3219    // loop on all cluster covering the requested transfer
3220    unsigned int cluster_id;
3221    unsigned int done = 0;
3222    for ( cluster_id = first_cluster_id ; cluster_id <= last_cluster_id ; cluster_id++ )
3223    {
3224        // get pointer on the cluster_id buffer in cache
3225        unsigned char*     cbuf;
3226        fat_cache_desc_t*  pdesc;
3227        if ( _get_buffer_from_cache( inode, 
3228                                     cluster_id,
3229                                     &pdesc ) )
3230        {
3231            _spin_lock_release( &_fat.fat_lock );
3232            _printf("\n[FAT ERROR] in _fat_read() : cannot load file <%s>\n",
3233                    inode->name );
3234            return -4;
3235        }
3236        cbuf = pdesc->buffer;
3237
3238#if GIET_DEBUG_FAT
3239if ( _get_proctime() > GIET_DEBUG_FAT )
3240_printf("\n[DEBUG FAT] _fat_read() : P[%d,%d,%d] moves cluster_id %d from Cache-File <%s>\n",
3241        x , y , p , cluster_id, inode->name );
3242#endif
3243
3244        // compute memcpy arguments
3245        unsigned char*  source;
3246        unsigned int    nbytes;
3247        unsigned char*  dest = (unsigned char*)buffer + done;
3248        if ( (cluster_id == first_cluster_id) && (cluster_id == last_cluster_id) )
3249        {
3250            source = cbuf + first_byte_to_move; 
3251            nbytes = last_byte_to_move - first_byte_to_move + 1;
3252        }
3253        else if ( cluster_id == first_cluster_id )
3254        {
3255            source = cbuf + first_byte_to_move; 
3256            nbytes = 4096 - first_byte_to_move;
3257        }
3258        else if ( cluster_id == last_cluster_id )
3259        {
3260            source = cbuf; 
3261            nbytes = last_byte_to_move + 1;
3262        }
3263        else  // not first / not last
3264        {
3265            source = cbuf; 
3266            nbytes = 4096;
3267        }
3268
3269        // move data
3270        memcpy( dest , source , nbytes );
3271        done = done + nbytes;
3272    }
3273
3274#if GIET_DEBUG_FAT
3275if ( _get_proctime() > GIET_DEBUG_FAT )
3276_printf("\n[DEBUG FAT] _fat_read() : P[%d,%d,%d] loaded file <%s> from Cache-File\n",
3277        x , y , p , inode->name );
3278#endif
3279
3280    // update seek
3281    _fat.fd[fd_id].seek += done;
3282
3283    // release lock
3284    _spin_lock_release( &_fat.fat_lock );
3285
3286    return done;
3287} // end _fat_read()
3288
3289
3290
3291
3292/////////////////////////////////////////////////////////////////////////////////
3293// The following function implements the "giet_fat_write()" system call.
3294// It transfers "count" bytes to the fat_cache associated to the file
3295// identified by "fd_id", from the user "buffer", using the current file offset.
3296// It increases the file size and allocate new clusters if (count + offset)
3297// is larger than the current file size. Then it loads and updates all
3298// involved clusters in the cache.
3299/////////////////////////////////////////////////////////////////////////////////
3300// Returns number of bytes actually written if success.
3301// Returns a negative value if error:
3302//   -1 :  "FAT not initialised"
3303//   -2 :  "Illegal file descriptor"
3304//   -3 :  "File not open"
3305//   -4 :  "File not writable"
3306//   -5 :  "No free clusters"
3307//   -6 :  "Cannot update parent directory entry"
3308//   -7 :  "Cannot access File-Cache"
3309/////////////////////////////////////////////////////////////////////////////////
3310int _fat_write( unsigned int fd_id,    // file descriptor index
3311                void*        buffer,   // source buffer
3312                unsigned int count )   // number of bytes to write
3313{
3314    // checking FAT initialised
3315    if( _fat.initialised != FAT_INITIALISED )
3316    {
3317        _printf("\n[FAT ERROR] in _fat_write() : FAT not initialised\n");
3318        return -1;
3319    }
3320
3321    // takes lock
3322    _spin_lock_acquire( &_fat.fat_lock );
3323           
3324    // check fd_id overflow
3325    if ( fd_id >= GIET_OPEN_FILES_MAX )
3326    {
3327        _spin_lock_release( &_fat.fat_lock );
3328        _printf("\n[FAT ERROR] in _fat_write() : illegal file descriptor\n");
3329        return -2;
3330    }
3331
3332    // check file open
3333    if ( _fat.fd[fd_id].allocated == 0 )
3334    {
3335        _spin_lock_release( &_fat.fat_lock );
3336        _printf("\n[FAT ERROR] in _fat_write() : file not open\n" );
3337        return -3;
3338    }
3339
3340    // check file writable
3341    if ( _fat.fd[fd_id].read_only )
3342    {
3343        _spin_lock_release( &_fat.fat_lock );
3344        _printf("\n[FAT ERROR] in _fat_write() : file <%s> is read-only\n",
3345                _fat.fd[fd_id].inode->name );
3346        return -4;
3347    }
3348
3349    // get file inode pointer and seek
3350    fat_inode_t* inode  = _fat.fd[fd_id].inode;
3351    unsigned int seek   = _fat.fd[fd_id].seek;
3352
3353#if GIET_DEBUG_FAT
3354unsigned int procid  = _get_procid();
3355unsigned int x       = procid >> (Y_WIDTH + P_WIDTH);
3356unsigned int y       = (procid >> P_WIDTH) & ((1<<Y_WIDTH)-1);
3357unsigned int p       = procid & ((1<<P_WIDTH)-1);
3358if ( _get_proctime() > GIET_DEBUG_FAT )
3359_printf("\n[DEBUG FAT] _fat_write() : P[%d,%d,%d] enters for file <%s> "
3360        " / bytes = %x / seek = %x\n",
3361        x , y , p , inode->name , count , seek );
3362#endif
3363
3364    // chek if file size must be incremented
3365    // and allocate new clusters from FAT if required
3366    unsigned int old_size = inode->size;
3367    unsigned int new_size = seek + count;
3368    if ( new_size > old_size )
3369    {
3370        // update size in inode
3371        inode->size = new_size;
3372 
3373        // compute current and required numbers of clusters
3374        unsigned old_clusters = old_size >> 12;
3375        if ( old_size & 0xFFF ) old_clusters++;
3376
3377        unsigned new_clusters = new_size >> 12;
3378        if ( new_size & 0xFFF ) new_clusters++;
3379
3380        // allocate new clusters from FAT if required
3381        if ( new_clusters > old_clusters )
3382        {
3383
3384#if GIET_DEBUG_FAT
3385if ( _get_proctime() > GIET_DEBUG_FAT )
3386_printf("\n[DEBUG FAT] _fat_write() : P[%d,%d,%d] allocates new clusters for file <%s>"
3387        " / current = %d / required = %d\n",
3388        x , y , p , inode->name , old_clusters , new_clusters );
3389#endif
3390            // allocate missing clusters
3391            if ( _clusters_allocate( inode,
3392                                     old_clusters,
3393                                     new_clusters - old_clusters ) )
3394            {
3395                _spin_lock_release( &_fat.fat_lock );
3396                _printf("\n[FAT ERROR] in _fat_write() : no free clusters"
3397                        " for file <%s>\n", _fat.fd[fd_id].inode->name );
3398                return -5;
3399            }
3400        }
3401         
3402        // update parent directory entry (size an cluster index)
3403        if ( _update_dir_entry( inode ) )
3404        {
3405            _spin_lock_release( &_fat.fat_lock );
3406            _printf("\n[FAT ERROR] in _fat_write() : cannot update parent directory entry"
3407                    " for file <%s>\n", _fat.fd[fd_id].inode->name );
3408            return -6;
3409        }
3410           
3411
3412#if GIET_DEBUG_FAT
3413if ( _get_proctime() > GIET_DEBUG_FAT )
3414_printf("\n[DEBUG FAT] _fat_write() : P[%d,%d,%d] updates size for file <%s> / size = %x\n",
3415        x , y , p , inode->name , (new_size - old_size) );
3416#endif
3417
3418    }
3419
3420    // compute first_cluster_id and first_byte_to_move
3421    unsigned int first_cluster_id   = seek >> 12;
3422    unsigned int first_byte_to_move = seek & 0xFFF;   
3423
3424    // compute last_cluster and last_byte_to_move
3425    unsigned int last_cluster_id   = (seek + count - 1) >> 12;   
3426    unsigned int last_byte_to_move = (seek + count - 1) & 0xFFF;
3427
3428#if GIET_DEBUG_FAT
3429if ( _get_proctime() > GIET_DEBUG_FAT )
3430_printf("\n[DEBUG FAT] _fat_write() : P[%d,%d,%d] starts loop on clusters for file <%s>\n"
3431        "  first_cluster_id = %d / first_byte_to_move = %x"
3432        " / last_cluster_id = %d / last_byte_to_move = %x\n",
3433        x , y , p , inode->name ,
3434        first_cluster_id , first_byte_to_move , last_cluster_id , last_byte_to_move );
3435#endif
3436
3437    // loop on all clusters covering the requested transfer
3438    unsigned int cluster_id;
3439    unsigned int done = 0;
3440    for ( cluster_id = first_cluster_id ; cluster_id <= last_cluster_id ; cluster_id++ )
3441    {
3442        // get pointer on one 4K buffer in File-Cache
3443        unsigned char*     cbuf;
3444        fat_cache_desc_t*  pdesc;
3445        if ( _get_buffer_from_cache( inode,   
3446                                     cluster_id, 
3447                                     &pdesc ) )   
3448        {
3449            _spin_lock_release( &_fat.fat_lock );
3450            _printf("\n[FAT ERROR] in _fat_write() : cannot load file <%s>\n",
3451                    inode->name );
3452            return -7;
3453        }
3454       
3455        cbuf         = pdesc->buffer;
3456        pdesc->dirty = 1;
3457   
3458#if GIET_DEBUG_FAT
3459if ( _get_proctime() > GIET_DEBUG_FAT )
3460_printf("\n[DEBUG FAT] _fat_write() : P[%d,%d,%d] move cluster_id %d to Cache-file <%s>\n",
3461        x , y , p , cluster_id, inode->name );
3462#endif
3463
3464        // compute memcpy arguments
3465        unsigned char* source = (unsigned char*)buffer + done;
3466        unsigned char* dest;
3467        unsigned int   nbytes;
3468        if ( (cluster_id == first_cluster_id) && (cluster_id == last_cluster_id) )
3469        {
3470            dest   = cbuf + first_byte_to_move; 
3471            nbytes = last_byte_to_move - first_byte_to_move + 1;
3472        }
3473        else if ( cluster_id == first_cluster_id )
3474        {
3475            dest   = cbuf + first_byte_to_move; 
3476            nbytes = 4096 - first_byte_to_move;
3477        }
3478        else if ( cluster_id == last_cluster_id )
3479        {
3480            dest   = cbuf; 
3481            nbytes = last_byte_to_move + 1;
3482        }
3483        else
3484        {
3485            dest   = cbuf; 
3486            nbytes = 4096;
3487        }
3488
3489        //move date
3490        memcpy( dest , source , nbytes ); 
3491        done = done + nbytes;
3492
3493    } // end for clusters
3494
3495    // update seek
3496    _fat.fd[fd_id].seek += done;
3497
3498#if GIET_DEBUG_FAT
3499if ( _get_proctime() > GIET_DEBUG_FAT )
3500_printf("\n[DEBUG FAT] _fat_write() : P[%d,%d,%d] store file <%s> into Cache-File\n",
3501        x , y , p , inode->name );
3502#endif
3503
3504    // release lock
3505    _spin_lock_release( &_fat.fat_lock );
3506
3507    return done;
3508} // end _fat_write()
3509
3510
3511
3512/////////////////////////////////////////////////////////////////////////////////
3513// The following function implements the "giet_fat_lseek()" system call.
3514// It repositions the seek in the file descriptor "fd_id", according to
3515// the "seek" and "whence" arguments.
3516// It has the same semantic as the UNIX lseek() function.
3517// Accepted values for whence are SEEK_SET and SEEK_CUR.
3518/////////////////////////////////////////////////////////////////////////////////
3519// Returns new seek value (bytes) if success.
3520// Returns negative value if error:
3521//   -1  : "FAT not initialised"
3522//   -2  : "Illegal file descriptor"
3523//   -3  : "File not open"
3524//   -4  : "Illegal whence argument"
3525/////////////////////////////////////////////////////////////////////////////////
3526int _fat_lseek( unsigned int fd_id,
3527                unsigned int seek,
3528                unsigned int whence )
3529{
3530    // checking FAT initialised
3531    if( _fat.initialised != FAT_INITIALISED )
3532    {
3533        _printf("\n[FAT ERROR] in _fat_lseek() : FAT not initialised\n");
3534        return -1;
3535    }
3536
3537    // check fd_id overflow
3538    if ( fd_id >= GIET_OPEN_FILES_MAX )
3539    {
3540        _printf("\n[FAT ERROR] in _fat_lseek() : illegal file descriptor\n");
3541        return -2;
3542    }
3543
3544    // takes lock
3545    _spin_lock_acquire( &_fat.fat_lock );
3546
3547    // check file open
3548    if ( _fat.fd[fd_id].allocated == 0 )
3549    {
3550        _spin_lock_release( &_fat.fat_lock );
3551        _printf("\n[FAT ERROR] in _fat_lseek() : file not open\n");
3552        return -3;
3553    }
3554
3555    unsigned int  new_seek;
3556
3557    // compute new seek
3558    if      ( whence == SEEK_CUR ) new_seek = _fat.fd[fd_id].seek + seek;
3559    else if ( whence == SEEK_SET ) new_seek = seek;
3560    else
3561    {
3562        _spin_lock_release( &_fat.fat_lock );
3563        _printf("\n[FAT ERROR] in _fat_user_lseek() : illegal whence valuel\n");
3564        return -4;
3565    }
3566
3567    // update file descriptor offset
3568    _fat.fd[fd_id].seek = new_seek;
3569
3570#if GIET_DEBUG_FAT
3571unsigned int procid  = _get_procid();
3572unsigned int x       = procid >> (Y_WIDTH + P_WIDTH);
3573unsigned int y       = (procid >> P_WIDTH) & ((1<<Y_WIDTH)-1);
3574unsigned int p       = procid & ((1<<P_WIDTH)-1);
3575if ( _get_proctime() > GIET_DEBUG_FAT )
3576_printf("\n[DEBUG FAT] _fat_lseek() : P[%d,%d,%d] set seek = %x for file <%s>\n",
3577        x , y , p , new_seek , _fat.fd[fd_id].inode->name );
3578#endif
3579
3580    // release lock
3581    _spin_lock_release( &_fat.fat_lock );
3582
3583    return new_seek;
3584}  // end _fat_lseek()
3585
3586
3587
3588/////////////////////////////////////////////////////////////////////////////////
3589// The following function implements the giet_fat_remove() system call.
3590// It deletes the file/directory identified by the "pathname" argument from
3591// the file system, if the remove condition is fulfilled (directory empty,
3592// or file not referenced).
3593// All clusters allocated in the block device DATA region are released.
3594// The FAT region is updated on the block device.
3595// The Inode-Tree is updated.
3596// The associated File_Cache is released.
3597// The Fat_Cache is updated.
3598/////////////////////////////////////////////////////////////////////////////////
3599// Returns 0 if success.
3600// Returns negative value if error
3601//   -1  : "FAT not initialised"
3602//   -2  : "File/Directory not found"
3603//   -3  : "Name too long in path"
3604//   -4  : "Has the wrong type"
3605//   -5  : "File still open"
3606//   -6  : "Cannot scan directory"
3607//   -7  : "Directory not empty"
3608//   -8  : "Cannot remove file/dir from FS"
3609/////////////////////////////////////////////////////////////////////////////////
3610int _fat_remove( char*        pathname,
3611                 unsigned int should_be_dir )
3612{
3613    fat_inode_t*  inode;            // searched file inode pointer
3614
3615#if GIET_DEBUG_FAT
3616unsigned int procid  = _get_procid();
3617unsigned int x       = procid >> (Y_WIDTH + P_WIDTH);
3618unsigned int y       = (procid >> P_WIDTH) & ((1<<Y_WIDTH)-1);
3619unsigned int p       = procid & ((1<<P_WIDTH)-1);
3620if ( _get_proctime() > GIET_DEBUG_FAT )
3621_printf("\n[DEBUG FAT] _fat_remove() : P[%d,%d,%d] enters for path <%s>\n",
3622        x, y, p, pathname );
3623#endif
3624
3625    // checking FAT initialised
3626    if( _fat.initialised != FAT_INITIALISED )
3627    {
3628        _printf("\n[FAT ERROR] in _fat_remove() : FAT not initialised\n");
3629        return -1;
3630    }
3631
3632    // take the lock
3633    _spin_lock_acquire( &_fat.fat_lock );
3634
3635    // get searched file inode
3636    unsigned int code = _get_inode_from_path( pathname , &inode );
3637
3638#if GIET_DEBUG_FAT
3639if ( _get_proctime() > GIET_DEBUG_FAT )
3640_printf("\n[DEBUG FAT] _fat_remove() : P[%d,%d,%d] found inode %x for <%s> / code = %d\n",
3641        x , y , p , (unsigned int)inode , pathname , code );
3642#endif
3643
3644    if ( (code == 1) || (code == 2) )
3645    {
3646        _spin_lock_release( &_fat.fat_lock );
3647        _printf("\n[FAT ERROR] in _fat_remove() : file <%s> not found\n", 
3648                pathname );
3649        return -2;
3650    }
3651    else if ( code == 3 )
3652    {
3653        _spin_lock_release( &_fat.fat_lock );
3654        _printf("\n[FAT ERROR] in _fat_remove() : name too long in <%s>\n",
3655                pathname );
3656        return -3;
3657    }
3658
3659    // check inode type
3660    if ( (inode->is_dir != 0) && (should_be_dir == 0) ) 
3661    {
3662        _spin_lock_release( &_fat.fat_lock );
3663        _printf("\n[FAT ERROR] in _fat_remove() : <%s> is a directory\n",
3664                pathname );
3665        return -4;
3666    }
3667    if ( (inode->is_dir == 0) && (should_be_dir != 0) )
3668    {
3669        _spin_lock_release( &_fat.fat_lock );
3670        _printf("\n[FAT ERROR] in _fat_remove() : <%s> is not a directory\n", 
3671                pathname );
3672        return -4;
3673    }
3674
3675#if GIET_DEBUG_FAT
3676if ( _get_proctime() > GIET_DEBUG_FAT )
3677_printf("\n[DEBUG FAT] _fat_remove() : P[%d,%d,%d] checked inode type for <%s>\n",
3678        x , y , p , pathname );
3679#endif
3680   
3681    // check references count for a file
3682    if ( (inode->is_dir == 0) && (inode->count != 0) )
3683    {
3684        _spin_lock_release( &_fat.fat_lock );
3685        _printf("\n[FAT ERROR] in _fat_remove() : file <%s> still referenced\n",
3686                pathname );
3687        return -5;
3688    }
3689
3690    //  check empty for a directory
3691    if ( inode->is_dir )
3692    {
3693        unsigned int entries;
3694        if ( _get_nb_entries( inode , &entries ) )
3695        {
3696            _spin_lock_release( &_fat.fat_lock );
3697            _printf("\n[FAT ERROR] in _fat_remove() : cannot scan directory <%s>\n", 
3698                    pathname );
3699            return -6;
3700        }
3701        else if ( entries > 2 )
3702        {
3703            _spin_lock_release( &_fat.fat_lock );
3704            _printf("\n[FAT ERROR] in _fat_remove() : directory <%s> not empty\n", 
3705                    pathname );
3706            return -7;
3707        }
3708    }
3709
3710#if GIET_DEBUG_FAT
3711if ( _get_proctime() > GIET_DEBUG_FAT )
3712_printf("\n[DEBUG FAT] _fat_remove() : P[%d,%d,%d] checked remove condition OK for <%s>\n",
3713        x , y , p , pathname );
3714#endif
3715   
3716    // remove the file or directory from the file system
3717    if ( _remove_node_from_fs( inode ) )
3718    {
3719        _spin_lock_release( &_fat.fat_lock );
3720        _printf("\n[FAT ERROR] in _fat_remove() : cannot remove <%s> from FS\n",
3721                pathname );
3722        return -8;
3723    }
3724
3725    // release lock and return success
3726    _spin_lock_release( &_fat.fat_lock );
3727
3728#if GIET_DEBUG_FAT
3729if ( _get_proctime() > GIET_DEBUG_FAT )
3730_printf("\n[DEBUG FAT] _fat_remove() : P[%d,%d,%d] removed  <%s> from FS\n",
3731        x, y, p, pathname );
3732#endif
3733   
3734    return 0;
3735       
3736}  // end _fat_remove()
3737
3738
3739
3740
3741
3742/////////////////////////////////////////////////////////////////////////////////
3743// This function implements the giet_fat_rename() system call.
3744// It moves an existing file or directory from one node (defined by "old_path"
3745// argument) to another node (defined by "new_path" argument) in the FS tree.
3746// The type (file/directory) and content are not modified.
3747// If the new_path file/dir exist, it is removed from the file system, but only 
3748// if the remove condition is respected (directory empty / file not referenced).
3749// The removed entry is only removed after the new entry is actually created.
3750/////////////////////////////////////////////////////////////////////////////////
3751// Returns 0 if success.
3752// Returns a negative value if error:
3753//  -1  : "FAT not initialised"
3754//  -2  : "old_path not found"
3755//  -3  : "new_path not found"
3756//  -4  : "cannot scan to_remove directory"
3757//  -5  : "to_remove directory not empty"
3758//  -6  : "to_remove file still referenced"
3759//  -7  : "cannot add new node to new_parent directory"
3760//  -8  : "cannot update new_parent directory on device"
3761//  -9  : "cannot remove old node from old_parent directory"
3762//  -10 : "cannot update old_parent directory on device"
3763//  -11 : "cannot remove to_remove node from FS"
3764//  -12 : "cannot move into its own subdirectory"
3765/////////////////////////////////////////////////////////////////////////////////
3766int _fat_rename( char*  old_path,
3767                 char*  new_path )
3768{
3769    fat_inode_t*  inode;        // anonymous inode pointer
3770    fat_inode_t*  old;          // inode identified by old_path      => to be deleted
3771    fat_inode_t*  new;          // inode identified by new_path      => to be created
3772    fat_inode_t*  old_parent;   // parent inode  in old_path         => to be modified
3773    fat_inode_t*  new_parent;   // parent inode  in new_path         => to be modified
3774    fat_inode_t*  to_remove;    // previouly identified by new_path  => to be removed
3775    unsigned int  code;
3776
3777#if GIET_DEBUG_FAT
3778unsigned int procid  = _get_procid();
3779unsigned int x       = procid >> (Y_WIDTH + P_WIDTH);
3780unsigned int y       = (procid >> P_WIDTH) & ((1<<Y_WIDTH)-1);
3781unsigned int p       = procid & ((1<<P_WIDTH)-1);
3782if ( _get_proctime() > GIET_DEBUG_FAT )
3783_printf("\n[DEBUG FAT] _fat_rename() : P[%d,%d,%d] enters to move <%s> to <%s>\n",
3784        x , y , p , old_path , new_path );
3785#endif
3786
3787    // checking FAT initialised
3788    if( _fat.initialised != FAT_INITIALISED )
3789    {
3790        _printf("\n[FAT ERROR] in _fat_rename() : FAT not initialised\n");
3791        return -1;
3792    }
3793
3794    // take the lock
3795    _spin_lock_acquire( &_fat.fat_lock );
3796
3797    // get "old" and "old_parent" inode pointers
3798    if ( _get_inode_from_path( old_path , &inode ) )
3799    {
3800        _spin_lock_release( &_fat.fat_lock );
3801        _printf("\n[FAT ERROR] in _fat_rename() : <%s> not found\n", old_path );
3802        return -2;
3803    }
3804    else
3805    {
3806        old        = inode;
3807        old_parent = inode->parent;
3808    }
3809
3810    // get "to_removed" and "new_parent" inode pointers
3811    code = _get_inode_from_path( new_path , &inode );
3812
3813    if ( code == 0 )       // new_path inode already exist
3814    {
3815        if ( inode == old )  // the file will replace itself, do nothing
3816        {
3817            _spin_lock_release( &_fat.fat_lock );
3818            return 0;
3819        }
3820
3821        to_remove        = inode;
3822        new_parent       = inode->parent;
3823    }
3824    else if ( code == 1 )  // to_remove does not exist but parent exist
3825    {
3826        to_remove        = NULL;
3827        new_parent       = inode;
3828    }
3829    else                   // parent directory in new_path not found
3830    {
3831        _spin_lock_release( &_fat.fat_lock );
3832        _printf("\n[FAT ERROR] in _fat_rename() : <%s> not found\n", new_path );
3833        return -3;
3834    }
3835
3836    // check for move into own subdirectory
3837    if ( _is_ancestor( old, new_parent ) )
3838    {
3839        _spin_lock_release( &_fat.fat_lock );
3840        _printf("\n[FAT ERROR] in _fat_rename() : can't move %s into its own subdirectory\n", old_path );
3841        return -12;
3842    }
3843
3844#if GIET_DEBUG_FAT
3845if ( _get_proctime() > GIET_DEBUG_FAT )
3846{
3847if ( to_remove )
3848_printf("\n[DEBUG FAT] _fat_rename() : old_parent = %s / old = %s / new_parent = %s "
3849        "/ to_remove = %s\n",
3850        old_parent->name , old->name , new_parent->name , to_remove->name );
3851else
3852_printf("\n[DEBUG FAT] _fat_rename() : old_parent = %s / old = %s / new_parent = %s "
3853        "/ no remove\n", 
3854        old_parent->name , old->name , new_parent->name );
3855}
3856#endif
3857
3858    // check remove condition for "to_remove" inode
3859    if ( to_remove )
3860    {
3861        if ( to_remove->is_dir )   // it's a directory
3862        {
3863            unsigned int entries;
3864            if ( _get_nb_entries( to_remove , &entries ) )
3865            {
3866                _spin_lock_release( &_fat.fat_lock );
3867                _printf("\n[FAT ERROR] in _fat_rename() : cannot scan directory <%s>\n", 
3868                        to_remove->name );
3869                return -4;
3870            }
3871            else if ( entries > 2 )
3872            {
3873                _spin_lock_release( &_fat.fat_lock );
3874                _printf("\n[FAT ERROR] in _fat_rename() : directory <%s> not empty\n", 
3875                        to_remove->name );
3876                return -5;
3877            }
3878        }
3879        else                       // it's a file
3880        {
3881            if ( to_remove->count ) 
3882            {
3883                _spin_lock_release( &_fat.fat_lock );
3884                _printf("\n[FAT ERROR] in _fat_rename() : file <%s> still referenced\n", 
3885                        to_remove->name );
3886                return -6;
3887            }
3888        }
3889    }
3890
3891#if GIET_DEBUG_FAT
3892if ( _get_proctime() > GIET_DEBUG_FAT )
3893_printf("\n[FAT DEBUG] _fat_rename() : P[%d,%d,%d] checked remove condition OK\n",
3894        x , y , p );
3895#endif
3896
3897    // get new last name / error checking already done by _get_inode_from_path()
3898    char  new_name[32];
3899    _get_last_name( new_path , new_name );
3900
3901    // allocate "new" inode
3902    new = _allocate_one_inode( new_name,
3903                               old->is_dir,
3904                               old->cluster,
3905                               old->size,
3906                               0,              // count
3907                               0,              // dentry
3908                               0 );            // no cache_allocate
3909 
3910    // give the "old" File-Cache to the "new inode
3911    new->levels = old->levels;
3912    new->cache  = old->cache;
3913
3914    // add "new" to "new_parent" directory File-Cache
3915    if ( _add_dir_entry( new , new_parent ) )
3916    {
3917        _spin_lock_release( &_fat.fat_lock );
3918        _printf("\n[FAT ERROR] in _fat_rename() : cannot add <%s> into <%s>\n",
3919                new->name , new_parent->name );
3920        return -7;
3921    }
3922
3923    // add "new" to "new_parent" directory in Inode-Tree
3924    _add_inode_in_tree( new , new_parent );
3925   
3926    // updates "new_parent" directory on device
3927    if ( _update_device_from_cache( new_parent->levels,
3928                                    new_parent->cache,
3929                                    new_parent->name ) )
3930    {
3931        _spin_lock_release( &_fat.fat_lock );
3932        _printf("\n[FAT ERROR] in _fat_rename() : cannot update <%s> on device\n",
3933                    new_parent->name );
3934        return -8;
3935    }
3936
3937    // remove "old" from "old_parent" File-Cache
3938    if ( _remove_dir_entry( old ) )
3939    {
3940        _spin_lock_release( &_fat.fat_lock );
3941        _printf("\n[FAT ERROR] in _fat_rename() : cannot remove <%s> from <%s>\n",
3942                old->name , old_parent->name );
3943        return -9;
3944    }
3945 
3946    // remove "old" inode from Inode-Tree
3947    _remove_inode_from_tree( old );
3948
3949    // release "old" inode
3950    _free( old );
3951
3952    // updates "old_parent" directory on device
3953    if ( _update_device_from_cache( old_parent->levels,
3954                                    old_parent->cache,
3955                                    old_parent->name ) )
3956    {
3957        _spin_lock_release( &_fat.fat_lock );
3958        _printf("\n[FAT ERROR] in _fat_rename() : cannot update <%s> on device\n",
3959                    old_parent->name );
3960        return -10;
3961    }
3962
3963    // remove "to_remove" from File System (if required)
3964    if ( to_remove )
3965    {
3966        if ( _remove_node_from_fs( to_remove ) )
3967        {
3968            _spin_lock_release( &_fat.fat_lock );
3969            _printf("\n[FAT ERROR] in _fat_rename() : cannot remove <%s> from FS\n",
3970                    to_remove->name );
3971            return -11;
3972        }
3973    }
3974
3975    // release lock
3976    _spin_lock_release( &_fat.fat_lock );
3977
3978    return 0;
3979}  // end _fat_rename()
3980
3981
3982
3983
3984/////////////////////////////////////////////////////////////////////////////////
3985// The following function implements the giet_fat_mkdir() system call.
3986// It creates in file system the directory specified by the "pathname" argument.
3987// The Inode-Tree is updated.
3988// One cluster is allocated to the new directory.
3989// The associated File-Cache is created.
3990// The FAT region on block device is updated.
3991// The DATA region on block device is updated.
3992/////////////////////////////////////////////////////////////////////////////////
3993// Returns 0 if success.
3994// Returns a negative value if error:
3995//   -1  : "Fat not initialised"
3996//   -2  : "Path to parent not found"
3997//   -3  : "One name in path too long"
3998//   -4  : "Directory already exist"
3999//   -5  : "No free cluster"
4000//   -6  : "Cannot update parent directory"
4001//   -7  : "Cannot update parent DATA region"
4002//   -8  : "Cannot update FAT region"
4003//   -9  : "Cannot update FS-INFO"
4004//   -10 : "Cannot update directory DATA region"
4005/////////////////////////////////////////////////////////////////////////////////
4006int _fat_mkdir( char* pathname )
4007{
4008    fat_inode_t*         inode;            // anonymous inode pointer
4009    fat_inode_t*         child;            // searched directory inode pointer
4010    fat_inode_t*         parent;           // parent directory inode pointer
4011
4012#if GIET_DEBUG_FAT
4013unsigned int procid  = _get_procid();
4014unsigned int x       = procid >> (Y_WIDTH + P_WIDTH);
4015unsigned int y       = (procid >> P_WIDTH) & ((1<<Y_WIDTH)-1);
4016unsigned int p       = procid & ((1<<P_WIDTH)-1);
4017if ( _get_proctime() > GIET_DEBUG_FAT )
4018_printf("\n[DEBUG FAT] _fat_mkdir() : P[%d,%d,%d] enters for path <%s>\n",
4019        x, y, p, pathname );
4020#endif
4021
4022    // checking FAT initialised
4023    if( _fat.initialised != FAT_INITIALISED )
4024    {
4025        _printf("\n[FAT ERROR] in _fat_mkdir() : FAT not initialised\n");
4026        return -1;
4027    }
4028
4029    // takes the lock
4030    _spin_lock_acquire( &_fat.fat_lock );
4031   
4032    // get inode
4033    unsigned int code = _get_inode_from_path( pathname , &inode );
4034
4035    if ( code == 2 ) 
4036    {
4037        _spin_lock_release( &_fat.fat_lock );
4038        _printf("\n[FAT ERROR] in _fat_mkdir() : path to parent not found"
4039                " for directory <%s>\n", pathname );
4040        return -2;
4041    }
4042    else if ( code == 3 ) 
4043    {
4044        _spin_lock_release( &_fat.fat_lock );
4045        _printf("\n[FAT ERROR] in _fat_mkdir() : one name in path too long"
4046                " for directory  <%s>\n", pathname );
4047        return -3;
4048    }
4049    else if ( code == 0 )
4050    {
4051        _spin_lock_release( &_fat.fat_lock );
4052        _printf("\n[FAT ERROR] in _fat_mkdir() : directory <%s> already exist\n",
4053                pathname );
4054        return -4;
4055    }
4056    else if ( code == 1 )   // directory not found => create
4057    {
4058        parent = inode;
4059
4060#if GIET_DEBUG_FAT
4061if ( _get_proctime() > GIET_DEBUG_FAT )
4062_printf("\n[DEBUG FAT] _fat_mkdir() : P[%d,%d,%d] create new directory <%s>\n",
4063        x , y , p , pathname );
4064#endif
4065
4066        // get directory name / error check already done by _get_inode_from_path()
4067        char name[32];       
4068        _get_last_name( pathname , name );
4069
4070        // allocate one cluster from FAT for the new directory
4071        unsigned int cluster;
4072        if ( _allocate_one_cluster( &cluster ) )
4073        {
4074            _spin_lock_release( &_fat.fat_lock );
4075            _printf("\n[FAT ERROR] in _fat_mkdir() : no free cluster"
4076                    " for directory <%s>\n" , pathname );
4077            return -5;
4078        }
4079
4080        // allocate a new inode and an empty Cache-File
4081        child = _allocate_one_inode( name,
4082                                     1,           // it's a directory
4083                                     cluster, 
4084                                     0,           // size not defined
4085                                     0,           // count
4086                                     0,           // dentry set by _add_dir_entry()
4087                                     1 );         // cache_allocate
4088
4089        // introduce inode in Inode-Tree
4090        _add_inode_in_tree( child , parent );
4091 
4092        // allocate and initialise one 4 Kbytes buffer and associated descriptor
4093        _allocate_one_buffer( child,
4094                              0,            // cluster_id,
4095                              cluster );
4096
4097        _add_special_directories( child, 
4098                                  parent );
4099
4100        // add an entry in the parent directory Cache_file
4101        if ( _add_dir_entry( child , parent ) )
4102        { 
4103            _spin_lock_release( &_fat.fat_lock );
4104            _printf("\n[FAT ERROR] in _fat_mkdir() : cannot update parent directory"
4105                    " for directory <%s>\n" , pathname );
4106            return -6;
4107        } 
4108
4109        // update DATA region on block device for parent directory
4110        if ( _update_device_from_cache( parent->levels,
4111                                        parent->cache,
4112                                        parent->name ) )
4113        {
4114            _spin_lock_release( &_fat.fat_lock );
4115            _printf("\n[FAT ERROR] in _fat_mkdir() : cannot update DATA region "
4116                    " for parent of directory <%s>\n", pathname );
4117            return -7;
4118        }
4119
4120        // update FAT region on block device
4121        if ( _update_device_from_cache( _fat.fat_cache_levels,
4122                                        _fat.fat_cache_root,
4123                                        "FAT" ) )
4124        {
4125            _spin_lock_release( &_fat.fat_lock );
4126            _printf("\n[FAT ERROR] in _fat_mkdir() : cannot update FAT region"
4127                    " for directory <%s>\n", pathname );
4128            return -8;
4129        }
4130
4131        // update FS_INFO sector
4132        if ( _update_fs_info() )
4133        {
4134            _spin_lock_release( &_fat.fat_lock );
4135            _printf("\n[FAT ERROR] in _fat_mkdir() : cannot update FS-INFO"
4136                    " for directory <%s>\n", pathname );
4137            return -9;
4138        }
4139
4140        // update DATA region on block device for the new directory
4141        if ( _update_device_from_cache( child->levels,   
4142                                        child->cache,
4143                                        child->name ) )
4144        {
4145            _spin_lock_release( &_fat.fat_lock );
4146            _printf("\n[FAT ERROR] in _fat_mkdir() : cannot update DATA region"
4147                    " for directory <%s>\n", pathname );
4148            return -10;
4149        }
4150    }  // end create directory
4151
4152    // release lock
4153    _spin_lock_release( &_fat.fat_lock );
4154
4155    return 0;
4156}  // end _fat_mkdir()
4157
4158
4159
4160
4161
4162/////////////////////////////////////////////////////////////////////////////////
4163// The following function implements the giet_fat_list() system call.
4164// It displays the content of a directory identified by the "pathname" argument.
4165// It returns an error code if the pathname is not a directory.
4166/////////////////////////////////////////////////////////////////////////////////
4167// Returns 0 if success.
4168// Returns a negative value if error:
4169//   -1  : "FAT not initialised
4170//   -2  : "Directory not found"
4171//   -3  : "Name in path too long
4172//   -4  : "Not a directory"
4173//   -5  : "Cannot access directory"
4174/////////////////////////////////////////////////////////////////////////////////
4175int _fat_list( char*  pathname )
4176{
4177    fat_inode_t*  inode;
4178
4179    // checking FAT initialised
4180    if( _fat.initialised != FAT_INITIALISED )
4181    {
4182        _printf("\n[FAT ERROR] in _fat_list() : FAT not initialised\n");
4183        return -1;
4184    }
4185
4186#if GIET_DEBUG_FAT
4187unsigned int procid  = _get_procid();
4188unsigned int x       = procid >> (Y_WIDTH + P_WIDTH);
4189unsigned int y       = (procid >> P_WIDTH) & ((1<<Y_WIDTH)-1);
4190unsigned int p       = procid & ((1<<P_WIDTH)-1);
4191if ( _get_proctime() > GIET_DEBUG_FAT )
4192_printf("\n[DEBUG FAT] _fat_list() : P[%d,%d,%d] enters for path <%s>\n",
4193        x, y, p, pathname );
4194#endif
4195
4196    // get inode
4197    unsigned int code = _get_inode_from_path( pathname , &inode );
4198
4199    if ( (code == 1) || (code == 2) ) 
4200    {
4201        _printf("\n[FAT ERROR] in _fat_list() : directory <%s> not found\n", pathname );
4202        return -2;
4203    }
4204    if ( code == 3 )
4205    {
4206        _printf("\n[FAT ERROR] in _fat_list() : name too long in path <%s>\n", pathname );
4207        return -3;
4208    }
4209
4210    // check found inode is a directory
4211    if ( inode->is_dir == 0 )
4212    {
4213        _printf("\n[FAT ERROR] in _fat_list() : <%s> is not a directory\n", pathname );
4214        return -4;
4215    }
4216
4217#if GIET_DEBUG_FAT
4218if ( _get_proctime() > GIET_DEBUG_FAT )
4219_printf("\n[DEBUG FAT] _fat_list() : P[%d,%d,%d] found inode for path <%s>\n",
4220        x, y, p, pathname );
4221#endif
4222
4223    // scan directory up to end of directory / two embedded loops :
4224    // - loop on the clusters allocated to the directory
4225    // - loop on the directory entries in each 4 Kbytes buffer
4226    unsigned char*     buffer; 
4227    fat_cache_desc_t*  pdesc;
4228    unsigned int       cluster_id = 0;     // cluster index in directory
4229    unsigned int       offset     = 0;     // position in scanned buffer
4230    unsigned int       lfn        = 0;     // number of lfn entries
4231    unsigned int       nb_entries = 0;     // number of directory entries
4232    unsigned int       done       = 0;     // end of directory found
4233    unsigned int       attr;               // ATTR field value
4234    unsigned int       ord;                // ORD field value
4235    char               lfn1[16];           // temporary buffer for string in LFN1
4236    char               lfn2[16];           // temporary buffer for string in LFN2
4237    char               lfn3[16];           // temporary buffer for string in LFN3
4238    char               name[36];           // directory entry full name
4239    unsigned int       cluster;            // directory entry cluster index
4240    unsigned int       size;               // directory entry size
4241    unsigned int       is_dir;             // directory entry is a directory
4242    unsigned int       is_vid;             // directory entry is volume_id
4243
4244    // TODO : define a method to transfer this information to user mode
4245    _printf("\n<%s>   cluster = %x / lba = %x\n", pathname ,
4246            inode->cluster , _cluster_to_lba( inode->cluster) );
4247
4248    while ( done == 0 )
4249    {
4250        // get one 4 Kytes buffer
4251        if ( _get_buffer_from_cache( inode,
4252                                     cluster_id,
4253                                     &pdesc ) ) 
4254        {
4255            _printf("\n[FAT ERROR] in _fat_list() : cannot access <%s>\n", pathname );
4256            return -5;
4257        }
4258        buffer = pdesc->buffer;
4259
4260        // scan this 4 Kbytes buffer
4261        while ( (offset < 4096)  && (done == 0) )
4262        {
4263            attr = _read_entry( DIR_ATTR , buffer + offset , 0 );   
4264            ord  = _read_entry( LDIR_ORD , buffer + offset , 0 );
4265
4266            if (ord == NO_MORE_ENTRY)                 // no more entry in directory => break
4267            {
4268                done = 1;
4269            }
4270            else if ( ord == FREE_ENTRY )             // free entry => skip
4271            {
4272                offset = offset + 32;
4273            }
4274            else if ( attr == ATTR_LONG_NAME_MASK )   // LFN entry => get partial names
4275            {
4276                unsigned int seq = ord & 0x3;
4277                lfn = (seq > lfn) ? seq : lfn;   
4278                if      ( seq == 1 ) _get_name_from_long( buffer + offset, lfn1 );
4279                else if ( seq == 2 ) _get_name_from_long( buffer + offset, lfn2 );
4280                else if ( seq == 3 ) _get_name_from_long( buffer + offset, lfn3 );
4281                offset = offset + 32;
4282            }
4283            else                                 // NORMAL entry
4284            {
4285                if      ( lfn == 0 )
4286                {
4287                    _get_name_from_short( buffer + offset , name );
4288                }
4289                else if ( lfn == 1 )
4290                {
4291                    _strcpy( name , lfn1 );
4292                }   
4293                else if ( lfn == 2 ) 
4294                {
4295                    _strcpy( name      , lfn1 );
4296                    _strcpy( name + 13 , lfn2 );
4297                }
4298                else if ( lfn == 3 ) 
4299                {
4300                    _strcpy( name      , lfn1 );
4301                    _strcpy( name + 13 , lfn2 );
4302                    _strcpy( name + 26 , lfn3 );
4303                }
4304                   
4305                is_dir  = ((attr & ATTR_DIRECTORY) == ATTR_DIRECTORY);
4306                is_vid  = ((attr & ATTR_VOLUME_ID) == ATTR_VOLUME_ID);
4307                size    = (_read_entry( DIR_FILE_SIZE   , buffer + offset , 1 )      ) ;
4308                cluster = (_read_entry( DIR_FST_CLUS_HI , buffer + offset , 1 ) << 16) |
4309                          (_read_entry( DIR_FST_CLUS_LO , buffer + offset , 1 )      ) ;
4310
4311                if ( is_vid == 0 )
4312                {
4313                    // TODO : define a method to transfer this information to user mode
4314                    if (is_dir) _printf("  DIR  | size = %X | cluster = %X | %s\n",
4315                                        size , cluster, name );
4316                    else        _printf("  FILE | size = %X | cluster = %X | %s\n",
4317                                        size , cluster, name );
4318                    nb_entries++;
4319                }
4320               
4321                offset = offset + 32;
4322                lfn    = 0;
4323            }
4324        }  // end loop on directory entries
4325
4326        if ( done == 0 )
4327        {
4328            cluster_id++;
4329            offset = 0;
4330        }
4331    }  // end loop on buffers
4332
4333    // TODO : define a method to transfer this information to user mode
4334    _printf("  total = %d entries\n", nb_entries );
4335
4336    return 0;
4337} // end _fat_list()
4338
4339
4340
4341
4342
4343///////////////////////////////////////////////////////////////////////////////
4344// This functiond load a file identified by the "pathname" argument into the
4345// memory buffer defined by the "buffer_vbase" and "buffer_size" arguments.
4346// It is intended to be called by the boot-loader, as it does not use the
4347// dynamically allocated FAT structures (Inode-Tree, Fat_Cache or File-Cache,
4348// File-Descriptor-Array).
4349// It uses only the 512 bytes buffer defined in the FAT descriptor.
4350///////////////////////////////////////////////////////////////////////////////
4351// Returns  0 if success.
4352// Returns negative value if error:
4353//  -1  : "FAT not initialised"
4354//  -2  : "File not found"
4355//  -3  : "Buffer too small"
4356//  -4  : "Cannot access block device"
4357//  -5  : "Cannot access FAT on block device"
4358///////////////////////////////////////////////////////////////////////////////
4359int _fat_load_no_cache( char*        pathname,
4360                        unsigned int buffer_vbase, 
4361                        unsigned int buffer_size ) 
4362{
4363    // checking FAT initialised
4364    if( _fat.initialised != FAT_INITIALISED )
4365    {
4366        _printf("\n[FAT ERROR] in _fat_load_no_cache() : FAT not initialised\n");
4367        return -1;
4368    }
4369
4370    unsigned int  file_size;
4371    unsigned int  cluster;
4372
4373#if GIET_DEBUG_FAT
4374unsigned int procid  = _get_procid();
4375unsigned int x       = procid >> (Y_WIDTH + P_WIDTH);
4376unsigned int y       = (procid >> P_WIDTH) & ((1<<Y_WIDTH)-1);
4377unsigned int p       = procid & ((1<<P_WIDTH)-1);
4378if ( _get_proctime() > GIET_DEBUG_FAT )
4379_printf("\n[DEBUG FAT] _fat_load_no_cache() : P[%d,%d,%d] enters for file <%s>\n",
4380        x , y , p , pathname );
4381#endif
4382
4383    // get file size, and cluster index in FAT
4384    if ( _file_info_no_cache( pathname,
4385                              &cluster,
4386                              &file_size ) )
4387    {
4388        _printf("\n[FAT ERROR] in _fat_load_no_cache() : file <%s> not found\n",
4389        pathname );
4390        return -2;
4391    }
4392
4393    // check buffer size
4394    if ( file_size > buffer_size )
4395    {
4396        _printf("\n[FAT ERROR] in _fat_load_no_cache() : buffer too small : "
4397                "file_size = %x / buffer_size = %x", file_size , buffer_size );
4398        return -3;
4399    }
4400
4401    // compute total number of clusters to read
4402    unsigned int nb_clusters = file_size >> 12;
4403    if ( file_size & 0xFFF ) nb_clusters++;
4404
4405    // initialise buffer address
4406    unsigned int dst = buffer_vbase;
4407
4408    // loop on the clusters containing the file
4409    while ( nb_clusters > 0 )
4410    {
4411        unsigned int lba = _cluster_to_lba( cluster );
4412
4413        if( _fat_ioc_access( 0,         // no descheduling
4414                             1,         // read
4415                             lba, 
4416                             dst, 
4417                             8 ) )      // 8 blocks
4418        {
4419            _printf("\n[FAT ERROR] in _fat_no _cache_read() : cannot load lba %x", lba );
4420            return -4;
4421        }
4422         
4423
4424        // compute next cluster index
4425        unsigned int next;
4426        if ( _next_cluster_no_cache( cluster , &next ) )
4427        {
4428            _printf("\n[FAT ERROR] in _fat_no _cache_read() : cannot get next cluster "
4429                    " for cluster = %x\n", cluster );
4430            return -5;
4431        }
4432       
4433        // update variables for next iteration
4434        nb_clusters = nb_clusters - 1;
4435        dst         = dst + 4096;
4436        cluster     = next;
4437    }
4438         
4439#if GIET_DEBUG_FAT
4440if ( _get_proctime() > GIET_DEBUG_FAT )
4441_printf("\n[DEBUG FAT] _fat_load_no_cache() : P[%d,%d,%d] loaded <%s> at vaddr = %x"
4442        " / size = %x\n", x , y , p , pathname , buffer_vbase , file_size );
4443#endif
4444
4445    return 0;
4446}  // end _fat_load_no_cache()
4447
4448
4449
4450// Local Variables:
4451// tab-width: 4
4452// c-basic-offset: 4
4453// c-file-offsets:((innamespace . 0)(inline-open . 0))
4454// indent-tabs-mode: nil
4455// End:
4456// vim: filetype=c:expandtab:shiftwidth=4:tabstop=4:softtabstop=4
4457
Note: See TracBrowser for help on using the repository browser.