xref: /linux/Documentation/ABI/stable/sysfs-bus-vmbus (revision a4eb44a6435d6d8f9e642407a4a06f65eb90ca04)
1What:		/sys/bus/vmbus/hibernation
2Date:		Jan 2021
3KernelVersion:	5.12
4Contact:	Dexuan Cui <decui@microsoft.com>
5Description:	Whether the host supports hibernation for the VM.
6Users:		Daemon that sets up swap partition/file for hibernation.
7
8What:		/sys/bus/vmbus/devices/<UUID>/id
9Date:		Jul 2009
10KernelVersion:	2.6.31
11Contact:	K. Y. Srinivasan <kys@microsoft.com>
12Description:	The VMBus child_relid of the device's primary channel
13Users:		tools/hv/lsvmbus
14
15What:		/sys/bus/vmbus/devices/<UUID>/class_id
16Date:		Jul 2009
17KernelVersion:	2.6.31
18Contact:	K. Y. Srinivasan <kys@microsoft.com>
19Description:	The VMBus interface type GUID of the device
20Users:		tools/hv/lsvmbus
21
22What:		/sys/bus/vmbus/devices/<UUID>/device_id
23Date:		Jul 2009
24KernelVersion:	2.6.31
25Contact:	K. Y. Srinivasan <kys@microsoft.com>
26Description:	The VMBus interface instance GUID of the device
27Users:		tools/hv/lsvmbus
28
29What:		/sys/bus/vmbus/devices/<UUID>/channel_vp_mapping
30Date:		Jul 2015
31KernelVersion:	4.2.0
32Contact:	K. Y. Srinivasan <kys@microsoft.com>
33Description:	The mapping of which primary/sub channels are bound to which
34		Virtual Processors.
35		Format: <channel's child_relid:the bound cpu's number>
36Users:		tools/hv/lsvmbus
37
38What:		/sys/bus/vmbus/devices/<UUID>/device
39Date:		Dec. 2015
40KernelVersion:	4.5
41Contact:	K. Y. Srinivasan <kys@microsoft.com>
42Description:	The 16 bit device ID of the device
43Users:		tools/hv/lsvmbus and user level RDMA libraries
44
45What:		/sys/bus/vmbus/devices/<UUID>/vendor
46Date:		Dec. 2015
47KernelVersion:	4.5
48Contact:	K. Y. Srinivasan <kys@microsoft.com>
49Description:	The 16 bit vendor ID of the device
50Users:		tools/hv/lsvmbus and user level RDMA libraries
51
52What:		/sys/bus/vmbus/devices/<UUID>/numa_node
53Date:		Jul 2018
54KernelVersion:	4.19
55Contact:	Stephen Hemminger <sthemmin@microsoft.com>
56Description:	This NUMA node to which the VMBUS device is
57		attached, or -1 if the node is unknown.
58
59What:		/sys/bus/vmbus/devices/<UUID>/channels/<N>
60Date:		September. 2017
61KernelVersion:	4.14
62Contact:	Stephen Hemminger <sthemmin@microsoft.com>
63Description:	Directory for per-channel information
64		NN is the VMBUS relid associated with the channel.
65
66What:		/sys/bus/vmbus/devices/<UUID>/channels/<N>/cpu
67Date:		September. 2017
68KernelVersion:	4.14
69Contact:	Stephen Hemminger <sthemmin@microsoft.com>
70Description:	VCPU (sub)channel is affinitized to
71Users:		tools/hv/lsvmbus and other debugging tools
72
73What:		/sys/bus/vmbus/devices/<UUID>/channels/<N>/in_mask
74Date:		September. 2017
75KernelVersion:	4.14
76Contact:	Stephen Hemminger <sthemmin@microsoft.com>
77Description:	Host to guest channel interrupt mask
78Users:		Debugging tools
79
80What:		/sys/bus/vmbus/devices/<UUID>/channels/<N>/latency
81Date:		September. 2017
82KernelVersion:	4.14
83Contact:	Stephen Hemminger <sthemmin@microsoft.com>
84Description:	Channel signaling latency. This file is available only for
85		performance critical channels (storage, network, etc.) that use
86		the monitor page mechanism.
87Users:		Debugging tools
88
89What:		/sys/bus/vmbus/devices/<UUID>/channels/<N>/out_mask
90Date:		September. 2017
91KernelVersion:	4.14
92Contact:	Stephen Hemminger <sthemmin@microsoft.com>
93Description:	Guest to host channel interrupt mask
94Users:		Debugging tools
95
96What:		/sys/bus/vmbus/devices/<UUID>/channels/<N>/pending
97Date:		September. 2017
98KernelVersion:	4.14
99Contact:	Stephen Hemminger <sthemmin@microsoft.com>
100Description:	Channel interrupt pending state. This file is available only for
101		performance critical channels (storage, network, etc.) that use
102		the monitor page mechanism.
103Users:		Debugging tools
104
105What:		/sys/bus/vmbus/devices/<UUID>/channels/<N>/read_avail
106Date:		September. 2017
107KernelVersion:	4.14
108Contact:	Stephen Hemminger <sthemmin@microsoft.com>
109Description:	Bytes available to read
110Users:		Debugging tools
111
112What:		/sys/bus/vmbus/devices/<UUID>/channels/<N>/write_avail
113Date:		September. 2017
114KernelVersion:	4.14
115Contact:	Stephen Hemminger <sthemmin@microsoft.com>
116Description:	Bytes available to write
117Users:		Debugging tools
118
119What:		/sys/bus/vmbus/devices/<UUID>/channels/<N>/events
120Date:		September. 2017
121KernelVersion:	4.14
122Contact:	Stephen Hemminger <sthemmin@microsoft.com>
123Description:	Number of times we have signaled the host
124Users:		Debugging tools
125
126What:		/sys/bus/vmbus/devices/<UUID>/channels/<N>/interrupts
127Date:		September. 2017
128KernelVersion:	4.14
129Contact:	Stephen Hemminger <sthemmin@microsoft.com>
130Description:	Number of times we have taken an interrupt (incoming)
131Users:		Debugging tools
132
133What:		/sys/bus/vmbus/devices/<UUID>/channels/<N>/subchannel_id
134Date:		January. 2018
135KernelVersion:	4.16
136Contact:	Stephen Hemminger <sthemmin@microsoft.com>
137Description:	Subchannel ID associated with VMBUS channel
138Users:		Debugging tools and userspace drivers
139
140What:		/sys/bus/vmbus/devices/<UUID>/channels/<N>/monitor_id
141Date:		January. 2018
142KernelVersion:	4.16
143Contact:	Stephen Hemminger <sthemmin@microsoft.com>
144Description:	Monitor bit associated with channel. This file is available only
145		for performance critical channels (storage, network, etc.) that
146		use the monitor page mechanism.
147Users:		Debugging tools and userspace drivers
148
149What:		/sys/bus/vmbus/devices/<UUID>/channels/<N>/ring
150Date:		January. 2018
151KernelVersion:	4.16
152Contact:	Stephen Hemminger <sthemmin@microsoft.com>
153Description:	Binary file created by uio_hv_generic for ring buffer
154Users:		Userspace drivers
155
156What:           /sys/bus/vmbus/devices/<UUID>/channels/<N>/intr_in_full
157Date:           February 2019
158KernelVersion:  5.0
159Contact:        Michael Kelley <mikelley@microsoft.com>
160Description:    Number of guest to host interrupts caused by the inbound ring
161		buffer transitioning from full to not full while a packet is
162		waiting for buffer space to become available
163Users:          Debugging tools
164
165What:           /sys/bus/vmbus/devices/<UUID>/channels/<N>/intr_out_empty
166Date:           February 2019
167KernelVersion:  5.0
168Contact:        Michael Kelley <mikelley@microsoft.com>
169Description:    Number of guest to host interrupts caused by the outbound ring
170		buffer transitioning from empty to not empty
171Users:          Debugging tools
172
173What:           /sys/bus/vmbus/devices/<UUID>/channels/<N>/out_full_first
174Date:           February 2019
175KernelVersion:  5.0
176Contact:        Michael Kelley <mikelley@microsoft.com>
177Description:    Number of write operations that were the first to encounter an
178		outbound ring buffer full condition
179Users:          Debugging tools
180
181What:           /sys/bus/vmbus/devices/<UUID>/channels/<N>/out_full_total
182Date:           February 2019
183KernelVersion:  5.0
184Contact:        Michael Kelley <mikelley@microsoft.com>
185Description:    Total number of write operations that encountered an outbound
186		ring buffer full condition
187Users:          Debugging tools
188