1 /******************************************************************************
4 * Unified block-device I/O interface for Xen guest OSes.
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to
8 * deal in the Software without restriction, including without limitation the
9 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10 * sell copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
24 * Copyright (c) 2003-2004, Keir Fraser
25 * Copyright (c) 2012, Spectra Logic Corporation
28 #ifndef __XEN_PUBLIC_IO_BLKIF_H__
29 #define __XEN_PUBLIC_IO_BLKIF_H__
32 #include "../grant_table.h"
35 * Front->back notifications: When enqueuing a new request, sending a
36 * notification can be made conditional on req_event (i.e., the generic
37 * hold-off mechanism provided by the ring macros). Backends must set
38 * req_event appropriately (e.g., using RING_FINAL_CHECK_FOR_REQUESTS()).
40 * Back->front notifications: When enqueuing a new response, sending a
41 * notification can be made conditional on rsp_event (i.e., the generic
42 * hold-off mechanism provided by the ring macros). Frontends must set
43 * rsp_event appropriately (e.g., using RING_FINAL_CHECK_FOR_RESPONSES()).
47 #define blkif_vdev_t uint16_t
49 #define blkif_sector_t uint64_t
52 * Feature and Parameter Negotiation
53 * =================================
54 * The two halves of a Xen block driver utilize nodes within the XenStore to
55 * communicate capabilities and to negotiate operating parameters. This
56 * section enumerates these nodes which reside in the respective front and
57 * backend portions of the XenStore, following the XenBus convention.
59 * All data in the XenStore is stored as strings. Nodes specifying numeric
60 * values are encoded in decimal. Integer value ranges listed below are
61 * expressed as fixed sized integer types capable of storing the conversion
62 * of a properly formatted node string, without loss of information.
64 * Any specified default value is in effect if the corresponding XenBus node
65 * is not present in the XenStore.
67 * XenStore nodes in sections marked "PRIVATE" are solely for use by the
68 * driver side whose XenBus tree contains them.
70 * XenStore nodes marked "DEPRECATED" in their notes section should only be
71 * used to provide interoperability with legacy implementations.
73 * See the XenBus state transition diagram below for details on when XenBus
74 * nodes must be published and when they can be queried.
76 *****************************************************************************
77 * Backend XenBus Nodes
78 *****************************************************************************
80 *------------------ Backend Device Identification (PRIVATE) ------------------
83 * Values: "r" (read only), "w" (writable)
85 * The read or write access permissions to the backing store to be
86 * granted to the frontend.
91 * Data used by the backend driver to locate and configure the backing
92 * device. The format and semantics of this data vary according to the
93 * backing device in use and are outside the scope of this specification.
96 * Values: "file", "phy", "tap"
98 * The type of the backing device/object.
100 *--------------------------------- Features ---------------------------------
103 * Values: 0/1 (boolean)
106 * A value of "1" indicates that the backend can process requests
107 * containing the BLKIF_OP_WRITE_BARRIER request opcode. Requests
108 * of this type may still be returned at any time with the
109 * BLKIF_RSP_EOPNOTSUPP result code.
111 * feature-flush-cache
112 * Values: 0/1 (boolean)
115 * A value of "1" indicates that the backend can process requests
116 * containing the BLKIF_OP_FLUSH_DISKCACHE request opcode. Requests
117 * of this type may still be returned at any time with the
118 * BLKIF_RSP_EOPNOTSUPP result code.
121 * Values: 0/1 (boolean)
124 * A value of "1" indicates that the backend can process requests
125 * containing the BLKIF_OP_DISCARD request opcode. Requests
126 * of this type may still be returned at any time with the
127 * BLKIF_RSP_EOPNOTSUPP result code.
129 *----------------------- Request Transport Parameters ------------------------
131 * max-ring-page-order
136 * The maximum supported size of the request ring buffer in units of
137 * lb(machine pages). (e.g. 0 == 1 page, 1 = 2 pages, 2 == 4 pages,
143 * Notes: DEPRECATED, 2, 3
145 * The maximum supported size of the request ring buffer in units of
146 * machine pages. The value must be a power of 2.
148 * max-requests <uint32_t>
149 * Default Value: BLKIF_MAX_RING_REQUESTS(PAGE_SIZE)
150 * Maximum Value: BLKIF_MAX_RING_REQUESTS(PAGE_SIZE * max-ring-pages)
152 * The maximum number of concurrent, logical requests supported by
155 * Note: A logical request may span multiple ring entries.
157 * max-request-segments
159 * Default Value: BLKIF_MAX_SEGMENTS_PER_HEADER_BLOCK
160 * Maximum Value: BLKIF_MAX_SEGMENTS_PER_REQUEST
162 * The maximum value of blkif_request.nr_segments supported by
167 * Default Value: BLKIF_MAX_SEGMENTS_PER_HEADER_BLOCK * PAGE_SIZE
168 * Maximum Value: BLKIF_MAX_SEGMENTS_PER_REQUEST * PAGE_SIZE
170 * The maximum amount of data, in bytes, that can be referenced by a
171 * request type that accesses frontend memory (currently BLKIF_OP_READ,
172 * BLKIF_OP_WRITE, or BLKIF_OP_WRITE_BARRIER).
174 *------------------------- Backend Device Properties -------------------------
181 * The offset, in bytes from the beginning of the virtual block device,
182 * to the first, addressable, discard extent on the underlying device.
184 * discard-granularity
186 * Default Value: <"sector-size">
189 * The size, in bytes, of the individually addressable discard extents
190 * of the underlying device.
193 * Values: 0/1 (boolean)
196 * A value of "1" indicates that the backend can process BLKIF_OP_DISCARD
197 * requests with the BLKIF_DISCARD_SECURE flag set.
200 * Values: <uint32_t> (bitmap)
202 * A collection of bit flags describing attributes of the backing
203 * device. The VDISK_* macros define the meaning of each bit
209 * The size, in bytes, of the individually addressible data blocks
210 * on the backend device.
215 * The size of the backend device, expressed in units of its native
216 * sector size ("sector-size").
218 *****************************************************************************
219 * Frontend XenBus Nodes
220 *****************************************************************************
222 *----------------------- Request Transport Parameters -----------------------
227 * The identifier of the Xen event channel used to signal activity
228 * in the ring buffer.
234 * The Xen grant reference granting permission for the backend to map
235 * the sole page in a single page sized ring buffer.
241 * For a frontend providing a multi-page ring, a "number of ring pages"
242 * sized list of nodes, each containing a Xen grant reference granting
243 * permission for the backend to map the page of the ring located
244 * at page index "%u". Page indexes are zero based.
247 * Values: string (XEN_IO_PROTO_ABI_*)
248 * Default Value: XEN_IO_PROTO_ABI_NATIVE
250 * The machine ABI rules governing the format of all ring request and
251 * response structures.
256 * Maximum Value: MAX(ffs(max-ring-pages) - 1, max-ring-page-order)
259 * The size of the frontend allocated request ring buffer in units
260 * of lb(machine pages). (e.g. 0 == 1 page, 1 = 2 pages, 2 == 4 pages,
266 * Maximum Value: MAX(max-ring-pages,(0x1 << max-ring-page-order))
267 * Notes: DEPRECATED, 2, 3
269 * The size of the frontend allocated request ring buffer in units of
270 * machine pages. The value must be a power of 2.
274 * Default Value: BLKIF_MAX_RING_REQUESTS(PAGE_SIZE)
275 * Maximum Value: BLKIF_MAX_RING_REQUESTS(PAGE_SIZE * max-ring-pages)
277 * The maximum number of concurrent, logical requests that will be
278 * issued by the frontend.
280 * Note: A logical request may span multiple ring entries.
282 * max-request-segments
284 * Default Value: BLKIF_MAX_SEGMENTS_PER_HEADER_BLOCK
285 * Maximum Value: MIN(255, backend/max-request-segments)
287 * The maximum value the frontend will set in the
288 * blkif_request.nr_segments field.
292 * Default Value: BLKIF_MAX_SEGMENTS_PER_HEADER_BLOCK * PAGE_SIZE
293 * Maximum Value: max-request-segments * PAGE_SIZE
295 * The maximum amount of data, in bytes, that can be referenced by
296 * a request type that accesses frontend memory (currently BLKIF_OP_READ,
297 * BLKIF_OP_WRITE, or BLKIF_OP_WRITE_BARRIER).
299 *------------------------- Virtual Device Properties -------------------------
302 * Values: "disk", "cdrom", "floppy", etc.
307 * A value indicating the physical device to virtualize within the
308 * frontend's domain. (e.g. "The first ATA disk", "The third SCSI
311 * See docs/misc/vbd-interface.txt for details on the format of this
316 * (1) Multi-page ring buffer scheme first developed in the Citrix XenServer
318 * (2) Multi-page ring buffer scheme first used in some Red Hat distributions
319 * including a distribution deployed on certain nodes of the Amazon
321 * (3) Support for multi-page ring buffers was implemented independently,
322 * in slightly different forms, by both Citrix and Red Hat/Amazon.
323 * For full interoperability, block front and backends should publish
324 * identical ring parameters, adjusted for unit differences, to the
325 * XenStore nodes used in both schemes.
326 * (4) Devices that support discard functionality may internally allocate
327 * space (discardable extents) in units that are larger than the
328 * exported logical block size.
329 * (5) The discard-alignment parameter allows a physical device to be
330 * partitioned into virtual devices that do not necessarily begin or
331 * end on a discardable extent boundary.
332 * (6) When there is only a single page allocated to the request ring,
333 * 'ring-ref' is used to communicate the grant reference for this
334 * page to the backend. When using a multi-page ring, the 'ring-ref'
335 * node is not created. Instead 'ring-ref0' - 'ring-refN' are used.
341 *****************************************************************************
343 *****************************************************************************
345 * Tool stack creates front and back nodes with state XenbusStateInitialising.
348 * ================================= =====================================
349 * XenbusStateInitialising XenbusStateInitialising
350 * o Query virtual device o Query backend device identification
352 * o Setup OS device instance. o Open and validate backend device.
353 * o Publish backend features and
354 * transport parameters.
358 * XenbusStateInitWait
360 * o Query backend features and
361 * transport parameters.
362 * o Allocate and initialize the
364 * o Publish transport parameters
365 * that will be in effect during
370 * XenbusStateInitialised
372 * o Query frontend transport parameters.
373 * o Connect to the request ring and
375 * o Publish backend device properties.
379 * XenbusStateConnected
381 * o Query backend device properties.
382 * o Finalize OS virtual device
387 * XenbusStateConnected
389 * Note: Drivers that do not support any optional features, or the negotiation
390 * of transport parameters, can skip certain states in the state machine:
392 * o A frontend may transition to XenbusStateInitialised without
393 * waiting for the backend to enter XenbusStateInitWait. In this
394 * case, default transport parameters are in effect and any
395 * transport parameters published by the frontend must contain
396 * their default values.
398 * o A backend may transition to XenbusStateInitialised, bypassing
399 * XenbusStateInitWait, without waiting for the frontend to first
400 * enter the XenbusStateInitialised state. In this case, default
401 * transport parameters are in effect and any transport parameters
402 * published by the backend must contain their default values.
404 * Drivers that support optional features and/or transport parameter
405 * negotiation must tolerate these additional state transition paths.
406 * In general this means performing the work of any skipped state
407 * transition, if it has not already been performed, in addition to the
408 * work associated with entry into the current state.
414 #define BLKIF_OP_READ 0
415 #define BLKIF_OP_WRITE 1
417 * All writes issued prior to a request with the BLKIF_OP_WRITE_BARRIER
418 * operation code ("barrier request") must be completed prior to the
419 * execution of the barrier request. All writes issued after the barrier
420 * request must not execute until after the completion of the barrier request.
422 * Optional. See "feature-barrier" XenBus node documentation above.
424 #define BLKIF_OP_WRITE_BARRIER 2
426 * Commit any uncommitted contents of the backing device's volatile cache
429 * Optional. See "feature-flush-cache" XenBus node documentation above.
431 #define BLKIF_OP_FLUSH_DISKCACHE 3
433 * Used in SLES sources for device specific command packet
434 * contained within the request. Reserved for that purpose.
436 #define BLKIF_OP_RESERVED_1 4
438 * Indicate to the backend device that a region of storage is no longer in
439 * use, and may be discarded at any time without impact to the client. If
440 * the BLKIF_DISCARD_SECURE flag is set on the request, all copies of the
441 * discarded region on the device must be rendered unrecoverable before the
444 * This operation is analogous to performing a trim (ATA) or unmap (SCSI),
445 * command on a native device.
447 * More information about trim/unmap operations can be found at:
448 * http://t13.org/Documents/UploadedDocuments/docs2008/
449 * e07154r6-Data_Set_Management_Proposal_for_ATA-ACS2.doc
450 * http://www.seagate.com/staticfiles/support/disc/manuals/
451 * Interface%20manuals/100293068c.pdf
453 * Optional. See "feature-discard", "discard-alignment",
454 * "discard-granularity", and "discard-secure" in the XenBus node
455 * documentation above.
457 #define BLKIF_OP_DISCARD 5
460 * Maximum scatter/gather segments per request (header + segment blocks).
462 #define BLKIF_MAX_SEGMENTS_PER_REQUEST 11
465 * NB. first_sect and last_sect in blkif_request_segment, as well as
466 * sector_number in blkif_request, are always expressed in 512-byte units.
467 * However they must be properly aligned to the real sector size of the
468 * physical disk, which is reported in the "sector-size" node in the backend
469 * xenbus info. Also the xenbus "sectors" node is expressed in 512-byte units.
471 struct blkif_request_segment {
472 grant_ref_t gref; /* reference to I/O buffer frame */
473 /* @first_sect: first sector in frame to transfer (inclusive). */
474 /* @last_sect: last sector in frame to transfer (inclusive). */
475 uint8_t first_sect, last_sect;
477 typedef struct blkif_request_segment blkif_request_segment_t;
480 * Starting ring element for any I/O request.
482 * One or more segment blocks can be inserted into the request ring
483 * just after a blkif_request_t, allowing requests to operate on
484 * up to BLKIF_MAX_SEGMENTS_PER_REQUEST.
486 * BLKIF_SEGS_TO_BLOCKS() can be used on blkif_requst.nr_segments
487 * to determine the number of contiguous ring entries associated
490 * Note: Due to the way Xen request rings operate, the producer and
491 * consumer indices of the ring must be incremented by the
492 * BLKIF_SEGS_TO_BLOCKS() value of the associated request.
493 * (e.g. a response to a 3 ring entry request must also consume
494 * 3 entries in the ring, even though only the first ring entry
495 * in the response has any data.)
497 struct blkif_request {
498 uint8_t operation; /* BLKIF_OP_??? */
499 uint8_t nr_segments; /* number of segments */
500 blkif_vdev_t handle; /* only for read/write requests */
501 uint64_t id; /* private guest value, echoed in resp */
502 blkif_sector_t sector_number;/* start sector idx on disk (r/w only) */
503 blkif_request_segment_t seg[BLKIF_MAX_SEGMENTS_PER_REQUEST];
505 typedef struct blkif_request blkif_request_t;
508 * Cast to this structure when blkif_request.operation == BLKIF_OP_DISCARD
509 * sizeof(struct blkif_request_discard) <= sizeof(struct blkif_request)
511 struct blkif_request_discard {
512 uint8_t operation; /* BLKIF_OP_DISCARD */
513 uint8_t flag; /* BLKIF_DISCARD_SECURE or zero */
514 #define BLKIF_DISCARD_SECURE (1<<0) /* ignored if discard-secure=0 */
515 blkif_vdev_t handle; /* same as for read/write requests */
516 uint64_t id; /* private guest value, echoed in resp */
517 blkif_sector_t sector_number;/* start sector idx on disk */
518 uint64_t nr_sectors; /* number of contiguous sectors to discard*/
520 typedef struct blkif_request_discard blkif_request_discard_t;
522 struct blkif_response {
523 uint64_t id; /* copied from request */
524 uint8_t operation; /* copied from request */
525 int16_t status; /* BLKIF_RSP_??? */
527 typedef struct blkif_response blkif_response_t;
530 * STATUS RETURN CODES.
532 /* Operation not supported (only happens on barrier writes). */
533 #define BLKIF_RSP_EOPNOTSUPP -2
534 /* Operation failed for some unspecified reason (-EIO). */
535 #define BLKIF_RSP_ERROR -1
536 /* Operation completed successfully. */
537 #define BLKIF_RSP_OKAY 0
540 * Generate blkif ring structures and types.
542 DEFINE_RING_TYPES(blkif, struct blkif_request, struct blkif_response);
544 #define VDISK_CDROM 0x1
545 #define VDISK_REMOVABLE 0x2
546 #define VDISK_READONLY 0x4
548 #endif /* __XEN_PUBLIC_IO_BLKIF_H__ */
556 * indent-tabs-mode: nil