CN109814845B - 一种基于OOP编程的NVMe模型 - Google Patents

Abstract

本发明公开了一种基于OOP编程的NVMe模型，包括：生成模块，用于生成待发送命令或待发送数据；封装模块，用于将待发送命令或待发送数据封装成对应的接口类，并发送到对应的信箱；其中，生成模块和封装模块均为类；本发明通过封装模块将生成模块生成的待发送命令或待发送数据封装成对应的接口类，并发送到对应的信箱，采用OOP的编程思想，将NVMe模型中的功能模块都使用类实现，并将复杂的总线接口定义成结构体，进而封装成类，利用信箱操作实现与上下游的通信，从而使模块间的通信和接口的通信变为类的调用，简化了模块和接口的设计，提高了建模中接口集成的效率。

Description

一种基于OOP编程的NVMe模型

技术领域

本发明涉及计算机技术领域，特别涉及一种基于OOP编程的NVMe模型。

背景技术

OOP(Object Oriented Programming，面向对象的程序设计)是一种面向对象的编程，是当今程序设计比较流行的编程思想。OOP编程思想的关键概念在于将数据以及对数据的操作行为集成，作为一个不可分割的整体——对象。而描述相同类型对象的集合即为类，OOP编程就是定义这些类。对象之间通过公共接口进行通信，这些接口也可以用类声明，从而完成系统功能。建模是对一个模块设计的功能性描述，主要在于设计的抽象，用于研究这个硬件协议的具体实现方式，以及在系统中进行上下游整体的功能验证。

NVMe(Non-Volatile Memory express，非易失性内存主机控制器接口规范)系统中协议的主要实现部分是NVMe Host，它完成NVMe命令的生成以及与上下层通信的功能，上层是用户层(User)，会下发读写命令，下层为控制器(Controller)，主要解析NVMe命令以及完成数据的存储。现有技术中，往往采用verilog语言建立如NVMe Host的功能模型(NVMeHost模型)的NVMe模型，由于verilog语言(一种硬件描述语言)是面向过程的编程设计，注重细节，对于具体的总线接口设计复杂冗余，在系统集成时费时费力，不利于建模设计和NVMe模型的使用。

因此，如何能够提供一种基于OOP的编程思想的NVMe模型，使模型内部的各个功能模块均使用类(class)实现，将复杂的总线接口设计定义成结构体再封装成类，利用信箱完成NVMe中的Host与User和Controller的通信，简化模块和接口的设计，提高建模中接口集成的效率，是现今急需解决的问题。

发明内容

本发明的目的是提供一种基于OOP编程的NVMe模型，以基于OOP的编程思想，利用类简化NVMe模型中模块和接口，提高建模中接口集成的效率。

为解决上述技术问题，本发明提供一种基于OOP编程的NVMe模型，包括：

生成模块，用于生成待发送命令或待发送数据；

封装模块，用于将所述待发送命令或所述待发送数据封装成对应的接口类，并发送到对应的信箱；其中，所述生成模块和所述封装模块均为类。

可选的，所述NVMe模型为NVMe Host模型时，所述生成模块，包括：

读写命令生成子模块，用于将第一处理子模块发送的读写命令转换为对应的NVMe读写命令，并将所述NVMe读写命令返回给所述第一处理子模块；其中，所述待发送命令包括所述NVMe读写命令；

对应的，所述封装模块，包括：

所述第一处理子模块，用于对用户层发送信箱中的接口类进行解析，获取所述读写命令；将所述读写命令发送到所述读写命令生成子模块，接收返回的所述NVMe读写命令，并将所述NVMe读写命令封装成对应的接口类发送到控制器接收信箱。

可选的，所述NVMe模型为NVMe Host模型时，所述生成模块，还包括：

Fabric命令生成子模块，用于生成Fabric命令；

Admin命令生成子模块，用于生成Admin命令；所述待发送命令包括所述Fabric命令和所述Admin命令；

对应的，所述封装模块，包括：

所述第二处理子模块，用于接收所述Fabric命令和所述Admin命令，并将所述Fabric命令和所述Admin命令封装成对应的接口类发送到所述控制器接收信箱。

可选的，所述用户层发送信箱中的每个接口类均包括：命令类型、ID信息标识、读写地址和写数据。

可选的，所述控制器接收信箱中的每个接口类均包括：ID信息标识、自定义命令类型、标准NVMe命令和传输数据。

可选的，所述NVMe模型为NVMe Host模型时，还包括：

解析封装模块，用于对控制器返回的接口类进行解析，得到响应数据和/或响应命令。

