]>
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> |
9988ce68 VK |
30 | #include <linux/vmalloc.h> |
31 | #include <linux/slab.h> | |
3f335ea2 | 32 | |
0f2a6619 | 33 | #include "hyperv_vmbus.h" |
3e7ee490 | 34 | |
6fdf3b21 S |
35 | void hv_begin_read(struct hv_ring_buffer_info *rbi) |
36 | { | |
37 | rbi->ring_buffer->interrupt_mask = 1; | |
dcd0eeca | 38 | virt_mb(); |
6fdf3b21 S |
39 | } |
40 | ||
41 | u32 hv_end_read(struct hv_ring_buffer_info *rbi) | |
42 | { | |
6fdf3b21 S |
43 | |
44 | rbi->ring_buffer->interrupt_mask = 0; | |
dcd0eeca | 45 | virt_mb(); |
6fdf3b21 S |
46 | |
47 | /* | |
48 | * Now check to see if the ring buffer is still empty. | |
49 | * If it is not, we raced and we need to process new | |
50 | * incoming messages. | |
51 | */ | |
a6341f00 | 52 | return hv_get_bytes_to_read(rbi); |
6fdf3b21 S |
53 | } |
54 | ||
98fa8cf4 S |
55 | /* |
56 | * When we write to the ring buffer, check if the host needs to | |
57 | * be signaled. Here is the details of this protocol: | |
58 | * | |
59 | * 1. The host guarantees that while it is draining the | |
60 | * ring buffer, it will set the interrupt_mask to | |
61 | * indicate it does not need to be interrupted when | |
62 | * new data is placed. | |
63 | * | |
64 | * 2. The host guarantees that it will completely drain | |
65 | * the ring buffer before exiting the read loop. Further, | |
66 | * once the ring buffer is empty, it will clear the | |
67 | * interrupt_mask and re-check to see if new data has | |
68 | * arrived. | |
69 | */ | |
70 | ||
ccef9bcc S |
71 | static bool hv_need_to_signal(u32 old_write, struct hv_ring_buffer_info *rbi, |
72 | enum hv_signal_policy policy) | |
98fa8cf4 | 73 | { |
dcd0eeca | 74 | virt_mb(); |
d45faaee | 75 | if (READ_ONCE(rbi->ring_buffer->interrupt_mask)) |
98fa8cf4 S |
76 | return false; |
77 | ||
ccef9bcc S |
78 | /* |
79 | * When the client wants to control signaling, | |
80 | * we only honour the host interrupt mask. | |
81 | */ | |
82 | if (policy == HV_SIGNAL_POLICY_EXPLICIT) | |
83 | return true; | |
84 | ||
e91e84fa | 85 | /* check interrupt_mask before read_index */ |
dcd0eeca | 86 | virt_rmb(); |
98fa8cf4 S |
87 | /* |
88 | * This is the only case we need to signal when the | |
89 | * ring transitions from being empty to non-empty. | |
90 | */ | |
d45faaee | 91 | if (old_write == READ_ONCE(rbi->ring_buffer->read_index)) |
98fa8cf4 S |
92 | return true; |
93 | ||
94 | return false; | |
95 | } | |
96 | ||
822f18d4 | 97 | /* Get the next write location for the specified ring buffer. */ |
4d643114 | 98 | static inline u32 |
2b8a912e | 99 | hv_get_next_write_location(struct hv_ring_buffer_info *ring_info) |
3e7ee490 | 100 | { |
fc8c72eb | 101 | u32 next = ring_info->ring_buffer->write_index; |
3e7ee490 | 102 | |
3e7ee490 HJ |
103 | return next; |
104 | } | |
105 | ||
822f18d4 | 106 | /* Set the next write location for the specified ring buffer. */ |
3e7ee490 | 107 | static inline void |
2b8a912e | 108 | hv_set_next_write_location(struct hv_ring_buffer_info *ring_info, |
fc8c72eb | 109 | u32 next_write_location) |
3e7ee490 | 110 | { |
fc8c72eb | 111 | ring_info->ring_buffer->write_index = next_write_location; |
3e7ee490 HJ |
112 | } |
113 | ||
822f18d4 | 114 | /* Get the next read location for the specified ring buffer. */ |
4d643114 | 115 | static inline u32 |
2b8a912e | 116 | hv_get_next_read_location(struct hv_ring_buffer_info *ring_info) |
3e7ee490 | 117 | { |
fc8c72eb | 118 | u32 next = ring_info->ring_buffer->read_index; |
3e7ee490 | 119 | |
3e7ee490 HJ |
120 | return next; |
121 | } | |
122 | ||
b2a5a585 | 123 | /* |
b2a5a585 | 124 | * Get the next read location + offset for the specified ring buffer. |
822f18d4 | 125 | * This allows the caller to skip. |
b2a5a585 | 126 | */ |
4d643114 | 127 | static inline u32 |
2b8a912e | 128 | hv_get_next_readlocation_withoffset(struct hv_ring_buffer_info *ring_info, |
1ac58644 | 129 | u32 offset) |
3e7ee490 | 130 | { |
fc8c72eb | 131 | u32 next = ring_info->ring_buffer->read_index; |
3e7ee490 | 132 | |
fc8c72eb HZ |
133 | next += offset; |
134 | next %= ring_info->ring_datasize; | |
3e7ee490 HJ |
135 | |
136 | return next; | |
137 | } | |
138 | ||
822f18d4 | 139 | /* Set the next read location for the specified ring buffer. */ |
3e7ee490 | 140 | static inline void |
2b8a912e | 141 | hv_set_next_read_location(struct hv_ring_buffer_info *ring_info, |
fc8c72eb | 142 | u32 next_read_location) |
3e7ee490 | 143 | { |
fc8c72eb | 144 | ring_info->ring_buffer->read_index = next_read_location; |
ab028db4 | 145 | ring_info->priv_read_index = next_read_location; |
3e7ee490 HJ |
146 | } |
147 | ||
822f18d4 | 148 | /* Get the size of the ring buffer. */ |
4d643114 | 149 | static inline u32 |
2b8a912e | 150 | hv_get_ring_buffersize(struct hv_ring_buffer_info *ring_info) |
3e7ee490 | 151 | { |
fc8c72eb | 152 | return ring_info->ring_datasize; |
3e7ee490 HJ |
153 | } |
154 | ||
822f18d4 | 155 | /* Get the read and write indices as u64 of the specified ring buffer. */ |
59471438 | 156 | static inline u64 |
2b8a912e | 157 | hv_get_ring_bufferindices(struct hv_ring_buffer_info *ring_info) |
3e7ee490 | 158 | { |
fc8c72eb | 159 | return (u64)ring_info->ring_buffer->write_index << 32; |
3e7ee490 HJ |
160 | } |
161 | ||
8f1136ae | 162 | /* |
8f1136ae S |
163 | * Helper routine to copy to source from ring buffer. |
164 | * Assume there is enough room. Handles wrap-around in src case only!! | |
8f1136ae S |
165 | */ |
166 | static u32 hv_copyfrom_ringbuffer( | |
167 | struct hv_ring_buffer_info *ring_info, | |
168 | void *dest, | |
169 | u32 destlen, | |
170 | u32 start_read_offset) | |
171 | { | |
172 | void *ring_buffer = hv_get_ring_buffer(ring_info); | |
173 | u32 ring_buffer_size = hv_get_ring_buffersize(ring_info); | |
174 | ||
f24f0b49 | 175 | memcpy(dest, ring_buffer + start_read_offset, destlen); |
8f1136ae S |
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); | |
f24f0b49 VK |
196 | |
197 | memcpy(ring_buffer + start_write_offset, src, srclen); | |
3e7ee490 | 198 | |
7581578d S |
199 | start_write_offset += srclen; |
200 | start_write_offset %= ring_buffer_size; | |
201 | ||
202 | return start_write_offset; | |
203 | } | |
3e7ee490 | 204 | |
822f18d4 | 205 | /* Get various debug metrics for the specified ring buffer. */ |
a75b61d5 | 206 | void hv_ringbuffer_get_debuginfo(struct hv_ring_buffer_info *ring_info, |
80682b7a | 207 | struct hv_ring_buffer_debug_info *debug_info) |
3e7ee490 | 208 | { |
fc8c72eb HZ |
209 | u32 bytes_avail_towrite; |
210 | u32 bytes_avail_toread; | |
3e7ee490 | 211 | |
fc8c72eb | 212 | if (ring_info->ring_buffer) { |
2b8a912e | 213 | hv_get_ringbuffer_availbytes(ring_info, |
fc8c72eb HZ |
214 | &bytes_avail_toread, |
215 | &bytes_avail_towrite); | |
3e7ee490 | 216 | |
fc8c72eb HZ |
217 | debug_info->bytes_avail_toread = bytes_avail_toread; |
218 | debug_info->bytes_avail_towrite = bytes_avail_towrite; | |
82f8bd40 | 219 | debug_info->current_read_index = |
fc8c72eb | 220 | ring_info->ring_buffer->read_index; |
82f8bd40 | 221 | debug_info->current_write_index = |
fc8c72eb | 222 | ring_info->ring_buffer->write_index; |
82f8bd40 | 223 | debug_info->current_interrupt_mask = |
fc8c72eb | 224 | ring_info->ring_buffer->interrupt_mask; |
3e7ee490 HJ |
225 | } |
226 | } | |
227 | ||
822f18d4 | 228 | /* Initialize the ring buffer. */ |
72a95cbc | 229 | int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info, |
9988ce68 | 230 | struct page *pages, u32 page_cnt) |
3e7ee490 | 231 | { |
9988ce68 VK |
232 | int i; |
233 | struct page **pages_wraparound; | |
234 | ||
235 | BUILD_BUG_ON((sizeof(struct hv_ring_buffer) != PAGE_SIZE)); | |
3e7ee490 | 236 | |
fc8c72eb | 237 | memset(ring_info, 0, sizeof(struct hv_ring_buffer_info)); |
3e7ee490 | 238 | |
9988ce68 VK |
239 | /* |
240 | * First page holds struct hv_ring_buffer, do wraparound mapping for | |
241 | * the rest. | |
242 | */ | |
243 | pages_wraparound = kzalloc(sizeof(struct page *) * (page_cnt * 2 - 1), | |
244 | GFP_KERNEL); | |
245 | if (!pages_wraparound) | |
246 | return -ENOMEM; | |
247 | ||
248 | pages_wraparound[0] = pages; | |
249 | for (i = 0; i < 2 * (page_cnt - 1); i++) | |
250 | pages_wraparound[i + 1] = &pages[i % (page_cnt - 1) + 1]; | |
251 | ||
252 | ring_info->ring_buffer = (struct hv_ring_buffer *) | |
253 | vmap(pages_wraparound, page_cnt * 2 - 1, VM_MAP, PAGE_KERNEL); | |
254 | ||
255 | kfree(pages_wraparound); | |
256 | ||
257 | ||
258 | if (!ring_info->ring_buffer) | |
259 | return -ENOMEM; | |
260 | ||
fc8c72eb HZ |
261 | ring_info->ring_buffer->read_index = |
262 | ring_info->ring_buffer->write_index = 0; | |
3e7ee490 | 263 | |
822f18d4 | 264 | /* Set the feature bit for enabling flow control. */ |
046c7911 S |
265 | ring_info->ring_buffer->feature_bits.value = 1; |
266 | ||
9988ce68 VK |
267 | ring_info->ring_size = page_cnt << PAGE_SHIFT; |
268 | ring_info->ring_datasize = ring_info->ring_size - | |
269 | sizeof(struct hv_ring_buffer); | |
3e7ee490 | 270 | |
fc8c72eb | 271 | spin_lock_init(&ring_info->ring_lock); |
3e7ee490 HJ |
272 | |
273 | return 0; | |
274 | } | |
275 | ||
822f18d4 | 276 | /* Cleanup the ring buffer. */ |
2dba688b | 277 | void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info) |
3e7ee490 | 278 | { |
9988ce68 | 279 | vunmap(ring_info->ring_buffer); |
3e7ee490 HJ |
280 | } |
281 | ||
822f18d4 | 282 | /* Write to the ring buffer. */ |
633c4dce | 283 | int hv_ringbuffer_write(struct hv_ring_buffer_info *outring_info, |
ccef9bcc S |
284 | struct kvec *kv_list, u32 kv_count, bool *signal, bool lock, |
285 | enum hv_signal_policy policy) | |
3e7ee490 | 286 | { |
4408f531 | 287 | int i = 0; |
fc8c72eb | 288 | u32 bytes_avail_towrite; |
fc8c72eb | 289 | u32 totalbytes_towrite = 0; |
3e7ee490 | 290 | |
66a60543 | 291 | u32 next_write_location; |
98fa8cf4 | 292 | u32 old_write; |
fc8c72eb | 293 | u64 prev_indices = 0; |
fe760e4d | 294 | unsigned long flags = 0; |
3e7ee490 | 295 | |
011a7c3c S |
296 | for (i = 0; i < kv_count; i++) |
297 | totalbytes_towrite += kv_list[i].iov_len; | |
3e7ee490 | 298 | |
fc8c72eb | 299 | totalbytes_towrite += sizeof(u64); |
3e7ee490 | 300 | |
fe760e4d S |
301 | if (lock) |
302 | spin_lock_irqsave(&outring_info->ring_lock, flags); | |
3e7ee490 | 303 | |
a6341f00 | 304 | bytes_avail_towrite = hv_get_bytes_to_write(outring_info); |
3e7ee490 | 305 | |
822f18d4 VK |
306 | /* |
307 | * If there is only room for the packet, assume it is full. | |
308 | * Otherwise, the next time around, we think the ring buffer | |
309 | * is empty since the read index == write index. | |
310 | */ | |
fc8c72eb | 311 | if (bytes_avail_towrite <= totalbytes_towrite) { |
fe760e4d S |
312 | if (lock) |
313 | spin_unlock_irqrestore(&outring_info->ring_lock, flags); | |
d2598f01 | 314 | return -EAGAIN; |
3e7ee490 HJ |
315 | } |
316 | ||
454f18a9 | 317 | /* Write to the ring buffer */ |
2b8a912e | 318 | next_write_location = hv_get_next_write_location(outring_info); |
3e7ee490 | 319 | |
98fa8cf4 S |
320 | old_write = next_write_location; |
321 | ||
011a7c3c | 322 | for (i = 0; i < kv_count; i++) { |
2b8a912e | 323 | next_write_location = hv_copyto_ringbuffer(outring_info, |
fc8c72eb | 324 | next_write_location, |
011a7c3c S |
325 | kv_list[i].iov_base, |
326 | kv_list[i].iov_len); | |
3e7ee490 HJ |
327 | } |
328 | ||
454f18a9 | 329 | /* Set previous packet start */ |
2b8a912e | 330 | prev_indices = hv_get_ring_bufferindices(outring_info); |
3e7ee490 | 331 | |
2b8a912e | 332 | next_write_location = hv_copyto_ringbuffer(outring_info, |
fc8c72eb HZ |
333 | next_write_location, |
334 | &prev_indices, | |
b219b3f7 | 335 | sizeof(u64)); |
3e7ee490 | 336 | |
98fa8cf4 | 337 | /* Issue a full memory barrier before updating the write index */ |
dcd0eeca | 338 | virt_mb(); |
3e7ee490 | 339 | |
454f18a9 | 340 | /* Now, update the write location */ |
2b8a912e | 341 | hv_set_next_write_location(outring_info, next_write_location); |
3e7ee490 | 342 | |
3e7ee490 | 343 | |
fe760e4d S |
344 | if (lock) |
345 | spin_unlock_irqrestore(&outring_info->ring_lock, flags); | |
98fa8cf4 | 346 | |
ccef9bcc | 347 | *signal = hv_need_to_signal(old_write, outring_info, policy); |
3e7ee490 HJ |
348 | return 0; |
349 | } | |
350 | ||
940b68e2 VK |
351 | int hv_ringbuffer_read(struct hv_ring_buffer_info *inring_info, |
352 | void *buffer, u32 buflen, u32 *buffer_actual_len, | |
353 | u64 *requestid, bool *signal, bool raw) | |
3e7ee490 | 354 | { |
fc8c72eb HZ |
355 | u32 bytes_avail_toread; |
356 | u32 next_read_location = 0; | |
357 | u64 prev_indices = 0; | |
940b68e2 VK |
358 | struct vmpacket_descriptor desc; |
359 | u32 offset; | |
360 | u32 packetlen; | |
361 | int ret = 0; | |
3e7ee490 | 362 | |
fc8c72eb | 363 | if (buflen <= 0) |
a16e1485 | 364 | return -EINVAL; |
3e7ee490 | 365 | |
3e7ee490 | 366 | |
940b68e2 VK |
367 | *buffer_actual_len = 0; |
368 | *requestid = 0; | |
369 | ||
a6341f00 | 370 | bytes_avail_toread = hv_get_bytes_to_read(inring_info); |
454f18a9 | 371 | /* Make sure there is something to read */ |
940b68e2 VK |
372 | if (bytes_avail_toread < sizeof(desc)) { |
373 | /* | |
374 | * No error is set when there is even no header, drivers are | |
375 | * supposed to analyze buffer_actual_len. | |
376 | */ | |
3eba9a77 | 377 | return ret; |
940b68e2 | 378 | } |
3e7ee490 | 379 | |
940b68e2 VK |
380 | next_read_location = hv_get_next_read_location(inring_info); |
381 | next_read_location = hv_copyfrom_ringbuffer(inring_info, &desc, | |
382 | sizeof(desc), | |
383 | next_read_location); | |
384 | ||
385 | offset = raw ? 0 : (desc.offset8 << 3); | |
386 | packetlen = (desc.len8 << 3) - offset; | |
387 | *buffer_actual_len = packetlen; | |
388 | *requestid = desc.trans_id; | |
389 | ||
3eba9a77 S |
390 | if (bytes_avail_toread < packetlen + offset) |
391 | return -EAGAIN; | |
940b68e2 | 392 | |
3eba9a77 S |
393 | if (packetlen > buflen) |
394 | return -ENOBUFS; | |
3e7ee490 | 395 | |
1ac58644 | 396 | next_read_location = |
2b8a912e | 397 | hv_get_next_readlocation_withoffset(inring_info, offset); |
3e7ee490 | 398 | |
2b8a912e | 399 | next_read_location = hv_copyfrom_ringbuffer(inring_info, |
fc8c72eb | 400 | buffer, |
940b68e2 | 401 | packetlen, |
fc8c72eb | 402 | next_read_location); |
3e7ee490 | 403 | |
2b8a912e | 404 | next_read_location = hv_copyfrom_ringbuffer(inring_info, |
fc8c72eb | 405 | &prev_indices, |
4408f531 | 406 | sizeof(u64), |
fc8c72eb | 407 | next_read_location); |
3e7ee490 | 408 | |
822f18d4 VK |
409 | /* |
410 | * Make sure all reads are done before we update the read index since | |
411 | * the writer may start writing to the read area once the read index | |
412 | * is updated. | |
413 | */ | |
dcd0eeca | 414 | virt_mb(); |
3e7ee490 | 415 | |
454f18a9 | 416 | /* Update the read index */ |
2b8a912e | 417 | hv_set_next_read_location(inring_info, next_read_location); |
3e7ee490 | 418 | |
a389fcfd | 419 | *signal = hv_need_to_signal_on_read(inring_info); |
c2b8e520 | 420 | |
940b68e2 | 421 | return ret; |
b5f53dde | 422 | } |