tinyEMU中常用技巧

本文主要介绍一下tinyEMU中常用的一些技巧。

使用c语言实现template
在tinyemu中，cpu可以是32，64甚至是128bit的。cpu位宽的差异不影响软件模拟cpu操作的主要逻辑，我们只需要在处理数据时，注意处理的cpu位宽就好。在这样的情况下，我们有两种实现方式

针对每种位宽的cpu都实现相应的一套模拟cpu操作的代码
利用c语言宏，让m4帮忙生成对应的代码。
第一种方案比较容易想到，但是，会多写很多重复的代码，作为软件工程师，我们希望将相同的逻辑都抽象出来。对于其他支持泛型的语言来说，我们只要将cpu的位宽作为参数传入到template函数中，就可以实现。对于c语言来说，我们可以使用宏来生成我们需要的代码，即我们需要将cpu的位宽作为参数传入到c语言的宏中，生成的结果应该是我们需要的函数。

下面是我举的一个例子，要注意的是，这样的template函数的使用的时候都需要带着宏，总体看上去还是挺丑的。所以感觉稍微复杂的软件开发还是少用c语言比较好，抽象能力还是偏弱，写出来的代码不容易理解，可维护性差。

#include <stdio.h>

#define xglue(x, y) x ## y
#define gule(x, y) xglue(x, y)

/* Instead of declaring the macro explicitly,
 * you can use this command that is 'gcc test-gule.c -DXLEN=32'
 */
//#define XLEN 32
#define no_inline __attribute__((noinline))

void no_inline gule(riscv_cpu_interp_x, XLEN)()
{
    printf("%d", XLEN);
}

int main()
{
    gule(riscv_cpu_interp_x, XLEN)();
    return 0;
}


下面是使用gcc -E预处理宏展开之后的代码

typedef的使用
通过tinyEMU项目，加深了对typedef理解，原先我对typedef的理解是类似于define宏，区别是define使用的顺序是别名是第一个参数，结构是第二个参数，typedef相反。

实际上typedef是c语言中声明新类型的关键字。声明类型和声明变量使用类似的语法分析方式，即在声明变量的语句前面加上typedef，表示声明了一种新类型，类型名就是变量名。

举个例子

/* 这里我们声明了一个unsigned int类型的变量，变量名为uint32_t */
unsigned int uint32_t;
/* 这里使用了typedef，声明了一种新的类型uint32_t，这种类型等同于unsigned int */
typedef unsigned int uint32_t;
/* 这里我们可以使用uint32_t类型声明变量，这里变量类型是uint32_t，等同于unsigned int */
uint32_t a;

tinyEmu中对于函数指针的使用
一般情况下，我们是这样使用函数指针的

/* 1. 先声明一个用于表示函数指针类型的新类型，取个名字fs_loaded_file_cb_t */
typedef void (*fs_loaded_file_cb_t)(void *args, uint8_t *buf, size_t buf_len);

/* 2. 实现一个符合函数接口的函数 */
void loaded_txt_file(void *args, uint8_t *buf, size_t buf_len)
{
    ...
}

/* 3. 在业务逻辑中声明一个fs_loaded_file_cb_t类型的变量，注意这个变量实际上指针类型 */
fs_loaded_file_cb_t cb;

/* 4. 将cb指向第2步中实现的函数, 函数名也被我们视作执行函数的指针 */
cb = load_txt_file;

/* 5. 通过函数指针调用函数 */
cb(args, buf, buf_len);

在tinyEmu中对于函数指针的使用大体上也是这样，但是声明的时候有些不同

/* 1. 先声明一个用于表示函数类型的新类型，取个名字fs_loaded_file_cb_t */
typedef void fs_loaded_file_cb(void *args, uint8_t *buf, size_t buf_len);

/* 2. 实现一个符合函数接口的函数 */
void loaded_txt_file(void *args, uint8_t *buf, size_t buf_len)
{
    ...
}

/* 3. 在业务逻辑中声明一个指向fs_loaded_file_cb_t类型的指针变量 */
fs_loaded_file_cb *cb;

/* 4. 将cb指向第2步中实现的函数 */
cb = load_txt_file;

/* 5. 通过函数指针调用函数 */
cb(args, buf, buf_len);

主要的差别是在第3步声明函数指针变量的时候，Fabrice Bellard的写法和普通的指针使用方式保持一致，我认为是更容易让人理解的写法。

函数的声明和变量的声明在c语言中应该是差不多的，函数的定义和变量的赋值类似。所以函数在声明之后，即使没有定义，编译也是可以编译的。如果接触过函数式编程应该更容易理解这些概念。

C语言命名的左右原则
从变量名开始，先从左边开始结合，遇到圆括号就返回，最后得到变量的完整定义。