可选的，所述解析封装模块还用于将所述响应数据和/或所述响应命令封装成对应的接口类，并发送到用户层接收信箱。

可选的，所述解析封装模块，包括：

数据解析子模块，用于对控制器数据发送信箱中的接口类进行解析，得到所述响应数据，并将所述响应数据放入缓存信箱；

命令解析子模块，用于对控制器命令发送信箱中的接口类进行解析，得到所述响应命令；根据所述响应命令判断是否需要返回到用户层；若是，则将所述响应命令和所述缓存信箱中对应的响应数据封装成对应的接口类，并发送到所述用户层接收信箱。

可选的，所述用户层接收信箱中的每个接口类均包括：命令完成状态、返回ID信息、返回读写地址和读数据。

可选的，所述控制器命令发送信箱中的每个接口类均包括：返回ID信息、返回命令类型和返回标准NVMe命令。

本发明所提供的一种基于OOP编程的NVMe模型，包括：生成模块，用于生成待发送命令或待发送数据；封装模块，用于将待发送命令或待发送数据封装成对应的接口类，并发送到对应的信箱；其中，生成模块和封装模块均为类；

可见，本发明通过封装模块将生成模块生成的待发送命令或待发送数据封装成对应的接口类，并发送到对应的信箱，采用OOP的编程思想，将NVMe模型中的功能模块都使用类实现，并将复杂的总线接口定义成结构体，进而封装成类，利用信箱操作实现与上下游的通信，从而使模块间的通信和接口的通信变为类的调用，简化了模块和接口的设计，提高了建模中接口集成的效率。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据提供的附图获得其他的附图。

图1为本发明实施例所提供的一种基于OOP编程的NVMe模型的结构框图；

图2为本发明实施例所提供的一种基于OOP编程的NVMe Host模型的结构框图；

图3为本发明实施例所提供的一种User与Host之间的接口类定义的示意图；

图4为本发明实施例所提供的一种Host与Controller之间的接口类定义的示意图；

图5为图2中NVMe Host模型中User与Host之间的通信示意图；

图6为图2中NVMe Host模型中Host与Controller之间的通信示意图。

具体实施方式

为使本发明实施例的目的、技术方案和优点更加清楚，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

请参考图1，图1为本发明实施例所提供的一种基于OOP编程的NVMe模型的结构框图；该NVMe模型可以包括：

生成模块100，用于生成待发送命令或待发送数据；

封装模块200，用于将待发送命令或待发送数据封装成对应的接口类，并发送到对应的信箱；其中，生成模块100和封装模块200均为类。

可以理解的是，本实施例的目的利用由OPP编程思想中的类实现的功能模块(生成模块100和封装模块200)，并将复杂的总线接口定义成结构体，进而封装成类(接口类)，利用信箱操作实现与上下游的通信，使NVMe模型(如NVMe Host模型、NVMe User模型或NVMeController模型)中模块间的通信和接口的通信变为类的调用。对于本实施例所提供的NVMe模型的具体编程实现方式，可以由设计人员自行设置，如可以通过System Verilog语言编程，也可以通过其他编程语言进行编程，只要可以实现上述目的，本实施例对此不做任何限制。

需要说明的是，本实施例中的生成模块100的具体结构设置，可以由设计人员根据实用场景何用需求自行设置，如本实施例所提供的NVMe模型为NVMe Host模型时，由于NVMeHost的功能是完成命令的接收、生成以及发送，设计的命令可以主要分为两类：IO命令、Fabric/Admin命令。IO命令即是读写，User发送给Host，Host继而发送给Controller；Controller完成后返回响应或数据给Host，Host再将响应命令或响应数据返回给User。Fabric/Admin命令主要管理功能，由Host生成并发送给Controller，Controller完成后返回响应或数据给Host。因此，如图2所示(图2中矩形框表示利用类实现的功能模块，圆形框表示用于通信的信箱)，生成模块100可以包括利用类实现的读写命令生成子模块(io_cmd)、Fabric命令生成子模块(fabric_cmd)以及Admin命令生成子模块(admin_cmd)，以完成NVMe协议中三种命令(IO命令、Fabric命令和Admin命令)的生成，模块使用类实现，使在其他模块中调用该类可以生成相应的命令，本实施例对此不做任何限制。

