Lustre可靠性增强系统MTFS：第6篇 编程风格

遵循约定总会使得多人协作的成本降低，对于软件开发来说也是这样。

6.1 编程风格

MTFS的编程风格基本与内核的风格基本保持一致。可以用indent命令查看是否有较大出入。一段代码如下所示：

int mtfs_setxattr(struct dentry *dentry, const char *name,const void *value, size_t size, int flags)
{
	int ret = 0;
	int undo_ret = 0;
	mtfs_bindex_t bindex = 0;
	HENTRY();
  
	HASSERT(mtfs_d2bnum(dentry));
	for (bindex = 0; bindex < mtfs_d2bnum(dentry); bindex++) {
		ret = mtfs_setxattr_branch(dentry, name, value, size, flags, bindex);
		if (ret) {
			bindex --;
			goto undo;
		}
	}
	goto out;
undo:
	for (; bindex >= 0; bindex--) {
		undo_ret = mtfs_undo_setxattr_branch(dentry, name, bindex);
		if (undo_ret) {
			report_undo_error();
		}
	}
out:
	HRETURN(ret);
}

以上述代码为例，需要注意：

1. 在重要函数的起始处加上HENTRY，结尾处用HRETURN或_HRETURN返回。这样可以通过内核日志机制跟踪函数调用过程。

2. 整个函数按流程顺序往下，如果出现意外，使用goto语句跳出，所做前面工作撤销或直接返回错误。虽然goto语句遭到了很多质疑，但是在系统软件中goto语句因其来得直接，仍不乏用武之地。例如在下面的情况下使用goto语句十分方便：函数依次地申请内存空间，如果某次申请失败，则goto到指定位置，逆序将所申请的内存释放。使用这种函数的流程控制方法的另一个好处，是使得函数只有一个HRETURN的返回点，流程清晰。

3. 多用HASSERT进行断言。断言好处多多，应当大加提倡，所以D语言之间将对断言的支持作为契约编程的一部分，加入到语言中。对输入参数进行断言，可以及早杜绝不规范参数的输入。对计算结果进行断言，可以及时发现程序BUG。更重要的是，它可以发现知识：在对系统理解的不全面时、不确定时，对重要的假设和判断进行断言，可以帮助验证这些理解的正确性。断言是意外情况的杀手，而意料之外则是BUG之源。健壮的源码总会有很大篇幅在处理常规情况之外的意外。

6.2 函数返回值

函数如果专用来申请内存，则函数名通常包含alloc。如果该函数申请内存失败，则返回NULL，否则返回指针。

如果函数不仅需要申请内存，还需要进行创建对象等初始化操作，则函数名通常包含new。申请内存失败，应返回 PTR_ERR(-ENOMEM)，初始化失败应返回PTR_ERR(-errno)，否则返回指针。

错误值参考posix对各错误值的含义定义，另外还要遵循一些约定。

本文章欢迎转载，请保留原始博客链接http://blog.youkuaiyun.com/fsdev/article