守护进程接收终端输入的一种变通性方法

说明

本文主要介绍某嵌入式产品中DSL用户态驱动模块作为守护进程时，如何接收终端输入的变通性方法。

出于信息安全考虑，文中涉及系统方面的接口函数未给出实现细节，但不影响表述的完整性。

相关性文章参见《GNU Readline库函数的应用示例》。

一 背景知识

init进程(如Busybox init)是嵌入式系统内核自举时启动的第一个也是惟一的用户进程。init进程是后续所有其他进程的父进程(其进程ID为1)，在系统运行期间以守护进程的形式一直存在。它主要负责启动各运行层次特定的系统服务(如执行某些脚本、启动shell及运行用户指定的程序等)，这些服务通常在其拥有的守护进程的帮助下实现。

Busybox init程序对应的代码在init/init.c文件中，首先启动init_main函数，以设置信号的处理函数、初始化控制台以及解析inittab内容。

守护进程没有控制终端。因此编写守护进程时，通常关闭标准输入、标准输出和标准出错等文件描述符(若不关闭会浪费系统资源，造成进程所在文件系统无法卸载甚至引起无法预料的错误)。这样，守护进程不再持有从其父进程继承而来的文件描述符，任何一个试图读标准输入、写标准输出和标准出错的库例程将不会产生任何效果。因为守护进程并不与终端设备相关联，所以不能在终端设备上显示其输出，也无处从交互式用户那里接收输入。

但某产品中因调试排障需要，未关闭标准输出描述符。事实上，该产品中所有进程均作为pc守护进程的子进程启动，但启动时并未执行关闭文件描述符的步骤，而是在Busybox的init_main函数关闭标准输入和标准出错。虽然守护进程已脱离控制终端，但仍可使用从父进程继承的文件描述符来输出到“原”终端。

此外，嵌入式系统中守护进程通常启动后一直运行直至系统关机，而不受用户输入的影响。若不关闭标准输入，虽然各守护进程可以不处理这些输入，或按需选择性地处理，但当多个进程试图读取标准输入时将引起混乱。

二 需求提出

BCM厂家SDK为该产品DSL驱动模块提供了丰富的配置、查询及调测命令集，入口函数为dispatchingTask。该函数行为类似多级Shell，内部通过BCM_GETLINE宏(循环+getchar实现)等待和捕获用户输入。其模型可简化为：

dispatchingTask
 {
while getchar
若输入 == "doSomething"
do something
若输入 == "-4"
break
}

DSL驱动模块作为守护进程没有控制终端，无法通过getchar捕获终端输入。因此，必须创建一个普通的前台进程，由该进程捕获终端输入并转发给DSL驱动。但这种消息驱动的异步方式无法实现BCM_GETLINE的“同步等待”特性，还需开辟一块读写缓存。

具体实现如下图所示：



前台进程dsltst捕获用户在终端输入的命令行，并转发给DslDriver(DSL驱动)进程下的dsldbg线程。dsldbg线程若接收到BcmShell启动命令行(“StartShell”)，则向dsldrv线程发送Shell启动消息；否则将命令行输入进行缓存。dsldrv线程启动BcmShell后将“轮询”该缓存，若缓存非空则读取其中的命令行并做相应处理。

注意，同一进程下线程间的消息收发通过读写一个由指向消息体数据的指针组成的循环缓冲区实现，并非传统意义上的进程间消息队列。

基于命令行交互模式的考虑，无需使用互斥机制保护缓存：

1) 每次执行单条输入并输出，等待下条输入；

2) 本次输入(写)必须等待上次输入被执行(读)并输出。

三 代码实现

为描述清晰，本节将按照代码文件组织各小节内容。

3.1 Readline.c/h

Readline.c/h为基本的命令行输入函数集。考虑到终端设备可能不支持GNU Readline库，本函数集可在需要时用来替代库的行为。

首先定义一组私有函数，如下：

/******************************************************************************
* 函数名称:  TerminateStr
* 功能说明:  对给定字符数组添加结束符
******************************************************************************/
static VOID TerminateStr(CHAR *pszStr, INT32U dwCharsNum)
{
if(0 == dwCharsNum)
return;
pszStr[dwCharsNum-1] = '\0';
}

