[HarmonyOS] v75.01 鸿蒙内核源码分析(远程登录篇) | 内核如何接待远方的客人 | 百篇博客分析OpenHarmony源码

  

• v67.03 鸿蒙内核源码分析(字符设备) | 绝大多数设备都是这类  
  
• v74.01 鸿蒙内核源码分析(控制台) | 一个让很多人模糊的概念  
  
• v75.01 鸿蒙内核源码分析(远程登录) | 内核如何接待远方的客人
  

  

• 通过本地的shell命令telnet on启动远程登录模块,由此创建Telnet的服务任务TelnetServer  
  
• TelnetServer任务,创建socket监听23端口,接受来自远程终端的 telnet xx.xx.xx.xx 23请求  
  
• 收到请求后创建一个TelnetClientLoop用于接待客户的任务,对接详细的客户需求.  
  
• 在接待客户期间创建一个远程登录类型的控制台,来处理和转发远程客户的请求给shell进程最终执行远程命令.  
  
• shell处理完成后通过专门的任务SendToSer回写远程终端,控制台部分详细看 系列篇的(控制台篇)  
  
• 
  

//SHELLCMD_ENTRY(telnet_shellcmd, CMD_TYPE_EX, "telnet", 1, (CmdCallBackFunc)TelnetCmd);/// 以静态方式注册shell 命令
/// 本命令用于启动或关闭telnet server服务 
INT32 TelnetCmd(UINT32 argc, const CHAR **argv)
{
  if (strcmp(argv[0], "on") == 0) { // 输入 telnet on
    /* telnet on: try to start telnet server task */
    TelnetdTaskInit(); //启动远程登录 服务端任务
    return 0;
  }
  if (strcmp(argv[0], "off") == 0) {// 输入 telnet off
    /* telnet off: try to stop clients, then stop server task */
    TelnetdTaskDeinit();//关闭所有的客户端,并关闭服务端任务
    return 0;
  }
  return 0;
}

STATIC VOID TelnetdTaskInit(VOID)
{
  UINT32 ret;
  TSK_INIT_PARAM_S initParam = {0};
  initParam.pfnTaskEntry = (TSK_ENTRY_FUNC)TelnetdMain; // telnet任务入口函数
  initParam.uwStackSize = TELNET_TASK_STACK_SIZE;// 8K
  initParam.pcName = "TelnetServer"; //任务名称
  initParam.usTaskPrio = TELNET_TASK_PRIORITY; //优先级 9,和 shell 的优先级一样
  initParam.uwResved = LOS_TASK_STATUS_DETACHED; //独立模式
  if (atomic_read(&g_telnetTaskId) != 0) {//只支持一个 telnet 服务任务
    PRINT_ERR("telnet server is already running!\n");
    return;
  }
  ret = LOS_TaskCreate((UINT32 *)&g_telnetTaskId, &initParam);//创建远程登录服务端任务并发起调度
}

//远程登录操作命令
STATIC const struct file_operations_vfs g_telnetOps = {
  TelnetOpen,
  TelnetClose,
  TelnetRead,
  TelnetWrite,
  NULL,
  TelnetIoctl,
  NULL,
#ifndef CONFIG_DISABLE_POLL
  TelnetPoll,
#endif
  NULL,
};
STATIC INT32 TelnetdMain(VOID)
{
  sock = TelnetdInit(TELNETD_PORT);//1.初始化创建 socket ,socket的本质就是打开了一个虚拟文件
  TelnetLock();
  ret = TelnetedRegister();//2.注册驱动程序 /dev/telnet ,g_telnetOps g_telnetDev
  TelnetUnlock();
  TelnetdAcceptLoop(sock);//3.等待连接,处理远程终端过来的命令 例如#task 命令
  return 0;
}

STATIC VOID TelnetdAcceptLoop(INT32 listenFd)
{
  while (g_telnetListenFd >= 0) {//必须启动监听
    TelnetUnlock();
    (VOID)memset_s(&inTelnetAddr, sizeof(inTelnetAddr), 0, sizeof(inTelnetAddr));
    clientFd = accept(listenFd, (struct sockaddr *)&inTelnetAddr, (socklen_t *)&len);//接收数据
    if (TelnetdAcceptClient(clientFd, &inTelnetAddr) == 0) {//
      /*
       * Sleep sometime before next loop: mostly we already have one connection here,
       * and the next connection will be declined. So don't waste our cpu.
       | 在下一个循环来临之前休息片刻,因为鸿蒙只支持一个远程登录,此时已经有一个链接,
       在TelnetdAcceptClient中创建线程不会立即调度, 休息下任务会挂起,重新调度
       */
      LOS_Msleep(TELNET_ACCEPT_INTERVAL);//以休息的方式发起调度. 直接申请调度也未尝不可吧 @note_thinking 
    } else {
      return;
    }
    TelnetLock();
  }
  TelnetUnlock();
}

