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