/******************************************************************************
* 函数名称:  FlushStdin
* 功能说明:  清空标准输入缓冲区
******************************************************************************/
static VOID FlushStdin(VOID)
{
INT32S cChar = 0;
while((cChar = getchar()) != '\n' && cChar != EOF);
}

/******************************************************************************
* 函数名称:  GetChars
* 功能说明:  命令行输入函数
* 输入参数:  CHAR *pszBuf     :字符缓冲区
*           INT32U dwBufSize :字符缓冲区字节大小
* 输出参数:  NA
* 返回值  :  若缓冲区空间不足，则返回-2，以指示需要扩展缓冲区或终止输入；
*           若函数出错且尚未输入，则返回-1；
*           否则返回当前调用所输入的字符数('\n'被替换为'\0'并计入字符数)
* 注意事项:  Linux下该函数不支持退格键(BackSpace)消字符，请使用删除键(Delete)
******************************************************************************/
#define LINUX_BS_KEY     (CHAR)0x08  //Unix/Linux系统BackSpace键ASCII值
static INT32S GetChars(CHAR *pszBuf, INT32U dwBufSize)
{
INT32U dwIdx = 0;
INT32S dwChar = 0;
for(; dwIdx<dwBufSize && (dwChar=getchar())!=EOF && dwChar!='\n'; dwIdx++)
{
if(LINUX_BS_KEY == dwChar)
{
printf("Try again from scratch, use 'Delete' key to BackSpace!\n");
FlushStdin();
return dwChar;
}
pszBuf[dwIdx] = dwChar;
}

if(dwIdx==0 && dwChar==EOF)
return -1;

if(dwIdx==dwBufSize && dwChar!=EOF && dwChar!='\n')
return -2;

if(dwChar == '\n')
pszBuf[dwIdx] = '\0';

return (++dwIdx);
}

TerminateStr()函数给字符串添加结束符，其封装性可有可无。FlushStdin()函数清空标准输入缓冲区中残留的字符。此处未采用fflush(stdin)的方式，因为C标准中fflush()函数仅针对输出流或更新流(output or update stream)。

GetChars()函数为核心的命令行输入函数，ReadLine()函数内将分配动态内存并调用该函数对外提供命令行输入功能：

/******************************************************************************
* 函数名称:  ReadLine
* 功能说明:  命令行输入函数
* 输入参数:  CHAR *pszPrompt: 命令行提示符，若无则置空字符串("")
* 输出参数:  NA
* 返回值  :  CHAR *已输入的命令行字符串或NULL(表示函数出错)
******************************************************************************/
CHAR *ReadLine(const CHAR *pszPrompt)
{
CHECK_SINGLE_POINTER(pszPrompt, NULL);

printf("%s", pszPrompt);

CHAR *pszLineRead = NULL;
INT32U dwCurAllocSize = ALLOC_BYTES_INIT_TRY;
INT32U dwEstReadCharNum = 0;
INT32S dwCharSize = 0;
while(1)
{
CHAR *pszReallocBuf = realloc(pszLineRead, dwCurAllocSize);
if(NULL == pszReallocBuf)
{
printf("[%s(%d)] reallocs %uBytes failed, no memory available!\n",
FUNC_NAME, __LINE__, dwCurAllocSize);
goto ReadLineError;
}
pszLineRead = pszReallocBuf; //Avoid memory leakage when realloc fails.
dwCharSize = GetChars(pszLineRead+dwEstReadCharNum, dwCurAllocSize-dwEstReadCharNum);
dwEstReadCharNum = dwCurAllocSize;
if(-2 != dwCharSize)
return pszLineRead;

INCREMENT_ALLOC_BYTES(dwCurAllocSize);
if(dwCurAllocSize >= ALLOC_BYTES_MAX_TRY)
{
printf("\nOver %uBytes Memory's Required, There must be something WRONG!\n", dwCurAllocSize);
goto ReadLineError;
}
}

ReadLineError:
FlushStdin();
TerminateStr(pszLineRead, dwEstReadCharNum);
return pszLineRead;
}

ReadLine()函数内会为命令行缓冲区分配内存，故调用者无需再分配缓存。也正因为如此，ReadLine()函数必须考虑内存裕量问题，即必要时扩展内存以确保足够容纳终端输入的命令行。