对应的，由于读写命令生成子模块生成的NVMe协议中的读写命令(NVMe读写命令)需要与User发送的读写命令相对应，因此，如图2所示，本实施例中的封装模块200可以包括第一处理子模块(h2c_run)，对用户层发送信箱(mailbox_Utr)中的接口类进行解析，获取读写命令(IO命令)；将读写命令发送到读写命令生成子模块(io_cmd)，接收返回的NVMe读写命令，并将NVMe读写命令封装成对应的接口类发送到控制器接收信箱(mailbox_PT0_sq)。即读写命令生成子模块可以用于将第一处理子模块发送的读写命令转换为对应的NVMe读写命令，并将NVMe读写命令返回给第一处理子模块。也就是说，第一处理子模块可以用于处理User与Controller的命令转换，User下发的命令，主要为IO(即读和写)命令，第一处理子模块从User接收到命令后，获取主要信息，通过读写命令生成子模块生成NVMe读写命令，之后封装成相应的接口类(PTO)发送给Controller。

具体的，如图2所示，本实施例中的封装模块200还可以包括第二处理子模块(h2c_run)，用于接收Fabric命令生成子模块(fabric_cmd)生成的Fabric命令和Admin命令生成子模块(admin_cmd)生成的Admin命令，并将Fabric命令和生成Admin命令封装成对应的接口类发送到控制器接收信箱。也就是说，第二处理子模块可以用于处理Host与Controller的命令转换，由于NVMe协议中有些命令是通过Host发送给Controller的，例如初始化和管理等，本模块通过Fabric命令生成子模块和Admin命令生成子模块生成这些NVMe命令，封装成相应的接口类(PTO)发送给Controller。

可以理解的是，本实施例所提供的NVMe模型为NVMe Host模型时，由于Controller在完成Host发送的NVMe协议中的命令(如NVMe读写命令)后，会返回响应命令和/或响应数据对应的接口类，因此，NVMe Host模型还可以包括解析封装模块，用于对控制器返回的接口类进行解析，得到响应数据和/或响应命令。进一步的，由于Controller返回的响应命令可以指示这一次响应是否完成，若未完成，还需要进一步发送给User。因此，解析封装模块还可以用于将响应数据和/或响应命令封装成对应的接口类，并发送到用户层接收信箱。

对应的，如图2所示，解析封装模块可以包括数据解析子模块(recv_pt0)，用于对控制器数据发送信箱(mailbox_PT0_rsp)中的接口类(PT0)进行解析，得到响应数据，并将响应数据放入缓存信箱(pt0_1)；命令解析子模块(recv_pt1)，用于对控制器命令发送信箱(mailbox_PT1_cq)中的接口类(PT1)进行解析，得到响应命令；根据响应命令判断是否需要返回到用户层；若是，则将响应命令和缓存信箱中对应的响应数据封装成对应的接口类，并发送到用户层接收信箱(mailbox_Urx)。也就是说，数据解析子模块可以用于接收Controller的响应数据，从Controller接收其响应数据并放入缓存信箱中；命令解析子模块可以用于接收Controller的响应命令，由于Controller返回的响应命令指示这一次响应是否完成，命令解析子模块可以接收该响应命令并判断，决定本次传输完成或者是需要进一步发送给User；缓存信箱可以为Host内部的信箱，由于Controller的响应数据和响应完成命令是分开返回的，因此可以在Host内部单独设置一个信箱(缓存信箱)用于存放返回的响应数据。

需要说明的是，上述用户层发送信箱和用户层接收信箱可以为User与Host之间的信箱；这些信箱中存放的是User与Host的接口类，User发送到Host或Host发送给User均需通过这两个信箱传输。上述控制器接收信箱、控制器数据发送信箱和控制器命令发送信箱可以为Host与Controller之间的信箱；这些信箱中存放的是Host与Controller之间定义的接口类，Host发送到Controller或Controller返回给Host均需通过这些信箱传输。具体的，对于本实施例中的各种信箱的具体设置位置，可以由设计人员自行设置，如图2所示，缓存信箱(pt0_1)可以设置在Host内部，用户层发送信箱(mailbox_Utr)和用户层接收信箱(mailbox_Urx)可以设置在User内部，控制器接收信箱(mailbox_PT0_sq)、控制器数据发送信箱(mailbox_PT0_rsp)和控制器命令发送信箱(mailbox_PT1_cq)可以设置在Controller内部；也可以将全部信箱均设置在Host内部，只要每个信箱可以实现上述功能，本实施例对此不做任何限制。

