Lab2:system calls

        在上一个实验室中，您使用系统调用编写了一些实用程序。在本实验室中，您将向xv6添加一些新的系统调用，这将帮助您了解它们是如何工作的，并使您了解xv6内核的一些内部结构。您将在以后的实验室中添加更多系统调用。

一、实验准备

在你开始写代码之前，请阅读xv6手册《book-riscv-rev1》的第2章、第4章的第4.3节和第4.4节以及相关源代码文件：

• 系统调用的用户空间代码在user/user.h和user/usys.pl中。
• 内核空间代码是kernel/syscall.h、kernel/syscall.c。
• 与进程相关的代码是kernel/proc.h和kernel/proc.c。

可看这一篇博客来增加理解。

158.xv6——2（system calls）-CSDN博客

要开始本章实验，请将代码切换到syscall分支：

$ git fetch
$ git checkout syscall
$ make clean

如果运行make grade，您将看到测试分数的脚本无法执行trace和sysinfotest。您的工作是添加必要的系统调用和存根（stubs）以使它们工作。

二、System call tracing实验（moderate）

 1.需求

        在本作业中，您将添加一个系统调用跟踪功能，该功能可能会在以后调试实验时对您有所帮助。您将创建一个新的trace系统调用来控制跟踪。它应该有一个参数，这个参数是一个整数“掩码”（mask），它的比特位指定要跟踪的系统调用。例如，要跟踪fork系统调用，程序调用trace(1 << SYS_fork)，其中SYS_fork是kernel/syscall.h中的系统调用编号。如果在掩码中设置了系统调用的编号，则必须修改xv6内核，以便在每个系统调用即将返回时打印出一行。该行应该包含进程id、系统调用的名称和返回值；您不需要打印系统调用参数。trace系统调用应启用对调用它的进程及其随后派生的任何子进程的跟踪，但不应影响其他进程。

        我们提供了一个用户级程序版本的trace，它运行另一个启用了跟踪的程序（参见user/trace.c）。完成后，您应该看到如下输出：

$ trace 32 grep hello README
3: syscall read -> 1023
3: syscall read -> 966
3: syscall read -> 70
3: syscall read -> 0
$
$ trace 2147483647 grep hello README
4: syscall trace -> 0
4: syscall exec -> 3
4: syscall open -> 3
4: syscall read -> 1023
4: syscall read -> 966
4: syscall read -> 70
4: syscall read -> 0
4: syscall close -> 0
$
$ grep hello README
$
$ trace 2 usertests forkforkfork
usertests starting
test forkforkfork: 407: syscall fork -> 408
408: syscall fork -> 409
409: syscall fork -> 410
410: syscall fork -> 411
409: syscall fork -> 412
410: syscall fork -> 413
409: syscall fork -> 414
411: syscall fork -> 415
...
$

        在上面的第一个例子中，trace调用grep，仅跟踪了read系统调用。32是1<<SYS_read。在第二个示例中，trace在运行grep时跟踪所有系统调用；2147483647将所有31个低位置为1。在第三个示例中，程序没有被跟踪，因此没有打印跟踪输出。在第四个示例中，在usertests中测试的forkforkfork中所有子孙进程的fork系统调用都被追踪。如果程序的行为如上所示，则解决方案是正确的（尽管进程ID可能不同）

2.提示：

• 在Makefile的UPROGS中添加$U/_trace
• 运行make qemu，您将看到编译器无法编译user/trace.c，因为系统调用的用户空间存根还不存在：将系统调用的原型添加到user/user.h，存根添加到user/usys.pl，以及将系统调用编号添加到kernel/syscall.h，Makefile调用perl脚本user/usys.pl，它生成实际的系统调用存根user/usys.S，这个文件中的汇编代码使用RISC-V的ecall指令转换到内核。一旦修复了编译问题（注：如果编译还未通过，尝试先make clean，再执行make qemu），就运行trace 32 grep hello README；但由于您还没有在内核中实现系统调用，执行将失败。
• 在kernel/sysproc.c中添加一个sys_trace()函数，它通过将参数保存到proc结构体（请参见kernel/proc.h）里的一个新变量中来实现新的系统调用。从用户空间检索系统调用参数的函数在kernel/syscall.c中，您可以在kernel/sysproc.c中看到它们的使用示例。
• 修改fork()（请参阅kernel/proc.c）将跟踪掩码从父进程复制到子进程。
• 修改kernel/syscall.c中的syscall()函数以打印跟踪输出。您将需要添加一个系统调用名称数组以建立索引。

3.trace实现

本实验主要是实现一个追踪系统调用的函数，那么首先根据提示定义trace系统调用，并修复编译错误。

首先看一下user/trace.c的内容，主要的代码如下

// 调用 trace 系统调用，并传递第一个命令行参数的整数值
if (trace(atoi(argv[1])) < 0) {
    // 如果 trace 调用失败，打印错误信息并退出
    fprintf(2, "%s: trace failed\n", argv[0]);
    exit(1);
}

// 将命令行参数从 argv[2] 开始复制到 nargv 数组中
for (i = 2; i < argc && i < MAXARG; i++) {
    nargv[i-2] = argv[i];
}

// 使用 exec 系统调用执行 nargv[0] 命令，并传递 nargv 数组作为参数
exec(nargv[0], nargv);

它首先调用trace(int)，然后将命令行中的参数argv复制到nargv中，同时删去前两个参数，例如

argv  = trace 32 grep hello README
nargv = grep hello README

那么，根据提示，我们首先再proc结构体中添加一个数据字段，用于保存trace的参数。并在sys_trace()的实现中实现参数的保存

