vhost_user

package
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 20, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package vhost_user contains generated bindings for API file vhost_user.api.

Contents: - 12 messages

Index

Constants

View Source 
const (
	APIFile    = "vhost_user"
	APIVersion = "4.1.1"
	VersionCrc = 0xd49ae8cd
)

Variables

This section is empty.

Functions

func AllMessages 

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type CreateVhostUserIf 

type CreateVhostUserIf struct {
	IsServer            bool                      `binapi:"bool,name=is_server" json:"is_server,omitempty"`
	SockFilename        string                    `binapi:"string[256],name=sock_filename" json:"sock_filename,omitempty"`
	Renumber            bool                      `binapi:"bool,name=renumber" json:"renumber,omitempty"`
	DisableMrgRxbuf     bool                      `binapi:"bool,name=disable_mrg_rxbuf" json:"disable_mrg_rxbuf,omitempty"`
	DisableIndirectDesc bool                      `binapi:"bool,name=disable_indirect_desc" json:"disable_indirect_desc,omitempty"`
	EnableGso           bool                      `binapi:"bool,name=enable_gso" json:"enable_gso,omitempty"`
	EnablePacked        bool                      `binapi:"bool,name=enable_packed" json:"enable_packed,omitempty"`
	CustomDevInstance   uint32                    `binapi:"u32,name=custom_dev_instance" json:"custom_dev_instance,omitempty"`
	UseCustomMac        bool                      `binapi:"bool,name=use_custom_mac" json:"use_custom_mac,omitempty"`
	MacAddress          ethernet_types.MacAddress `binapi:"mac_address,name=mac_address" json:"mac_address,omitempty"`
	Tag                 string                    `binapi:"string[64],name=tag" json:"tag,omitempty"`
}

vhost-user interface create request

  • is_server - our side is socket server
  • sock_filename - unix socket filename, used to speak with frontend
  • use_custom_mac - enable or disable the use of the provided hardware address
  • disable_mrg_rxbuf - disable the use of merge receive buffers
  • disable_indirect_desc - disable the use of indirect descriptors which driver can use
  • enable_gso - enable gso support (default 0)
  • enable_packed - enable packed ring support (default 0)
  • mac_address - hardware address to use if 'use_custom_mac' is set

CreateVhostUserIf defines message 'create_vhost_user_if'. Deprecated: the message will be removed in the future versions

func (*CreateVhostUserIf) GetCrcString 

func (*CreateVhostUserIf) GetCrcString() string

func (*CreateVhostUserIf) GetMessageName 

func (*CreateVhostUserIf) GetMessageName() string

func (*CreateVhostUserIf) GetMessageType 

func (*CreateVhostUserIf) GetMessageType() api.MessageType

func (*CreateVhostUserIf) Marshal 

func (m *CreateVhostUserIf) Marshal(b []byte) ([]byte, error)

func (*CreateVhostUserIf) Reset 

func (m *CreateVhostUserIf) Reset()

func (*CreateVhostUserIf) Size 

func (m *CreateVhostUserIf) Size() (size int)

func (*CreateVhostUserIf) Unmarshal 

func (m *CreateVhostUserIf) Unmarshal(b []byte) error

type CreateVhostUserIfReply 