对应的，对于本实例中的各种信箱中的接口类的具体定义设置，可以由设计人员自行设置，如图3所示的User与Host的接口类定义，由于User与Host之间只涉及读写命令，因此，用户层发送信箱(mailbox_Utr)中User发送到Host的接口类(utr)可以包括命令类型(Cmd)，为读或写；ID信息标识(Cmd_id)；读写地址(Addr)；写数据(Data)。用户层接收信箱(mailbox_Urx)中Host发送到User的接口类(urx)可以包括命令完成状态(STATUS)，成功或失败；返回ID信息(Cmd_id)；返回读写地址(Addr)；读数据(Data)。如图4所示的Host与Controller的接口类定义，控制器接收信箱(mailbox_PT0_sq)和控制器数据发送信箱(mailbox_PT0_rsp)中的Host发送到Controller或者Controller返回给Host的接口类(PT0)可以包括ID信息标识(cmd_id)；自定义命令类型(cmd_type)，所有命令统一编码；标准NVMe命令(nvme_cmd)；传输数据(data)。控制器命令发送信箱(mailbox_PT1_cq)中Controller返回给Host的接口类(PT1)可以包括返回ID信息(cmd_id)；返回命令类型(cmd_type)；返回标准NVMe命令(nvme_cmd)。本实施例对此不做任何限制。

以图2所示的NVMe Host模型为例，User与Host通过信箱的通信可以如图5所示。当User发起一个读或写命令时，这个命令信息包含在接口类utr中，将这个接口类utr放入信箱mailbox_Utr中，Host将从信箱中获取这个接口类utr并解析，进一步获取这个命令；当这个命令完成时，完成的响应或数据信息包含在接口类urx中，Host将这个接口类urx放入信箱mailbox_Urx中，User从信箱中获取这个接口类urx，进一步获取完成信息。

以图2所示的NVMe Host模型为例，Host与Controller通过信箱的通信可以如图6所示。当Host发送一个命令到Controller时，这个命令信息封装成接口类PT0，将这个接口类PT0放入信箱mailbox_PT0_sq中，Controller将从信箱中获取这个接口类PT0解析并采取操作；当这个命令完成时，Controller将返回响应数据或响应命令给Host，响应数据信息封装成接口类PT0并放入信箱mailbox_PT0_rsp，Host接收后再放入信箱pt0_1等待进一步处理，响应命令信息封装成接口类PT1并放入信箱mailbox_PT1_cq，Host接收这个接口类PT1进一步处理。

具体的，下面分别以一个读命令和一个Admin命令的操作为例来介绍图2所示的NVMe Host模型的处理流程。

User发起一个读命令，生成一个接口类utr放入信箱mailbox_Utr。NVMe Host模型中的u2c_run从该信箱中接收这个接口类并解析，获取有效命令信息后调用io_cmd生成标准的NVMe读命令。u2c_run将这个NVMe读命令封装成接口类PT0放入信箱mailbox_PT0_sq中，Controller将从该信箱中获取这个接口类解析出是一个读命令，读出相应地址的响应数据并封装成接口类PT0放入信箱mailbox_PT0_rsp，然后Controller生成响应命令并封装成接口类PT1放入信箱mailbox_PT1_cq。NVMe Host模型中的recv_pt0从mailbox_PT0_rsp中获取响应数据PT0，解析出具体数据后放入信箱pt0_1中；NVMe Host模型中的recv_pt1从mailbox_PT1_cq中获取响应命令PT1，解析出是一个读命令，再从pt0_1中取出数据，将响应命令及数据封装成一个接口类urx，放入信箱mailbox_Urx。User从mailbox_Urx取出这个接口类urx，解析获取了响应数据和读响应信息，至此一个读命令完成。

NVMe Host模型发起一个Admin命令，h2c_run调用admin_cmd生成NVMe协议中的Admin命令，将这个命令信息封装成一个接口类PT0放入信箱mailbox_PT0_sq。Controller从该信箱中获取这个接口类PT0并解析出是一个Admin命令，采取对应的操作，如果这个命令需要返回响应数据，Controller将响应数据封装成接口类PT0放入信箱mailbox_PT0_rsp，NVMe Host模型中的recv_pt0获取这个接口类PT0并解析出具体数据放入信箱pt0_1，然后Controller将响应命令封装成接口类PT1放入信箱mailbox_PT1_cq，NVMe Host模型中的recv_pt1获取这个接口类PT1，解析后再从pt0_1中取得响应数据，至此一个Admin命令完成；如果这个命令不需要返回数据，Controller将只返回响应命令，将响应命令封装成接口类PT1放入信箱mailbox_PT1_cq，NVMe Host模型中的recv_pt1获取这个接口类PT1，至此一个Admin命令完成。

