电子技术论坛_中国专业的电子工程师学习交流社区-中电网技术论坛

标题: Relay：一种内核到用户空间的高效数据传输技术（2） [打印本页]

作者: look_w 时间: 2018-5-19 15:26 标题: Relay：一种内核到用户空间的高效数据传输技术（2）

Relay的主要API前面提到的 relay_write() 就是 relay API 之一。除此以外，Relay 还提供了更多的 API来支持用户程序完整的使用 relay。这些 API，主要按照面向用户空间和面向内核空间分为两大类，下面我们来分别进行介绍。
面向用户空间的 API这些 Relay 编程接口向用户空间程序提供了访问 relay 通道缓冲区数据的基本操作的入口，包括：

open() - 允许用户打开一个已经存在的通道缓冲区
mmap() - 使通道缓冲区被映射到位于用户空间的调用者的地址空间。要特别注意的是，我们不能仅对局部区域进行映射。也就是说，必须映射整个缓冲区文件，其大小是 CPU的个数和单个 CPU 缓冲区大小的乘积
read() - 读取通道缓冲区的内容。这些数据一旦被读出，就意味着他们被用户空间的程序消费掉了，也就不能被之后的读操作看到
sendfile() - 将数据从通道缓冲区传输到一个输出文件描述符。其中可能的填充字符会被自动去掉，不会被用户看到
poll() - 支持 POLLIN/POLLRDNORM/POLLERR 信号。每次子缓冲区的边界被越过时，等待着的用户空间程序会得到通知
close() - 将通道缓冲区的引用数减1。当引用数减为0时，表明没有进程或者内核用户需要打开它，从而这个通道缓冲区被释放。

面向内核空间的 API这些API接口向位于内核空间的用户提供了管理relay通道、数据写入等功能。下面介绍其中主要的部分，完整的API接口列表请参见这里。

relay_open() - 创建一个relay通道，包括创建每个CPU对应的relay缓冲区。
relay_close() - 关闭一个relay通道，包括释放所有的relay缓冲区，在此之前会调用relay_switch()来处理这些relay缓冲区以保证已读取但是未满的数据不会丢失
relay_write() - 将数据写入到当前CPU对应的relay缓冲区内。由于它使用了local_irqsave()保护，因此也可以在中断上下文中使用。
relay_reserve() - 在relay通道中保留一块连续的区域来留给未来的写入操作。这通常用于那些希望直接写入到relay缓冲区的用户。考虑到性能或者其它因素，这些用户不希望先把数据写到一个临时缓冲区中，然后再通过relay_write()进行写入。

Relay的例子我们用一个最简单的例子来介绍怎么使用Relay。这个例子由两部分组成：一部分是位于内核空间将数据写入relay文件的程序，使用时需要作为一个内核模块被加载；另一部分是位于用户空间从relay文件中读取数据的程序，使用时作为普通用户态程序运行。
内核空间的程序主要操作是：

加载模块时，打开一个relay通道，并且往打开的relay通道中写入消息；
卸载模块时，关闭relay通道。

程序内容：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

/*
* hello-mod.c
* a kernel-space client example of relayfs filesystem
*/
#include <linux/module.h>
#include <linux/relayfs_fs.h>
static struct rchan *hello_rchan;
int init_module(void)
{
      const char *msg="Hello world\n";
      hello_rchan = relay_open("cpu", NULL, 8192, 2, NULL);
      if(!hello_rchan){
            printk("relay_open() failed.\n");
            return -ENOMEM;
      }
      relay_write(hello_rchan, msg, strlen(msg));
      return 0;
}
void cleanup_module(void)
{
      if(hello_rchan) {
            relay_close(hello_rchan);
            hello_rchan = NULL;
      }
      return;
}
MODULE_LICENSE ("GPL");
MODULE_DESCRIPTION ("Simple example of Relay");

用户空间的函数主要操作是：

如果relayfs文件系统还没有被mount，则将其mount到目录/mnt/relay上；
遍历每一个CPU对应的缓冲文件
- 打开文件
- 读取所有文件内容
- 关闭文件
最后，umount掉relay文件系统。

程序内容：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

/*
* audience.c
* a user-space client example of relayfs filesystem
*/
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/mount.h>
#include <fcntl.h>
#include <sched.h>
#include <errno.h>
#include <stdio.h>
#define MAX_BUFLEN 256
const char filename_base[]="/mnt/relay/cpu";
// implement your own get_cputotal() before compilation
static int get_cputotal(void);
int main(void)
{
      char filename[128]={0};
      char buf[MAX_BUFLEN];
      int fd, c, i, bytesread, cputotal = 0;
      if(mount("relayfs", "/mnt/relay", "relayfs", 0, NULL)
                     && (errno != EBUSY)) {
            printf("mount() failed: %s\n", strerror(errno));
            return 1;
      }
      cputotal = get_cputotal();
      if(cputotal <= 0) {
            printf("invalid cputotal value: %d\n", cputotal);
            return 1;
      }
      for(i=0; i<cputotal; i++) {
            // open per-cpu file
            sprintf(filename, "%s%d", filename_base, i);
            fd = open(filename, O_RDONLY);
            if (fd < 0) {
                     printf("fopen() failed: %s\n", strerror(errno));
                     return 1;
            }
            // read per-cpu file
            bytesread = read(fd, buf, MAX_BUFLEN);
            while(bytesread > 0) {
                     buf[bytesread] = '\0';
                     puts(buf);
                     bytesread = read(fd, buf, MAX_BUFLEN);
            };
            // close per-cpu file
            if(fd > 0) {
                     close(fd);
                     fd = 0;
            }
      }
      if(umount("/mnt/relay") && (errno != EINVAL)) {
            printf("umount() failed: %s\n", strerror(errno));
            return 1;
      }
      return 0;
}

上面这个例子给出了使用relay的一个最简单的情形，并没有实际用处，但是形象描述了从用户空间和内核空间两个方面使用relay的基本流程。实际应用中对relay的使用当然要比这复杂得多。更多的例子请参见relay的主页。

欢迎光临电子技术论坛_中国专业的电子工程师学习交流社区-中电网技术论坛 (http://bbs.eccn.com/)