例子：

/* 下面的例子是关于函数指针的声明 */
#include <stdio.h>
/* 这里声明了一种新类型interrupt_handler，这种类型是一个不接受传入参数且返回值为void的函数 */
typedef void interrupt_handler();
void foo()
{
    printf("foo\n");
}
int main(void)
{
    /* 声明了一个指针类型的变量foo_ptr_ordinary, 可以指向不接受传入参数且返回值为void的函数 */
    void (*foo_ptr_ordinary)() = foo;
    /*  */
    interrupt_handler *foo_ptr = foo; // no need for parantheses
    foo_ptr_ordinary();
    foo_ptr();
    return 0;
}

回调函数的使用
从实现上讲，指向回调函数的函数指针作为调用者函数的参数，如果后续需求有变更，可以做到尽量不修改调用者函数，只修改回调函数。

下面举个例子，比如我要实现一个加载文件的函数，在文件加载之后希望根据不同的后缀名，对文件的内容做第一步的处理。为了实现这个需求，我们先定义一下接口。这里有几条原则：

如果接口没有以返回值的形式返回分配的数据结构变量，而是以传入指针的方式返回处理结果，那么分配内存的部分一定要在接口之外
如果接口是以返回值的形式返回分配的数据结构变量，那么需要对应的实现释放变量的接口。
/* 回调函数的类型声明，主要实现的是文件加载到内存之后需要做的一些处理 */
typedef void fs_loaded_file_cb(void *args, uint8_t *buf, size_t buf_len);
/* 暴露给用户使用的接口，从文件中读取属性，最后得到一个config变量 */
void load_config_from_file(struct config *cfg, const char *filename);
/* 加载文件的通用接口，对文件处理逻辑的抽象 */
void load_file(const char *filename, fs_loaded_file_cb cb, void *args);
/* 针对特定文件的处理接口 */
void loaded_txt_file(void *args, uint8_t *buf, size_t buf_len);
void loaded_tar_gz_file(void *args, uint8_t *buf, size_t buf_len);

代码示例如下，这里举的例子主要是把加载文件这个过程中的每一步解耦。每一步之间订好接口可以同时开发。

#include <stdio.h> 
/* for memset */
#include <string.h>
/* for error handling */
#include <errno.h>
#include <stdlib.h>

#define CB_TABLE_MAX 2

typedef unsigned int uint32_t;
typedef unsigned short uint16_t;
typedef unsigned char uint8_t;

enum {
    FILE_TYPE_TXT = 0,
    FILE_TYPE_TAR_GZ,
};

struct config {
    uint32_t file_type;
    uint32_t key;
    uint32_t value;
};

typedef void fs_loaded_file_cb(void *args, uint8_t *buf, size_t buf_len);

void load_config_from_file(struct config *cfg, const char *filename);

void config_load_file(const char *filename, fs_loaded_file_cb *cb, void *args);
int load_file(uint8_t **pbuf, const char *filename);
void loaded_txt_file(void *args, uint8_t *buf, size_t buf_len);
void loaded_tar_gz_file(void *args, uint8_t *buf, size_t buf_len);

/* 这个函数的功能就是加载了txt文件之后，将txt文件的内容都打印出来 */
void loaded_txt_file(void *args, uint8_t *buf, size_t buf_len)
{
    int i = 0;
    for(i = 0; i < buf_len; i++)
    printf("%c\n", buf[i]);

    (void)args;
}

/* malloc buffer in this function */
int load_file(uint8_t **pbuf, const char *filename)
{
    FILE *f;
    int size;
    uint8_t *buf;

    f = fopen(filename, "rb");
    if (!f) {
    perror(filename);
    exit(1);
    }

    fseek(f, 0, SEEK_END);
    size = ftell(f);
    fseek(f, 0, SEEK_SET);

    buf = malloc(size);
    if (fread(buf, 1, size, f) != size) {
    fprintf(stderr, "%s: read error\n", filename);
    exit(1);
    }
    fclose(f);
    *pbuf = buf;
    return size;
    
}

void config_load_file(const char *filename, fs_loaded_file_cb *cb, void *args)
{
    int size = 0;
    uint8_t *buf;
    size = load_file(&buf, filename);
    cb(args, buf, size);
    free(buf);
}

void load_config_from_file(struct config *cfg, const char *filename)
{
    config_load_file(filename, loaded_txt_file, NULL);
}

int main ()
{
    struct config cfg, *cfg_ptr;

    cfg_ptr = &cfg;

    memset((void *)cfg_ptr, 0, sizeof(*cfg_ptr));

    cfg.file_type = FILE_TYPE_TXT;

    load_config_from_file(cfg_ptr, "config.txt");

    return 0;
}