Code with comments

fs/hmfs/Makefile

@@ -0,0 +1,20 @@
+ccflags-y += -DCONFIG_HMFS_DEBUG
+ccflags-y += -DCONFIG_HMFS_DEBUG_GC
+ccflags-y += -DCONFIG_HMFS_XATTR
+#ccflags-y += -DCONFIG_HMFS_FAST_READ
+ccflags-y += -DCONFIG_HMFS_ACL
+ccflags-y += -DCONFIG_HMFS_DEBUG_RW_LOCK
+
+obj-m += hmfs.o
+
+hmfs-objs := super.o node.o inode.o checkpoint.o file.o data.o namei.o segment.o hash.o dir.o symlink.o gc.o recovery.o
+
+hmfs-objs += debug.o
+hmfs-objs += xattr.o
+hmfs-objs += util.o
+hmfs-objs += acl.o
+
+all:
+	make -C /lib/modules/`uname -r`/build M=`pwd` modules
+clean:
+	make -C /lib/modules/`uname -r`/build M=`pwd` clean

fs/hmfs/acl.c

@@ -19,7 +19,10 @@
 #include "hmfs.h"
 #include "xattr.h"
 #include "acl.h"
-
+/**
+ * @param[in] count 字节数
+ * @return 返回count个acl_entry对应的字节数
+ */
 static inline size_t hmfs_acl_size(int count)
 {
 	if (count <= 4) {
@@ -29,7 +32,10 @@ static inline size_t hmfs_acl_size(int count)
 					(count - 4) * ACL_ENTRY_SIZE;
 	}
 }
-
+/**
+ * @param[in] size entry数
+ * @return 返回size个字节对应的访问控制表entry数
+ */
 static inline int hmfs_acl_count(size_t size)
 {
 	ssize_t s;
@@ -46,7 +52,11 @@ static inline int hmfs_acl_count(size_t size)
 		return s / ACL_ENTRY_SIZE + 4;
 	}
 }
-
+/**
+ * 获取文件访问控制表的地址
+ * @param[in] inode 为该文件inode
+ * @return 成功则返回访问控制表地址，否则返回NULL
+ */
 static void *get_acl_block(struct inode *inode)
 {
 	struct hmfs_sb_info *sbi = HMFS_I_SB(inode);
@@ -62,7 +72,12 @@ static void *get_acl_block(struct inode *inode)
 		return ADDR(sbi, acl_addr);
 	return NULL;
 }
-
+/**
+ * 读取访问控制表内容
+ * @param[in] base_addr 为要读取的ACL的起始地址
+ * @param[in] size 为要读取的字节数
+ * @return 返回值为指向存储了访问控制表内容的新建ACL表的指针
+ */
 static struct posix_acl *hmfs_read_acl(const char *base_addr, size_t size)
 {
 	int i, count;
@@ -117,7 +132,12 @@ static struct posix_acl *hmfs_read_acl(const char *base_addr, size_t size)
 	posix_acl_release(acl);
 	return ERR_PTR(-EINVAL);
 }
-
+/**
+ * 获取文件访问控制表内容
+ * @param[in] inode 为该文件inode
+ * @param[in] type 定义获取类型为ACL_TYPE_ACCESS或是ACL_TYPE_DEFAULT，从而读取不同的内容
+ * @return 成功时返回指向存储获取到内容的ACL表的指针
+ */
 struct posix_acl *hmfs_get_acl(struct inode *inode, int type)
 {
 	struct hmfs_acl_header *acl_header = NULL;
@@ -160,15 +180,27 @@ struct posix_acl *hmfs_get_acl(struct inode *inode, int type)
 
 	return acl;
 }
-
+/**
+ * 初始化@base_addr指向的acl块
+ * 修改其h_magic值为HMFS_X_BLOCK_TAG_ACL
+ * 修改a_version值为HMFS_ACL_VERSION
+ * @param[in] base_addr 指向acl块
+ */
 static void init_acl_block(void *base_addr) 
 {
 	struct hmfs_acl_header *acl_header = ACL_HEADER(base_addr);
 
 	XATTR_HDR(base_addr)->h_magic = cpu_to_le16(HMFS_X_BLOCK_TAG_ACL);
 	acl_header->a_version = cpu_to_le32(HMFS_ACL_VERSION);
 }	