因本文所涉产品不支持-lreadline、-lhistory甚至-lncurses库，故AddHistory实现为空函数：

/******************************************************************************
* 函数名称:  AddHistory
* 功能说明:  将命令添加到历史记录，以支持上下键调出历史命令
* 输入参数:  CHAR *pszCmd :待添加的命令
* 输出参数:  NA
* 返回值  :  VOID
******************************************************************************/
VOID AddHistory(CHAR *pszCmd)
{
/* Remains to be implemented! */
}

终端输入结束后，需调用CloseLine()函数释放ReadLine()函数分配的动态内存：

/******************************************************************************
* 函数名称:  CloseLine
* 功能说明:  关闭命令行输入
* 输入参数:  CHAR *pszLine :命令行输入字符串指针
* 输出参数:  NA
* 返回值  :  VOID
******************************************************************************/
VOID CloseLine(CHAR *pszLine)
{
if(!pszLine)
return;

free(pszLine);
}

为支持用户自定义ReadLine()函数的内存扩展方式，ReadLine.h头文件内定义如下宏：

#ifndef ALLOC_BYTES_INIT_TRY
#define ALLOC_BYTES_INIT_TRY    32    //初次尝试分配的内存字节数
#endif
#ifndef ALLOC_BYTES_MAX_TRY
#define ALLOC_BYTES_MAX_TRY     1024  //累计尝试分配的最大内存字节数
#endif
#ifndef INCREMENT_ALLOC_BYTES
#define INCREMENT_ALLOC_BYTES(dwCurAllocSize) do{ \
dwCurAllocSize <<= 1; \
}while(0)
#endif

用户可在包含ReadLine.h头文件之前，重定义ALLOC_BYTES_INIT_TRY等宏。

3.2 Dsl_Readline.c/h

Dsl_Readline.c/h为DSL模块命令行输入函数集。

首先，根据GNU Readline库的支持情况，做如下条件编译控制：

#ifdef READLINE_DEBUG
#include <readline/readline.h>
#include <readline/history.h>
#define READ_LINE     readline
#define ADD_HISTORY   add_history
#define CLR_LINE      free
#else
#include "Readline.h"
#define READ_LINE     ReadLine
#define ADD_HISTORY   AddHistory
#define CLR_LINE      CloseLine
#endif

然后，定义两个字符串指针：

static CHAR *pszLineRead = NULL;  //命令行输入字符串
static CHAR *pszStripLine = NULL;  //剔除首尾空白字符的输入字符串

ReadCmdLine()函数通过READ_LINE宏读取终端输入的命令行后，调用StripWhite()函数剔除命令行字符串首尾的空白字符(主要是空格符)。若剔除后的字符串非空且非空串，则通过ADD_HISTORY宏将该串存入历史记录。

/******************************************************************************
* 函数名称:  ReadCmdLine
* 功能说明:  命令行输入函数
* 输入参数:  CHAR *pszPrompt: 命令行提示符，若无则置空字符串("")
* 输出参数:  NA
* 返回值  :  CHAR *已输入且剔除首尾空白字符的命令行字符串
******************************************************************************/
CHAR *ReadCmdLine(const CHAR *pszPrompt)
{
CLR_LINE(pszLineRead);
pszLineRead = READ_LINE(pszPrompt);

pszStripLine = StripWhite(pszLineRead);
if(pszStripLine && *pszStripLine)
ADD_HISTORY(pszStripLine);

return pszStripLine;
}

StripWhite()函数沿用《GNU Readline库函数的应用示例》一文的实现。

结束命令行输入时，必须调用QuitCmdLine()函数退出输入。该函数会做一些必要的清理工作。

/******************************************************************************
* 函数名称:  QuitCmdLine
* 功能说明:  命令行退出函数
* 输入参数:  NA
* 输出参数:  NA
* 返回值  :  VOID
* 注意事项:  结束命令行输入时必须调用该函数！
******************************************************************************/
VOID QuitCmdLine(VOID)
{
CLR_LINE(pszLineRead);
pszLineRead = NULL;
}

3.3 Dsl_Test.c

Dsl_Test.c为DSL模块的测试函数，也是dsltst进程的入口所在。

