WebSVN – HelenOS – Diff – /branches/fs/uspace/fs/inode.c

  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
+/** @addtogroup FileSystemImpl
+* @{
+*/
+/**
+ * @file    inode.c
-/* This file manages the inode table.  There are procedures to allocate and
+ * @brief   This file manages the inode table.  There are procedures to allocate and
-* deallocate inodes, acquire, erase, and release them, and read and write
+*         deallocate inodes, acquire, erase, and release them, and read and write
-* them from the disk.
+*         them from the disk.
 */
-/* Methods:
- * get_inode:       search inode table for a given inode; if not there, read it
- * read_inode:      read a disk block and extract an inode
- * v1_copy_inode    copy from disk inode (V1.x) to in-memory inode struct
- * v2_copy_inode    copy from disk inode (V2.x) to in-memory inode structs
- * put_inode        indicate that an inode is no longer needed in memory
- * dup_inode:       indicate that someone else is using an inode table entry
- */
 #include "fs.h"
 #include "block.h"
 #include "file.h"
 #include "fproc.h"
 #include "inode.h"
 #include "super.h"
-inode_t inode[NR_INODES];
+inode_t inode[NR_INODES];  /**< A variable to store inode entries */
 static void v1_copy_inode(inode_t *rip, d1_inode_t *dip, int normal);
 static void v2_copy_inode(inode_t *rip, d2_inode_t *dip, int normal);
+/**
+ * Search inode table for a given inode; if not there, read it
+ */
 inode_t *get_inode(int numb)
+{
     /* Find a slot in the inode table, load the specified inode into it, and
      * return a pointer to the slot.
      */
     read_inode(xp);
     return xp;
+}
+/**
+ * Read a disk block and extract an inode
+ */
 void read_inode(register inode_t *rip)
+{
     /* An entry in the inode table is to be copied from the disk. */
+    }
     else {
         v2_copy_inode(rip, dip2, sp->s_native);
+    }
+}
+/**
+ * Copy from disk inode (V1.x) to in-memory inode struct
+ */
 void v1_copy_inode(inode_t *rip, d1_inode_t *dip, int normal)
+{
     /* The V1.x IBM disk, the V1.x 68000 disk, and the V2 disk (same for IBM and
      * 68000) all have different inode layouts.  When an inode is read or written
      * this routine handles the conversions so that the information in the inode
      * table is independent of the disk structure from which the inode came.
      * This routine copies from V1 disks.
     rip->i_nindirs = V1_INDIRECTS;
     for (i = 0; i < V1_NR_TZONES; i++)
         rip->i_zone[i] = conv2(normal, dip->d1_zone[i]);
+}
+/**
+ * Copy from disk inode (V2.x) to in-memory inode structs
+ */
 void v2_copy_inode(inode_t *rip, d2_inode_t *dip, int normal)
+{
     /* Same as old_icopy, but to/from V2 disk layout. */
     int i;
     /* Some check is made for valid number of inode. */
     for (i = 0; i < V2_NR_TZONES; i++)
         rip->i_zone[i] = conv4(normal, dip->d2_zone[i]);
+}
+/**
+ * Indicate that an inode is no longer needed in memory
+ */
 void put_inode(inode_t *rip)
+{
     /* The caller is no longer using this inode. */
     if (rip == NIL_INODE)
         return;
     rip->i_count--;
+}
+/**
+ * Indicate that someone else is using an inode table entry
+ */
 void dup_inode(inode_t *rip)
+{
     /* This routine is a simplified form of get_inode() for the case where
      * the inode pointer is already known.
         return;
     rip->i_count++;
+}
+/**
+ * }
+ */

Subversion Repositories HelenOS

(root)/branches/fs/uspace/fs/inode.c – Rev 2404 → 2435