简单虚拟文件系统的设计与实现
-----云风Windsoul源码剖析
虚拟文件系统(VFS)是由Sunmicrosystems公司在定义网络文件系统(NFS)时创造的。它是物理文件系统与服务之间的一个接口层,是对整个操作系统每个文件系统的抽象,因此,严格的说,它并不是具体的文件系统。它存在于内存中,不存在任何外存空间。
无意中阅读到云风在github上的Windsoul源码,感受到了高手代码的扎实,也体会到了思考后的设计之美。虽然早前Linux已实现了VFS,但对于初学者来说过于复杂且需要丰富的阅读Linux源码的经验,每每想到剖析某文件系统的痛苦,内心总有些许气馁。通常情况下,阅读代码往往比写代码来得困难得多。因此,培养良好的阅读兴趣,懂得欣赏他人优秀的设计艺术显得尤为重要了。
一、初始化
阅读代码的关键在于确定在何处开始阅读。大部分时间内我们选择从代码的初始化开始。
虚拟文件系统虽然不同于具体文件系统,但基本原理是一致的,包括初始化。对于一个文件系统,要想使用它,必须得先知道它的根目录。Windsoul是通过VfsInit函数进行初始化的。如下
Int VfsInit(void)
{
vfsMount(“_”,”native”,”.”);
}
函数vfsMount的主要流程是首先取得”.”的绝对路径,然后为nativefs结构体变量fs分配内存,fs->sz的值为该路径的字符串大小,fs->root存储该路径。好,我们先放下源码仔细思考一下,既然我们保存了某个路径的信息,我们该如何操作它呢?答案是多种的,可读、可写、可定位等等。如果将这些信息进行汇编,就可以得到一个文件系统的基本数据结构。云风是这么定义的:
struct filesystem {
void * fs;
int (*list)(void *fs,const char *name, atom *buffer, int sz);
int (*chsize)(void *fs,const char *name, size_t sz);
int (*create)(void*fs,const char *name, char mode);
size_t (*size)(void *fs, const char *name);
int (*read)(void *fs ,const char *name, size_t pos, void *buffer, int sz);
int (*write)(void *fs , const char *name,size_t pos, const void *buffer, int sz);
};
其中fs指向的是刚才填充的nativefs类型变量fs。
vfsMount函数会将struct filesystem * fs进行填充:
fs = memoryPermanent(sizeof(*fs));
memset(fs,0,sizeof(*fs));
fs->fs = f;
fs->list = nativefsList;
fs->create = nativefsCreate;
fs->read = nativefsRead;
接着,会调用void pathMount(const char * root, struct filesystem *fs)函数,将刚才的fs作为实参传进去。这个函数将实现文件的挂载。
我们现在看看他是怎样实现的。首先,他维护了一个struct map *g_fs全局变量:
struct map {
int freenode;
int size;
struct node* buffer;
};
Freenode指向可用的文件节点首地址,size表示,buffer则指向了一片空间,该空间存储着各个文件节点。而这些节点的数据结构是:
struct node {
struct value *value;
struct key *key;
struct node *next;
};
通过这个结构体可知,各个文件节点形成了一个单链表。Key存储的是路径的哈希值,value指向的是该文件节点的struct filesystem类型的文件句柄。
因此,pathMount函数的实现如下:
voidpathMount(const char * root, struct filesystem *fs)
{
struct map_op op;
op.op = MAP_INSERT;
op.key.p = atomString(root);
op.value = fs;
void * old = mapSearch(g_fs,&op);
if (old!=NULL) {
logFatal("%s is alreadymounted.",atomToString(op.key.p));
}
}
函数mapSearch是将文件句柄插入到buffer指向的哈希表中。原理图如下:
二、vfsOpen函数操作
既然我们已经得到了一个系统初始化的结构体,那么操作就变得简单了。这里只是拿vfsOpen函数作示范,其他操作类似,不在赘述。
假设我们要在当前目录下新建一个文件“a/b.dat”,那么我们该怎么做呢?当然我们先得到b.dat文件名,其次是得到目录a。Windsoul维护了两个哈希表,一个为上图所示,一个为存储目录的哈希表,下图所示:
文件夹a首先跟struct hash_string中的str值进行比较,也就是跟最近使用的目录比较。如果相等,则返回该哈希表项;如果不成功,则将a填充到str里,作为当前使用的目录。最后,将a重新进行一次哈希,在全局变量g_fs维护的哈希表中找到其所对应的struct filesystem fs句柄,最后进行具体的文件操作。
struct file {
struct filesystem *fs;
const char * name;
size_t size;
size_t pos;
int mode;
};
struct file *vfsOpen(atom pathname, const char * m)
{
const char *name=NULL;
struct filesystem * fs = pathGet(pathname,&name);
if (fs == NULL)
return NULL;
int mode = 0;
if (strchr(m,'r')) {
mode |= MODE_READ;
if (fs->read == NULL)
return NULL;
}
if (strchr(m,'w')) {
mode |= MODE_WRITE;
if (fs->write == NULL)
return NULL;
}
if (mode & (MODE_WRITE|MODE_READ)) {
if(!fs->create(fs->fs,name,'q')) {
if(!fs->create(fs->fs,name,'c')) {
return NULL;
}
}
} else if (mode & MODE_WRITE) {
if(!fs->create(fs->fs,name,'c')) {
return NULL;
}
} else if (mode & MODE_READ) {
if(!fs->create(fs->fs,name,'q')) {
return NULL;
}
} else {
return NULL;
}
size_t sz = fs->size(fs->fs,name);
if (sz == NONE_EXIST) {
return NULL;
}
struct file *f = memoryAlloc(sizeof(structfile));
f->fs = fs;
f->name = name;
f->size = sz;
f->pos = 0;
f->mode = mode;
return f;
}
关键操作是pathGet函数。它的功能就是实现在g_map中修改其当前目录,并在g_fs找到struct filesystem类型的文件句柄,最后产生一个文件。
三、其他
Windsoul的其他操作无非是修改g_map所对应的当前目录字符,这里就不一一阐述了,而整个文件系统是对读写文件的一次包装,这样有利于安装我们常人的思维操作文件,这个概念跟内存管理(如内存池)是一致的。
如果在细细回味这些代码,你会发现一些具体力道的设计。当然这些设计是有根据的,比如整个项目中都穿插这原子(Atom)的概念,其实这里是引自《C语言接口与设计》的某些内容。这里给我们的启示是平时多阅读代码,起码多阅读一些书籍,并且学以致用,有自己的思考,只有这样才能达到高手的境界。