-
+/**
+ * 写文件访问控制表
+ * @param[in] inode 为该文件的inode
+ * @param[in] acl 指向的结构体存储了要写入文件ACL的值
+ * @param[in] size 用于存储写入后的ACL大小
+ * @param[in] type 定义ACL类型为ACL_TYPE_ACCESS还是ACL_TYPE_DEFAULT
+ * @return 成功则返回写入的访问控制表地址
+ */
 static void *hmfs_write_acl(struct inode *inode, const struct posix_acl *acl,
 				size_t *size, int type)
 {
@@ -249,7 +281,13 @@ static void *hmfs_write_acl(struct inode *inode, const struct posix_acl *acl,
 fail:
 	return ERR_PTR(-EINVAL);
 }
-
+/**
+ * 设置文件访问控制表
+ * @param[in] inode 为该文件的inode
+ * @param[in] acl 指向的结构体存储了要写入文件ACL的值
+ * @param[in] type 定义ACL类型为ACL_TYPE_ACCESS还是ACL_TYPE_DEFAULT
+ * @return 成功则返回0
+ */
 int hmfs_set_acl(struct inode *inode, struct posix_acl *acl, int type)
 {
 	struct hmfs_inode_info *fi = HMFS_I(inode);
@@ -292,7 +330,12 @@ int hmfs_set_acl(struct inode *inode, struct posix_acl *acl, int type)
 	clear_inode_flag(fi, FI_ACL_MODE);
 	return error;
 }
-
+/**
+ * 复制访问控制表
+ * @param[in] acl 为要复制的访问控制表
+ * @param[in] flags 为复制时使用的gfp掩码
+ * @return 返回复制的访问控制表
+ */
 static struct posix_acl *hmfs_acl_clone(const struct posix_acl *acl,
 				gfp_t flags)
 {
@@ -308,7 +351,10 @@ static struct posix_acl *hmfs_acl_clone(const struct posix_acl *acl,
 	}
 	return clone;
 }
-
+/**
+ * 创建新节点时修改文件acl
+ * @return 成功则返回0
+ */
 static int hmfs_acl_create_masq(struct posix_acl *acl, umode_t *mode_p)
 {
 	struct posix_acl_entry *pa, *pe;
@@ -360,7 +406,14 @@ static int hmfs_acl_create_masq(struct posix_acl *acl, umode_t *mode_p)
 	*mode_p = (*mode_p & ~S_IRWXUGO) | mode;
 	return not_equiv;
 }
-
+/**
+ * 创建一个访问控制表
+ * @param[in] dir为参照的已有文件inode
+ * @param[in] mode对应文件类型
+ * @param[in] *default_acl指向dir文件的acl
+ * @param[in] *acl指向新建的文件acl
+ * @return 成功则返回0
+ */
 static int hmfs_acl_create(struct inode *dir, umode_t *mode,
 				struct posix_acl **default_acl, struct posix_acl **acl)
 {
@@ -407,7 +460,12 @@ static int hmfs_acl_create(struct inode *dir, umode_t *mode,
 	posix_acl_release(p);
 	return -ENOMEM;
 }
-
+/**
+ * 初始化访问控制表
+ * @param[in] inode 为需要初始化的文件inode
+ * @param[in] dir 为参照的文件inode
+ * @return 成功则返回0
+ */
 int hmfs_init_acl(struct inode *inode, struct inode *dir)
 {
 	struct posix_acl *default_acl = NULL, *acl = NULL;
@@ -430,7 +488,13 @@ int hmfs_init_acl(struct inode *inode, struct inode *dir)
 
 	return error;
 }
-
+/**
+ * 列出文件POSIX_ACL_XATTR_ACCESS属性值
+ * @param[in] dentry用于索引超级块
+ * @param[in] list用于存储字符串
+ * @param[in] list_size为list存储的最大空间
+ * @return 返回属性值的字节长度
+ */
 size_t hmfs_acl_access_xattr_list(struct dentry *dentry, char *list, 
 				size_t list_size, const char *name, size_t name_len, 
 				int type)
@@ -444,7 +508,13 @@ size_t hmfs_acl_access_xattr_list(struct dentry *dentry, char *list,
 		memcpy(list, POSIX_ACL_XATTR_ACCESS, size);
 	return size;
 }
-
+/**
+ * 列出文件POSIX_ACL_XATTR_DEFAULT属性值
+ * @param[in] dentry 用于索引超级块
+ * @param[in] list 用于存储字符串
+ * @param[in] list_size 为list存储的最大空间
+ * @return 返回属性值的字节长度
+ */
 size_t hmfs_acl_default_xattr_list(struct dentry *dentry, char *list,
 				size_t list_size, const char *name, size_t name_len,
 				int type)
@@ -458,7 +528,13 @@ size_t hmfs_acl_default_xattr_list(struct dentry *dentry, char *list,
 		memcpy(list, POSIX_ACL_XATTR_DEFAULT, size);
 	return size;
 }
-
+/**
+ * 获取文件acl扩展属性
+ * @param[in] dentry 为该文件目录项
+ * @param[in] buffer 为属性复制到的目标缓冲区地址
+ * @param[in] size 为目标缓冲区最大大小
+ * @return 成功则返回acl属性字节长度
+ */
 int hmfs_acl_xattr_get(struct dentry *dentry, const char *name, void *buffer,
 				size_t size, int type)
 {
@@ -483,7 +559,13 @@ int hmfs_acl_xattr_get(struct dentry *dentry, const char *name, void *buffer,
 
 	return error;
 }
-
+/**
+ * 设置文件acl扩展属性
+ * @param[in] dentry 为该文件目录项
+ * @param[in] value 为要设置的属性值
+ * @param[in] size 为要设置的属性值字节数
+ * @return 成功则返回0
+ */
 static int hmfs_acl_xattr_set(struct dentry *dentry, const char *name,
 				const void *value, size_t size, int flags, int type)
 {

fs/hmfs/build.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+if [ "$1" == "hmfs" ] 
+    then
+    insmod ./hmfs.ko 
+    sudo mount -t hmfs -o physaddr=0x4B000000,init=100M none ~/mount_hmfs/
+elif [ "$1" == "nohmfs" ] 
+    then
+    umount ~/mount_hmfs
+    rmmod hmfs
+fi