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[] = {
37 { .dev_type = HV_SCSI,
61 { .dev_type = HV_PCIE,
66 /* Synthetic Frame Buffer */
72 /* Synthetic Keyboard */
79 { .dev_type = HV_MOUSE,
103 { .dev_type = HV_SHUTDOWN,
105 .perf_device = false,
109 { .dev_type = HV_FCOPY,
111 .perf_device = false,
115 { .dev_type = HV_BACKUP,
117 .perf_device = false,
123 .perf_device = false,
127 { .dev_type = HV_UNKNOWN,
128 .perf_device = false,
132 static const struct {
134 } vmbus_unsupported_devs[] = {
141 * The rescinded channel may be blocked waiting for a response from the host;
144 static void vmbus_rescind_cleanup(struct vmbus_channel *channel)
146 struct vmbus_channel_msginfo *msginfo;
150 spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
151 channel->rescind = true;
152 list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
155 if (msginfo->waiting_channel == channel) {
156 complete(&msginfo->waitevent);
160 spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
163 static bool is_unsupported_vmbus_devs(const guid_t *guid)
167 for (i = 0; i < ARRAY_SIZE(vmbus_unsupported_devs); i++)
168 if (guid_equal(guid, &vmbus_unsupported_devs[i].guid))
173 static u16 hv_get_dev_type(const struct vmbus_channel *channel)
175 const guid_t *guid = &channel->offermsg.offer.if_type;
178 if (is_hvsock_channel(channel) || is_unsupported_vmbus_devs(guid))
181 for (i = HV_IDE; i < HV_UNKNOWN; i++) {
182 if (guid_equal(guid, &vmbus_devs[i].guid))
185 pr_info("Unknown GUID: %pUl\n", guid);
190 * vmbus_prep_negotiate_resp() - Create default response for Negotiate message
191 * @icmsghdrp: Pointer to msg header structure
192 * @buf: Raw buffer channel data
193 * @fw_version: The framework versions we can support.
194 * @fw_vercnt: The size of @fw_version.
195 * @srv_version: The service versions we can support.
196 * @srv_vercnt: The size of @srv_version.
197 * @nego_fw_version: The selected framework version.
198 * @nego_srv_version: The selected service version.
200 * Note: Versions are given in decreasing order.
202 * Set up and fill in default negotiate response message.
203 * Mainly used by Hyper-V drivers.
205 bool vmbus_prep_negotiate_resp(struct icmsg_hdr *icmsghdrp,
206 u8 *buf, const int *fw_version, int fw_vercnt,
207 const int *srv_version, int srv_vercnt,
208 int *nego_fw_version, int *nego_srv_version)
210 int icframe_major, icframe_minor;
211 int icmsg_major, icmsg_minor;
212 int fw_major, fw_minor;
213 int srv_major, srv_minor;
215 bool found_match = false;
216 struct icmsg_negotiate *negop;
218 icmsghdrp->icmsgsize = 0x10;
219 negop = (struct icmsg_negotiate *)&buf[
220 sizeof(struct vmbuspipe_hdr) +
221 sizeof(struct icmsg_hdr)];
223 icframe_major = negop->icframe_vercnt;
226 icmsg_major = negop->icmsg_vercnt;
230 * Select the framework version number we will
234 for (i = 0; i < fw_vercnt; i++) {
235 fw_major = (fw_version[i] >> 16);
236 fw_minor = (fw_version[i] & 0xFFFF);
238 for (j = 0; j < negop->icframe_vercnt; j++) {
239 if ((negop->icversion_data[j].major == fw_major) &&
240 (negop->icversion_data[j].minor == fw_minor)) {
241 icframe_major = negop->icversion_data[j].major;
242 icframe_minor = negop->icversion_data[j].minor;
257 for (i = 0; i < srv_vercnt; i++) {
258 srv_major = (srv_version[i] >> 16);
259 srv_minor = (srv_version[i] & 0xFFFF);
261 for (j = negop->icframe_vercnt;
262 (j < negop->icframe_vercnt + negop->icmsg_vercnt);
265 if ((negop->icversion_data[j].major == srv_major) &&
266 (negop->icversion_data[j].minor == srv_minor)) {
268 icmsg_major = negop->icversion_data[j].major;
269 icmsg_minor = negop->icversion_data[j].minor;
280 * Respond with the framework and service
281 * version numbers we can support.
286 negop->icframe_vercnt = 0;
287 negop->icmsg_vercnt = 0;
289 negop->icframe_vercnt = 1;
290 negop->icmsg_vercnt = 1;
294 *nego_fw_version = (icframe_major << 16) | icframe_minor;
296 if (nego_srv_version)
297 *nego_srv_version = (icmsg_major << 16) | icmsg_minor;
299 negop->icversion_data[0].major = icframe_major;
300 negop->icversion_data[0].minor = icframe_minor;
301 negop->icversion_data[1].major = icmsg_major;
302 negop->icversion_data[1].minor = icmsg_minor;
306 EXPORT_SYMBOL_GPL(vmbus_prep_negotiate_resp);
309 * alloc_channel - Allocate and initialize a vmbus channel object
311 static struct vmbus_channel *alloc_channel(void)
313 struct vmbus_channel *channel;
315 channel = kzalloc(sizeof(*channel), GFP_ATOMIC);
319 spin_lock_init(&channel->sched_lock);
320 init_completion(&channel->rescind_event);
322 INIT_LIST_HEAD(&channel->sc_list);
324 tasklet_init(&channel->callback_event,
325 vmbus_on_event, (unsigned long)channel);
327 hv_ringbuffer_pre_init(channel);
333 * free_channel - Release the resources used by the vmbus channel object
335 static void free_channel(struct vmbus_channel *channel)
337 tasklet_kill(&channel->callback_event);
338 vmbus_remove_channel_attr_group(channel);
340 kobject_put(&channel->kobj);
343 void vmbus_channel_map_relid(struct vmbus_channel *channel)
345 if (WARN_ON(channel->offermsg.child_relid >= MAX_CHANNEL_RELIDS))
348 * The mapping of the channel's relid is visible from the CPUs that
349 * execute vmbus_chan_sched() by the time that vmbus_chan_sched() will
352 * (a) In the "normal (i.e., not resuming from hibernation)" path,
353 * the full barrier in virt_store_mb() guarantees that the store
354 * is propagated to all CPUs before the add_channel_work work
355 * is queued. In turn, add_channel_work is queued before the
356 * channel's ring buffer is allocated/initialized and the
357 * OPENCHANNEL message for the channel is sent in vmbus_open().
358 * Hyper-V won't start sending the interrupts for the channel
359 * before the OPENCHANNEL message is acked. The memory barrier
360 * in vmbus_chan_sched() -> sync_test_and_clear_bit() ensures
361 * that vmbus_chan_sched() must find the channel's relid in
362 * recv_int_page before retrieving the channel pointer from the
365 * (b) In the "resuming from hibernation" path, the virt_store_mb()
366 * guarantees that the store is propagated to all CPUs before
367 * the VMBus connection is marked as ready for the resume event
368 * (cf. check_ready_for_resume_event()). The interrupt handler
369 * of the VMBus driver and vmbus_chan_sched() can not run before
370 * vmbus_bus_resume() has completed execution (cf. resume_noirq).
373 vmbus_connection.channels[channel->offermsg.child_relid],
377 void vmbus_channel_unmap_relid(struct vmbus_channel *channel)
379 if (WARN_ON(channel->offermsg.child_relid >= MAX_CHANNEL_RELIDS))
382 vmbus_connection.channels[channel->offermsg.child_relid],
386 static void vmbus_release_relid(u32 relid)
388 struct vmbus_channel_relid_released msg;
391 memset(&msg, 0, sizeof(struct vmbus_channel_relid_released));
392 msg.child_relid = relid;
393 msg.header.msgtype = CHANNELMSG_RELID_RELEASED;
394 ret = vmbus_post_msg(&msg, sizeof(struct vmbus_channel_relid_released),
397 trace_vmbus_release_relid(&msg, ret);
400 void hv_process_channel_removal(struct vmbus_channel *channel)
402 lockdep_assert_held(&vmbus_connection.channel_mutex);
403 BUG_ON(!channel->rescind);
406 * hv_process_channel_removal() could find INVALID_RELID only for
407 * hv_sock channels. See the inline comments in vmbus_onoffer().
409 WARN_ON(channel->offermsg.child_relid == INVALID_RELID &&
410 !is_hvsock_channel(channel));
413 * Upon suspend, an in-use hv_sock channel is removed from the array of
414 * channels and the relid is invalidated. After hibernation, when the
415 * user-space appplication destroys the channel, it's unnecessary and
416 * unsafe to remove the channel from the array of channels. See also
417 * the inline comments before the call of vmbus_release_relid() below.
419 if (channel->offermsg.child_relid != INVALID_RELID)
420 vmbus_channel_unmap_relid(channel);
422 if (channel->primary_channel == NULL)
423 list_del(&channel->listentry);
425 list_del(&channel->sc_list);
428 * If this is a "perf" channel, updates the hv_numa_map[] masks so that
429 * init_vp_index() can (re-)use the CPU.
431 if (hv_is_perf_channel(channel))
432 hv_clear_alloced_cpu(channel->target_cpu);
435 * Upon suspend, an in-use hv_sock channel is marked as "rescinded" and
436 * the relid is invalidated; after hibernation, when the user-space app
437 * destroys the channel, the relid is INVALID_RELID, and in this case
438 * it's unnecessary and unsafe to release the old relid, since the same
439 * relid can refer to a completely different channel now.
441 if (channel->offermsg.child_relid != INVALID_RELID)
442 vmbus_release_relid(channel->offermsg.child_relid);
444 free_channel(channel);
447 void vmbus_free_channels(void)
449 struct vmbus_channel *channel, *tmp;
451 list_for_each_entry_safe(channel, tmp, &vmbus_connection.chn_list,
453 /* hv_process_channel_removal() needs this */
454 channel->rescind = true;
456 vmbus_device_unregister(channel->device_obj);
460 /* Note: the function can run concurrently for primary/sub channels. */
461 static void vmbus_add_channel_work(struct work_struct *work)
463 struct vmbus_channel *newchannel =
464 container_of(work, struct vmbus_channel, add_channel_work);
465 struct vmbus_channel *primary_channel = newchannel->primary_channel;
469 * This state is used to indicate a successful open
470 * so that when we do close the channel normally, we
471 * can cleanup properly.
473 newchannel->state = CHANNEL_OPEN_STATE;
475 if (primary_channel != NULL) {
476 /* newchannel is a sub-channel. */
477 struct hv_device *dev = primary_channel->device_obj;
479 if (vmbus_add_channel_kobj(dev, newchannel))
482 if (primary_channel->sc_creation_callback != NULL)
483 primary_channel->sc_creation_callback(newchannel);
485 newchannel->probe_done = true;
490 * Start the process of binding the primary channel to the driver
492 newchannel->device_obj = vmbus_device_create(
493 &newchannel->offermsg.offer.if_type,
494 &newchannel->offermsg.offer.if_instance,
496 if (!newchannel->device_obj)
499 newchannel->device_obj->device_id = newchannel->device_id;
501 * Add the new device to the bus. This will kick off device-driver
502 * binding which eventually invokes the device driver's AddDevice()
505 * If vmbus_device_register() fails, the 'device_obj' is freed in
506 * vmbus_device_release() as called by device_unregister() in the
507 * error path of vmbus_device_register(). In the outside error
508 * path, there's no need to free it.
510 ret = vmbus_device_register(newchannel->device_obj);
513 pr_err("unable to add child device object (relid %d)\n",
514 newchannel->offermsg.child_relid);
518 newchannel->probe_done = true;
522 mutex_lock(&vmbus_connection.channel_mutex);
525 * We need to set the flag, otherwise
526 * vmbus_onoffer_rescind() can be blocked.
528 newchannel->probe_done = true;
530 if (primary_channel == NULL)
531 list_del(&newchannel->listentry);
533 list_del(&newchannel->sc_list);
535 /* vmbus_process_offer() has mapped the channel. */
536 vmbus_channel_unmap_relid(newchannel);
538 mutex_unlock(&vmbus_connection.channel_mutex);
540 vmbus_release_relid(newchannel->offermsg.child_relid);
542 free_channel(newchannel);
546 * vmbus_process_offer - Process the offer by creating a channel/device
547 * associated with this offer
549 static void vmbus_process_offer(struct vmbus_channel *newchannel)
551 struct vmbus_channel *channel;
552 struct workqueue_struct *wq;
556 * Synchronize vmbus_process_offer() and CPU hotplugging:
560 * [vmbus_process_offer()] [Hot removal of the CPU]
562 * CPU_READ_LOCK CPUS_WRITE_LOCK
563 * LOAD cpu_online_mask SEARCH chn_list
564 * STORE target_cpu LOAD target_cpu
565 * INSERT chn_list STORE cpu_online_mask
566 * CPUS_READ_UNLOCK CPUS_WRITE_UNLOCK
568 * Forbids: CPU1's LOAD from *not* seing CPU2's STORE &&
569 * CPU2's SEARCH from *not* seeing CPU1's INSERT
571 * Forbids: CPU2's SEARCH from seeing CPU1's INSERT &&
572 * CPU2's LOAD from *not* seing CPU1's STORE
577 * Serializes the modifications of the chn_list list as well as
578 * the accesses to next_numa_node_id in init_vp_index().
580 mutex_lock(&vmbus_connection.channel_mutex);
582 init_vp_index(newchannel);
584 /* Remember the channels that should be cleaned up upon suspend. */
585 if (is_hvsock_channel(newchannel) || is_sub_channel(newchannel))
586 atomic_inc(&vmbus_connection.nr_chan_close_on_suspend);
589 * Now that we have acquired the channel_mutex,
590 * we can release the potentially racing rescind thread.
592 atomic_dec(&vmbus_connection.offer_in_progress);
594 list_for_each_entry(channel, &vmbus_connection.chn_list, listentry) {
595 if (guid_equal(&channel->offermsg.offer.if_type,
596 &newchannel->offermsg.offer.if_type) &&
597 guid_equal(&channel->offermsg.offer.if_instance,
598 &newchannel->offermsg.offer.if_instance)) {
605 list_add_tail(&newchannel->listentry,
606 &vmbus_connection.chn_list);
609 * Check to see if this is a valid sub-channel.
611 if (newchannel->offermsg.offer.sub_channel_index == 0) {
612 mutex_unlock(&vmbus_connection.channel_mutex);
615 * Don't call free_channel(), because newchannel->kobj
616 * is not initialized yet.
623 * Process the sub-channel.
625 newchannel->primary_channel = channel;
626 list_add_tail(&newchannel->sc_list, &channel->sc_list);
629 vmbus_channel_map_relid(newchannel);
631 mutex_unlock(&vmbus_connection.channel_mutex);
635 * vmbus_process_offer() mustn't call channel->sc_creation_callback()
636 * directly for sub-channels, because sc_creation_callback() ->
637 * vmbus_open() may never get the host's response to the
638 * OPEN_CHANNEL message (the host may rescind a channel at any time,
639 * e.g. in the case of hot removing a NIC), and vmbus_onoffer_rescind()
640 * may not wake up the vmbus_open() as it's blocked due to a non-zero
641 * vmbus_connection.offer_in_progress, and finally we have a deadlock.
643 * The above is also true for primary channels, if the related device
644 * drivers use sync probing mode by default.
646 * And, usually the handling of primary channels and sub-channels can
647 * depend on each other, so we should offload them to different
648 * workqueues to avoid possible deadlock, e.g. in sync-probing mode,
649 * NIC1's netvsc_subchan_work() can race with NIC2's netvsc_probe() ->
650 * rtnl_lock(), and causes deadlock: the former gets the rtnl_lock
651 * and waits for all the sub-channels to appear, but the latter
652 * can't get the rtnl_lock and this blocks the handling of
655 INIT_WORK(&newchannel->add_channel_work, vmbus_add_channel_work);
656 wq = fnew ? vmbus_connection.handle_primary_chan_wq :
657 vmbus_connection.handle_sub_chan_wq;
658 queue_work(wq, &newchannel->add_channel_work);
662 * We use this state to statically distribute the channel interrupt load.
664 static int next_numa_node_id;
667 * Starting with Win8, we can statically distribute the incoming
668 * channel interrupt load by binding a channel to VCPU.
670 * For pre-win8 hosts or non-performance critical channels we assign the
673 * Starting with win8, performance critical channels will be distributed
674 * evenly among all the available NUMA nodes. Once the node is assigned,
675 * we will assign the CPU based on a simple round robin scheme.
677 static void init_vp_index(struct vmbus_channel *channel)
679 bool perf_chn = hv_is_perf_channel(channel);
680 cpumask_var_t available_mask;
681 struct cpumask *alloced_mask;
685 if ((vmbus_proto_version == VERSION_WS2008) ||
686 (vmbus_proto_version == VERSION_WIN7) || (!perf_chn) ||
687 !alloc_cpumask_var(&available_mask, GFP_KERNEL)) {
689 * Prior to win8, all channel interrupts are
690 * delivered on VMBUS_CONNECT_CPU.
691 * Also if the channel is not a performance critical
692 * channel, bind it to VMBUS_CONNECT_CPU.
693 * In case alloc_cpumask_var() fails, bind it to
696 channel->target_cpu = VMBUS_CONNECT_CPU;
698 hv_set_alloced_cpu(VMBUS_CONNECT_CPU);
703 numa_node = next_numa_node_id++;
704 if (numa_node == nr_node_ids) {
705 next_numa_node_id = 0;
708 if (cpumask_empty(cpumask_of_node(numa_node)))
712 alloced_mask = &hv_context.hv_numa_map[numa_node];
714 if (cpumask_weight(alloced_mask) ==
715 cpumask_weight(cpumask_of_node(numa_node))) {
717 * We have cycled through all the CPUs in the node;
718 * reset the alloced map.
720 cpumask_clear(alloced_mask);
723 cpumask_xor(available_mask, alloced_mask, cpumask_of_node(numa_node));
725 target_cpu = cpumask_first(available_mask);
726 cpumask_set_cpu(target_cpu, alloced_mask);
728 channel->target_cpu = target_cpu;
730 free_cpumask_var(available_mask);
733 #define UNLOAD_DELAY_UNIT_MS 10 /* 10 milliseconds */
734 #define UNLOAD_WAIT_MS (100*1000) /* 100 seconds */
735 #define UNLOAD_WAIT_LOOPS (UNLOAD_WAIT_MS/UNLOAD_DELAY_UNIT_MS)
736 #define UNLOAD_MSG_MS (5*1000) /* Every 5 seconds */
737 #define UNLOAD_MSG_LOOPS (UNLOAD_MSG_MS/UNLOAD_DELAY_UNIT_MS)
739 static void vmbus_wait_for_unload(void)
743 struct hv_message *msg;
744 struct vmbus_channel_message_header *hdr;
748 * CHANNELMSG_UNLOAD_RESPONSE is always delivered to the CPU which was
749 * used for initial contact or to CPU0 depending on host version. When
750 * we're crashing on a different CPU let's hope that IRQ handler on
751 * the cpu which receives CHANNELMSG_UNLOAD_RESPONSE is still
752 * functional and vmbus_unload_response() will complete
753 * vmbus_connection.unload_event. If not, the last thing we can do is
754 * read message pages for all CPUs directly.
756 * Wait up to 100 seconds since an Azure host must writeback any dirty
757 * data in its disk cache before the VMbus UNLOAD request will
758 * complete. This flushing has been empirically observed to take up
759 * to 50 seconds in cases with a lot of dirty data, so allow additional
760 * leeway and for inaccuracies in mdelay(). But eventually time out so
761 * that the panic path can't get hung forever in case the response
762 * message isn't seen.
764 for (i = 1; i <= UNLOAD_WAIT_LOOPS; i++) {
765 if (completion_done(&vmbus_connection.unload_event))
768 for_each_present_cpu(cpu) {
769 struct hv_per_cpu_context *hv_cpu
770 = per_cpu_ptr(hv_context.cpu_context, cpu);
773 * In a CoCo VM the synic_message_page is not allocated
774 * in hv_synic_alloc(). Instead it is set/cleared in
775 * hv_synic_enable_regs() and hv_synic_disable_regs()
776 * such that it is set only when the CPU is online. If
777 * not all present CPUs are online, the message page
778 * might be NULL, so skip such CPUs.
780 page_addr = hv_cpu->synic_message_page;
784 msg = (struct hv_message *)page_addr
785 + VMBUS_MESSAGE_SINT;
787 message_type = READ_ONCE(msg->header.message_type);
788 if (message_type == HVMSG_NONE)
791 hdr = (struct vmbus_channel_message_header *)
794 if (hdr->msgtype == CHANNELMSG_UNLOAD_RESPONSE)
795 complete(&vmbus_connection.unload_event);
797 vmbus_signal_eom(msg, message_type);
801 * Give a notice periodically so someone watching the
802 * serial output won't think it is completely hung.
804 if (!(i % UNLOAD_MSG_LOOPS))
805 pr_notice("Waiting for VMBus UNLOAD to complete\n");
807 mdelay(UNLOAD_DELAY_UNIT_MS);
809 pr_err("Continuing even though VMBus UNLOAD did not complete\n");
813 * We're crashing and already got the UNLOAD_RESPONSE, cleanup all
814 * maybe-pending messages on all CPUs to be able to receive new
815 * messages after we reconnect.
817 for_each_present_cpu(cpu) {
818 struct hv_per_cpu_context *hv_cpu
819 = per_cpu_ptr(hv_context.cpu_context, cpu);
821 page_addr = hv_cpu->synic_message_page;
825 msg = (struct hv_message *)page_addr + VMBUS_MESSAGE_SINT;
826 msg->header.message_type = HVMSG_NONE;
831 * vmbus_unload_response - Handler for the unload response.
833 static void vmbus_unload_response(struct vmbus_channel_message_header *hdr)
836 * This is a global event; just wakeup the waiting thread.
837 * Once we successfully unload, we can cleanup the monitor state.
839 complete(&vmbus_connection.unload_event);
842 void vmbus_initiate_unload(bool crash)
844 struct vmbus_channel_message_header hdr;
846 if (xchg(&vmbus_connection.conn_state, DISCONNECTED) == DISCONNECTED)
849 /* Pre-Win2012R2 hosts don't support reconnect */
850 if (vmbus_proto_version < VERSION_WIN8_1)
853 init_completion(&vmbus_connection.unload_event);
854 memset(&hdr, 0, sizeof(struct vmbus_channel_message_header));
855 hdr.msgtype = CHANNELMSG_UNLOAD;
856 vmbus_post_msg(&hdr, sizeof(struct vmbus_channel_message_header),
860 * vmbus_initiate_unload() is also called on crash and the crash can be
861 * happening in an interrupt context, where scheduling is impossible.
864 wait_for_completion(&vmbus_connection.unload_event);
866 vmbus_wait_for_unload();
869 static void check_ready_for_resume_event(void)
872 * If all the old primary channels have been fixed up, then it's safe
875 if (atomic_dec_and_test(&vmbus_connection.nr_chan_fixup_on_resume))
876 complete(&vmbus_connection.ready_for_resume_event);
879 static void vmbus_setup_channel_state(struct vmbus_channel *channel,
880 struct vmbus_channel_offer_channel *offer)
883 * Setup state for signalling the host.
885 channel->sig_event = VMBUS_EVENT_CONNECTION_ID;
887 if (vmbus_proto_version != VERSION_WS2008) {
888 channel->is_dedicated_interrupt =
889 (offer->is_dedicated_interrupt != 0);
890 channel->sig_event = offer->connection_id;
893 memcpy(&channel->offermsg, offer,
894 sizeof(struct vmbus_channel_offer_channel));
895 channel->monitor_grp = (u8)offer->monitorid / 32;
896 channel->monitor_bit = (u8)offer->monitorid % 32;
897 channel->device_id = hv_get_dev_type(channel);
901 * find_primary_channel_by_offer - Get the channel object given the new offer.
902 * This is only used in the resume path of hibernation.
904 static struct vmbus_channel *
905 find_primary_channel_by_offer(const struct vmbus_channel_offer_channel *offer)
907 struct vmbus_channel *channel = NULL, *iter;
908 const guid_t *inst1, *inst2;
910 /* Ignore sub-channel offers. */
911 if (offer->offer.sub_channel_index != 0)
914 mutex_lock(&vmbus_connection.channel_mutex);
916 list_for_each_entry(iter, &vmbus_connection.chn_list, listentry) {
917 inst1 = &iter->offermsg.offer.if_instance;
918 inst2 = &offer->offer.if_instance;
920 if (guid_equal(inst1, inst2)) {
926 mutex_unlock(&vmbus_connection.channel_mutex);
932 * vmbus_onoffer - Handler for channel offers from vmbus in parent partition.
935 static void vmbus_onoffer(struct vmbus_channel_message_header *hdr)
937 struct vmbus_channel_offer_channel *offer;
938 struct vmbus_channel *oldchannel, *newchannel;
941 offer = (struct vmbus_channel_offer_channel *)hdr;
943 trace_vmbus_onoffer(offer);
945 oldchannel = find_primary_channel_by_offer(offer);
947 if (oldchannel != NULL) {
949 * We're resuming from hibernation: all the sub-channel and
950 * hv_sock channels we had before the hibernation should have
951 * been cleaned up, and now we must be seeing a re-offered
952 * primary channel that we had before the hibernation.
956 * { Initially: channel relid = INVALID_RELID,
957 * channels[valid_relid] = NULL }
961 * [vmbus_onoffer()] [vmbus_device_release()]
963 * LOCK channel_mutex LOCK channel_mutex
964 * STORE channel relid = valid_relid LOAD r1 = channel relid
965 * MAP_RELID channel if (r1 != INVALID_RELID)
966 * UNLOCK channel_mutex UNMAP_RELID channel
967 * UNLOCK channel_mutex
969 * Forbids: r1 == valid_relid &&
970 * channels[valid_relid] == channel
972 * Note. r1 can be INVALID_RELID only for an hv_sock channel.
973 * None of the hv_sock channels which were present before the
974 * suspend are re-offered upon the resume. See the WARN_ON()
975 * in hv_process_channel_removal().
977 mutex_lock(&vmbus_connection.channel_mutex);
979 atomic_dec(&vmbus_connection.offer_in_progress);
981 WARN_ON(oldchannel->offermsg.child_relid != INVALID_RELID);
982 /* Fix up the relid. */
983 oldchannel->offermsg.child_relid = offer->child_relid;
985 offer_sz = sizeof(*offer);
986 if (memcmp(offer, &oldchannel->offermsg, offer_sz) != 0) {
988 * This is not an error, since the host can also change
989 * the other field(s) of the offer, e.g. on WS RS5
990 * (Build 17763), the offer->connection_id of the
991 * Mellanox VF vmbus device can change when the host
992 * reoffers the device upon resume.
994 pr_debug("vmbus offer changed: relid=%d\n",
997 print_hex_dump_debug("Old vmbus offer: ",
998 DUMP_PREFIX_OFFSET, 16, 4,
999 &oldchannel->offermsg, offer_sz,
1001 print_hex_dump_debug("New vmbus offer: ",
1002 DUMP_PREFIX_OFFSET, 16, 4,
1003 offer, offer_sz, false);
1005 /* Fix up the old channel. */
1006 vmbus_setup_channel_state(oldchannel, offer);
1009 /* Add the channel back to the array of channels. */
1010 vmbus_channel_map_relid(oldchannel);
1011 check_ready_for_resume_event();
1013 mutex_unlock(&vmbus_connection.channel_mutex);
1017 /* Allocate the channel object and save this offer. */
1018 newchannel = alloc_channel();
1020 vmbus_release_relid(offer->child_relid);
1021 atomic_dec(&vmbus_connection.offer_in_progress);
1022 pr_err("Unable to allocate channel object\n");
1026 vmbus_setup_channel_state(newchannel, offer);
1028 vmbus_process_offer(newchannel);
1031 static void check_ready_for_suspend_event(void)
1034 * If all the sub-channels or hv_sock channels have been cleaned up,
1035 * then it's safe to suspend.
1037 if (atomic_dec_and_test(&vmbus_connection.nr_chan_close_on_suspend))
1038 complete(&vmbus_connection.ready_for_suspend_event);
1042 * vmbus_onoffer_rescind - Rescind offer handler.
1044 * We queue a work item to process this offer synchronously
1046 static void vmbus_onoffer_rescind(struct vmbus_channel_message_header *hdr)
1048 struct vmbus_channel_rescind_offer *rescind;
1049 struct vmbus_channel *channel;
1051 bool clean_up_chan_for_suspend;
1053 rescind = (struct vmbus_channel_rescind_offer *)hdr;
1055 trace_vmbus_onoffer_rescind(rescind);
1058 * The offer msg and the corresponding rescind msg
1059 * from the host are guranteed to be ordered -
1060 * offer comes in first and then the rescind.
1061 * Since we process these events in work elements,
1062 * and with preemption, we may end up processing
1063 * the events out of order. We rely on the synchronization
1064 * provided by offer_in_progress and by channel_mutex for
1065 * ordering these events:
1067 * { Initially: offer_in_progress = 1 }
1071 * [vmbus_onoffer()] [vmbus_onoffer_rescind()]
1073 * LOCK channel_mutex WAIT_ON offer_in_progress == 0
1074 * DECREMENT offer_in_progress LOCK channel_mutex
1075 * STORE channels[] LOAD channels[]
1076 * UNLOCK channel_mutex UNLOCK channel_mutex
1078 * Forbids: CPU2's LOAD from *not* seeing CPU1's STORE
1081 while (atomic_read(&vmbus_connection.offer_in_progress) != 0) {
1083 * We wait here until any channel offer is currently
1089 mutex_lock(&vmbus_connection.channel_mutex);
1090 channel = relid2channel(rescind->child_relid);
1091 mutex_unlock(&vmbus_connection.channel_mutex);
1093 if (channel == NULL) {
1095 * We failed in processing the offer message;
1096 * we would have cleaned up the relid in that
1102 clean_up_chan_for_suspend = is_hvsock_channel(channel) ||
1103 is_sub_channel(channel);
1105 * Before setting channel->rescind in vmbus_rescind_cleanup(), we
1106 * should make sure the channel callback is not running any more.
1108 vmbus_reset_channel_cb(channel);
1111 * Now wait for offer handling to complete.
1113 vmbus_rescind_cleanup(channel);
1114 while (READ_ONCE(channel->probe_done) == false) {
1116 * We wait here until any channel offer is currently
1123 * At this point, the rescind handling can proceed safely.
1126 if (channel->device_obj) {
1127 if (channel->chn_rescind_callback) {
1128 channel->chn_rescind_callback(channel);
1130 if (clean_up_chan_for_suspend)
1131 check_ready_for_suspend_event();
1136 * We will have to unregister this device from the
1139 dev = get_device(&channel->device_obj->device);
1141 vmbus_device_unregister(channel->device_obj);
1144 } else if (channel->primary_channel != NULL) {
1146 * Sub-channel is being rescinded. Following is the channel
1147 * close sequence when initiated from the driveri (refer to
1148 * vmbus_close() for details):
1149 * 1. Close all sub-channels first
1150 * 2. Then close the primary channel.
1152 mutex_lock(&vmbus_connection.channel_mutex);
1153 if (channel->state == CHANNEL_OPEN_STATE) {
1155 * The channel is currently not open;
1156 * it is safe for us to cleanup the channel.
1158 hv_process_channel_removal(channel);
1160 complete(&channel->rescind_event);
1162 mutex_unlock(&vmbus_connection.channel_mutex);
1165 /* The "channel" may have been freed. Do not access it any longer. */
1167 if (clean_up_chan_for_suspend)
1168 check_ready_for_suspend_event();
1171 void vmbus_hvsock_device_unregister(struct vmbus_channel *channel)
1173 BUG_ON(!is_hvsock_channel(channel));
1175 /* We always get a rescind msg when a connection is closed. */
1176 while (!READ_ONCE(channel->probe_done) || !READ_ONCE(channel->rescind))
1179 vmbus_device_unregister(channel->device_obj);
1181 EXPORT_SYMBOL_GPL(vmbus_hvsock_device_unregister);
1185 * vmbus_onoffers_delivered -
1186 * This is invoked when all offers have been delivered.
1188 * Nothing to do here.
1190 static void vmbus_onoffers_delivered(
1191 struct vmbus_channel_message_header *hdr)
1196 * vmbus_onopen_result - Open result handler.
1198 * This is invoked when we received a response to our channel open request.
1199 * Find the matching request, copy the response and signal the requesting
1202 static void vmbus_onopen_result(struct vmbus_channel_message_header *hdr)
1204 struct vmbus_channel_open_result *result;
1205 struct vmbus_channel_msginfo *msginfo;
1206 struct vmbus_channel_message_header *requestheader;
1207 struct vmbus_channel_open_channel *openmsg;
1208 unsigned long flags;
1210 result = (struct vmbus_channel_open_result *)hdr;
1212 trace_vmbus_onopen_result(result);
1215 * Find the open msg, copy the result and signal/unblock the wait event
1217 spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
1219 list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
1222 (struct vmbus_channel_message_header *)msginfo->msg;
1224 if (requestheader->msgtype == CHANNELMSG_OPENCHANNEL) {
1226 (struct vmbus_channel_open_channel *)msginfo->msg;
1227 if (openmsg->child_relid == result->child_relid &&
1228 openmsg->openid == result->openid) {
1229 memcpy(&msginfo->response.open_result,
1232 struct vmbus_channel_open_result));
1233 complete(&msginfo->waitevent);
1238 spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
1242 * vmbus_ongpadl_created - GPADL created handler.
1244 * This is invoked when we received a response to our gpadl create request.
1245 * Find the matching request, copy the response and signal the requesting
1248 static void vmbus_ongpadl_created(struct vmbus_channel_message_header *hdr)
1250 struct vmbus_channel_gpadl_created *gpadlcreated;
1251 struct vmbus_channel_msginfo *msginfo;
1252 struct vmbus_channel_message_header *requestheader;
1253 struct vmbus_channel_gpadl_header *gpadlheader;
1254 unsigned long flags;
1256 gpadlcreated = (struct vmbus_channel_gpadl_created *)hdr;
1258 trace_vmbus_ongpadl_created(gpadlcreated);
1261 * Find the establish msg, copy the result and signal/unblock the wait
1264 spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
1266 list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
1269 (struct vmbus_channel_message_header *)msginfo->msg;
1271 if (requestheader->msgtype == CHANNELMSG_GPADL_HEADER) {
1273 (struct vmbus_channel_gpadl_header *)requestheader;
1275 if ((gpadlcreated->child_relid ==
1276 gpadlheader->child_relid) &&
1277 (gpadlcreated->gpadl == gpadlheader->gpadl)) {
1278 memcpy(&msginfo->response.gpadl_created,
1281 struct vmbus_channel_gpadl_created));
1282 complete(&msginfo->waitevent);
1287 spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
1291 * vmbus_ongpadl_torndown - GPADL torndown handler.
1293 * This is invoked when we received a response to our gpadl teardown request.
1294 * Find the matching request, copy the response and signal the requesting
1297 static void vmbus_ongpadl_torndown(
1298 struct vmbus_channel_message_header *hdr)
1300 struct vmbus_channel_gpadl_torndown *gpadl_torndown;
1301 struct vmbus_channel_msginfo *msginfo;
1302 struct vmbus_channel_message_header *requestheader;
1303 struct vmbus_channel_gpadl_teardown *gpadl_teardown;
1304 unsigned long flags;
1306 gpadl_torndown = (struct vmbus_channel_gpadl_torndown *)hdr;
1308 trace_vmbus_ongpadl_torndown(gpadl_torndown);
1311 * Find the open msg, copy the result and signal/unblock the wait event
1313 spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
1315 list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
1318 (struct vmbus_channel_message_header *)msginfo->msg;
1320 if (requestheader->msgtype == CHANNELMSG_GPADL_TEARDOWN) {
1322 (struct vmbus_channel_gpadl_teardown *)requestheader;
1324 if (gpadl_torndown->gpadl == gpadl_teardown->gpadl) {
1325 memcpy(&msginfo->response.gpadl_torndown,
1328 struct vmbus_channel_gpadl_torndown));
1329 complete(&msginfo->waitevent);
1334 spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
1338 * vmbus_onversion_response - Version response handler
1340 * This is invoked when we received a response to our initiate contact request.
1341 * Find the matching request, copy the response and signal the requesting
1344 static void vmbus_onversion_response(
1345 struct vmbus_channel_message_header *hdr)
1347 struct vmbus_channel_msginfo *msginfo;
1348 struct vmbus_channel_message_header *requestheader;
1349 struct vmbus_channel_version_response *version_response;
1350 unsigned long flags;
1352 version_response = (struct vmbus_channel_version_response *)hdr;
1354 trace_vmbus_onversion_response(version_response);
1356 spin_lock_irqsave(&vmbus_connection.channelmsg_lock, flags);
1358 list_for_each_entry(msginfo, &vmbus_connection.chn_msg_list,
1361 (struct vmbus_channel_message_header *)msginfo->msg;
1363 if (requestheader->msgtype ==
1364 CHANNELMSG_INITIATE_CONTACT) {
1365 memcpy(&msginfo->response.version_response,
1367 sizeof(struct vmbus_channel_version_response));
1368 complete(&msginfo->waitevent);
1371 spin_unlock_irqrestore(&vmbus_connection.channelmsg_lock, flags);
1374 /* Channel message dispatch table */
1375 const struct vmbus_channel_message_table_entry
1376 channel_message_table[CHANNELMSG_COUNT] = {
1377 { CHANNELMSG_INVALID, 0, NULL, 0},
1378 { CHANNELMSG_OFFERCHANNEL, 0, vmbus_onoffer,
1379 sizeof(struct vmbus_channel_offer_channel)},
1380 { CHANNELMSG_RESCIND_CHANNELOFFER, 0, vmbus_onoffer_rescind,
1381 sizeof(struct vmbus_channel_rescind_offer) },
1382 { CHANNELMSG_REQUESTOFFERS, 0, NULL, 0},
1383 { CHANNELMSG_ALLOFFERS_DELIVERED, 1, vmbus_onoffers_delivered, 0},
1384 { CHANNELMSG_OPENCHANNEL, 0, NULL, 0},
1385 { CHANNELMSG_OPENCHANNEL_RESULT, 1, vmbus_onopen_result,
1386 sizeof(struct vmbus_channel_open_result)},
1387 { CHANNELMSG_CLOSECHANNEL, 0, NULL, 0},
1388 { CHANNELMSG_GPADL_HEADER, 0, NULL, 0},
1389 { CHANNELMSG_GPADL_BODY, 0, NULL, 0},
1390 { CHANNELMSG_GPADL_CREATED, 1, vmbus_ongpadl_created,
1391 sizeof(struct vmbus_channel_gpadl_created)},
1392 { CHANNELMSG_GPADL_TEARDOWN, 0, NULL, 0},
1393 { CHANNELMSG_GPADL_TORNDOWN, 1, vmbus_ongpadl_torndown,
1394 sizeof(struct vmbus_channel_gpadl_torndown) },
1395 { CHANNELMSG_RELID_RELEASED, 0, NULL, 0},
1396 { CHANNELMSG_INITIATE_CONTACT, 0, NULL, 0},
1397 { CHANNELMSG_VERSION_RESPONSE, 1, vmbus_onversion_response,
1398 sizeof(struct vmbus_channel_version_response)},
1399 { CHANNELMSG_UNLOAD, 0, NULL, 0},
1400 { CHANNELMSG_UNLOAD_RESPONSE, 1, vmbus_unload_response, 0},
1401 { CHANNELMSG_18, 0, NULL, 0},
1402 { CHANNELMSG_19, 0, NULL, 0},
1403 { CHANNELMSG_20, 0, NULL, 0},
1404 { CHANNELMSG_TL_CONNECT_REQUEST, 0, NULL, 0},
1405 { CHANNELMSG_MODIFYCHANNEL, 0, NULL, 0},
1406 { CHANNELMSG_TL_CONNECT_RESULT, 0, NULL, 0},
1410 * vmbus_onmessage - Handler for channel protocol messages.
1412 * This is invoked in the vmbus worker thread context.
1414 void vmbus_onmessage(struct vmbus_channel_message_header *hdr)
1416 trace_vmbus_on_message(hdr);
1419 * vmbus_on_msg_dpc() makes sure the hdr->msgtype here can not go
1420 * out of bound and the message_handler pointer can not be NULL.
1422 channel_message_table[hdr->msgtype].message_handler(hdr);
1426 * vmbus_request_offers - Send a request to get all our pending offers.
1428 int vmbus_request_offers(void)
1430 struct vmbus_channel_message_header *msg;
1431 struct vmbus_channel_msginfo *msginfo;
1434 msginfo = kmalloc(sizeof(*msginfo) +
1435 sizeof(struct vmbus_channel_message_header),
1440 msg = (struct vmbus_channel_message_header *)msginfo->msg;
1442 msg->msgtype = CHANNELMSG_REQUESTOFFERS;
1444 ret = vmbus_post_msg(msg, sizeof(struct vmbus_channel_message_header),
1447 trace_vmbus_request_offers(ret);
1450 pr_err("Unable to request offers - %d\n", ret);
1461 static void invoke_sc_cb(struct vmbus_channel *primary_channel)
1463 struct list_head *cur, *tmp;
1464 struct vmbus_channel *cur_channel;
1466 if (primary_channel->sc_creation_callback == NULL)
1469 list_for_each_safe(cur, tmp, &primary_channel->sc_list) {
1470 cur_channel = list_entry(cur, struct vmbus_channel, sc_list);
1472 primary_channel->sc_creation_callback(cur_channel);
1476 void vmbus_set_sc_create_callback(struct vmbus_channel *primary_channel,
1477 void (*sc_cr_cb)(struct vmbus_channel *new_sc))
1479 primary_channel->sc_creation_callback = sc_cr_cb;
1481 EXPORT_SYMBOL_GPL(vmbus_set_sc_create_callback);
1483 bool vmbus_are_subchannels_present(struct vmbus_channel *primary)
1487 ret = !list_empty(&primary->sc_list);
1491 * Invoke the callback on sub-channel creation.
1492 * This will present a uniform interface to the
1495 invoke_sc_cb(primary);
1500 EXPORT_SYMBOL_GPL(vmbus_are_subchannels_present);
1502 void vmbus_set_chn_rescind_callback(struct vmbus_channel *channel,
1503 void (*chn_rescind_cb)(struct vmbus_channel *))
1505 channel->chn_rescind_callback = chn_rescind_cb;
1507 EXPORT_SYMBOL_GPL(vmbus_set_chn_rescind_callback);