xref: /freebsd/share/man/man4/hv_storvsc.4 (revision 6c89995002b9c6d1a9c7365483c55c106fc752d5)
1fad4aec8SGlen Barber.\" $FreeBSD$
2fad4aec8SGlen Barber.\"
3fad4aec8SGlen Barber.\" Copyright (c) 2012 Microsoft Corp.
4fad4aec8SGlen Barber.\" All rights reserved.
5fad4aec8SGlen Barber.\"
6fad4aec8SGlen Barber.\" Redistribution and use in source and binary forms, with or without
7fad4aec8SGlen Barber.\" modification, are permitted provided that the following conditions
8fad4aec8SGlen Barber.\" are met:
9fad4aec8SGlen Barber.\" 1. Redistributions of source code must retain the above copyright
10fad4aec8SGlen Barber.\"    notice, this list of conditions and the following disclaimer.
11fad4aec8SGlen Barber.\" 2. Redistributions in binary form must reproduce the above copyright
12fad4aec8SGlen Barber.\"    notice, this list of conditions and the following disclaimer in the
13fad4aec8SGlen Barber.\"    documentation and/or other materials provided with the distribution.
14fad4aec8SGlen Barber.\"
15fad4aec8SGlen Barber.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16fad4aec8SGlen Barber.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17fad4aec8SGlen Barber.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18fad4aec8SGlen Barber.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19fad4aec8SGlen Barber.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20fad4aec8SGlen Barber.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21fad4aec8SGlen Barber.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22fad4aec8SGlen Barber.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23fad4aec8SGlen Barber.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24fad4aec8SGlen Barber.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25fad4aec8SGlen Barber.\" SUCH DAMAGE.
26fad4aec8SGlen Barber.\"
27fad4aec8SGlen Barber.Dd September 10, 2013
28fad4aec8SGlen Barber.Dt HYPER-V 4
29fad4aec8SGlen Barber.Os
30fad4aec8SGlen Barber.Sh NAME
31fad4aec8SGlen Barber.Nm hv_storvsc
32fad4aec8SGlen Barber.Nd Hyper-V Storage Virtual Service Consumer
33fad4aec8SGlen Barber.Sh SYNOPSIS
34fad4aec8SGlen BarberTo compile this driver into the kernel, place the following lines in
35fad4aec8SGlen Barberthe system kernel configuration file:
36fad4aec8SGlen Barber.Bd -ragged -offset indent
37fad4aec8SGlen Barber.Cd "device hyperv"
38fad4aec8SGlen Barber.Ed
39fad4aec8SGlen Barber.Sh DESCRIPTION
40fad4aec8SGlen BarberThe
41fad4aec8SGlen Barber.Nm
42fad4aec8SGlen Barberdriver implements the virtual store device for
43fad4aec8SGlen Barber.Fx
44fad4aec8SGlen Barberguest
45fad4aec8SGlen Barberpartitions running on Hyper-V.
46fad4aec8SGlen Barber.Fx
47fad4aec8SGlen Barberguest partitions running on Hyper-V do not have direct access to
48fad4aec8SGlen Barberstorage devices attached to the Hyper-V server.
49fad4aec8SGlen BarberAlthough a
50fad4aec8SGlen Barber.Fx
51fad4aec8SGlen Barberguest can access storage devices using Hyper-V's
52fad4aec8SGlen Barberfull emulation mode, the performance in this mode tends to be unsatisfactory.
53fad4aec8SGlen Barber.Pp
54fad4aec8SGlen BarberTo counter the above issues, the
55fad4aec8SGlen Barber.Nm
56fad4aec8SGlen Barberdriver implements a storage
57fad4aec8SGlen BarberVirtual
58fad4aec8SGlen BarberService Consumer (VSC) that relays storage requests from the guest partition
59fad4aec8SGlen Barberto the storage Virtual Service Provider (VSP) hosted in the root partition
60fad4aec8SGlen Barberusing the high performance data exchange infrastructure provided by
61fad4aec8SGlen Barber.Xr hv_vmbus 4
62fad4aec8SGlen Barberdriver.
63fad4aec8SGlen BarberThe VSP in the root partition then forwards the storage related requests to
64fad4aec8SGlen Barberthe physical storage device.
65fad4aec8SGlen Barber.Pp
66fad4aec8SGlen BarberThis driver functions by presenting a SCSI HBA interface to the Comman Access
67fad4aec8SGlen BarberMethod (CAM) layer.
68fad4aec8SGlen BarberCAM control blocks (CCBs) are
69fad4aec8SGlen Barberconverted into VSCSI protocol messages which are delivered to the root
70fad4aec8SGlen Barberpartition VSP over the Hyper-V VMBus.
71fad4aec8SGlen Barber.Sh SEE ALSO
72fad4aec8SGlen Barber.Xr hv_vmbus 4 ,
73fad4aec8SGlen Barber.Xr hv_utils 4 ,
74fad4aec8SGlen Barber.Xr hv_netvsc 4 ,
75fad4aec8SGlen Barber.Xr hv_ata_pci_disengage 4
76fad4aec8SGlen Barber.Sh HISTORY
77fad4aec8SGlen BarberSupport for
78fad4aec8SGlen Barber.Nm
79fad4aec8SGlen Barberfirst appeared in
80fad4aec8SGlen Barber.Fx 10.0 .
81fad4aec8SGlen BarberThe driver was developed through a joint effort between Citrix Incorporated,
82fad4aec8SGlen BarberMicrosoft Corporation, and Network Appliance Incorporated.
83fad4aec8SGlen Barber.Sh AUTHORS
84fad4aec8SGlen Barber.An -nosplit
85fad4aec8SGlen Barber.Fx
86fad4aec8SGlen Barbersupport for
87fad4aec8SGlen Barber.Nm
88fad4aec8SGlen Barberwas first added by
89*6c899950SBaptiste Daroussin.An Microsoft BSD Integration Services Team Aq Mt bsdic@microsoft.com .
90