Changes between Version 38 and Version 39 of file_system

Timestamp:

Jan 19, 2016, 2:58:06 PM (9 years ago)

Author:

alain

Comment:

--

file_system

@@ -399 +399 @@
 It returns 0 on success. It returns 1 on error.
 
-
-
-//////////////////////////////////////////////////////////////////////////////////
-// This recursive function scans one File-Cache (or Fat-Cache) from root to
-// leaves. All memory allocated for 4KB buffers, and buffer descriptors (in
-// leaves) is released, along with the 64-Tree structure (root node is kept).
-// The cache is identified by the "root" and "levels" arguments.
-// It should not contain any dirty clusters.
-//////////////////////////////////////////////////////////////////////////////////
-
-static void _release_cache_memory( fat_cache_node_t*  root,
-                                   unsigned int       levels );
-
-//////////////////////////////////////////////////////////////////////////////////
-// The following function allocates and initializes a new cache node.
-// Its first child can be specified (used when adding a cache level).
-// The 63 other children are set to NULL.
-// It returns a pointer to a new Fat-Cache node.
-//////////////////////////////////////////////////////////////////////////////////
-
-static fat_cache_node_t* _allocate_one_cache_node( fat_cache_node_t* first_child );
-
-//////////////////////////////////////////////////////////////////////////////////
-// The following function allocates and initializes a new inode, 
-// using the values defined by the arguments.
-// If the "cache_allocate" argument is true, an empty cache is allocated.
-// It returns a pointer on the new inode.
-//////////////////////////////////////////////////////////////////////////////////
-
-static fat_inode_t* _allocate_one_inode( char*        name,
-                                         unsigned int is_dir,
-                                         unsigned int cluster,
-                                         unsigned int size,
-                                         unsigned int count,
-                                         unsigned int dentry,
-                                         unsigned int cache_allocate );
-
-//////////////////////////////////////////////////////////////////////////////////
-// The following function allocates a 4 Kbytes buffer and the associated cluster 
-// descriptor for the file (or directory) identified by the <inode> argument,
-// and updates the Cache_File slot identified by the <cluster_id> argument. 
-// The File-Cache slot must be empty.
-// It updates the buffer descriptor, using the <cluster> argument, that is 
-// the cluster index in FAT.  The cluster descriptor dirty field is set.
-// It traverse the 64-tree Cache-file from top to bottom to find the last level.
-//////////////////////////////////////////////////////////////////////////////////
-
-static void _allocate_one_buffer( fat_inode_t*    inode,
-                                  unsigned int    cluster_id,
-                                  unsigned int    cluster );
-
-//////////////////////////////////////////////////////////////////////////////////
-// The following function allocates one free cluster from the FAT  
-// and returns the cluster index in the <cluster> argument.
-// It updates the FAT slot, and the two FAT global variables: first_free_cluster,
-// and free_clusters_number.
-// It returns 0 on success.
-// It returns 1 on error.
-//////////////////////////////////////////////////////////////////////////////////
-
-static unsigned int _allocate_one_cluster( unsigned int*  cluster );
-
-/////////////////////////////////////////////////////////////////////////////
-// This function remove from the file system a file or a directory 
-// identified by the <inode> argument. 
-// The remove condition must be checked by the caller.
-// The relevant lock(s) must have been taken by te caller.
-// It returns 0 on success.
-// It returns 1 on error.
-/////////////////////////////////////////////////////////////////////////////
-
-static unsigned int _remove_node_from_fs( fat_inode_t* inode );
-
+=== __void '''_release_cache_memory'''( fat_cache_node_t*  root , unsigned int levels )__ ===
+This recursive function scans one File-Cache (or Fat-Cache) from root to leaves. All memory allocated for 4KB buffers, and buffer descriptors (in leaves) is released, along with the 64-Tree structure (root node is kept).
+The released cache is identified by the <root> and <levels> arguments.
+It should not contain any dirty clusters.
+
+=== __fat_cache_node_t* '''_allocate_one_cache_node'''( fat_cache_node_t* first_child )__ ===
+This function allocates and initializes a new cache node.
+Its first child can be specified (used when adding a cache level).
+The 63 other children are set to NULL.
+It returns a pointer to the new Fat-Cache node.
+
+=== __fat_inode_t* '''_allocate_one_inode'''( char* name , unsigned int is_dir , unsigned int cluster , unsigned int size , unsigned int count ,  unsigned int dentry , unsigned int cache_allocate )__ ===
+This function allocates and initializes a new inode, using the values defined by the <name>, <is_dir>, <cluster>, <size>, <count>, and <dentry> arguments. If the <cache_allocate> argument is true, an empty cache is allocated.
+It returns a pointer on the new inode.
+
+=== __void '''_allocate_one_buffer'''( fat_inode_t* inode , unsigned int cluster_id , unsigned int cluster )__ ===
+This function allocates a 4 Kbytes buffer and the associated cluster descriptor from the heap[x,y] defined by the calling thread, for the file (or directory) identified by the <inode> argument. It updates the Cache_File slot identified by the <cluster_id> argument. 
+The File-Cache slot must be empty. It updates the buffer descriptor, using the <cluster> argument, that is the cluster index in FAT.  The buffer descriptor dirty bit is set.
+It traverses the 64-tree Cache-file from top to bottom to find the last level.
+
+=== __unsigned int '''_allocate_one_cluster'''( unsigned int*  cluster )__ ==
+This  function allocates one free cluster from the FAT and returns the cluster index in the <cluster> argument.
+It updates the FAT slot, and the two FAT global variables "first_free_cluster" and "free_clusters_number".
+It returns 0 on success. It returns 1 on error.
+
+=== __unsigned int '''_remove_node_from_fs'''( fat_inode_t* inode )__ ===
+This function remove from the file system a file or a directory identified by the <inode> argument. 
+The remove conditions must be checked by the caller. The relevant lock(s) must have been taken by te caller.
+It returns 0 on success. It returns 1 on error.
 
 === __unsigned int '''_file_info_no_cache'''( char* pathname , unsigned int*  file_cluster , unsigned int*  file_size )__ ===