1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2009, Microsoft Corporation.
6 * Haiyang Zhang <haiyangz@microsoft.com>
7 * Hank Janssen <hjanssen@microsoft.com>
9 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
11 #include <linux/kernel.h>
12 #include <linux/interrupt.h>
13 #include <linux/sched.h>
14 #include <linux/wait.h>
16 #include <linux/slab.h>
17 #include <linux/list.h>
18 #include <linux/module.h>
19 #include <linux/completion.h>
20 #include <linux/delay.h>
21 #include <linux/cpu.h>
22 #include <linux/hyperv.h>
23 #include <asm/mshyperv.h>
25 #include "hyperv_vmbus.h"
27 static void init_vp_index(struct vmbus_channel *channel);
29 const struct vmbus_device vmbus_devs[] = {
34 .allowed_in_isolated = false,
38 { .dev_type = HV_SCSI,
41 .allowed_in_isolated = true,
48 .allowed_in_isolated = false,
55 .allowed_in_isolated = true,
62 .allowed_in_isolated = false,
66 { .dev_type = HV_PCIE,
69 .allowed_in_isolated = false,
72 /* Synthetic Frame Buffer */
76 .allowed_in_isolated = false,
79 /* Synthetic Keyboard */
83 .allowed_in_isolated = false,
87 { .dev_type = HV_MOUSE,
90 .allowed_in_isolated = false,
97 .allowed_in_isolated = false,
103 .perf_device = false,
104 .allowed_in_isolated = true,
110 .perf_device = false,
111 .allowed_in_isolated = true,
115 { .dev_type = HV_SHUTDOWN,
117 .perf_device = false,
118 .allowed_in_isolated = true,
122 { .dev_type = HV_FCOPY,
124 .perf_device = false,
125 .allowed_in_isolated = false,
129 { .dev_type = HV_BACKUP,
131 .perf_device = false,
132 .allowed_in_isolated = false,
138 .perf_device = false,
139 .allowed_in_isolated = false,
143 { .dev_type = HV_UNKNOWN,
144 .perf_device = false,
145 .allowed_in_isolated = false,
149 static const struct {
151 } vmbus_unsupported_devs[] = {
158 * The rescinded channel may be blocked waiting for a response from the host;
161 static void vmbus_rescind_cleanup(struct vmbus_channel *channel)
163 struct vmbus_channel_msginfo *msginfo;
167 spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
168 channel->rescind = true;
169 list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
172 if (msginfo->waiting_channel == channel) {
173 complete(&msginfo->waitevent);
177 spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
180 static bool is_unsupported_vmbus_devs(const guid_t *guid)
184 for (i = 0; i < ARRAY_SIZE(vmbus_unsupported_devs); i++)
185 if (guid_equal(guid, &vmbus_unsupported_devs[i].guid))
190 static u16 hv_get_dev_type(const struct vmbus_channel *channel)
192 const guid_t *guid = &channel->offermsg.offer.if_type;
195 if (is_hvsock_channel(channel) || is_unsupported_vmbus_devs(guid))
198 for (i = HV_IDE; i < HV_UNKNOWN; i++) {
199 if (guid_equal(guid, &vmbus_devs[i].guid))
202 pr_info("Unknown GUID: %pUl\n", guid);
207 * vmbus_prep_negotiate_resp() - Create default response for Negotiate message
208 * @icmsghdrp: Pointer to msg header structure
209 * @buf: Raw buffer channel data
210 * @buflen: Length of the raw buffer channel data.
211 * @fw_version: The framework versions we can support.
212 * @fw_vercnt: The size of @fw_version.
213 * @srv_version: The service versions we can support.
214 * @srv_vercnt: The size of @srv_version.
215 * @nego_fw_version: The selected framework version.
216 * @nego_srv_version: The selected service version.
218 * Note: Versions are given in decreasing order.
220 * Set up and fill in default negotiate response message.
221 * Mainly used by Hyper-V drivers.
223 bool vmbus_prep_negotiate_resp(struct icmsg_hdr *icmsghdrp, u8 *buf,
224 u32 buflen, const int *fw_version, int fw_vercnt,
225 const int *srv_version, int srv_vercnt,
226 int *nego_fw_version, int *nego_srv_version)
228 int icframe_major, icframe_minor;
229 int icmsg_major, icmsg_minor;
230 int fw_major, fw_minor;
231 int srv_major, srv_minor;
233 bool found_match = false;
234 struct icmsg_negotiate *negop;
236 /* Check that there's enough space for icframe_vercnt, icmsg_vercnt */
237 if (buflen < ICMSG_HDR + offsetof(struct icmsg_negotiate, reserved)) {
238 pr_err_ratelimited("Invalid icmsg negotiate\n");
242 icmsghdrp->icmsgsize = 0x10;
243 negop = (struct icmsg_negotiate *)&buf[ICMSG_HDR];
245 icframe_major = negop->icframe_vercnt;
248 icmsg_major = negop->icmsg_vercnt;
251 /* Validate negop packet */
252 if (icframe_major > IC_VERSION_NEGOTIATION_MAX_VER_COUNT ||
253 icmsg_major > IC_VERSION_NEGOTIATION_MAX_VER_COUNT ||
254 ICMSG_NEGOTIATE_PKT_SIZE(icframe_major, icmsg_major) > buflen) {
255 pr_err_ratelimited("Invalid icmsg negotiate - icframe_major: %u, icmsg_major: %u\n",
256 icframe_major, icmsg_major);
261 * Select the framework version number we will
265 for (i = 0; i < fw_vercnt; i++) {
266 fw_major = (fw_version[i] >> 16);
267 fw_minor = (fw_version[i] & 0xFFFF);
269 for (j = 0; j < negop->icframe_vercnt; j++) {
270 if ((negop->icversion_data[j].major == fw_major) &&
271 (negop->icversion_data[j].minor == fw_minor)) {
272 icframe_major = negop->icversion_data[j].major;
273 icframe_minor = negop->icversion_data[j].minor;
288 for (i = 0; i < srv_vercnt; i++) {
289 srv_major = (srv_version[i] >> 16);
290 srv_minor = (srv_version[i] & 0xFFFF);
292 for (j = negop->icframe_vercnt;
293 (j < negop->icframe_vercnt + negop->icmsg_vercnt);
296 if ((negop->icversion_data[j].major == srv_major) &&
297 (negop->icversion_data[j].minor == srv_minor)) {
299 icmsg_major = negop->icversion_data[j].major;
300 icmsg_minor = negop->icversion_data[j].minor;
311 * Respond with the framework and service
312 * version numbers we can support.
317 negop->icframe_vercnt = 0;
318 negop->icmsg_vercnt = 0;
320 negop->icframe_vercnt = 1;
321 negop->icmsg_vercnt = 1;
325 *nego_fw_version = (icframe_major << 16) | icframe_minor;
327 if (nego_srv_version)
328 *nego_srv_version = (icmsg_major << 16) | icmsg_minor;
330 negop->icversion_data[0].major = icframe_major;
331 negop->icversion_data[0].minor = icframe_minor;
332 negop->icversion_data[1].major = icmsg_major;
333 negop->icversion_data[1].minor = icmsg_minor;
336 EXPORT_SYMBOL_GPL(vmbus_prep_negotiate_resp);
339 * alloc_channel - Allocate and initialize a vmbus channel object
341 static struct vmbus_channel *alloc_channel(void)
343 struct vmbus_channel *channel;
345 channel = kzalloc(sizeof(*channel), GFP_ATOMIC);
349 spin_lock_init(&channel->sched_lock);
350 init_completion(&channel->rescind_event);
352 INIT_LIST_HEAD(&channel->sc_list);
354 tasklet_init(&channel->callback_event,
355 vmbus_on_event, (unsigned long)channel);
357 hv_ringbuffer_pre_init(channel);
363 * free_channel - Release the resources used by the vmbus channel object
365 static void free_channel(struct vmbus_channel *channel)
367 tasklet_kill(&channel->callback_event);
368 vmbus_remove_channel_attr_group(channel);
370 kobject_put(&channel->kobj);
373 void vmbus_channel_map_relid(struct vmbus_channel *channel)
375 if (WARN_ON(channel->offermsg.child_relid >= MAX_CHANNEL_RELIDS))
378 * The mapping of the channel's relid is visible from the CPUs that
379 * execute vmbus_chan_sched() by the time that vmbus_chan_sched() will
382 * (a) In the "normal (i.e., not resuming from hibernation)" path,
383 * the full barrier in virt_store_mb() guarantees that the store
384 * is propagated to all CPUs before the add_channel_work work
385 * is queued. In turn, add_channel_work is queued before the
386 * channel's ring buffer is allocated/initialized and the
387 * OPENCHANNEL message for the channel is sent in vmbus_open().
388 * Hyper-V won't start sending the interrupts for the channel
389 * before the OPENCHANNEL message is acked. The memory barrier
390 * in vmbus_chan_sched() -> sync_test_and_clear_bit() ensures
391 * that vmbus_chan_sched() must find the channel's relid in
392 * recv_int_page before retrieving the channel pointer from the
395 * (b) In the "resuming from hibernation" path, the virt_store_mb()
396 * guarantees that the store is propagated to all CPUs before
397 * the VMBus connection is marked as ready for the resume event
398 * (cf. check_ready_for_resume_event()). The interrupt handler
399 * of the VMBus driver and vmbus_chan_sched() can not run before
400 * vmbus_bus_resume() has completed execution (cf. resume_noirq).
403 vmbus_connection.channels[channel->offermsg.child_relid],
407 void vmbus_channel_unmap_relid(struct vmbus_channel *channel)
409 if (WARN_ON(channel->offermsg.child_relid >= MAX_CHANNEL_RELIDS))
412 vmbus_connection.channels[channel->offermsg.child_relid],
416 static void vmbus_release_relid(u32 relid)
418 struct vmbus_channel_relid_released msg;
421 memset(&msg, 0, sizeof(struct vmbus_channel_relid_released));
422 msg.child_relid = relid;
423 msg.header.msgtype = CHANNELMSG_RELID_RELEASED;
424 ret = vmbus_post_msg(&msg, sizeof(struct vmbus_channel_relid_released),
427 trace_vmbus_release_relid(&msg, ret);
430 void hv_process_channel_removal(struct vmbus_channel *channel)
432 lockdep_assert_held(&vmbus_connection.channel_mutex);
433 BUG_ON(!channel->rescind);
436 * hv_process_channel_removal() could find INVALID_RELID only for
437 * hv_sock channels. See the inline comments in vmbus_onoffer().
439 WARN_ON(channel->offermsg.child_relid == INVALID_RELID &&
440 !is_hvsock_channel(channel));
443 * Upon suspend, an in-use hv_sock channel is removed from the array of
444 * channels and the relid is invalidated. After hibernation, when the
445 * user-space appplication destroys the channel, it's unnecessary and
446 * unsafe to remove the channel from the array of channels. See also
447 * the inline comments before the call of vmbus_release_relid() below.
449 if (channel->offermsg.child_relid != INVALID_RELID)
450 vmbus_channel_unmap_relid(channel);
452 if (channel->primary_channel == NULL)
453 list_del(&channel->listentry);
455 list_del(&channel->sc_list);
458 * If this is a "perf" channel, updates the hv_numa_map[] masks so that
459 * init_vp_index() can (re-)use the CPU.
461 if (hv_is_perf_channel(channel))
462 hv_clear_alloced_cpu(channel->target_cpu);
465 * Upon suspend, an in-use hv_sock channel is marked as "rescinded" and
466 * the relid is invalidated; after hibernation, when the user-space app
467 * destroys the channel, the relid is INVALID_RELID, and in this case
468 * it's unnecessary and unsafe to release the old relid, since the same
469 * relid can refer to a completely different channel now.
471 if (channel->offermsg.child_relid != INVALID_RELID)
472 vmbus_release_relid(channel->offermsg.child_relid);
474 free_channel(channel);
477 void vmbus_free_channels(void)
479 struct vmbus_channel *channel, *tmp;
481 list_for_each_entry_safe(channel, tmp, &vmbus_connection.chn_list,
483 /* hv_process_channel_removal() needs this */
484 channel->rescind = true;
486 vmbus_device_unregister(channel->device_obj);
490 /* Note: the function can run concurrently for primary/sub channels. */
491 static void vmbus_add_channel_work(struct work_struct *work)
493 struct vmbus_channel *newchannel =
494 container_of(work, struct vmbus_channel, add_channel_work);
495 struct vmbus_channel *primary_channel = newchannel->primary_channel;
499 * This state is used to indicate a successful open
500 * so that when we do close the channel normally, we
501 * can cleanup properly.
503 newchannel->state = CHANNEL_OPEN_STATE;
505 if (primary_channel != NULL) {
506 /* newchannel is a sub-channel. */
507 struct hv_device *dev = primary_channel->device_obj;
509 if (vmbus_add_channel_kobj(dev, newchannel))
512 if (primary_channel->sc_creation_callback != NULL)
513 primary_channel->sc_creation_callback(newchannel);
515 newchannel->probe_done = true;
520 * Start the process of binding the primary channel to the driver
522 newchannel->device_obj = vmbus_device_create(
523 &newchannel->offermsg.offer.if_type,
524 &newchannel->offermsg.offer.if_instance,
526 if (!newchannel->device_obj)
529 newchannel->device_obj->device_id = newchannel->device_id;
531 * Add the new device to the bus. This will kick off device-driver
532 * binding which eventually invokes the device driver's AddDevice()
535 ret = vmbus_device_register(newchannel->device_obj);
538 pr_err("unable to add child device object (relid %d)\n",
539 newchannel->offermsg.child_relid);
540 kfree(newchannel->device_obj);
544 newchannel->probe_done = true;
548 mutex_lock(&vmbus_connection.channel_mutex);
551 * We need to set the flag, otherwise
552 * vmbus_onoffer_rescind() can be blocked.
554 newchannel->probe_done = true;
556 if (primary_channel == NULL)
557 list_del(&newchannel->listentry);
559 list_del(&newchannel->sc_list);
561 /* vmbus_process_offer() has mapped the channel. */
562 vmbus_channel_unmap_relid(newchannel);
564 mutex_unlock(&vmbus_connection.channel_mutex);
566 vmbus_release_relid(newchannel->offermsg.child_relid);
568 free_channel(newchannel);
572 * vmbus_process_offer - Process the offer by creating a channel/device
573 * associated with this offer
575 static void vmbus_process_offer(struct vmbus_channel *newchannel)
577 struct vmbus_channel *channel;
578 struct workqueue_struct *wq;
582 * Synchronize vmbus_process_offer() and CPU hotplugging:
586 * [vmbus_process_offer()] [Hot removal of the CPU]
588 * CPU_READ_LOCK CPUS_WRITE_LOCK
589 * LOAD cpu_online_mask SEARCH chn_list
590 * STORE target_cpu LOAD target_cpu
591 * INSERT chn_list STORE cpu_online_mask
592 * CPUS_READ_UNLOCK CPUS_WRITE_UNLOCK
594 * Forbids: CPU1's LOAD from *not* seing CPU2's STORE &&
595 * CPU2's SEARCH from *not* seeing CPU1's INSERT
597 * Forbids: CPU2's SEARCH from seeing CPU1's INSERT &&
598 * CPU2's LOAD from *not* seing CPU1's STORE
603 * Serializes the modifications of the chn_list list as well as
604 * the accesses to next_numa_node_id in init_vp_index().
606 mutex_lock(&vmbus_connection.channel_mutex);
608 list_for_each_entry(channel, &vmbus_connection.chn_list, listentry) {
609 if (guid_equal(&channel->offermsg.offer.if_type,
610 &newchannel->offermsg.offer.if_type) &&
611 guid_equal(&channel->offermsg.offer.if_instance,
612 &newchannel->offermsg.offer.if_instance)) {
614 newchannel->primary_channel = channel;
619 init_vp_index(newchannel);
621 /* Remember the channels that should be cleaned up upon suspend. */
622 if (is_hvsock_channel(newchannel) || is_sub_channel(newchannel))
623 atomic_inc(&vmbus_connection.nr_chan_close_on_suspend);
626 * Now that we have acquired the channel_mutex,
627 * we can release the potentially racing rescind thread.
629 atomic_dec(&vmbus_connection.offer_in_progress);
632 list_add_tail(&newchannel->listentry,
633 &vmbus_connection.chn_list);
636 * Check to see if this is a valid sub-channel.
638 if (newchannel->offermsg.offer.sub_channel_index == 0) {
639 mutex_unlock(&vmbus_connection.channel_mutex);
642 * Don't call free_channel(), because newchannel->kobj
643 * is not initialized yet.
650 * Process the sub-channel.
652 list_add_tail(&newchannel->sc_list, &channel->sc_list);
655 vmbus_channel_map_relid(newchannel);
657 mutex_unlock(&vmbus_connection.channel_mutex);
661 * vmbus_process_offer() mustn't call channel->sc_creation_callback()
662 * directly for sub-channels, because sc_creation_callback() ->
663 * vmbus_open() may never get the host's response to the
664 * OPEN_CHANNEL message (the host may rescind a channel at any time,
665 * e.g. in the case of hot removing a NIC), and vmbus_onoffer_rescind()
666 * may not wake up the vmbus_open() as it's blocked due to a non-zero
667 * vmbus_connection.offer_in_progress, and finally we have a deadlock.
669 * The above is also true for primary channels, if the related device
670 * drivers use sync probing mode by default.
672 * And, usually the handling of primary channels and sub-channels can
673 * depend on each other, so we should offload them to different
674 * workqueues to avoid possible deadlock, e.g. in sync-probing mode,
675 * NIC1's netvsc_subchan_work() can race with NIC2's netvsc_probe() ->
676 * rtnl_lock(), and causes deadlock: the former gets the rtnl_lock
677 * and waits for all the sub-channels to appear, but the latter
678 * can't get the rtnl_lock and this blocks the handling of
681 INIT_WORK(&newchannel->add_channel_work, vmbus_add_channel_work);
682 wq = fnew ? vmbus_connection.handle_primary_chan_wq :
683 vmbus_connection.handle_sub_chan_wq;
684 queue_work(wq, &newchannel->add_channel_work);
688 * Check if CPUs used by other channels of the same device.
689 * It should only be called by init_vp_index().
691 static bool hv_cpuself_used(u32 cpu, struct vmbus_channel *chn)
693 struct vmbus_channel *primary = chn->primary_channel;
694 struct vmbus_channel *sc;
696 lockdep_assert_held(&vmbus_connection.channel_mutex);
701 if (primary->target_cpu == cpu)
704 list_for_each_entry(sc, &primary->sc_list, sc_list)
705 if (sc != chn && sc->target_cpu == cpu)
712 * We use this state to statically distribute the channel interrupt load.
714 static int next_numa_node_id;
717 * Starting with Win8, we can statically distribute the incoming
718 * channel interrupt load by binding a channel to VCPU.
720 * For pre-win8 hosts or non-performance critical channels we assign the
723 * Starting with win8, performance critical channels will be distributed
724 * evenly among all the available NUMA nodes. Once the node is assigned,
725 * we will assign the CPU based on a simple round robin scheme.
727 static void init_vp_index(struct vmbus_channel *channel)
729 bool perf_chn = hv_is_perf_channel(channel);
730 u32 i, ncpu = num_online_cpus();
731 cpumask_var_t available_mask;
732 struct cpumask *alloced_mask;
736 if ((vmbus_proto_version == VERSION_WS2008) ||
737 (vmbus_proto_version == VERSION_WIN7) || (!perf_chn) ||
738 !alloc_cpumask_var(&available_mask, GFP_KERNEL)) {
740 * Prior to win8, all channel interrupts are
741 * delivered on VMBUS_CONNECT_CPU.
742 * Also if the channel is not a performance critical
743 * channel, bind it to VMBUS_CONNECT_CPU.
744 * In case alloc_cpumask_var() fails, bind it to
747 channel->target_cpu = VMBUS_CONNECT_CPU;
749 hv_set_alloced_cpu(VMBUS_CONNECT_CPU);
753 for (i = 1; i <= ncpu + 1; i++) {
755 numa_node = next_numa_node_id++;
756 if (numa_node == nr_node_ids) {
757 next_numa_node_id = 0;
760 if (cpumask_empty(cpumask_of_node(numa_node)))
764 alloced_mask = &hv_context.hv_numa_map[numa_node];
766 if (cpumask_weight(alloced_mask) ==
767 cpumask_weight(cpumask_of_node(numa_node))) {
769 * We have cycled through all the CPUs in the node;
770 * reset the alloced map.
772 cpumask_clear(alloced_mask);
775 cpumask_xor(available_mask, alloced_mask,
776 cpumask_of_node(numa_node));
778 target_cpu = cpumask_first(available_mask);
779 cpumask_set_cpu(target_cpu, alloced_mask);
781 if (channel->offermsg.offer.sub_channel_index >= ncpu ||
782 i > ncpu || !hv_cpuself_used(target_cpu, channel))
786 channel->target_cpu = target_cpu;
788 free_cpumask_var(available_mask);
791 #define UNLOAD_DELAY_UNIT_MS 10 /* 10 milliseconds */
792 #define UNLOAD_WAIT_MS (100*1000) /* 100 seconds */
793 #define UNLOAD_WAIT_LOOPS (UNLOAD_WAIT_MS/UNLOAD_DELAY_UNIT_MS)
794 #define UNLOAD_MSG_MS (5*1000) /* Every 5 seconds */
795 #define UNLOAD_MSG_LOOPS (UNLOAD_MSG_MS/UNLOAD_DELAY_UNIT_MS)
797 static void vmbus_wait_for_unload(void)
801 struct hv_message *msg;
802 struct vmbus_channel_message_header *hdr;
806 * CHANNELMSG_UNLOAD_RESPONSE is always delivered to the CPU which was
807 * used for initial contact or to CPU0 depending on host version. When
808 * we're crashing on a different CPU let's hope that IRQ handler on
809 * the cpu which receives CHANNELMSG_UNLOAD_RESPONSE is still
810 * functional and vmbus_unload_response() will complete
811 * vmbus_connection.unload_event. If not, the last thing we can do is
812 * read message pages for all CPUs directly.
814 * Wait up to 100 seconds since an Azure host must writeback any dirty
815 * data in its disk cache before the VMbus UNLOAD request will
816 * complete. This flushing has been empirically observed to take up
817 * to 50 seconds in cases with a lot of dirty data, so allow additional
818 * leeway and for inaccuracies in mdelay(). But eventually time out so
819 * that the panic path can't get hung forever in case the response
820 * message isn't seen.
822 for (i = 1; i <= UNLOAD_WAIT_LOOPS; i++) {
823 if (completion_done(&vmbus_connection.unload_event))
826 for_each_online_cpu(cpu) {
827 struct hv_per_cpu_context *hv_cpu
828 = per_cpu_ptr(hv_context.cpu_context, cpu);
830 page_addr = hv_cpu->synic_message_page;
831 msg = (struct hv_message *)page_addr
832 + VMBUS_MESSAGE_SINT;
834 message_type = READ_ONCE(msg->header.message_type);
835 if (message_type == HVMSG_NONE)
838 hdr = (struct vmbus_channel_message_header *)
841 if (hdr->msgtype == CHANNELMSG_UNLOAD_RESPONSE)
842 complete(&vmbus_connection.unload_event);
844 vmbus_signal_eom(msg, message_type);
848 * Give a notice periodically so someone watching the
849 * serial output won't think it is completely hung.
851 if (!(i % UNLOAD_MSG_LOOPS))
852 pr_notice("Waiting for VMBus UNLOAD to complete\n");
854 mdelay(UNLOAD_DELAY_UNIT_MS);
856 pr_err("Continuing even though VMBus UNLOAD did not complete\n");
860 * We're crashing and already got the UNLOAD_RESPONSE, cleanup all
861 * maybe-pending messages on all CPUs to be able to receive new
862 * messages after we reconnect.
864 for_each_online_cpu(cpu) {
865 struct hv_per_cpu_context *hv_cpu
866 = per_cpu_ptr(hv_context.cpu_context, cpu);
868 page_addr = hv_cpu->synic_message_page;
869 msg = (struct hv_message *)page_addr + VMBUS_MESSAGE_SINT;
870 msg->header.message_type = HVMSG_NONE;
875 * vmbus_unload_response - Handler for the unload response.
877 static void vmbus_unload_response(struct vmbus_channel_message_header *hdr)
880 * This is a global event; just wakeup the waiting thread.
881 * Once we successfully unload, we can cleanup the monitor state.
883 * NB. A malicious or compromised Hyper-V could send a spurious
884 * message of type CHANNELMSG_UNLOAD_RESPONSE, and trigger a call
885 * of the complete() below. Make sure that unload_event has been
886 * initialized by the time this complete() is executed.
888 complete(&vmbus_connection.unload_event);
891 void vmbus_initiate_unload(bool crash)
893 struct vmbus_channel_message_header hdr;
895 if (xchg(&vmbus_connection.conn_state, DISCONNECTED) == DISCONNECTED)
898 /* Pre-Win2012R2 hosts don't support reconnect */
899 if (vmbus_proto_version < VERSION_WIN8_1)
902 reinit_completion(&vmbus_connection.unload_event);
903 memset(&hdr, 0, sizeof(struct vmbus_channel_message_header));
904 hdr.msgtype = CHANNELMSG_UNLOAD;
905 vmbus_post_msg(&hdr, sizeof(struct vmbus_channel_message_header),
909 * vmbus_initiate_unload() is also called on crash and the crash can be
910 * happening in an interrupt context, where scheduling is impossible.
913 wait_for_completion(&vmbus_connection.unload_event);
915 vmbus_wait_for_unload();
918 static void check_ready_for_resume_event(void)
921 * If all the old primary channels have been fixed up, then it's safe
924 if (atomic_dec_and_test(&vmbus_connection.nr_chan_fixup_on_resume))
925 complete(&vmbus_connection.ready_for_resume_event);
928 static void vmbus_setup_channel_state(struct vmbus_channel *channel,
929 struct vmbus_channel_offer_channel *offer)
932 * Setup state for signalling the host.
934 channel->sig_event = VMBUS_EVENT_CONNECTION_ID;
936 if (vmbus_proto_version != VERSION_WS2008) {
937 channel->is_dedicated_interrupt =
938 (offer->is_dedicated_interrupt != 0);
939 channel->sig_event = offer->connection_id;
942 memcpy(&channel->offermsg, offer,
943 sizeof(struct vmbus_channel_offer_channel));
944 channel->monitor_grp = (u8)offer->monitorid / 32;
945 channel->monitor_bit = (u8)offer->monitorid % 32;
946 channel->device_id = hv_get_dev_type(channel);
950 * find_primary_channel_by_offer - Get the channel object given the new offer.
951 * This is only used in the resume path of hibernation.
953 static struct vmbus_channel *
954 find_primary_channel_by_offer(const struct vmbus_channel_offer_channel *offer)
956 struct vmbus_channel *channel = NULL, *iter;
957 const guid_t *inst1, *inst2;
959 /* Ignore sub-channel offers. */
960 if (offer->offer.sub_channel_index != 0)
963 mutex_lock(&vmbus_connection.channel_mutex);
965 list_for_each_entry(iter, &vmbus_connection.chn_list, listentry) {
966 inst1 = &iter->offermsg.offer.if_instance;
967 inst2 = &offer->offer.if_instance;
969 if (guid_equal(inst1, inst2)) {
975 mutex_unlock(&vmbus_connection.channel_mutex);
980 static bool vmbus_is_valid_device(const guid_t *guid)
984 if (!hv_is_isolation_supported())
987 for (i = 0; i < ARRAY_SIZE(vmbus_devs); i++) {
988 if (guid_equal(guid, &vmbus_devs[i].guid))
989 return vmbus_devs[i].allowed_in_isolated;
995 * vmbus_onoffer - Handler for channel offers from vmbus in parent partition.
998 static void vmbus_onoffer(struct vmbus_channel_message_header *hdr)
1000 struct vmbus_channel_offer_channel *offer;
1001 struct vmbus_channel *oldchannel, *newchannel;
1004 offer = (struct vmbus_channel_offer_channel *)hdr;
1006 trace_vmbus_onoffer(offer);
1008 if (!vmbus_is_valid_device(&offer->offer.if_type)) {
1009 pr_err_ratelimited("Invalid offer %d from the host supporting isolation\n",
1010 offer->child_relid);
1011 atomic_dec(&vmbus_connection.offer_in_progress);
1015 oldchannel = find_primary_channel_by_offer(offer);
1017 if (oldchannel != NULL) {
1019 * We're resuming from hibernation: all the sub-channel and
1020 * hv_sock channels we had before the hibernation should have
1021 * been cleaned up, and now we must be seeing a re-offered
1022 * primary channel that we had before the hibernation.
1026 * { Initially: channel relid = INVALID_RELID,
1027 * channels[valid_relid] = NULL }
1031 * [vmbus_onoffer()] [vmbus_device_release()]
1033 * LOCK channel_mutex LOCK channel_mutex
1034 * STORE channel relid = valid_relid LOAD r1 = channel relid
1035 * MAP_RELID channel if (r1 != INVALID_RELID)
1036 * UNLOCK channel_mutex UNMAP_RELID channel
1037 * UNLOCK channel_mutex
1039 * Forbids: r1 == valid_relid &&
1040 * channels[valid_relid] == channel
1042 * Note. r1 can be INVALID_RELID only for an hv_sock channel.
1043 * None of the hv_sock channels which were present before the
1044 * suspend are re-offered upon the resume. See the WARN_ON()
1045 * in hv_process_channel_removal().
1047 mutex_lock(&vmbus_connection.channel_mutex);
1049 atomic_dec(&vmbus_connection.offer_in_progress);
1051 WARN_ON(oldchannel->offermsg.child_relid != INVALID_RELID);
1052 /* Fix up the relid. */
1053 oldchannel->offermsg.child_relid = offer->child_relid;
1055 offer_sz = sizeof(*offer);
1056 if (memcmp(offer, &oldchannel->offermsg, offer_sz) != 0) {
1058 * This is not an error, since the host can also change
1059 * the other field(s) of the offer, e.g. on WS RS5
1060 * (Build 17763), the offer->connection_id of the
1061 * Mellanox VF vmbus device can change when the host
1062 * reoffers the device upon resume.
1064 pr_debug("vmbus offer changed: relid=%d\n",
1065 offer->child_relid);
1067 print_hex_dump_debug("Old vmbus offer: ",
1068 DUMP_PREFIX_OFFSET, 16, 4,
1069 &oldchannel->offermsg, offer_sz,
1071 print_hex_dump_debug("New vmbus offer: ",
1072 DUMP_PREFIX_OFFSET, 16, 4,
1073 offer, offer_sz, false);
1075 /* Fix up the old channel. */
1076 vmbus_setup_channel_state(oldchannel, offer);
1079 /* Add the channel back to the array of channels. */
1080 vmbus_channel_map_relid(oldchannel);
1081 check_ready_for_resume_event();
1083 mutex_unlock(&vmbus_connection.channel_mutex);
1087 /* Allocate the channel object and save this offer. */
1088 newchannel = alloc_channel();
1090 vmbus_release_relid(offer->child_relid);
1091 atomic_dec(&vmbus_connection.offer_in_progress);
1092 pr_err("Unable to allocate channel object\n");
1096 vmbus_setup_channel_state(newchannel, offer);
1098 vmbus_process_offer(newchannel);
1101 static void check_ready_for_suspend_event(void)
1104 * If all the sub-channels or hv_sock channels have been cleaned up,
1105 * then it's safe to suspend.
1107 if (atomic_dec_and_test(&vmbus_connection.nr_chan_close_on_suspend))
1108 complete(&vmbus_connection.ready_for_suspend_event);
1112 * vmbus_onoffer_rescind - Rescind offer handler.
1114 * We queue a work item to process this offer synchronously
1116 static void vmbus_onoffer_rescind(struct vmbus_channel_message_header *hdr)
1118 struct vmbus_channel_rescind_offer *rescind;
1119 struct vmbus_channel *channel;
1121 bool clean_up_chan_for_suspend;
1123 rescind = (struct vmbus_channel_rescind_offer *)hdr;
1125 trace_vmbus_onoffer_rescind(rescind);
1128 * The offer msg and the corresponding rescind msg
1129 * from the host are guranteed to be ordered -
1130 * offer comes in first and then the rescind.
1131 * Since we process these events in work elements,
1132 * and with preemption, we may end up processing
1133 * the events out of order. We rely on the synchronization
1134 * provided by offer_in_progress and by channel_mutex for
1135 * ordering these events:
1137 * { Initially: offer_in_progress = 1 }
1141 * [vmbus_onoffer()] [vmbus_onoffer_rescind()]
1143 * LOCK channel_mutex WAIT_ON offer_in_progress == 0
1144 * DECREMENT offer_in_progress LOCK channel_mutex
1145 * STORE channels[] LOAD channels[]
1146 * UNLOCK channel_mutex UNLOCK channel_mutex
1148 * Forbids: CPU2's LOAD from *not* seeing CPU1's STORE
1151 while (atomic_read(&vmbus_connection.offer_in_progress) != 0) {
1153 * We wait here until any channel offer is currently
1159 mutex_lock(&vmbus_connection.channel_mutex);
1160 channel = relid2channel(rescind->child_relid);
1161 if (channel != NULL) {
1163 * Guarantee that no other instance of vmbus_onoffer_rescind()
1164 * has got a reference to the channel object. Synchronize on
1165 * &vmbus_connection.channel_mutex.
1167 if (channel->rescind_ref) {
1168 mutex_unlock(&vmbus_connection.channel_mutex);
1171 channel->rescind_ref = true;
1173 mutex_unlock(&vmbus_connection.channel_mutex);
1175 if (channel == NULL) {
1177 * We failed in processing the offer message;
1178 * we would have cleaned up the relid in that
1184 clean_up_chan_for_suspend = is_hvsock_channel(channel) ||
1185 is_sub_channel(channel);
1187 * Before setting channel->rescind in vmbus_rescind_cleanup(), we
1188 * should make sure the channel callback is not running any more.
1190 vmbus_reset_channel_cb(channel);
1193 * Now wait for offer handling to complete.
1195 vmbus_rescind_cleanup(channel);
1196 while (READ_ONCE(channel->probe_done) == false) {
1198 * We wait here until any channel offer is currently
1205 * At this point, the rescind handling can proceed safely.
1208 if (channel->device_obj) {
1209 if (channel->chn_rescind_callback) {
1210 channel->chn_rescind_callback(channel);
1212 if (clean_up_chan_for_suspend)
1213 check_ready_for_suspend_event();
1218 * We will have to unregister this device from the
1221 dev = get_device(&channel->device_obj->device);
1223 vmbus_device_unregister(channel->device_obj);
1226 } else if (channel->primary_channel != NULL) {
1228 * Sub-channel is being rescinded. Following is the channel
1229 * close sequence when initiated from the driveri (refer to
1230 * vmbus_close() for details):
1231 * 1. Close all sub-channels first
1232 * 2. Then close the primary channel.
1234 mutex_lock(&vmbus_connection.channel_mutex);
1235 if (channel->state == CHANNEL_OPEN_STATE) {
1237 * The channel is currently not open;
1238 * it is safe for us to cleanup the channel.
1240 hv_process_channel_removal(channel);
1242 complete(&channel->rescind_event);
1244 mutex_unlock(&vmbus_connection.channel_mutex);
1247 /* The "channel" may have been freed. Do not access it any longer. */
1249 if (clean_up_chan_for_suspend)
1250 check_ready_for_suspend_event();
1253 void vmbus_hvsock_device_unregister(struct vmbus_channel *channel)
1255 BUG_ON(!is_hvsock_channel(channel));
1257 /* We always get a rescind msg when a connection is closed. */
1258 while (!READ_ONCE(channel->probe_done) || !READ_ONCE(channel->rescind))
1261 vmbus_device_unregister(channel->device_obj);
1263 EXPORT_SYMBOL_GPL(vmbus_hvsock_device_unregister);
1267 * vmbus_onoffers_delivered -
1268 * This is invoked when all offers have been delivered.
1270 * Nothing to do here.
1272 static void vmbus_onoffers_delivered(
1273 struct vmbus_channel_message_header *hdr)
1278 * vmbus_onopen_result - Open result handler.
1280 * This is invoked when we received a response to our channel open request.
1281 * Find the matching request, copy the response and signal the requesting
1284 static void vmbus_onopen_result(struct vmbus_channel_message_header *hdr)
1286 struct vmbus_channel_open_result *result;
1287 struct vmbus_channel_msginfo *msginfo;
1288 struct vmbus_channel_message_header *requestheader;
1289 struct vmbus_channel_open_channel *openmsg;
1290 unsigned long flags;
1292 result = (struct vmbus_channel_open_result *)hdr;
1294 trace_vmbus_onopen_result(result);
1297 * Find the open msg, copy the result and signal/unblock the wait event
1299 spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
1301 list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
1304 (struct vmbus_channel_message_header *)msginfo->msg;
1306 if (requestheader->msgtype == CHANNELMSG_OPENCHANNEL) {
1308 (struct vmbus_channel_open_channel *)msginfo->msg;
1309 if (openmsg->child_relid == result->child_relid &&
1310 openmsg->openid == result->openid) {
1311 memcpy(&msginfo->response.open_result,
1314 struct vmbus_channel_open_result));
1315 complete(&msginfo->waitevent);
1320 spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
1324 * vmbus_ongpadl_created - GPADL created handler.
1326 * This is invoked when we received a response to our gpadl create request.
1327 * Find the matching request, copy the response and signal the requesting
1330 static void vmbus_ongpadl_created(struct vmbus_channel_message_header *hdr)
1332 struct vmbus_channel_gpadl_created *gpadlcreated;
1333 struct vmbus_channel_msginfo *msginfo;
1334 struct vmbus_channel_message_header *requestheader;
1335 struct vmbus_channel_gpadl_header *gpadlheader;
1336 unsigned long flags;
1338 gpadlcreated = (struct vmbus_channel_gpadl_created *)hdr;
1340 trace_vmbus_ongpadl_created(gpadlcreated);
1343 * Find the establish msg, copy the result and signal/unblock the wait
1346 spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
1348 list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
1351 (struct vmbus_channel_message_header *)msginfo->msg;
1353 if (requestheader->msgtype == CHANNELMSG_GPADL_HEADER) {
1355 (struct vmbus_channel_gpadl_header *)requestheader;
1357 if ((gpadlcreated->child_relid ==
1358 gpadlheader->child_relid) &&
1359 (gpadlcreated->gpadl == gpadlheader->gpadl)) {
1360 memcpy(&msginfo->response.gpadl_created,
1363 struct vmbus_channel_gpadl_created));
1364 complete(&msginfo->waitevent);
1369 spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
1373 * vmbus_onmodifychannel_response - Modify Channel response handler.
1375 * This is invoked when we received a response to our channel modify request.
1376 * Find the matching request, copy the response and signal the requesting thread.
1378 static void vmbus_onmodifychannel_response(struct vmbus_channel_message_header *hdr)
1380 struct vmbus_channel_modifychannel_response *response;
1381 struct vmbus_channel_msginfo *msginfo;
1382 unsigned long flags;
1384 response = (struct vmbus_channel_modifychannel_response *)hdr;
1386 trace_vmbus_onmodifychannel_response(response);
1389 * Find the modify msg, copy the response and signal/unblock the wait event.
1391 spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
1393 list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list, msglistentry) {
1394 struct vmbus_channel_message_header *responseheader =
1395 (struct vmbus_channel_message_header *)msginfo->msg;
1397 if (responseheader->msgtype == CHANNELMSG_MODIFYCHANNEL) {
1398 struct vmbus_channel_modifychannel *modifymsg;
1400 modifymsg = (struct vmbus_channel_modifychannel *)msginfo->msg;
1401 if (modifymsg->child_relid == response->child_relid) {
1402 memcpy(&msginfo->response.modify_response, response,
1404 complete(&msginfo->waitevent);
1409 spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
1413 * vmbus_ongpadl_torndown - GPADL torndown handler.
1415 * This is invoked when we received a response to our gpadl teardown request.
1416 * Find the matching request, copy the response and signal the requesting
1419 static void vmbus_ongpadl_torndown(
1420 struct vmbus_channel_message_header *hdr)
1422 struct vmbus_channel_gpadl_torndown *gpadl_torndown;
1423 struct vmbus_channel_msginfo *msginfo;
1424 struct vmbus_channel_message_header *requestheader;
1425 struct vmbus_channel_gpadl_teardown *gpadl_teardown;
1426 unsigned long flags;
1428 gpadl_torndown = (struct vmbus_channel_gpadl_torndown *)hdr;
1430 trace_vmbus_ongpadl_torndown(gpadl_torndown);
1433 * Find the open msg, copy the result and signal/unblock the wait event
1435 spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
1437 list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
1440 (struct vmbus_channel_message_header *)msginfo->msg;
1442 if (requestheader->msgtype == CHANNELMSG_GPADL_TEARDOWN) {
1444 (struct vmbus_channel_gpadl_teardown *)requestheader;
1446 if (gpadl_torndown->gpadl == gpadl_teardown->gpadl) {
1447 memcpy(&msginfo->response.gpadl_torndown,
1450 struct vmbus_channel_gpadl_torndown));
1451 complete(&msginfo->waitevent);
1456 spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
1460 * vmbus_onversion_response - Version response handler
1462 * This is invoked when we received a response to our initiate contact request.
1463 * Find the matching request, copy the response and signal the requesting
1466 static void vmbus_onversion_response(
1467 struct vmbus_channel_message_header *hdr)
1469 struct vmbus_channel_msginfo *msginfo;
1470 struct vmbus_channel_message_header *requestheader;
1471 struct vmbus_channel_version_response *version_response;
1472 unsigned long flags;
1474 version_response = (struct vmbus_channel_version_response *)hdr;
1476 trace_vmbus_onversion_response(version_response);
1478 spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
1480 list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
1483 (struct vmbus_channel_message_header *)msginfo->msg;
1485 if (requestheader->msgtype ==
1486 CHANNELMSG_INITIATE_CONTACT) {
1487 memcpy(&msginfo->response.version_response,
1489 sizeof(struct vmbus_channel_version_response));
1490 complete(&msginfo->waitevent);
1493 spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
1496 /* Channel message dispatch table */
1497 const struct vmbus_channel_message_table_entry
1498 channel_message_table[CHANNELMSG_COUNT] = {
1499 { CHANNELMSG_INVALID, 0, NULL, 0},
1500 { CHANNELMSG_OFFERCHANNEL, 0, vmbus_onoffer,
1501 sizeof(struct vmbus_channel_offer_channel)},
1502 { CHANNELMSG_RESCIND_CHANNELOFFER, 0, vmbus_onoffer_rescind,
1503 sizeof(struct vmbus_channel_rescind_offer) },
1504 { CHANNELMSG_REQUESTOFFERS, 0, NULL, 0},
1505 { CHANNELMSG_ALLOFFERS_DELIVERED, 1, vmbus_onoffers_delivered, 0},
1506 { CHANNELMSG_OPENCHANNEL, 0, NULL, 0},
1507 { CHANNELMSG_OPENCHANNEL_RESULT, 1, vmbus_onopen_result,
1508 sizeof(struct vmbus_channel_open_result)},
1509 { CHANNELMSG_CLOSECHANNEL, 0, NULL, 0},
1510 { CHANNELMSG_GPADL_HEADER, 0, NULL, 0},
1511 { CHANNELMSG_GPADL_BODY, 0, NULL, 0},
1512 { CHANNELMSG_GPADL_CREATED, 1, vmbus_ongpadl_created,
1513 sizeof(struct vmbus_channel_gpadl_created)},
1514 { CHANNELMSG_GPADL_TEARDOWN, 0, NULL, 0},
1515 { CHANNELMSG_GPADL_TORNDOWN, 1, vmbus_ongpadl_torndown,
1516 sizeof(struct vmbus_channel_gpadl_torndown) },
1517 { CHANNELMSG_RELID_RELEASED, 0, NULL, 0},
1518 { CHANNELMSG_INITIATE_CONTACT, 0, NULL, 0},
1519 { CHANNELMSG_VERSION_RESPONSE, 1, vmbus_onversion_response,
1520 sizeof(struct vmbus_channel_version_response)},
1521 { CHANNELMSG_UNLOAD, 0, NULL, 0},
1522 { CHANNELMSG_UNLOAD_RESPONSE, 1, vmbus_unload_response, 0},
1523 { CHANNELMSG_18, 0, NULL, 0},
1524 { CHANNELMSG_19, 0, NULL, 0},
1525 { CHANNELMSG_20, 0, NULL, 0},
1526 { CHANNELMSG_TL_CONNECT_REQUEST, 0, NULL, 0},
1527 { CHANNELMSG_MODIFYCHANNEL, 0, NULL, 0},
1528 { CHANNELMSG_TL_CONNECT_RESULT, 0, NULL, 0},
1529 { CHANNELMSG_MODIFYCHANNEL_RESPONSE, 1, vmbus_onmodifychannel_response,
1530 sizeof(struct vmbus_channel_modifychannel_response)},
1534 * vmbus_onmessage - Handler for channel protocol messages.
1536 * This is invoked in the vmbus worker thread context.
1538 void vmbus_onmessage(struct vmbus_channel_message_header *hdr)
1540 trace_vmbus_on_message(hdr);
1543 * vmbus_on_msg_dpc() makes sure the hdr->msgtype here can not go
1544 * out of bound and the message_handler pointer can not be NULL.
1546 channel_message_table[hdr->msgtype].message_handler(hdr);
1550 * vmbus_request_offers - Send a request to get all our pending offers.
1552 int vmbus_request_offers(void)
1554 struct vmbus_channel_message_header *msg;
1555 struct vmbus_channel_msginfo *msginfo;
1558 msginfo = kmalloc(sizeof(*msginfo) +
1559 sizeof(struct vmbus_channel_message_header),
1564 msg = (struct vmbus_channel_message_header *)msginfo->msg;
1566 msg->msgtype = CHANNELMSG_REQUESTOFFERS;
1568 ret = vmbus_post_msg(msg, sizeof(struct vmbus_channel_message_header),
1571 trace_vmbus_request_offers(ret);
1574 pr_err("Unable to request offers - %d\n", ret);
1585 static void invoke_sc_cb(struct vmbus_channel *primary_channel)
1587 struct list_head *cur, *tmp;
1588 struct vmbus_channel *cur_channel;
1590 if (primary_channel->sc_creation_callback == NULL)
1593 list_for_each_safe(cur, tmp, &primary_channel->sc_list) {
1594 cur_channel = list_entry(cur, struct vmbus_channel, sc_list);
1596 primary_channel->sc_creation_callback(cur_channel);
1600 void vmbus_set_sc_create_callback(struct vmbus_channel *primary_channel,
1601 void (*sc_cr_cb)(struct vmbus_channel *new_sc))
1603 primary_channel->sc_creation_callback = sc_cr_cb;
1605 EXPORT_SYMBOL_GPL(vmbus_set_sc_create_callback);
1607 bool vmbus_are_subchannels_present(struct vmbus_channel *primary)
1611 ret = !list_empty(&primary->sc_list);
1615 * Invoke the callback on sub-channel creation.
1616 * This will present a uniform interface to the
1619 invoke_sc_cb(primary);
1624 EXPORT_SYMBOL_GPL(vmbus_are_subchannels_present);
1626 void vmbus_set_chn_rescind_callback(struct vmbus_channel *channel,
1627 void (*chn_rescind_cb)(struct vmbus_channel *))
1629 channel->chn_rescind_callback = chn_rescind_cb;
1631 EXPORT_SYMBOL_GPL(vmbus_set_chn_rescind_callback);