// kernel/proc.h
struct proc {
  // ...
  int trace_mask;    // trace系统调用参数
};

// kernel/sysproc.c
uint64
sys_trace(void)
{
  // 获取系统调用的参数
  argint(0, &(myproc()->trace_mask));
  return 0;
}

由于struct proc中增加了一个新的变量,当fork的时候我们也需要将这个变量传递到子进程中(提示中已说明)

//kernel/proc.c
int
fork(void)
{
  // ...

  safestrcpy(np->name, p->name, sizeof(p->name));

  //将trace_mask拷贝到子进程
  np->trace_mask = p->trace_mask;

  pid = np->pid;
  // ...

  return pid;
}

接下来应当考虑如何进行系统调用追踪了，根据提示，这将在syscall()函数中实现。下面是实现代码，需要注意的是条件判断中使用了&而不是==，这是因为在实验说明书的例子中，trace 2147483647 grep hello README将所有31个低位置为1，使得其可以追踪所有的系统调用。

void
syscall(void)
{
  int num;
  struct proc *p = myproc();

  num = p->trapframe->a7;  // 系统调用编号，参见书中4.3节
  if(num > 0 && num < NELEM(syscalls) && syscalls[num]) {
    p->trapframe->a0 = syscalls[num]();  // 执行系统调用，然后将返回值存入a0

    // 系统调用是否匹配
    if ((1 << num) & p->trace_mask)
      printf("%d: syscall %s -> %d\n", p->pid, syscalls_name[num], p->trapframe->a0);
  } else {
    printf("%d %s: unknown sys call %d\n",
            p->pid, p->name, num);
    p->trapframe->a0 = -1;
  }
}

在上面的代码中，我们还有一些引用的变量尚未定义，在syscall.c中定义他们

// ...
extern uint64 sys_trace(void);

static uint64 (*syscalls[])(void) = {
// ...
[SYS_trace]   sys_trace,
};

static char *syscalls_name[] = {
[SYS_fork]    "fork",
[SYS_exit]    "exit",
[SYS_wait]    "wait",
[SYS_pipe]    "pipe",
[SYS_read]    "read",
[SYS_kill]    "kill",
[SYS_exec]    "exec",
[SYS_fstat]   "fstat",
[SYS_chdir]   "chdir",
[SYS_dup]     "dup",
[SYS_getpid]  "getpid",
[SYS_sbrk]    "sbrk",
[SYS_sleep]   "sleep",
[SYS_uptime]  "uptime",
[SYS_open]    "open",
[SYS_write]   "write",
[SYS_mknod]   "mknod",
[SYS_unlink]  "unlink",
[SYS_link]    "link",
[SYS_mkdir]   "mkdir",
[SYS_close]   "close",
[SYS_trace]   "trace",
};

4.测试结果

在xv6-labs-2020中，执行下面指令，测试程序

./grade-lab-syscall trace

将你当前的修改提交到你的版本控制系统中，以保存当前工作的进度。

git commit -m "实现并通过了 trace 系统调用的所有测试"

三、System call sysinfo

1.实验要求

        在这个作业中，您将添加一个系统调用sysinfo，它收集有关正在运行的系统的信息。系统调用采用一个参数：一个指向struct sysinfo的指针（参见kernel/sysinfo.h）。内核应该填写这个结构的字段：freemem字段应该设置为空闲内存的字节数，nproc字段应该设置为state字段不为UNUSED的进程数。我们提供了一个测试程序sysinfotest；如果输出“sysinfotest: OK”则通过。

2.提示

• 在Makefile的UPROGS中添加$U/_sysinfotest
• 当运行make qemu时，user/sysinfotest.c将会编译失败，遵循和上一个作业一样的步骤添加sysinfo系统调用。要在user/user.h中声明sysinfo()的原型，需要预先声明struct sysinfo的存在：

3.sysinfo实现

（1）在Makefile的UPROGS中添加$U/_sysinfotest

（2）在kernel/syscall.h中添加宏定义

#define SYS_sysinfo  23

（3）在user/usys.pl中添加entry("sys_info")

(4)在user/user.h中新增sysinfo结构体和sysinfo函数声明

（5）在kernel/syscall.c中添加sysinfo函数定义

（6）在kernel/syscall.c中添加sysinfo数组以及syscall_names中添加

（7）在kernel/kalloc.c中添加一个函数用于获取空闲内存量

uint64
getfreemem(void)
{
  struct run *r;
  uint64 ret = 0;
  acquire(&kmem.lock);
  r = kmem.freelist;
  while(r)
  {
    ret += PGSIZE;
    r = r->next;
  }
  release(&kmem.lock);
  return ret;
}

（8）在kernel/proc.c中添加一个函数获取进程数

遍历proc数组，统计处于活动状态的进程即可，循环的写法参考scheduler函数

uint64
getnproc(void)
{
  struct proc *p;
  uint64 ret = 0;
  for (p = proc; p < &proc[NPROC];p++)
  {
    if(p->state!=UNUSED)
    {
      ret++;
    }
  }
  return ret;
}

（9）实现sys_sysinfo，将数据写入结构体并传递到用户空间

uint64 sys_sysinfo(void)
{
  uint64 addr;
  if(argaddr(0,&addr)<0)
  {
    return -1;
  }

  struct sysinfo si;
  struct proc *p = myproc();
  si.freemem = getfreemem();
  si.nproc = getnproc();
  
  if(copyout(p->pagetable,addr,(char*)&si,sizeof(si))<0)
  {
    return -1;
  }

  return 0;
}

4.测试结果

在xv6-labs-2020中，执行下面指令，测试程序

./grade-lab-syscall sysinfo

将代码先保存在本地

推送到远程仓库