该文件内仅有一个main()函数，实现如下：

INT32S main(INT32S argc, CHAR *argv[])
{
INT32S retCode = 0;
retCode = InitAppComm((DSL_DRV_APP>>4), 0);
if(retCode != OSS_OK)
{
printf("Dsl Test[InitAppComm] failed, retCode=%d!\n", retCode);
goto ErrorHandle;
}

CHAR *pszCmdLine = "StartShell";
retCode = asend(DSL_DBG_SH_CMD, pszCmdLine, strlen(pszCmdLine)+1, DSL_DBG_PROC_PID);
if(retCode != OSS_OK)
{
printf("Dsl Test[asend](%s) failed, retCode=%d!\n", pszCmdLine, retCode);
goto ErrorHandle;
}

while(1)
{
pszCmdLine = ReadCmdLine("");
retCode = asend(DSL_DBG_SH_CMD, pszCmdLine, strlen(pszCmdLine)+1, DSL_DBG_PROC_PID);
if(retCode != OSS_OK)
{
printf("Dsl Test[asend](%s) failed, retCode=%d!\n", pszCmdLine, retCode);
goto ErrorHandle;
}
if(!strcmp(pszCmdLine, "-4"))
{
QuitCmdLine();
goto ErrorHandle;
}
}

ErrorHandle:
FreeAppComm();
return retCode;
}

其中，InitAppComm()函数初始化套接字通讯接口。asend()调用表示通过套接字发送DSL_DBG_SH_CMD异步消息到dsldbg线程(隶属DslDriver进程)，消息体内容为终端命令行输入(pszCmdLine)。

为便于展示输入效果，将main()函数改为如下实现：

INT32S main(INT32S argc, CHAR *argv[])
{
CHAR *pszCmdLine = NULL;
while(1)
{
pszCmdLine = ReadCmdLine(">>");
printf("pszCmdLine = %s!\n", pszCmdLine);

if(!strcmp(pszCmdLine, "-4"))
{
QuitCmdLine();
break;
}
}

printf("Quit!\n");
return 0;
}

编译后执行结果如下：

[wangxiaoyuan_@localhost ReadLine]$ ./Dsl_Test
>>hello
pszCmdLine = hello!
>>world
pszCmdLine = world!
>>i'm
pszCmdLine = i'm!
>>clover!
pszCmdLine = clover!!
>>-4
pszCmdLine = -4!
Quit!

3.4 Dsl_GetLine.c/h

Dsl_GetLine.c/h为DslDriver进程内读取终端命令行输入并缓存的实现。

根据前文所述的缓存机制，dsldbg线程接收到BcmShell启动命令行(“StartShell”)后，向dsldrv线程发送Shell启动消息，并缓存之后的命令行输入。dsldrv线程收到启动消息后调用dispatchingTask()函数“轮询”该缓存，若缓存非空则读取其中的命令行并做相应处理。

首先定义一组私有函数，如下：

/******************************************************************************
* 函数名称:  DslClearShCmd
* 功能说明:  清除缓存的命令行输入
******************************************************************************/
static VOID DslClearShCmd(VOID)
{
gIsShCmdCached = DSL_FALSE; //必须先设置有效标记后清除缓存
memset(gCachedShCmd, 0, sizeof(gCachedShCmd));
}

/******************************************************************************
* 函数名称:  DslReadShCmd
* 功能说明:  读取缓存的命令行输入
* 输入参数:  VOID
* 输出参数:  NA
* 返回值  :  成功: 已缓存的命令行输入；失败: NULL
******************************************************************************/
static CHAR *DslReadShCmd(VOID)
{
if(!gIsShCmdCached)
return NULL;

gIsShCmdCached = DSL_FALSE;
return gCachedShCmd;
}

注意，清除或读取缓存时必须先设置gIsShCmdCached标记，以保证多线程环境下全局缓存的访问安全性(本线程读取时先向其他线程宣告该缓存已不可读)。

dsldbg线程接收到dsltst进程发来的消息后，调用DslDebugShCmd()函数解析和缓存命令行输入：

