62  * In more detail. When a VMCI queue pair is first created, it will be in the
71  *       vmci_qp_broker_set_page_store to specify the UVAs of the queue pair at
76  * - VMCIQPB_CREATED_MEM: this state is the result when the queue pair
77  *     is created by a VMX using the queue pair device backend that
78  *     sets the UVAs of the queue pair immediately and stores the
82  * Once the queue pair is in one of the created states (with the exception of
84  * queue pair. Again we have two new states possible:
90  *       pair, and attaches to a queue pair previously created by the host side.
92  *     - from VMCIQPB_CREATED_MEM when the host side attaches to a queue pair
98  * - VMCIQPB_ATTACHED_NO_MEM: If the queue pair already was in the
100  *     bring the queue pair into this state. Once vmci_qp_broker_set_page_store
104  * From the attached queue pair, the queue pair can enter the shutdown states
105  * when either side of the queue pair detaches. If the guest side detaches
106  * first, the queue pair will enter the VMCIQPB_SHUTDOWN_NO_MEM state, where
107  * the content of the queue pair will no longer be available. If the host
108  * side detaches first, the queue pair will either enter the
115  * memory will no longer be available, and the queue pair will transition from
117  * in which case the queue pair will transition from the *_NO_MEM state at that
176  * In the queue pair broker, we always use the guest point of view for
181  * that creates the queue pair will have the right orientation, and
209 	void *local_mem;	/* Kernel memory for local queue pair */
476  * Frees the two list of PPNs for a queue pair.
572  * Initialize the mutex for the pair of queues.  This mutex is used to
594  * Cleans up the mutex for the pair of queues.
693  * pair. Enough information to map in pages is stored in the OS specific
737  * queue, the queue pair headers can be mapped into the
780  * Unmaps previously mapped queue pair headers from the kernel.
849  * Dispatches a queue pair event message directly into the local event
1020  * pages for the queue pair.
1089  * pair guest endpoint. Allocates physical pages for the queue
1090  * pair. It makes OS dependent calls through generic wrappers.
1130 				pr_devel("Error mismatched queue pair in local attach\n");  in qp_alloc_guest_work()
1185 	 * It's only necessary to notify the host if this queue pair will be  in qp_alloc_guest_work()
1232 	 * We should initialize the queue pair header pages on a local  in qp_alloc_guest_work()
1233 	 * queue pair create.  For non-local queue pairs, the  in qp_alloc_guest_work()
1264  * The first endpoint issuing a queue pair allocation will create the state
1265  * of the queue pair in the queue pair broker.
1268  * with the queue pair as specified by the page_store. For compatibility with
1275  * since the host is not able to supply a page store for the queue pair.
1277  * For older VMX and host callers, the queue pair will be created in the
1326 		 * The queue pair broker entry stores values from the guest  in qp_broker_create()
1329 		 * pair, in which case no swapping is necessary, since the local  in qp_broker_create()
1387 		 * The VMX already initialized the queue pair headers, so no  in qp_broker_create()
1402 		 * queue pair create (in which case we will expect a  in qp_broker_create()
1446  * the given queue pair handle about attach/detach event by the
1489  * The second endpoint issuing a queue pair allocation will attach to
1490  * the queue pair registered with the queue pair broker.
1493  * range with the queue pair as specified by the page_store. At this
1495  * pair, and an attach event is sent to it. For compatibility with
1505  * For new VMX and host callers, the queue pair will be moved to the
1569 		 * and a host created this queue pair.  in qp_broker_attach()
1580 		 * Do not attach a host to a user created queue pair if that  in qp_broker_attach()
1581 		 * user doesn't support host queue pair end points.  in qp_broker_attach()
1597 		 * The queue pair broker entry stores values from the guest  in qp_broker_attach()
1613 		 * If a guest attached to a queue pair, it will supply  in qp_broker_attach()
1621 		 * must the initially created queue pair not have any  in qp_broker_attach()
1632 			 * initialized the queue pair headers, so no  in qp_broker_attach()
1649 		 * pair that doesn't have any memory associated with  in qp_broker_attach()
1656 		/* The host side has successfully attached to a queue pair. */  in qp_broker_attach()
1665 			pr_warn("Failed to notify peer (ID=0x%x) of attach to queue pair (handle=0x%x:0x%x)\n",  in qp_broker_attach()
1679 	 * an entry tracking the queue pair, so don't add another one.  in qp_broker_attach()
1691  * queue_pair_Alloc for use when setting up queue pair endpoints
1732 		pr_devel("Context (ID=0x%x) already attached to queue pair (handle=0x%x:0x%x)\n",  in qp_broker_alloc()
1766  * pair.
1800 			 * If this is a local queue pair, the attacher  in qp_alloc_host_work()
1815 		pr_devel("queue pair broker failed to alloc (result=%d)\n",  in qp_alloc_host_work()
1858  * a queue pair.
1922  * Requests that a queue pair be allocated with the VMCI queue
1923  * pair broker. Allocates a queue pair entry if one does not
1925  * files backing that queue_pair.  Assumes that the queue pair
1947  * step to add the UVAs of the VMX mapping of the queue pair. This function
1949  * registering the page store for a queue pair previously allocated by the
1950  * VMX during create or attach. This function will move the queue pair state
1953  * attached state with memory, the queue pair is ready to be used by the
1956  * Assumes that the queue pair broker lock is held.
1985 		pr_warn("Context (ID=0x%x) not attached to queue pair (handle=0x%x:0x%x)\n",  in vmci_qp_broker_set_page_store()
2039 			pr_warn("Failed to notify peer (ID=0x%x) of attach to queue pair (handle=0x%x:0x%x)\n",  in vmci_qp_broker_set_page_store()
2063  * The main entry point for detaching from a queue pair registered with the
2064  * queue pair broker. If more than one endpoint is attached to the queue
2065  * pair, the first endpoint will mainly decrement a reference count and
2067  * the queue pair state registered with the broker.
2070  * memory backing the queue pair. If the host is still attached, it will
2071  * no longer be able to access the queue pair content.
2073  * If the queue pair is already in a state where there is no memory
2074  * registered for the queue pair (any *_NO_MEM state), it will transition to
2077  * the first out of two to detach, the queue pair will move to the
2096 		pr_devel("Context (ID=0x%x) not attached to queue pair (handle=0x%x:0x%x)\n",  in vmci_qp_broker_detach()
2104 …pr_devel("Context (ID=0x%x) reports being attached to queue pair(handle=0x%x:0x%x) that isn't pres…  in vmci_qp_broker_detach()
2130 		 * Pre NOVMVM vmx'en may detach from a queue pair  in vmci_qp_broker_detach()
2133 		 * recent VMX'en may detach from a queue pair in the  in vmci_qp_broker_detach()
2146 				pr_warn("Failed to unmap queue headers for queue pair (handle=0x%x:0x%x,result=%d)\n",  in vmci_qp_broker_detach()
2205  * Establishes the necessary mappings for a queue pair given a
2206  * reference to the queue pair guest memory. This is usually
2225 		pr_devel("Context (ID=0x%x) not attached to queue pair (handle=0x%x:0x%x)\n",  in vmci_qp_broker_map()
2233 …pr_devel("Context (ID=0x%x) reports being attached to queue pair (handle=0x%x:0x%x) that isn't pre…  in vmci_qp_broker_map()
2315  * Removes all references to the guest memory of a given queue pair, and
2316  * will move the queue pair from state *_MEM to *_NO_MEM. It is usually
2335 		pr_devel("Context (ID=0x%x) not attached to queue pair (handle=0x%x:0x%x)\n",  in vmci_qp_broker_unmap()
2343 …pr_devel("Context (ID=0x%x) reports being attached to queue pair (handle=0x%x:0x%x) that isn't pre…  in vmci_qp_broker_unmap()
2359 			pr_warn("Failed to save queue headers for queue pair (handle=0x%x:0x%x,result=%d)\n",  in vmci_qp_broker_unmap()
2367 		 * registered memory. If the queue pair is mapped again at a  in vmci_qp_broker_unmap()
2390  * Destroys all guest queue pair endpoints. If active guest queue
2420  * Helper routine that will lock the queue pair before subsequent
2433  * Helper routine that unlocks the queue pair after calling
2464  * headers of a given queue pair. If the guest memory of the
2465  * queue pair is currently not available, the saved queue headers
2489  * Callback from VMCI queue pair broker indicating that a queue
2490  * pair that was previously not ready, now either is ready or
2509  * Makes the calling thread wait for the queue pair to become
2511  * woken up after queue pair state change, false otherwise.
2534  * VMCI_ERROR_QUEUEPAIR_NOTATTACHED, if the queue pair pages aren't
2650  * vmci_qpair_alloc() - Allocates a queue pair.
2761  * vmci_qpair_detach() - Detatches the client from a queue pair.
2801  * @qpair:      Pointer to the queue pair struct.
2838  * @qpair:      Pointer to the queue pair struct.
2875  * @qpair:      Pointer to the queue pair struct.
2909  * @qpair:      Pointer to the queue pair struct.
2944  * @qpair:      Pointer to the queue pair struct.
2979  * @qpair:      Pointer to the queue pair struct.
3013  * @qpair:      Pointer to the queue pair struct.
3057  * @qpair:      Pointer to the queue pair struct.
3101  * @qpair:      Pointer to the queue pair struct.
3146  * @qpair:      Pointer to the queue pair struct.
3187  * @qpair:      Pointer to the queue pair struct.
3228  * @qpair:      Pointer to the queue pair struct.