STATIC INT32 TelnetdAcceptClient(INT32 clientFd, const struct sockaddr_in *inTelnetAddr)
{
  g_telnetClientFd = clientFd;
//创建一个线程处理客户端的请求
  if (pthread_create(&tmp, &useAttr, TelnetClientLoop, (VOID *)(UINTPTR)clientFd) != 0) {
    PRINT_ERR("Failed to create client handle task\n");
    g_telnetClientFd = -1;
    goto ERROUT_UNLOCK;
  }
}

STATIC VOID *TelnetClientLoop(VOID *arg)
{
  struct pollfd pollFd;
  INT32 ret;
  INT32 nRead;
  UINT32 len;
  UINT8 buf[TELNET_CLIENT_READ_BUF_SIZE];
  UINT8 *cmdBuf = NULL;
  INT32 clientFd = (INT32)(UINTPTR)arg;
  (VOID)prctl(PR_SET_NAME, "TelnetClientLoop", 0, 0, 0);
  TelnetLock();
  if (TelnetClientPrepare(clientFd) != 0) {//做好准备工作
    TelnetUnlock();
    (VOID)close(clientFd);
    return NULL;
  }
  TelnetUnlock();
  while (1) {//死循环接受远程输入的数据
    pollFd.fd = clientFd;
    pollFd.events = POLLIN | POLLRDHUP;//监听读数据和挂起事件
    pollFd.revents = 0;
/*
POLLIN 普通或优先级带数据可读
POLLRDNORM 普通数据可读
POLLRDBAND 优先级带数据可读
POLLPRI 高优先级数据可读
POLLOUT 普通数据可写
POLLWRNORM 普通数据可写
POLLWRBAND 优先级带数据可写
POLLERR 发生错误
POLLHUP 发生挂起
POLLNVAL 描述字不是一个打开的文件
poll本质上和select没有区别，它将用户传入的数组拷贝到内核空间，然后查询每个fd对应的设备状态，
如果设备就绪则在设备等待队列中加入一项并继续遍历，如果遍历完所有fd后没有发现就绪设备，则挂起当前进程，
直到设备就绪或者主动超时，被唤醒后它又要再次遍历fd。
这个过程经历了多次无谓的遍历。
poll还有一个特点是“水平触发”，如果报告了fd后，没有被处理，那么下次poll时会再次报告该fd。
poll与select的不同，通过一个pollfd数组向内核传递需要关注的事件，故没有描述符个数的限制，
pollfd中的events字段和revents分别用于标示关注的事件和发生的事件，故pollfd数组只需要被初始化一次
poll的实现机制与select类似，其对应内核中的sys_poll，只不过poll向内核传递pollfd数组，
然后对pollfd中的每个描述符进行poll，相比处理fdset来说，poll效率更高。poll返回后，
需要对pollfd中的每个元素检查其revents值，来得指事件是否发生。
优点
1）poll() 不要求开发者计算最大文件描述符加一的大小。
2）poll() 在应付大数目的文件描述符的时候速度更快，相比于select。
3）它没有最大连接数的限制，原因是它是基于链表来存储的。
缺点
1）大量的fd的数组被整体复制于用户态和内核地址空间之间，而不管这样的复制是不是有意义。
2）与select一样，poll返回后，需要轮询pollfd来获取就绪的描述符
*/
    ret = poll(&pollFd, 1, TELNET_CLIENT_POLL_TIMEOUT);//等2秒钟返回
    if (ret < 0) {//失败时，poll()返回-1
      break;
/*ret < 0 各值
EBADF一个或多个结构体中指定的文件描述符无效。
EFAULTfds 指针指向的地址超出进程的地址空间。
EINTR  请求的事件之前产生一个信号，调用可以重新发起。
EINVALnfds参数超出PLIMIT_NOFILE值。
ENOMEM   可用内存不足，无法完成请求
*/
    }
    if (ret == 0) {//如果在超时前没有任何事件发生，poll()返回0
      continue;
    }
    /* connection reset, maybe keepalive failed or reset by peer | 连接重置，可能keepalive失败或被peer重置*/
    if ((UINT16)pollFd.revents & (POLLERR | POLLHUP | POLLRDHUP)) {
      break;
    }
    if ((UINT16)pollFd.revents & POLLIN) {//数据事件
      nRead = read(clientFd, buf, sizeof(buf));//读远程终端过来的数据
      if (nRead <= 0) {
        /* telnet client shutdown */
        break;
      }
      cmdBuf = ReadFilter(buf, (UINT32)nRead, &len);//对数据过滤
      if (len > 0) {
        (VOID)TelnetTx((CHAR *)cmdBuf, len);//对数据加工处理
      }
    }
  }
  TelnetLock();
  TelnetClientClose();
  (VOID)close(clientFd);
  clientFd = -1;
  g_telnetClientFd = -1;
  TelnetUnlock();
  return NULL;
}

  

• 给鸿蒙内核源码加注释过程中，整理出以下文章。内容立足源码，常以生活场景打比方尽可能多的将内核知识点置入某种场景，具有画面感，容易理解记忆。说别人能听得懂的话很重要! 百篇博客绝不是百度教条式的在说一堆诘屈聱牙的概念，那没什么意思。更希望让内核变得栩栩如生，倍感亲切.确实有难度，自不量力，但已经出发，回头已是不可能的了。