对应的，上述是以本实施例中NVMe模型为NVMe Host模型为例进行的具体展示，对于NVMe模型为NVMe User模型和NVMe Controller模型的情况，可以与采用NVMe Host模型相对应的方式进行设置，本实施例对此不做任何限制。

本实施例中，本发明实施例通过封装模块200将生成模块100生成的待发送命令或待发送数据封装成对应的接口类，并发送到对应的信箱，采用OOP的编程思想，将NVMe模型中的功能模块都使用类实现，并将复杂的总线接口定义成结构体，进而封装成类，利用信箱操作实现与上下游的通信，从而使模块间的通信和接口的通信变为类的调用，简化了模块和接口的设计，提高了建模中接口集成的效率。

以上对本发明所提供的一种基于OOP编程的NVMe模型进行了详细介绍。本文中应用了具体个例对本发明的原理及实施方式进行了阐述，以上实施例的说明只是用于帮助理解本发明的方法及其核心思想。应当指出，对于本技术领域的普通技术人员来说，在不脱离本发明原理的前提下，还可以对本发明进行若干改进和修饰，这些改进和修饰也落入本发明权利要求的保护范围内。

Claims (9)

1.一种基于OOP编程的NVMe模型，其特征在于，包括：

生成模块，用于生成待发送命令或待发送数据；

封装模块，用于将所述待发送命令或所述待发送数据封装成对应的接口类，并发送到对应的信箱；其中，所述生成模块和所述封装模块均为类；

所述NVMe模型为NVMe Host模型时，所述生成模块，包括：

读写命令生成子模块，用于将第一处理子模块发送的读写命令转换为对应的NVMe读写命令，并将所述NVMe读写命令返回给所述第一处理子模块；其中，所述待发送命令包括所述NVMe读写命令；

对应的，所述封装模块，包括：

所述第一处理子模块，用于对用户层发送信箱中的接口类进行解析，获取所述读写命令；将所述读写命令发送到所述读写命令生成子模块，接收返回的所述NVMe读写命令，并将所述NVMe读写命令封装成对应的接口类发送到控制器接收信箱。

2.根据权利要求1所述的基于OOP编程的NVMe模型，其特征在于，所述NVMe模型为NVMeHost模型时，所述生成模块，还包括：

Fabric命令生成子模块，用于生成Fabric命令；

Admin命令生成子模块，用于生成Admin命令；所述待发送命令包括所述Fabric命令和所述Admin命令；

对应的，所述封装模块，包括：

第二处理子模块，用于接收所述Fabric命令和所述Admin命令，并将所述Fabric命令和所述Admin命令封装成对应的接口类发送到所述控制器接收信箱。

3.根据权利要求2所述的基于OOP编程的NVMe模型，其特征在于，所述用户层发送信箱中的每个接口类均包括：命令类型、ID信息标识、读写地址和写数据。

4.根据权利要求2所述的基于OOP编程的NVMe模型，其特征在于，所述控制器接收信箱中的每个接口类均包括：ID信息标识、自定义命令类型、标准NVMe命令和传输数据。

5.根据权利要求1至4任一项所述的基于OOP编程的NVMe模型，其特征在于，所述NVMe模型为NVMe Host模型时，还包括：

解析封装模块，用于对控制器返回的接口类进行解析，得到响应数据和/或响应命令。

6.根据权利要求5所述的基于OOP编程的NVMe模型，其特征在于，所述解析封装模块还用于将所述响应数据和/或所述响应命令封装成对应的接口类，并发送到用户层接收信箱。

7.根据权利要求6所述的基于OOP编程的NVMe模型，其特征在于，所述解析封装模块，包括：

数据解析子模块，用于对控制器数据发送信箱中的接口类进行解析，得到所述响应数据，并将所述响应数据放入缓存信箱；

命令解析子模块，用于对控制器命令发送信箱中的接口类进行解析，得到所述响应命令；根据所述响应命令判断是否需要返回到用户层；若是，则将所述响应命令和所述缓存信箱中对应的响应数据封装成对应的接口类，并发送到所述用户层接收信箱。

8.根据权利要求7所述的基于OOP编程的NVMe模型，其特征在于，所述用户层接收信箱中的每个接口类均包括：命令完成状态、返回ID信息、返回读写地址和读数据。

9.根据权利要求7所述的基于OOP编程的NVMe模型，其特征在于，所述控制器命令发送信箱中的每个接口类均包括：返回ID信息、返回命令类型和返回标准NVMe命令。

Images