Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures
virtio.h File Reference
#include <linux/types.h>
#include <linux/scatterlist.h>
#include <linux/spinlock.h>
#include <linux/device.h>
#include <linux/mod_devicetable.h>
#include <linux/gfp.h>

Go to the source code of this file.

Data Structures

struct  virtqueue
 
struct  virtio_device
 
struct  virtio_driver
 

: the name of this virtqueue (mainly for debugging)

virtqueue - a queue to register buffers for sending or receiving. : the chain of virtqueues for this device : the function to call when buffers are consumed (can be NULL).

: the virtio device this queue was created for. : a pointer for the virtqueue implementation to use.

#define dev_to_virtio(dev)   container_of(dev, struct virtio_device, dev)
 
int virtqueue_add_buf (struct virtqueue *vq, struct scatterlist sg[], unsigned int out_num, unsigned int in_num, void *data, gfp_t gfp)
 
void virtqueue_kick (struct virtqueue *vq)
 
bool virtqueue_kick_prepare (struct virtqueue *vq)
 
void virtqueue_notify (struct virtqueue *vq)
 
voidvirtqueue_get_buf (struct virtqueue *vq, unsigned int *len)
 
void virtqueue_disable_cb (struct virtqueue *vq)
 
bool virtqueue_enable_cb (struct virtqueue *vq)
 
bool virtqueue_enable_cb_delayed (struct virtqueue *vq)
 
voidvirtqueue_detach_unused_buf (struct virtqueue *vq)
 
unsigned int virtqueue_get_vring_size (struct virtqueue *vq)
 
int virtqueue_get_queue_index (struct virtqueue *vq)
 
int register_virtio_device (struct virtio_device *dev)
 
void unregister_virtio_device (struct virtio_device *dev)
 
int register_virtio_driver (struct virtio_driver *drv)
 
void unregister_virtio_driver (struct virtio_driver *drv)
 

Macro Definition Documentation

#define dev_to_virtio (   dev)    container_of(dev, struct virtio_device, dev)

Definition at line 76 of file virtio.h.

Function Documentation

int register_virtio_device ( struct virtio_device dev)

Definition at line 193 of file virtio.c.

int register_virtio_driver ( struct virtio_driver drv)

Definition at line 178 of file virtio.c.

void unregister_virtio_device ( struct virtio_device dev)

Definition at line 226 of file virtio.c.

void unregister_virtio_driver ( struct virtio_driver drv)

Definition at line 187 of file virtio.c.

int virtqueue_add_buf ( struct virtqueue _vq,
struct scatterlist  sg[],
unsigned int  out,
unsigned int  in,
void data,
gfp_t  gfp 
)

virtqueue_add_buf - expose buffer to other end : the struct virtqueue we're talking about. : the description of the buffer(s). : the number of sg readable by other side : the number of sg which are writable (after readable ones) : the token identifying the buffer. : how to do memory allocations (if necessary).

Caller must ensure we don't call this with other virtqueue operations at the same time (except where noted).

Returns remaining capacity of queue or a negative error (ie. ENOSPC). Note that it only really makes sense to treat all positive return values as "available": indirect buffers mean that we can put an entire sg[] array inside a single queue entry.

Definition at line 201 of file virtio_ring.c.

void* virtqueue_detach_unused_buf ( struct virtqueue _vq)

virtqueue_detach_unused_buf - detach first unused buffer : the struct virtqueue we're talking about.

Returns NULL or the "data" token handed to virtqueue_add_buf(). This is not valid on an active queue; it is useful only for device shutdown.

Definition at line 583 of file virtio_ring.c.

void virtqueue_disable_cb ( struct virtqueue _vq)

virtqueue_disable_cb - disable callbacks : the struct virtqueue we're talking about.

Note that this is not necessarily synchronous, hence unreliable and only useful as an optimization.

Unlike other operations, this need not be serialized.

Definition at line 492 of file virtio_ring.c.

bool virtqueue_enable_cb ( struct virtqueue _vq)

virtqueue_enable_cb - restart callbacks after disable_cb. : the struct virtqueue we're talking about.

This re-enables callbacks; it returns "false" if there are pending buffers in the queue, to detect a possible race between the driver checking for more work, and enabling callbacks.

Caller must ensure we don't call this with other virtqueue operations at the same time (except where noted).

Definition at line 511 of file virtio_ring.c.

bool virtqueue_enable_cb_delayed ( struct virtqueue _vq)

virtqueue_enable_cb_delayed - restart callbacks after disable_cb. : the struct virtqueue we're talking about.

This re-enables callbacks but hints to the other side to delay interrupts until most of the available buffers have been processed; it returns "false" if there are many pending buffers in the queue, to detect a possible race between the driver checking for more work, and enabling callbacks.

Caller must ensure we don't call this with other virtqueue operations at the same time (except where noted).

Definition at line 548 of file virtio_ring.c.

void* virtqueue_get_buf ( struct virtqueue _vq,
unsigned int len 
)

virtqueue_get_buf - get the next used buffer : the struct virtqueue we're talking about. : the length written into the buffer

If the driver wrote data into the buffer, will be set to the amount written. This means you don't need to clear the buffer beforehand to ensure there's no data leakage in the case of short writes.

Caller must ensure we don't call this with other virtqueue operations at the same time (except where noted).

Returns NULL if there are no used buffers, or the "data" token handed to virtqueue_add_buf().

Definition at line 426 of file virtio_ring.c.

int virtqueue_get_queue_index ( struct virtqueue vq)

Definition at line 177 of file virtio_ring.c.

unsigned int virtqueue_get_vring_size ( struct virtqueue _vq)

virtqueue_get_vring_size - return the size of the virtqueue's vring : the struct virtqueue containing the vring of interest.

Returns the size of the vring. This is mainly used for boasting to userspace. Unlike other operations, this need not be serialized.

Definition at line 721 of file virtio_ring.c.

void virtqueue_kick ( struct virtqueue vq)

virtqueue_kick - update after add_buf : the struct virtqueue

After one or more virtqueue_add_buf calls, invoke this to kick the other side.

Caller must ensure we don't call this with other virtqueue operations at the same time (except where noted).

Definition at line 373 of file virtio_ring.c.

bool virtqueue_kick_prepare ( struct virtqueue _vq)

virtqueue_kick_prepare - first half of split virtqueue_kick call. : the struct virtqueue

Instead of virtqueue_kick(), you can do: if (virtqueue_kick_prepare(vq)) virtqueue_notify(vq);

This is sometimes useful because the virtqueue_kick_prepare() needs to be serialized, but the actual virtqueue_notify() call does not.

Definition at line 314 of file virtio_ring.c.

void virtqueue_notify ( struct virtqueue _vq)

virtqueue_notify - second half of split virtqueue_kick call. : the struct virtqueue

This does not need to be serialized.

Definition at line 354 of file virtio_ring.c.