郭洪锋 (
[email protected])
2001 年 10 月
我们在编写Linux运行库时，特别是作为组件提交给其他程序员使用时，很有必要提供返回消息以提高组件在开发过程中的可用性。本文将为您讲述一些实用的技巧。
在编写C/C++应用时，我们非常熟悉系统调用中的返回消息的处理。在返回消息中，包含了两类信息，一个是返回信息代码，指明返回的是何类信息；另一个返回的是信息的文字说明，指明调用是否成功。这两类信息均有各自的作用，不能相互代替。比如调用加载内存的系统调用，如果该内存已经加载，该调用可能返回错误，但是程序可能还会继续正确运行，如果需要中止程序，则需要了解程序中止的具体原因，这时仅靠返回消息标识是不够的，返回信息文字说明则立刻让用户知道错误原因。我们在编写Linux运行库时，特别是作为组件提交给其他程序员使用时，很有必要提供类似的返回消息，以提高组件在开发过程中的可用性。
1. 利用标准C库中的返回消息
在自己组件中的方法或过程中，如果消息比较一般，可以直接利用标准C库中的返回消息。标准C库中的返回消息代码定义列在头文件errno.h中，返回消息是用从0开始的一个整数值表示的，其中0为正确的返回值，其他为警告类型或错误类型的返回值。在标准C库中，用了一个全局变量errno来指明当前调用的返回消息值。在组件的方法或过程中，可以直接设置errno的值，当然要符合errno.h中的类型定义。在调用组件中的方法或过程时，可以直接调用C中的函数perror()或strerrno()来提交返回消息的文字说明。
2. 实现自定义的返回消息
一般情况下，标准C中的消息不足以反映自己组件中的方法或过程运行状态的。这时需要实现自己特有的返回消息。主要步骤如下：
第一，规定返回消息代码。
组件中方法或过程的运行状态中有一部分要作为返回值，这些返回值要反映多种复杂的运行状态，有成功返回值、一般运行消息值、警告值、一般错误值、严重错误值等。返回消息代码要直接反映这些状态。另外，返回值中还需要反映该方法或过程位于那个组件中。我们可以用一个整数值的头两位标识返回类型，其中成功返回值、一般运行消息值用正数，可以分别标识为0X10000000,0X20000000。警告值、一般错误值、严重错误值用负数值，可以分别标识为0X80000000,0X90000000，0XA0000000。而组件可以用第二个字节标识，如事务安全组件用11标识，则可以用0X000B00000标识。返回消息的具体代码则可以沿用标准C库中的表示方法，如正确返回值用0标识，某一严重错误错误用5表示。则对于事务安全组件，这两种消息可以标识为0X100B0000和0XA00B0005。
第二，表述返回消息的文字说明
表述返回消息的文字说明列在组件里的一个字符串数组中，各个消息的文字说明在数组中的位置按照消息的具体代码值决定。
例如事务安全组件中定义如下四个返回消息：0，成功返回值；1，事务定义错误；2，事务提交错误；3，事务返回错误。可以在定义如下字符串数组：
char *ReturnMessage_11[] =
{
""成功返回"",
""事务定义错误"",
""事务提交错误"",
""事务返回错误"",
(char *)0
};
};
对应的返回消息代码分别为：0X100B0000，0X900B0001，0X900B0002，0X900B0003。
第三，注册组件返回消息
在利用组件开发应用时，首先在组件的构造函数或初始化函数中注册组件返回消息，这一步是隐藏在组件内部。对于外部应用提供了一个全局的指向组件返回消息字符串数组的指针msg_ptr。注册代码如下：
void *handle;
char *messageShow;
// 加载该组件的动态库
handle = dlopen(NULL, RTLD_LAZY);
// 获得组件的标识
sprintf(messageShow,""ReturnMessage_%d"", ComponentIdx);
// 取得组件返回消息字符串数组指针
msg_ptr[ComponentIdx] = dlsym(handle, messageShow);
第四，获取组件返回消息的文字说明
在注册组件返回消息后，在应用调用组件中的方法或过程时，一般情况下，可以直接从返回代码中判断返回的消息内容。也可以调用组件中的StrError(int rts)方法获取组件返回消息的文字说明。
该方法的代码如下：
int ErrnoIdx;
int CompomentIdx;
// 获得返回消息的具体代码
ErrnoIdx = rts & 0xFFFF;
// 获得组件的标识
CompomentIdx = (rts & 00FF0000) >> 16 ;
// 返回组件返回消息的文字说明
return msg_ptr[CompomentIdx][ErrnoIdx] ;
利用如上的技巧，可以使得我们发布的Linux包在使用时具有较好的可用性。
关于作者
郭洪锋，在烟台东方电子信息产业集团公司中心所工作，一直从事分布式系统的开发和研究。