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