openharmony_kernel_liteos_a/shell/full/src/base/shmsg.c

463 lines
15 KiB
C

/*
* Copyright (c) 2013-2019 Huawei Technologies Co., Ltd. All rights reserved.
* Copyright (c) 2020-2021 Huawei Device Co., Ltd. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors may be used
* to endorse or promote products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "shmsg.h"
#include "shell_pri.h"
#include "shcmd.h"
#include "stdlib.h"
#include "stdio.h"
#include "unistd.h"
#include "securec.h"
#include "los_base.h"
#include "los_task.h"
#include "los_event.h"
#include "los_list.h"
#include "los_printf.h"
#ifdef LOSCFG_FS_VFS
#include "console.h"
#endif
CHAR *ShellGetInputBuf(ShellCB *shellCB)
{
CmdKeyLink *cmdkey = shellCB->cmdKeyLink;
CmdKeyLink *cmdNode = NULL;
(VOID)pthread_mutex_lock(&shellCB->keyMutex);
if ((cmdkey == NULL) || LOS_ListEmpty(&cmdkey->list)) {
(VOID)pthread_mutex_unlock(&shellCB->keyMutex);
return NULL;
}
cmdNode = LOS_DL_LIST_ENTRY(cmdkey->list.pstNext, CmdKeyLink, list);
LOS_ListDelete(&(cmdNode->list)); /* 'cmdNode' freed in history save process */
(VOID)pthread_mutex_unlock(&shellCB->keyMutex);
return cmdNode->cmdString;
}
STATIC VOID ShellSaveHistoryCmd(const CHAR *string, ShellCB *shellCB)
{
CmdKeyLink *cmdHistory = shellCB->cmdHistoryKeyLink;
CmdKeyLink *cmdkey = LOS_DL_LIST_ENTRY(string, CmdKeyLink, cmdString);
CmdKeyLink *cmdNxt = NULL;
if ((string == NULL) || (strlen(string) == 0)) {
return;
}
(VOID)pthread_mutex_lock(&shellCB->historyMutex);
if (cmdHistory->count != 0) {
cmdNxt = LOS_DL_LIST_ENTRY(cmdHistory->list.pstPrev, CmdKeyLink, list);
if (strcmp(string, cmdNxt->cmdString) == 0) {
(VOID)LOS_MemFree(m_aucSysMem0, (VOID *)cmdkey);
(VOID)pthread_mutex_unlock(&shellCB->historyMutex);
return;
}
}
if (cmdHistory->count == CMD_HISTORY_LEN) {
cmdNxt = LOS_DL_LIST_ENTRY(cmdHistory->list.pstNext, CmdKeyLink, list);
LOS_ListDelete(&(cmdNxt->list));
LOS_ListTailInsert(&(cmdHistory->list), &(cmdkey->list));
(VOID)LOS_MemFree(m_aucSysMem0, (VOID *)cmdNxt);
(VOID)pthread_mutex_unlock(&shellCB->historyMutex);
return;
}
LOS_ListTailInsert(&(cmdHistory->list), &(cmdkey->list));
cmdHistory->count++;
(VOID)pthread_mutex_unlock(&shellCB->historyMutex);
return;
}
STATIC VOID ShellNotify(ShellCB *shellCB)
{
(VOID)LOS_EventWrite(&shellCB->shellEvent, SHELL_CMD_PARSE_EVENT);
}
enum {
STAT_NORMAL_KEY,
STAT_ESC_KEY,
STAT_MULTI_KEY
};
STATIC INT32 ShellCmdLineCheckUDRL(const CHAR ch, ShellCB *shellCB)
{
INT32 ret = LOS_OK;
if (ch == 0x1b) { /* 0x1b: ESC */
shellCB->shellKeyType = STAT_ESC_KEY;
return ret;
} else if (ch == 0x5b) { /* 0x5b: first Key combination */
if (shellCB->shellKeyType == STAT_ESC_KEY) {
shellCB->shellKeyType = STAT_MULTI_KEY;
return ret;
}
} else if (ch == 0x41) { /* up */
if (shellCB->shellKeyType == STAT_MULTI_KEY) {
OsShellHistoryShow(CMD_KEY_UP, shellCB);
shellCB->shellKeyType = STAT_NORMAL_KEY;
return ret;
}
} else if (ch == 0x42) { /* down */
if (shellCB->shellKeyType == STAT_MULTI_KEY) {
shellCB->shellKeyType = STAT_NORMAL_KEY;
OsShellHistoryShow(CMD_KEY_DOWN, shellCB);
return ret;
}
} else if (ch == 0x43) { /* right */
if (shellCB->shellKeyType == STAT_MULTI_KEY) {
shellCB->shellKeyType = STAT_NORMAL_KEY;
return ret;
}
} else if (ch == 0x44) { /* left */
if (shellCB->shellKeyType == STAT_MULTI_KEY) {
shellCB->shellKeyType = STAT_NORMAL_KEY;
return ret;
}
}
return LOS_NOK;
}
LITE_OS_SEC_TEXT_MINOR VOID ShellCmdLineParse(CHAR c, pf_OUTPUT outputFunc, ShellCB *shellCB)
{
const CHAR ch = c;
INT32 ret;
if ((shellCB->shellBufOffset == 0) && (ch != '\n') && (ch != '\0')) {
(VOID)memset_s(shellCB->shellBuf, SHOW_MAX_LEN, 0, SHOW_MAX_LEN);
}
if ((ch == '\r') || (ch == '\n')) {
if (shellCB->shellBufOffset < (SHOW_MAX_LEN - 1)) {
shellCB->shellBuf[shellCB->shellBufOffset] = '\0';
}
shellCB->shellBufOffset = 0;
(VOID)pthread_mutex_lock(&shellCB->keyMutex);
OsShellCmdPush(shellCB->shellBuf, shellCB->cmdKeyLink);
(VOID)pthread_mutex_unlock(&shellCB->keyMutex);
ShellNotify(shellCB);
return;
} else if ((ch == '\b') || (ch == 0x7F)) { /* backspace or delete(0x7F) */
if ((shellCB->shellBufOffset > 0) && (shellCB->shellBufOffset < (SHOW_MAX_LEN - 1))) {
shellCB->shellBuf[shellCB->shellBufOffset - 1] = '\0';
shellCB->shellBufOffset--;
outputFunc("\b \b");
}
return;
} else if (ch == 0x09) { /* 0x09: tab */
if ((shellCB->shellBufOffset > 0) && (shellCB->shellBufOffset < (SHOW_MAX_LEN - 1))) {
ret = OsTabCompletion(shellCB->shellBuf, &shellCB->shellBufOffset);
if (ret > 1) {
outputFunc("OHOS # %s", shellCB->shellBuf);
}
}
return;
}
/* parse the up/down/right/left key */
ret = ShellCmdLineCheckUDRL(ch, shellCB);
if (ret == LOS_OK) {
return;
}
if ((ch != '\n') && (ch != '\0')) {
if (shellCB->shellBufOffset < (SHOW_MAX_LEN - 1)) {
shellCB->shellBuf[shellCB->shellBufOffset] = ch;
} else {
shellCB->shellBuf[SHOW_MAX_LEN - 1] = '\0';
}
shellCB->shellBufOffset++;
outputFunc("%c", ch);
}
shellCB->shellKeyType = STAT_NORMAL_KEY;
}
LITE_OS_SEC_TEXT_MINOR UINT32 ShellMsgTypeGet(CmdParsed *cmdParsed, const CHAR *cmdType)
{
CmdItemNode *curCmdItem = (CmdItemNode *)NULL;
UINT32 len;
UINT32 minLen;
CmdModInfo *cmdInfo = OsCmdInfoGet();
if ((cmdParsed == NULL) || (cmdType == NULL)) {
return OS_INVALID;
}
len = strlen(cmdType);
LOS_DL_LIST_FOR_EACH_ENTRY(curCmdItem, &(cmdInfo->cmdList.list), CmdItemNode, list) {
if ((len == strlen(curCmdItem->cmd->cmdKey)) &&
(strncmp((CHAR *)(curCmdItem->cmd->cmdKey), cmdType, len) == 0)) {
minLen = (len < CMD_KEY_LEN) ? len : CMD_KEY_LEN;
(VOID)memcpy_s((CHAR *)(cmdParsed->cmdKeyword), CMD_KEY_LEN, cmdType, minLen);
cmdParsed->cmdType = curCmdItem->cmd->cmdType;
return LOS_OK;
}
}
return OS_INVALID;
}
STATIC UINT32 ShellMsgNameGetAndExec(CmdParsed *cmdParsed, const CHAR *output, UINT32 len)
{
UINT32 loop;
UINT32 ret;
const CHAR *tmpStr = NULL;
BOOL quotes = FALSE;
CHAR *msgName = (CHAR *)LOS_MemAlloc(m_aucSysMem0, len + 1);
if (msgName == NULL) {
PRINTK("malloc failure in %s[%d]\n", __FUNCTION__, __LINE__);
return OS_INVALID;
}
/* Scan the 'output' string for command */
/* Notice: Command string must not have any special name */
for (tmpStr = output, loop = 0; (*tmpStr != '\0') && (loop < len);) {
/* If reach a double quotes, switch the quotes matching status */
if (*tmpStr == '\"') {
SWITCH_QUOTES_STATUS(quotes);
/* Ignore the double quote CHARactor itself */
tmpStr++;
continue;
}
/* If detected a space which the quotes matching status is false */
/* which said has detected the first space for separator, finish this scan operation */
if ((*tmpStr == ' ') && (QUOTES_STATUS_CLOSE(quotes))) {
break;
}
msgName[loop] = *tmpStr++;
loop++;
}
msgName[loop] = '\0';
/* Scan the command list to check whether the command can be found */
ret = ShellMsgTypeGet(cmdParsed, msgName);
PRINTK("\n");
if (ret != LOS_OK) {
PRINTK("%s:command not found", msgName);
} else {
(VOID)OsCmdExec(cmdParsed, (CHAR *)output);
}
(VOID)LOS_MemFree(m_aucSysMem0, msgName);
return ret;
}
LITE_OS_SEC_TEXT_MINOR UINT32 ShellMsgParse(const VOID *msg)
{
CHAR *output = NULL;
UINT32 len, cmdLen, newLen;
CmdParsed cmdParsed;
UINT32 ret = OS_INVALID;
CHAR *buf = (CHAR *)msg;
CHAR *newMsg = NULL;
CHAR *cmd = "exec";
if (msg == NULL) {
goto END;
}
len = strlen(msg);
/* 2: strlen("./") */
if ((len > 2) && (buf[0] == '.') && (buf[1] == '/')) {
cmdLen = strlen(cmd);
newLen = len + 1 + cmdLen + 1;
newMsg = (CHAR *)LOS_MemAlloc(m_aucSysMem0, newLen);
if (newMsg == NULL) {
PRINTK("malloc failure in %s[%d]\n", __FUNCTION__, __LINE__);
goto END;
}
(VOID)memcpy_s(newMsg, newLen, cmd, cmdLen);
newMsg[cmdLen] = ' ';
(VOID)memcpy_s(newMsg + cmdLen + 1, newLen - cmdLen - 1, (CHAR *)msg + 1, len);
msg = newMsg;
len = newLen - 1;
}
output = (CHAR *)LOS_MemAlloc(m_aucSysMem0, len + 1);
if (output == NULL) {
PRINTK("malloc failure in %s[%d]\n", __FUNCTION__, __LINE__);
goto END;
}
/* Call function 'OsCmdKeyShift' to squeeze and clear useless or overmuch space if string buffer */
ret = OsCmdKeyShift((CHAR *)msg, output, len + 1);
if ((ret != LOS_OK) || (strlen(output) == 0)) {
ret = OS_INVALID;
goto END_FREE_OUTPUT;
}
(VOID)memset_s(&cmdParsed, sizeof(CmdParsed), 0, sizeof(CmdParsed));
ret = ShellMsgNameGetAndExec(&cmdParsed, output, len);
END_FREE_OUTPUT:
(VOID)LOS_MemFree(m_aucSysMem0, output);
END:
if (newMsg != NULL) {
(VOID)LOS_MemFree(m_aucSysMem0, newMsg);
}
return ret;
}
#ifdef LOSCFG_FS_VFS
LITE_OS_SEC_TEXT_MINOR UINT32 ShellEntry(UINTPTR param)
{
CHAR ch;
INT32 n;
ShellCB *shellCB = (ShellCB *)param;
CONSOLE_CB *consoleCB = OsGetConsoleByID((INT32)shellCB->consoleID);
if (consoleCB == NULL) {
PRINT_ERR("Shell task init error!\n");
return 1;
}
(VOID)memset_s(shellCB->shellBuf, SHOW_MAX_LEN, 0, SHOW_MAX_LEN);
while (1) {
#ifdef LOSCFG_PLATFORM_CONSOLE
if (!IsConsoleOccupied(consoleCB)) {
#endif
/* is console ready for shell ? */
n = read(consoleCB->fd, &ch, 1);
if (n == 1) {
ShellCmdLineParse(ch, (pf_OUTPUT)dprintf, shellCB);
}
if (is_nonblock(consoleCB)) {
LOS_Msleep(50); /* 50: 50MS for sleep */
}
#ifdef LOSCFG_PLATFORM_CONSOLE
}
#endif
}
}
#endif
STATIC VOID ShellCmdProcess(ShellCB *shellCB)
{
CHAR *buf = NULL;
while (1) {
buf = ShellGetInputBuf(shellCB);
if (buf == NULL) {
break;
}
(VOID)ShellMsgParse(buf);
ShellSaveHistoryCmd(buf, shellCB);
shellCB->cmdMaskKeyLink = shellCB->cmdHistoryKeyLink;
}
}
LITE_OS_SEC_TEXT_MINOR UINT32 ShellTask(UINTPTR param1,
UINTPTR param2,
UINTPTR param3,
UINTPTR param4)
{
UINT32 ret;
ShellCB *shellCB = (ShellCB *)param1;
(VOID)param2;
(VOID)param3;
(VOID)param4;
while (1) {
PRINTK("\nOHOS # ");
ret = LOS_EventRead(&shellCB->shellEvent,
0xFFF, LOS_WAITMODE_OR | LOS_WAITMODE_CLR, LOS_WAIT_FOREVER);
if (ret == SHELL_CMD_PARSE_EVENT) {
ShellCmdProcess(shellCB);
} else if (ret == CONSOLE_SHELL_KEY_EVENT) {
break;
}
}
OsShellKeyDeInit((CmdKeyLink *)shellCB->cmdKeyLink);
OsShellKeyDeInit((CmdKeyLink *)shellCB->cmdHistoryKeyLink);
(VOID)LOS_EventDestroy(&shellCB->shellEvent);
(VOID)LOS_MemFree((VOID *)m_aucSysMem0, shellCB);
return 0;
}
#define SERIAL_SHELL_TASK_NAME "SerialShellTask"
#define SERIAL_ENTRY_TASK_NAME "SerialEntryTask"
#define TELNET_SHELL_TASK_NAME "TelnetShellTask"
#define TELNET_ENTRY_TASK_NAME "TelnetEntryTask"
LITE_OS_SEC_TEXT_MINOR UINT32 ShellTaskInit(ShellCB *shellCB)
{
CHAR *name = NULL;
TSK_INIT_PARAM_S initParam = {0};
if (shellCB->consoleID == CONSOLE_SERIAL) {
name = SERIAL_SHELL_TASK_NAME;
} else if (shellCB->consoleID == CONSOLE_TELNET) {
name = TELNET_SHELL_TASK_NAME;
} else {
return LOS_NOK;
}
initParam.pfnTaskEntry = (TSK_ENTRY_FUNC)ShellTask;
initParam.usTaskPrio = 9; /* 9:shell task priority */
initParam.auwArgs[0] = (UINTPTR)shellCB;
initParam.uwStackSize = 0x3000;
initParam.pcName = name;
initParam.uwResved = LOS_TASK_STATUS_DETACHED;
(VOID)LOS_EventInit(&shellCB->shellEvent);
return LOS_TaskCreate(&shellCB->shellTaskHandle, &initParam);
}
LITE_OS_SEC_TEXT_MINOR UINT32 ShellEntryInit(ShellCB *shellCB)
{
UINT32 ret;
CHAR *name = NULL;
TSK_INIT_PARAM_S initParam = {0};
if (shellCB->consoleID == CONSOLE_SERIAL) {
name = SERIAL_ENTRY_TASK_NAME;
} else if (shellCB->consoleID == CONSOLE_TELNET) {
name = TELNET_ENTRY_TASK_NAME;
} else {
return LOS_NOK;
}
initParam.pfnTaskEntry = (TSK_ENTRY_FUNC)ShellEntry;
initParam.usTaskPrio = 9; /* 9:shell task priority */
initParam.auwArgs[0] = (UINTPTR)shellCB;
initParam.uwStackSize = 0x1000;
initParam.pcName = name;
initParam.uwResved = LOS_TASK_STATUS_DETACHED;
ret = LOS_TaskCreate(&shellCB->shellEntryHandle, &initParam);
#ifdef LOSCFG_PLATFORM_CONSOLE
(VOID)ConsoleTaskReg((INT32)shellCB->consoleID, shellCB->shellEntryHandle);
#endif
return ret;
}