type CreateVhostUserIfReply struct {
	Retval    int32                          `binapi:"i32,name=retval" json:"retval,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

vhost-user interface create response

  • retval - return code for the request
  • sw_if_index - interface the operation is applied to

CreateVhostUserIfReply defines message 'create_vhost_user_if_reply'. Deprecated: the message will be removed in the future versions

func (*CreateVhostUserIfReply) GetCrcString 

func (*CreateVhostUserIfReply) GetCrcString() string

func (*CreateVhostUserIfReply) GetMessageName 

func (*CreateVhostUserIfReply) GetMessageName() string

func (*CreateVhostUserIfReply) GetMessageType 

func (*CreateVhostUserIfReply) GetMessageType() api.MessageType

func (*CreateVhostUserIfReply) Marshal 

func (m *CreateVhostUserIfReply) Marshal(b []byte) ([]byte, error)

func (*CreateVhostUserIfReply) Reset 

func (m *CreateVhostUserIfReply) Reset()

func (*CreateVhostUserIfReply) Size 

func (m *CreateVhostUserIfReply) Size() (size int)

func (*CreateVhostUserIfReply) Unmarshal 

func (m *CreateVhostUserIfReply) Unmarshal(b []byte) error

type CreateVhostUserIfV2 

type CreateVhostUserIfV2 struct {
	IsServer            bool                      `binapi:"bool,name=is_server" json:"is_server,omitempty"`
	SockFilename        string                    `binapi:"string[256],name=sock_filename" json:"sock_filename,omitempty"`
	Renumber            bool                      `binapi:"bool,name=renumber" json:"renumber,omitempty"`
	DisableMrgRxbuf     bool                      `binapi:"bool,name=disable_mrg_rxbuf" json:"disable_mrg_rxbuf,omitempty"`
	DisableIndirectDesc bool                      `binapi:"bool,name=disable_indirect_desc" json:"disable_indirect_desc,omitempty"`
	EnableGso           bool                      `binapi:"bool,name=enable_gso" json:"enable_gso,omitempty"`
	EnablePacked        bool                      `binapi:"bool,name=enable_packed" json:"enable_packed,omitempty"`
	EnableEventIdx      bool                      `binapi:"bool,name=enable_event_idx" json:"enable_event_idx,omitempty"`
	CustomDevInstance   uint32                    `binapi:"u32,name=custom_dev_instance" json:"custom_dev_instance,omitempty"`
	UseCustomMac        bool                      `binapi:"bool,name=use_custom_mac" json:"use_custom_mac,omitempty"`
	MacAddress          ethernet_types.MacAddress `binapi:"mac_address,name=mac_address" json:"mac_address,omitempty"`
	Tag                 string                    `binapi:"string[64],name=tag" json:"tag,omitempty"`
}

vhost-user interface create request

  • is_server - our side is socket server
  • sock_filename - unix socket filename, used to speak with frontend
  • use_custom_mac - enable or disable the use of the provided hardware address
  • disable_mrg_rxbuf - disable the use of merge receive buffers
  • disable_indirect_desc - disable the use of indirect descriptors which driver can use
  • enable_gso - enable gso support (default 0)
  • enable_packed - enable packed ring support (default 0)
  • enable_event_idx - enable event_idx support (default 0)
  • mac_address - hardware address to use if 'use_custom_mac' is set
  • renumber - if true, use custom_dev_instance is valid
  • custom_dev_instance - custom device instance number

CreateVhostUserIfV2 defines message 'create_vhost_user_if_v2'.

func (*CreateVhostUserIfV2) GetCrcString 

func (*CreateVhostUserIfV2) GetCrcString() string

func (*CreateVhostUserIfV2) GetMessageName 

func (*CreateVhostUserIfV2) GetMessageName() string

func (*CreateVhostUserIfV2) GetMessageType 

func (*CreateVhostUserIfV2) GetMessageType() api.MessageType

func (*CreateVhostUserIfV2) Marshal 

func (m *CreateVhostUserIfV2) Marshal(b []byte) ([]byte, error)

func (*CreateVhostUserIfV2) Reset 

func (m *CreateVhostUserIfV2) Reset()

func (*CreateVhostUserIfV2) Size 

func (m *CreateVhostUserIfV2) Size() (size int)

func (*CreateVhostUserIfV2) Unmarshal 

func (m *CreateVhostUserIfV2) Unmarshal(b []byte) error

type CreateVhostUserIfV2Reply 

type CreateVhostUserIfV2Reply struct {
	Retval    int32                          `binapi:"i32,name=retval" json:"retval,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

vhost-user interface create response

  • retval - return code for the request
  • sw_if_index - interface the operation is applied to

CreateVhostUserIfV2Reply defines message 'create_vhost_user_if_v2_reply'.

func (*CreateVhostUserIfV2Reply) GetCrcString 

func (*CreateVhostUserIfV2Reply) GetCrcString() string

func (*CreateVhostUserIfV2Reply) GetMessageName 

func (*CreateVhostUserIfV2Reply) GetMessageName() string

func (*CreateVhostUserIfV2Reply) GetMessageType 

func (*CreateVhostUserIfV2Reply) GetMessageType() api.MessageType

func (*CreateVhostUserIfV2Reply) Marshal 

func (m *CreateVhostUserIfV2Reply) Marshal(b []byte) ([]byte, error)

func (*CreateVhostUserIfV2Reply) Reset 

func (m *CreateVhostUserIfV2Reply) Reset()

func (*CreateVhostUserIfV2Reply) Size 

func (m *CreateVhostUserIfV2Reply) Size() (size int)

func (*CreateVhostUserIfV2Reply) Unmarshal 

func (m *CreateVhostUserIfV2Reply) Unmarshal(b []byte) error

type DeleteVhostUserIf 

type DeleteVhostUserIf struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

vhost-user interface delete request DeleteVhostUserIf defines message 'delete_vhost_user_if'.

func (*DeleteVhostUserIf) GetCrcString 

func (*DeleteVhostUserIf) GetCrcString() string

func (*DeleteVhostUserIf) GetMessageName 

func (*DeleteVhostUserIf) GetMessageName() string

func (*DeleteVhostUserIf) GetMessageType 

func (*DeleteVhostUserIf) GetMessageType() api.MessageType

func (*DeleteVhostUserIf) Marshal 

func (m *DeleteVhostUserIf) Marshal(b []byte) ([]byte, error)

func (*DeleteVhostUserIf) Reset 

func (m *DeleteVhostUserIf) Reset()

func (*DeleteVhostUserIf) Size 

func (m *DeleteVhostUserIf) Size() (size int)

func (*DeleteVhostUserIf) Unmarshal 

func (m *DeleteVhostUserIf) Unmarshal(b []byte) error

type DeleteVhostUserIfReply 

type DeleteVhostUserIfReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

DeleteVhostUserIfReply defines message 'delete_vhost_user_if_reply'.

func (*DeleteVhostUserIfReply) GetCrcString 

func (*DeleteVhostUserIfReply) GetCrcString() string

func (*DeleteVhostUserIfReply) GetMessageName 

func (*DeleteVhostUserIfReply) GetMessageName() string

func (*DeleteVhostUserIfReply) GetMessageType 

func (*DeleteVhostUserIfReply) GetMessageType() api.MessageType

func (*DeleteVhostUserIfReply) Marshal 

func (m *DeleteVhostUserIfReply) Marshal(b []byte) ([]byte, error)

func (*DeleteVhostUserIfReply) Reset 

func (m *DeleteVhostUserIfReply) Reset()

func (*DeleteVhostUserIfReply) Size 

func (m *DeleteVhostUserIfReply) Size() (size int)

func (*DeleteVhostUserIfReply) Unmarshal 

func (m *DeleteVhostUserIfReply) Unmarshal(b []byte) error

type ModifyVhostUserIf 

type ModifyVhostUserIf struct {
	SwIfIndex         interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	IsServer          bool                           `binapi:"bool,name=is_server" json:"is_server,omitempty"`
	SockFilename      string                         `binapi:"string[256],name=sock_filename" json:"sock_filename,omitempty"`
	Renumber          bool                           `binapi:"bool,name=renumber" json:"renumber,omitempty"`
	EnableGso         bool                           `binapi:"bool,name=enable_gso" json:"enable_gso,omitempty"`
	EnablePacked      bool                           `binapi:"bool,name=enable_packed" json:"enable_packed,omitempty"`
	CustomDevInstance uint32                         `binapi:"u32,name=custom_dev_instance" json:"custom_dev_instance,omitempty"`
}

vhost-user interface modify request

  • is_server - our side is socket server
  • sock_filename - unix socket filename, used to speak with frontend
  • enable_gso - enable gso support (default 0)
  • enable_packed - enable packed ring support (default 0)

ModifyVhostUserIf defines message 'modify_vhost_user_if'. Deprecated: the message will be removed in the future versions

func (*ModifyVhostUserIf) GetCrcString 

func (*ModifyVhostUserIf) GetCrcString() string

func (*ModifyVhostUserIf) GetMessageName 

func (*ModifyVhostUserIf) GetMessageName() string

func (*ModifyVhostUserIf) GetMessageType 

func (*ModifyVhostUserIf) GetMessageType() api.MessageType

func (*ModifyVhostUserIf) Marshal 

func (m *ModifyVhostUserIf) Marshal(b []byte) ([]byte, error)

func (*ModifyVhostUserIf) Reset 

func (m *ModifyVhostUserIf) Reset()

func (*ModifyVhostUserIf) Size 

func (m *ModifyVhostUserIf) Size() (size int)

func (*ModifyVhostUserIf) Unmarshal 

func (m *ModifyVhostUserIf) Unmarshal(b []byte) error

type ModifyVhostUserIfReply 

type ModifyVhostUserIfReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

ModifyVhostUserIfReply defines message 'modify_vhost_user_if_reply'. Deprecated: the message will be removed in the future versions

func (*ModifyVhostUserIfReply) GetCrcString 

func (*ModifyVhostUserIfReply) GetCrcString() string

func (*ModifyVhostUserIfReply) GetMessageName 

func (*ModifyVhostUserIfReply) GetMessageName() string

func (*ModifyVhostUserIfReply) GetMessageType 

func (*ModifyVhostUserIfReply) GetMessageType() api.MessageType

func (*ModifyVhostUserIfReply) Marshal 

func (m *ModifyVhostUserIfReply) Marshal(b []byte) ([]byte, error)

func (*ModifyVhostUserIfReply) Reset 

func (m *ModifyVhostUserIfReply) Reset()

func (*ModifyVhostUserIfReply) Size 

func (m *ModifyVhostUserIfReply) Size() (size int)

func (*ModifyVhostUserIfReply) Unmarshal 

func (m *ModifyVhostUserIfReply) Unmarshal(b []byte) error

type ModifyVhostUserIfV2 

type ModifyVhostUserIfV2 struct {
	SwIfIndex         interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	IsServer          bool                           `binapi:"bool,name=is_server" json:"is_server,omitempty"`
	SockFilename      string                         `binapi:"string[256],name=sock_filename" json:"sock_filename,omitempty"`
	Renumber          bool                           `binapi:"bool,name=renumber" json:"renumber,omitempty"`
	EnableGso         bool                           `binapi:"bool,name=enable_gso" json:"enable_gso,omitempty"`
	EnablePacked      bool                           `binapi:"bool,name=enable_packed" json:"enable_packed,omitempty"`
	EnableEventIdx    bool                           `binapi:"bool,name=enable_event_idx" json:"enable_event_idx,omitempty"`
	CustomDevInstance uint32                         `binapi:"u32,name=custom_dev_instance" json:"custom_dev_instance,omitempty"`
}

vhost-user interface modify request

  • is_server - our side is socket server
  • sock_filename - unix socket filename, used to speak with frontend
  • enable_gso - enable gso support (default 0)
  • enable_packed - enable packed ring support (default 0)
  • enable_event_idx - enable event idx support (default 0)
  • renumber - if true, use custom_dev_instance is valid
  • custom_dev_instance - custom device instance number

ModifyVhostUserIfV2 defines message 'modify_vhost_user_if_v2'.

func (*ModifyVhostUserIfV2) GetCrcString 

func (*ModifyVhostUserIfV2) GetCrcString() string

func (*ModifyVhostUserIfV2) GetMessageName 

func (*ModifyVhostUserIfV2) GetMessageName() string

func (*ModifyVhostUserIfV2) GetMessageType 

func (*ModifyVhostUserIfV2) GetMessageType() api.MessageType

func (*ModifyVhostUserIfV2) Marshal 

func (m *ModifyVhostUserIfV2) Marshal(b []byte) ([]byte, error)

func (*ModifyVhostUserIfV2) Reset 

func (m *ModifyVhostUserIfV2) Reset()

func (*ModifyVhostUserIfV2) Size 

func (m *ModifyVhostUserIfV2) Size() (size int)

func (*ModifyVhostUserIfV2) Unmarshal 

func (m *ModifyVhostUserIfV2) Unmarshal(b []byte) error

type ModifyVhostUserIfV2Reply 

type ModifyVhostUserIfV2Reply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

ModifyVhostUserIfV2Reply defines message 'modify_vhost_user_if_v2_reply'.

func (*ModifyVhostUserIfV2Reply) GetCrcString 

func (*ModifyVhostUserIfV2Reply) GetCrcString() string

func (*ModifyVhostUserIfV2Reply) GetMessageName 

func (*ModifyVhostUserIfV2Reply) GetMessageName() string

func (*ModifyVhostUserIfV2Reply) GetMessageType 

func (*ModifyVhostUserIfV2Reply) GetMessageType() api.MessageType

func (*ModifyVhostUserIfV2Reply) Marshal 

func (m *ModifyVhostUserIfV2Reply) Marshal(b []byte) ([]byte, error)

func (*ModifyVhostUserIfV2Reply) Reset 

func (m *ModifyVhostUserIfV2Reply) Reset()

func (*ModifyVhostUserIfV2Reply) Size 

func (m *ModifyVhostUserIfV2Reply) Size() (size int)

func (*ModifyVhostUserIfV2Reply) Unmarshal 

func (m *ModifyVhostUserIfV2Reply) Unmarshal(b []byte) error

type RPCService 

type RPCService interface {
	CreateVhostUserIf(ctx context.Context, in *CreateVhostUserIf) (*CreateVhostUserIfReply, error)
	CreateVhostUserIfV2(ctx context.Context, in *CreateVhostUserIfV2) (*CreateVhostUserIfV2Reply, error)
	DeleteVhostUserIf(ctx context.Context, in *DeleteVhostUserIf) (*DeleteVhostUserIfReply, error)
	ModifyVhostUserIf(ctx context.Context, in *ModifyVhostUserIf) (*ModifyVhostUserIfReply, error)
	ModifyVhostUserIfV2(ctx context.Context, in *ModifyVhostUserIfV2) (*ModifyVhostUserIfV2Reply, error)
	SwInterfaceVhostUserDump(ctx context.Context, in *SwInterfaceVhostUserDump) (RPCService_SwInterfaceVhostUserDumpClient, error)
}

RPCService defines RPC service vhost_user.

func NewServiceClient 

func NewServiceClient(conn api.Connection) RPCService

type RPCService_SwInterfaceVhostUserDumpClient 

type RPCService_SwInterfaceVhostUserDumpClient interface {
	Recv() (*SwInterfaceVhostUserDetails, error)
	api.Stream
}

type SwInterfaceVhostUserDetails 

type SwInterfaceVhostUserDetails struct {
	SwIfIndex       interface_types.InterfaceIndex        `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	InterfaceName   string                                `binapi:"string[64],name=interface_name" json:"interface_name,omitempty"`
	VirtioNetHdrSz  uint32                                `binapi:"u32,name=virtio_net_hdr_sz" json:"virtio_net_hdr_sz,omitempty"`
	FeaturesFirst32 virtio_types.VirtioNetFeaturesFirst32 `binapi:"virtio_net_features_first_32,name=features_first_32" json:"features_first_32,omitempty"`
	FeaturesLast32  virtio_types.VirtioNetFeaturesLast32  `binapi:"virtio_net_features_last_32,name=features_last_32" json:"features_last_32,omitempty"`
	IsServer        bool                                  `binapi:"bool,name=is_server" json:"is_server,omitempty"`
	SockFilename    string                                `binapi:"string[256],name=sock_filename" json:"sock_filename,omitempty"`
	NumRegions      uint32                                `binapi:"u32,name=num_regions" json:"num_regions,omitempty"`
	SockErrno       int32                                 `binapi:"i32,name=sock_errno" json:"sock_errno,omitempty"`
}

Vhost-user interface details structure (fix this)

  • sw_if_index - index of the interface
  • interface_name - name of interface
  • virtio_net_hdr_sz - net header size
  • features_first_32 - interface features, first 32 bits
  • features_last_32 - interface features, last 32 bits
  • is_server - vhost-user server socket
  • sock_filename - socket filename
  • num_regions - number of used memory regions
  • sock_errno - socket errno

SwInterfaceVhostUserDetails defines message 'sw_interface_vhost_user_details'.

func (*SwInterfaceVhostUserDetails) GetCrcString 

func (*SwInterfaceVhostUserDetails) GetCrcString() string

func (*SwInterfaceVhostUserDetails) GetMessageName 

func (*SwInterfaceVhostUserDetails) GetMessageName() string

func (*SwInterfaceVhostUserDetails) GetMessageType 

func (*SwInterfaceVhostUserDetails) GetMessageType() api.MessageType

func (*SwInterfaceVhostUserDetails) Marshal 

func (m *SwInterfaceVhostUserDetails) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceVhostUserDetails) Reset 

func (m *SwInterfaceVhostUserDetails) Reset()

func (*SwInterfaceVhostUserDetails) Size 

func (m *SwInterfaceVhostUserDetails) Size() (size int)

func (*SwInterfaceVhostUserDetails) Unmarshal 

func (m *SwInterfaceVhostUserDetails) Unmarshal(b []byte) error

type SwInterfaceVhostUserDump 

type SwInterfaceVhostUserDump struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index,default=4294967295" json:"sw_if_index,omitempty"`
}

Vhost-user interface dump request

  • sw_if_index - filter by sw_if_index

SwInterfaceVhostUserDump defines message 'sw_interface_vhost_user_dump'.

func (*SwInterfaceVhostUserDump) GetCrcString 

func (*SwInterfaceVhostUserDump) GetCrcString() string

func (*SwInterfaceVhostUserDump) GetMessageName 

func (*SwInterfaceVhostUserDump) GetMessageName() string

func (*SwInterfaceVhostUserDump) GetMessageType 

func (*SwInterfaceVhostUserDump) GetMessageType() api.MessageType

func (*SwInterfaceVhostUserDump) Marshal 

func (m *SwInterfaceVhostUserDump) Marshal(b []byte) ([]byte, error)

func (*SwInterfaceVhostUserDump) Reset 

func (m *SwInterfaceVhostUserDump) Reset()

func (*SwInterfaceVhostUserDump) Size 

func (m *SwInterfaceVhostUserDump) Size() (size int)

func (*SwInterfaceVhostUserDump) Unmarshal 

func (m *SwInterfaceVhostUserDump) Unmarshal(b []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.