Commit | Line | Data |
---|---|---|
3e7ee490 HJ |
1 | /* |
2 | * | |
3 | * Copyright (c) 2009, Microsoft Corporation. | |
4 | * | |
5 | * This program is free software; you can redistribute it and/or modify it | |
6 | * under the terms and conditions of the GNU General Public License, | |
7 | * version 2, as published by the Free Software Foundation. | |
8 | * | |
9 | * This program is distributed in the hope it will be useful, but WITHOUT | |
10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for | |
12 | * more details. | |
13 | * | |
14 | * You should have received a copy of the GNU General Public License along with | |
15 | * this program; if not, write to the Free Software Foundation, Inc., 59 Temple | |
16 | * Place - Suite 330, Boston, MA 02111-1307 USA. | |
17 | * | |
18 | * Authors: | |
19 | * Haiyang Zhang <haiyangz@microsoft.com> | |
20 | * Hank Janssen <hjanssen@microsoft.com> | |
b2a5a585 | 21 | * K. Y. Srinivasan <kys@microsoft.com> |
3e7ee490 HJ |
22 | * |
23 | */ | |
0a46618d | 24 | #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt |
3e7ee490 | 25 | |
a0086dc5 GKH |
26 | #include <linux/kernel.h> |
27 | #include <linux/mm.h> | |
46a97191 | 28 | #include <linux/hyperv.h> |
011a7c3c | 29 | #include <linux/uio.h> |
3f335ea2 | 30 | |
0f2a6619 | 31 | #include "hyperv_vmbus.h" |
3e7ee490 | 32 | |
6fdf3b21 S |
33 | void hv_begin_read(struct hv_ring_buffer_info *rbi) |
34 | { | |
35 | rbi->ring_buffer->interrupt_mask = 1; | |
dcd0eeca | 36 | virt_mb(); |
6fdf3b21 S |
37 | } |
38 | ||
39 | u32 hv_end_read(struct hv_ring_buffer_info *rbi) | |
40 | { | |
6fdf3b21 S |
41 | |
42 | rbi->ring_buffer->interrupt_mask = 0; | |
dcd0eeca | 43 | virt_mb(); |
6fdf3b21 S |
44 | |
45 | /* | |
46 | * Now check to see if the ring buffer is still empty. | |
47 | * If it is not, we raced and we need to process new | |
48 | * incoming messages. | |
49 | */ | |
a6341f00 | 50 | return hv_get_bytes_to_read(rbi); |
6fdf3b21 S |
51 | } |
52 | ||
98fa8cf4 S |
53 | /* |
54 | * When we write to the ring buffer, check if the host needs to | |
55 | * be signaled. Here is the details of this protocol: | |
56 | * | |
57 | * 1. The host guarantees that while it is draining the | |
58 | * ring buffer, it will set the interrupt_mask to | |
59 | * indicate it does not need to be interrupted when | |
60 | * new data is placed. | |
61 | * | |
62 | * 2. The host guarantees that it will completely drain | |
63 | * the ring buffer before exiting the read loop. Further, | |
64 | * once the ring buffer is empty, it will clear the | |
65 | * interrupt_mask and re-check to see if new data has | |
66 | * arrived. | |
67 | */ | |
68 | ||
69 | static bool hv_need_to_signal(u32 old_write, struct hv_ring_buffer_info *rbi) | |
70 | { | |
dcd0eeca | 71 | virt_mb(); |
d45faaee | 72 | if (READ_ONCE(rbi->ring_buffer->interrupt_mask)) |
98fa8cf4 S |
73 | return false; |
74 | ||
e91e84fa | 75 | /* check interrupt_mask before read_index */ |
dcd0eeca | 76 | virt_rmb(); |
98fa8cf4 S |
77 | /* |
78 | * This is the only case we need to signal when the | |
79 | * ring transitions from being empty to non-empty. | |
80 | */ | |
d45faaee | 81 | if (old_write == READ_ONCE(rbi->ring_buffer->read_index)) |
98fa8cf4 S |
82 | return true; |
83 | ||
84 | return false; | |
85 | } | |
86 | ||
822f18d4 | 87 | /* Get the next write location for the specified ring buffer. */ |
4d643114 | 88 | static inline u32 |
2b8a912e | 89 | hv_get_next_write_location(struct hv_ring_buffer_info *ring_info) |
3e7ee490 | 90 | { |
fc8c72eb | 91 | u32 next = ring_info->ring_buffer->write_index; |
3e7ee490 | 92 | |
3e7ee490 HJ |
93 | return next; |
94 | } | |
95 | ||
822f18d4 | 96 | /* Set the next write location for the specified ring buffer. */ |
3e7ee490 | 97 | static inline void |
2b8a912e | 98 | hv_set_next_write_location(struct hv_ring_buffer_info *ring_info, |
fc8c72eb | 99 | u32 next_write_location) |
3e7ee490 | 100 | { |
fc8c72eb | 101 | ring_info->ring_buffer->write_index = next_write_location; |
3e7ee490 HJ |
102 | } |
103 | ||
822f18d4 | 104 | /* Get the next read location for the specified ring buffer. */ |
4d643114 | 105 | static inline u32 |
2b8a912e | 106 | hv_get_next_read_location(struct hv_ring_buffer_info *ring_info) |
3e7ee490 | 107 | { |
fc8c72eb | 108 | u32 next = ring_info->ring_buffer->read_index; |
3e7ee490 | 109 | |
3e7ee490 HJ |
110 | return next; |
111 | } | |
112 | ||
b2a5a585 | 113 | /* |
b2a5a585 | 114 | * Get the next read location + offset for the specified ring buffer. |
822f18d4 | 115 | * This allows the caller to skip. |
b2a5a585 | 116 | */ |
4d643114 | 117 | static inline u32 |
2b8a912e | 118 | hv_get_next_readlocation_withoffset(struct hv_ring_buffer_info *ring_info, |
1ac58644 | 119 | u32 offset) |
3e7ee490 | 120 | { |
fc8c72eb | 121 | u32 next = ring_info->ring_buffer->read_index; |
3e7ee490 | 122 | |
fc8c72eb HZ |
123 | next += offset; |
124 | next %= ring_info->ring_datasize; | |
3e7ee490 HJ |
125 | |
126 | return next; | |
127 | } | |
128 | ||
822f18d4 | 129 | /* Set the next read location for the specified ring buffer. */ |
3e7ee490 | 130 | static inline void |
2b8a912e | 131 | hv_set_next_read_location(struct hv_ring_buffer_info *ring_info, |
fc8c72eb | 132 | u32 next_read_location) |
3e7ee490 | 133 | { |
fc8c72eb | 134 | ring_info->ring_buffer->read_index = next_read_location; |
3e7ee490 HJ |
135 | } |
136 | ||
822f18d4 | 137 | /* Get the size of the ring buffer. */ |
4d643114 | 138 | static inline u32 |
2b8a912e | 139 | hv_get_ring_buffersize(struct hv_ring_buffer_info *ring_info) |
3e7ee490 | 140 | { |
fc8c72eb | 141 | return ring_info->ring_datasize; |
3e7ee490 HJ |
142 | } |
143 | ||
822f18d4 | 144 | /* Get the read and write indices as u64 of the specified ring buffer. */ |
59471438 | 145 | static inline u64 |
2b8a912e | 146 | hv_get_ring_bufferindices(struct hv_ring_buffer_info *ring_info) |
3e7ee490 | 147 | { |
fc8c72eb | 148 | return (u64)ring_info->ring_buffer->write_index << 32; |
3e7ee490 HJ |
149 | } |
150 | ||
8f1136ae | 151 | /* |
8f1136ae S |
152 | * Helper routine to copy to source from ring buffer. |
153 | * Assume there is enough room. Handles wrap-around in src case only!! | |
8f1136ae S |
154 | */ |
155 | static u32 hv_copyfrom_ringbuffer( | |
156 | struct hv_ring_buffer_info *ring_info, | |
157 | void *dest, | |
158 | u32 destlen, | |
159 | u32 start_read_offset) | |
160 | { | |
161 | void *ring_buffer = hv_get_ring_buffer(ring_info); | |
162 | u32 ring_buffer_size = hv_get_ring_buffersize(ring_info); | |
163 | ||
164 | u32 frag_len; | |
165 | ||
166 | /* wrap-around detected at the src */ | |
167 | if (destlen > ring_buffer_size - start_read_offset) { | |
168 | frag_len = ring_buffer_size - start_read_offset; | |
169 | ||
170 | memcpy(dest, ring_buffer + start_read_offset, frag_len); | |
171 | memcpy(dest + frag_len, ring_buffer, destlen - frag_len); | |
172 | } else | |
173 | ||
174 | memcpy(dest, ring_buffer + start_read_offset, destlen); | |
175 | ||
176 | ||
177 | start_read_offset += destlen; | |
178 | start_read_offset %= ring_buffer_size; | |
179 | ||
180 | return start_read_offset; | |
181 | } | |
182 | ||
183 | ||
7581578d | 184 | /* |
7581578d S |
185 | * Helper routine to copy from source to ring buffer. |
186 | * Assume there is enough room. Handles wrap-around in dest case only!! | |
7581578d S |
187 | */ |
188 | static u32 hv_copyto_ringbuffer( | |
fc8c72eb HZ |
189 | struct hv_ring_buffer_info *ring_info, |
190 | u32 start_write_offset, | |
191 | void *src, | |
7581578d S |
192 | u32 srclen) |
193 | { | |
194 | void *ring_buffer = hv_get_ring_buffer(ring_info); | |
195 | u32 ring_buffer_size = hv_get_ring_buffersize(ring_info); | |
196 | u32 frag_len; | |
197 | ||
198 | /* wrap-around detected! */ | |
199 | if (srclen > ring_buffer_size - start_write_offset) { | |
200 | frag_len = ring_buffer_size - start_write_offset; | |
201 | memcpy(ring_buffer + start_write_offset, src, frag_len); | |
202 | memcpy(ring_buffer, src + frag_len, srclen - frag_len); | |
203 | } else | |
204 | memcpy(ring_buffer + start_write_offset, src, srclen); | |
3e7ee490 | 205 | |
7581578d S |
206 | start_write_offset += srclen; |
207 | start_write_offset %= ring_buffer_size; | |
208 | ||
209 | return start_write_offset; | |
210 | } | |
3e7ee490 | 211 | |
822f18d4 | 212 | /* Get various debug metrics for the specified ring buffer. */ |
a75b61d5 | 213 | void hv_ringbuffer_get_debuginfo(struct hv_ring_buffer_info *ring_info, |
80682b7a | 214 | struct hv_ring_buffer_debug_info *debug_info) |
3e7ee490 | 215 | { |
fc8c72eb HZ |
216 | u32 bytes_avail_towrite; |
217 | u32 bytes_avail_toread; | |
3e7ee490 | 218 | |
fc8c72eb | 219 | if (ring_info->ring_buffer) { |
2b8a912e | 220 | hv_get_ringbuffer_availbytes(ring_info, |
fc8c72eb HZ |
221 | &bytes_avail_toread, |
222 | &bytes_avail_towrite); | |
3e7ee490 | 223 | |
fc8c72eb HZ |
224 | debug_info->bytes_avail_toread = bytes_avail_toread; |
225 | debug_info->bytes_avail_towrite = bytes_avail_towrite; | |
82f8bd40 | 226 | debug_info->current_read_index = |
fc8c72eb | 227 | ring_info->ring_buffer->read_index; |
82f8bd40 | 228 | debug_info->current_write_index = |
fc8c72eb | 229 | ring_info->ring_buffer->write_index; |
82f8bd40 | 230 | debug_info->current_interrupt_mask = |
fc8c72eb | 231 | ring_info->ring_buffer->interrupt_mask; |
3e7ee490 HJ |
232 | } |
233 | } | |
234 | ||
822f18d4 | 235 | /* Initialize the ring buffer. */ |
72a95cbc | 236 | int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info, |
fc8c72eb | 237 | void *buffer, u32 buflen) |
3e7ee490 | 238 | { |
4a1b3acc | 239 | if (sizeof(struct hv_ring_buffer) != PAGE_SIZE) |
3324fb40 | 240 | return -EINVAL; |
3e7ee490 | 241 | |
fc8c72eb | 242 | memset(ring_info, 0, sizeof(struct hv_ring_buffer_info)); |
3e7ee490 | 243 | |
fc8c72eb HZ |
244 | ring_info->ring_buffer = (struct hv_ring_buffer *)buffer; |
245 | ring_info->ring_buffer->read_index = | |
246 | ring_info->ring_buffer->write_index = 0; | |
3e7ee490 | 247 | |
822f18d4 | 248 | /* Set the feature bit for enabling flow control. */ |
046c7911 S |
249 | ring_info->ring_buffer->feature_bits.value = 1; |
250 | ||
fc8c72eb HZ |
251 | ring_info->ring_size = buflen; |
252 | ring_info->ring_datasize = buflen - sizeof(struct hv_ring_buffer); | |
3e7ee490 | 253 | |
fc8c72eb | 254 | spin_lock_init(&ring_info->ring_lock); |
3e7ee490 HJ |
255 | |
256 | return 0; | |
257 | } | |
258 | ||
822f18d4 | 259 | /* Cleanup the ring buffer. */ |
2dba688b | 260 | void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info) |
3e7ee490 | 261 | { |
3e7ee490 HJ |
262 | } |
263 | ||
822f18d4 | 264 | /* Write to the ring buffer. */ |
633c4dce | 265 | int hv_ringbuffer_write(struct hv_ring_buffer_info *outring_info, |
fe760e4d | 266 | struct kvec *kv_list, u32 kv_count, bool *signal, bool lock) |
3e7ee490 | 267 | { |
4408f531 | 268 | int i = 0; |
fc8c72eb | 269 | u32 bytes_avail_towrite; |
fc8c72eb | 270 | u32 totalbytes_towrite = 0; |
3e7ee490 | 271 | |
66a60543 | 272 | u32 next_write_location; |
98fa8cf4 | 273 | u32 old_write; |
fc8c72eb | 274 | u64 prev_indices = 0; |
fe760e4d | 275 | unsigned long flags = 0; |
3e7ee490 | 276 | |
011a7c3c S |
277 | for (i = 0; i < kv_count; i++) |
278 | totalbytes_towrite += kv_list[i].iov_len; | |
3e7ee490 | 279 | |
fc8c72eb | 280 | totalbytes_towrite += sizeof(u64); |
3e7ee490 | 281 | |
fe760e4d S |
282 | if (lock) |
283 | spin_lock_irqsave(&outring_info->ring_lock, flags); | |
3e7ee490 | 284 | |
a6341f00 | 285 | bytes_avail_towrite = hv_get_bytes_to_write(outring_info); |
3e7ee490 | 286 | |
822f18d4 VK |
287 | /* |
288 | * If there is only room for the packet, assume it is full. | |
289 | * Otherwise, the next time around, we think the ring buffer | |
290 | * is empty since the read index == write index. | |
291 | */ | |
fc8c72eb | 292 | if (bytes_avail_towrite <= totalbytes_towrite) { |
fe760e4d S |
293 | if (lock) |
294 | spin_unlock_irqrestore(&outring_info->ring_lock, flags); | |
d2598f01 | 295 | return -EAGAIN; |
3e7ee490 HJ |
296 | } |
297 | ||
454f18a9 | 298 | /* Write to the ring buffer */ |
2b8a912e | 299 | next_write_location = hv_get_next_write_location(outring_info); |
3e7ee490 | 300 | |
98fa8cf4 S |
301 | old_write = next_write_location; |
302 | ||
011a7c3c | 303 | for (i = 0; i < kv_count; i++) { |
2b8a912e | 304 | next_write_location = hv_copyto_ringbuffer(outring_info, |
fc8c72eb | 305 | next_write_location, |
011a7c3c S |
306 | kv_list[i].iov_base, |
307 | kv_list[i].iov_len); | |
3e7ee490 HJ |
308 | } |
309 | ||
454f18a9 | 310 | /* Set previous packet start */ |
2b8a912e | 311 | prev_indices = hv_get_ring_bufferindices(outring_info); |
3e7ee490 | 312 | |
2b8a912e | 313 | next_write_location = hv_copyto_ringbuffer(outring_info, |
fc8c72eb HZ |
314 | next_write_location, |
315 | &prev_indices, | |
b219b3f7 | 316 | sizeof(u64)); |
3e7ee490 | 317 | |
98fa8cf4 | 318 | /* Issue a full memory barrier before updating the write index */ |
dcd0eeca | 319 | virt_mb(); |
3e7ee490 | 320 | |
454f18a9 | 321 | /* Now, update the write location */ |
2b8a912e | 322 | hv_set_next_write_location(outring_info, next_write_location); |
3e7ee490 | 323 | |
3e7ee490 | 324 | |
fe760e4d S |
325 | if (lock) |
326 | spin_unlock_irqrestore(&outring_info->ring_lock, flags); | |
98fa8cf4 S |
327 | |
328 | *signal = hv_need_to_signal(old_write, outring_info); | |
3e7ee490 HJ |
329 | return 0; |
330 | } | |
331 | ||
940b68e2 VK |
332 | int hv_ringbuffer_read(struct hv_ring_buffer_info *inring_info, |
333 | void *buffer, u32 buflen, u32 *buffer_actual_len, | |
334 | u64 *requestid, bool *signal, bool raw) | |
3e7ee490 | 335 | { |
fc8c72eb HZ |
336 | u32 bytes_avail_toread; |
337 | u32 next_read_location = 0; | |
338 | u64 prev_indices = 0; | |
940b68e2 VK |
339 | struct vmpacket_descriptor desc; |
340 | u32 offset; | |
341 | u32 packetlen; | |
342 | int ret = 0; | |
3e7ee490 | 343 | |
fc8c72eb | 344 | if (buflen <= 0) |
a16e1485 | 345 | return -EINVAL; |
3e7ee490 | 346 | |
3e7ee490 | 347 | |
940b68e2 VK |
348 | *buffer_actual_len = 0; |
349 | *requestid = 0; | |
350 | ||
a6341f00 | 351 | bytes_avail_toread = hv_get_bytes_to_read(inring_info); |
454f18a9 | 352 | /* Make sure there is something to read */ |
940b68e2 VK |
353 | if (bytes_avail_toread < sizeof(desc)) { |
354 | /* | |
355 | * No error is set when there is even no header, drivers are | |
356 | * supposed to analyze buffer_actual_len. | |
357 | */ | |
3eba9a77 | 358 | return ret; |
940b68e2 | 359 | } |
3e7ee490 | 360 | |
940b68e2 VK |
361 | next_read_location = hv_get_next_read_location(inring_info); |
362 | next_read_location = hv_copyfrom_ringbuffer(inring_info, &desc, | |
363 | sizeof(desc), | |
364 | next_read_location); | |
365 | ||
366 | offset = raw ? 0 : (desc.offset8 << 3); | |
367 | packetlen = (desc.len8 << 3) - offset; | |
368 | *buffer_actual_len = packetlen; | |
369 | *requestid = desc.trans_id; | |
370 | ||
3eba9a77 S |
371 | if (bytes_avail_toread < packetlen + offset) |
372 | return -EAGAIN; | |
940b68e2 | 373 | |
3eba9a77 S |
374 | if (packetlen > buflen) |
375 | return -ENOBUFS; | |
3e7ee490 | 376 | |
1ac58644 | 377 | next_read_location = |
2b8a912e | 378 | hv_get_next_readlocation_withoffset(inring_info, offset); |
3e7ee490 | 379 | |
2b8a912e | 380 | next_read_location = hv_copyfrom_ringbuffer(inring_info, |
fc8c72eb | 381 | buffer, |
940b68e2 | 382 | packetlen, |
fc8c72eb | 383 | next_read_location); |
3e7ee490 | 384 | |
2b8a912e | 385 | next_read_location = hv_copyfrom_ringbuffer(inring_info, |
fc8c72eb | 386 | &prev_indices, |
4408f531 | 387 | sizeof(u64), |
fc8c72eb | 388 | next_read_location); |
3e7ee490 | 389 | |
822f18d4 VK |
390 | /* |
391 | * Make sure all reads are done before we update the read index since | |
392 | * the writer may start writing to the read area once the read index | |
393 | * is updated. | |
394 | */ | |
dcd0eeca | 395 | virt_mb(); |
3e7ee490 | 396 | |
454f18a9 | 397 | /* Update the read index */ |
2b8a912e | 398 | hv_set_next_read_location(inring_info, next_read_location); |
3e7ee490 | 399 | |
a389fcfd | 400 | *signal = hv_need_to_signal_on_read(inring_info); |
c2b8e520 | 401 | |
940b68e2 | 402 | return ret; |
b5f53dde | 403 | } |