/******************************************************************************
* 函数名称:  DslDebugShCmd
* 功能说明:  dsldbg线程接收命令行输入并处理
* 输入参数:  VOID *lpMsg :线程当前消息内容指针
* 输出参数:  NA
* 返回值  :  VOID
******************************************************************************/
VOID DslDebugShCmd(VOID *pvMsg)
{
CHECK_SINGLE_POINTER(pvMsg, RET_VOID);
CHAR *pszShCmd = (CHAR *)pvMsg;

if(!strcmp(pszShCmd, "StartShell"))
{   //若为BcmShell启动命令(StartShell)，则向dsldrv线程发送Shell启动消息
DslClearShCmd();
DslAsynSendDrv(DSL_SH_START_MSG, NULL, 0);
return;
}

memset(gCachedShCmd, 0, sizeof(gCachedShCmd));
strncpy(gCachedShCmd, pszShCmd, sizeof(gCachedShCmd)-1);
gCachedShCmd[sizeof(gCachedShCmd)-1] = '\0';
gIsShCmdCached = DSL_TRUE; //必须先缓存命令后设置有效标记
}

当终端输入异常终止时，如在多级提示符下直接输入-4导致dsltst提前退出，缓存内将没有命令可读。为避免dsldrv线程陷入死循环，需要增加超时自动退出轮询的机制。

超时机制相关的几个宏定义如下：

#define READ_LINE_TIMEOUT_MS      1000*120 //该超时时长内未等到命令行输入则启动退出机制
#define READ_LINE_STEP_MS         1000     //计时步长
#define READ_LINE_TRY_TIMES       (READ_LINE_TIMEOUT_MS/READ_LINE_STEP_MS)
#define READ_EXIT_TRY_TIMES       3        //该宏值不应小于BcmShell的提示符级数(如>、api>计两级)

基于该超时机制的命令行输入读取函数如下：

/******************************************************************************
* 函数名称:  DslGetLine
* 功能说明:  dsldrv线程内BcmShell读取命令行输入
* 输入参数:  CHAR *pszShCmd   :命令行缓冲区
*           INT32U dwCmdSize :命令行缓冲区大小(字节)
* 输出参数:  NA
* 返回值  :  INT32U 命令行字符串长度
******************************************************************************/
INT32U DslGetLine(CHAR *pszShCmd, INT32U dwCmdSize)
{
INT32U dwTryIdx = 0;
static INT32U dwExitTryCnt = 0;

for(; dwTryIdx < READ_LINE_TRY_TIMES; dwTryIdx++)
{
char *pszCmd = DslReadShCmd();
if(pszCmd != NULL)
{
dwExitTryCnt = 0;
strncpy(pszShCmd, pszCmd, dwCmdSize-1);
pszShCmd[dwCmdSize-1] = '\0';
return strlen(pszShCmd);
}
DslUsleep(READ_LINE_STEP_MS*1000);
}

//当与dsltst通讯异常时，此处可确保dispatchingTask函数安全退出
dwExitTryCnt++;
if(READ_EXIT_TRY_TIMES != dwExitTryCnt)
strcpy(pszShCmd, "exit");
else
strcpy(pszShCmd, "-4");
return strlen(pszShCmd);
}

3.5 其他

BCM厂家SDK相关头文件内对BCM_GETLINE宏定义如下：

#ifndef BCM_GETLINE
#define BCM_GETLINE  getLine
int getLine(char *s, int lim);
#endif

可见，在包含该头文件之前，重新定义BCM_GETLINE宏值为DslGetLine即可：

#define BCM_GETLINE  DslGetLine

四 效果验证

该缓存机制可精确模拟原SDK中BCM_GETLINE的同步等待特征。其操作示例如下：

root@FXXX:~ # dsltst

Enter line number to process (-1: all, -2: shutdown, -3: cli, -4: exit): -3

calling t&d module
Entering interactive trace and debug session
> api

api> configline downSlowMinDataRate 128
Configuration modified

api> exit
> ext
Unknown command: ext

> exitt(多输't'后退格)
Try again from scratch, use 'Delete' key to BackSpace!
Unknown command: exittgline downSlowMinDataRate 1

> exit

Enter line number to process (-1: all, -2: shutdown, -3: cli, -4: exit): -4
root@FXXX:~ #
Now Quit the Dsl Shell!

dsltst命令不支持超时退出机制(需要另起线程)，故操作结束后必须输入-4退出。