Vitis HLS 学习笔记--C/C++ static 关键字的作用

1. 简介

2. c/c++共有性质

3. c++独有性质

4. 示例说明

5. static 对于 HLS 工具的影响

6. 总结

1. 简介

在Vitis HLS中，偶尔会用到 static 关键字。考虑到Vitis HLS同时兼容C和C++语言，有必要理解这两种语言中static关键字细微差异。本文旨在梳理和总结C与C++中static关键字的具体差别，以便于开发者更加精确地应用于Vitis HLS环境中。

2. c/c++共有性质

static 修饰全局变量

表明一个全局变量只对定义在同一文件中的函数可见。

全局变量的作用域被限制在定义它的文件内，这意味着该全局变量只能被同一源文件中的函数访问。

static 修饰局部变量

表明该变量的值不会因为函数终止而丢失。

局部变量的生命周期变为整个程序执行期间，但其作用域不变，仍然只在定义它的函数内。

这种特性使得static局部变量适合于实现需要记录之前状态或结果的功能，例如，用于计数函数被调用的次数。

static 修饰函数

表明该函数只在同一文件中调用。

函数的作用域被限制在其定义的文件中，这与 static 全局变量的行为是一致的。

3. c++独有性质

修饰类的数据成员

表明对该类所有对象这个数据成员都只有一个实例。即该实例归所有对象共有。

用static修饰不访问非静态数据成员的类成员函数。

这意味着一个静态成员函数只能访问它的参数、类的静态数据成员和全局变量。

如果不使用static关键词修饰函数或变量，它们就具有全局可见性，可以在其他文件中使用。在C++中，未被static关键词修饰的函数和变量都具有外部链接（external linkage），这意味着它们可以被其他文件引用。需要注意的是，如果在多个文件中定义了同名的全局函数或变量，编译器会报“multiple definition”错误。在这种情况下，可以将这些函数或变量定义为static，或者使用命名空间（namespace）来避免命名冲突。

4. 示例说明

Vitis-HLS-Introductory-Examples/Vitis/single_kernel/vadd_kernel/krnl_vadd.cpp at master · Xilinx/Vitis-HLS-Introductory-Examples · GitHubContribute to Xilinx/Vitis-HLS-Introductory-Examples development by creating an account on GitHub.https://github.com/Xilinx/Vitis-HLS-Introductory-Examples/blob/master/Vitis/single_kernel/vadd_kernel/krnl_vadd.cpp

链接所示例子中，以下三个函数都static修饰，都只能在本文件中调用：

static void read_input(uint32_t* in, hls::stream<uint32_t>& inStream, int vSize)

static void compute_add(hls::stream<uint32_t>& inStream1,...)

static void write_result(uint32_t* out, hls::stream<uint32_t>& outStream, int vSize)

以下函数调用了上面三个函数，此函数在头文件中被申明，属于被别的文件调用，那么不能使用static修饰

void krnl_vadd(uint32_t* in1, uint32_t* in2, uint32_t* out, int vSize)

静态成员是类或结构体的成员，它们在整个程序执行期间都只有一个实例。

换句话说，静态成员在所有对象之间共享。这与非静态成员不同，非静态成员在每个对象中都有一个单独的实例。静态成员可以是变量或者函数。例如，定义如下类：

class MyClass {
public:
    // 静态成员变量
    static int staticVar;

    // 非静态成员变量
    int nonStaticVar;

    // 静态成员函数
    static void staticFunction() {
    // 静态成员函数可以访问静态成员变量，但不能访问非静态成员变量
        staticVar = 10;
    }

    // 非静态成员函数
    void nonStaticFunction() {
    // 非静态成员函数可以访问这两者：
    // 静态成员变量和非静态成员变量
        staticVar = 15;
        nonStaticVar = 20;
    }
};

// 静态成员变量需要在类外进行定义和初始化
int MyClass::staticVar = 0;

int main() {
    MyClass obj1, obj2;

    MyClass::staticVar = 42; // 访问静态成员变量，它在所有对象之间共享
    std::cout << "obj1.staticVar: " << obj1.staticVar << std::endl; // 输出 42
    std::cout << "obj2.staticVar: " << obj2.staticVar << std::endl; // 输出 42

    // 访问非静态成员变量，它在每个对象中有一个单独的实例
    obj1.nonStaticVar = 5;
    obj2.nonStaticVar = 10;
    std::cout << "obj1.nonStaticVar: " << obj1.nonStaticVar << std::endl; // 输出 5
    std::cout << "obj2.nonStaticVar: " << obj2.nonStaticVar << std::endl; // 输出 10

    return 0; }

要点：

staticVar 是一个静态成员变量，它在所有 MyClass 对象之间共享。
nonStaticVar 是一个非静态成员变量，它在每个对象中都有一个单独的实例。
静态成员函数 staticFunction() 只能访问静态成员变量，而非静态成员函数 nonStaticFunction() 可以访问静态成员变量和非静态成员变量。

5. static 对于 HLS 工具的影响

在使用HLS工具进行综合时，输入和输出端口可以映射到实际的硬件接口，例如AXI接口。对于HLS中的数据流（stream）类型，数据可以通过FIFO或DMA等硬件模块进行传输。在综合过程中，这些数据流通常会被映射到FIFO或DMA硬件模块，并在硬件设计中使用。

尽管 inStream1 是一个在 HLS C++ 代码中定义的变量，但在硬件设计中，它可能被映射到一个FIFO或DMA硬件模块。在这种情况下，static 关键词的作用仅仅是限制变量的作用域，以避免与其他变量发生命名冲突。实际上，inStream1 的状态和值在运行时存储在FIFO或DMA中，而不是存储在静态内存中。