1 /* 2 * 3 * Copyright (c) 2011, 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> 21 * K. Y. Srinivasan <kys@microsoft.com> 22 * 23 */ 24 25 #ifndef _HYPERV_VMBUS_H 26 #define _HYPERV_VMBUS_H 27 28 #include <linux/list.h> 29 #include <asm/sync_bitops.h> 30 #include <linux/atomic.h> 31 #include <linux/hyperv.h> 32 #include <linux/interrupt.h> 33 34 #include "hv_trace.h" 35 36 /* 37 * Timeout for services such as KVP and fcopy. 38 */ 39 #define HV_UTIL_TIMEOUT 30 40 41 /* 42 * Timeout for guest-host handshake for services. 43 */ 44 #define HV_UTIL_NEGO_TIMEOUT 55 45 46 /* Define synthetic interrupt controller flag constants. */ 47 #define HV_EVENT_FLAGS_COUNT (256 * 8) 48 #define HV_EVENT_FLAGS_LONG_COUNT (256 / sizeof(unsigned long)) 49 50 /* 51 * Timer configuration register. 52 */ 53 union hv_timer_config { 54 u64 as_uint64; 55 struct { 56 u64 enable:1; 57 u64 periodic:1; 58 u64 lazy:1; 59 u64 auto_enable:1; 60 u64 apic_vector:8; 61 u64 direct_mode:1; 62 u64 reserved_z0:3; 63 u64 sintx:4; 64 u64 reserved_z1:44; 65 }; 66 }; 67 68 69 /* Define the synthetic interrupt controller event flags format. */ 70 union hv_synic_event_flags { 71 unsigned long flags[HV_EVENT_FLAGS_LONG_COUNT]; 72 }; 73 74 /* Define SynIC control register. */ 75 union hv_synic_scontrol { 76 u64 as_uint64; 77 struct { 78 u64 enable:1; 79 u64 reserved:63; 80 }; 81 }; 82 83 /* Define synthetic interrupt source. */ 84 union hv_synic_sint { 85 u64 as_uint64; 86 struct { 87 u64 vector:8; 88 u64 reserved1:8; 89 u64 masked:1; 90 u64 auto_eoi:1; 91 u64 reserved2:46; 92 }; 93 }; 94 95 /* Define the format of the SIMP register */ 96 union hv_synic_simp { 97 u64 as_uint64; 98 struct { 99 u64 simp_enabled:1; 100 u64 preserved:11; 101 u64 base_simp_gpa:52; 102 }; 103 }; 104 105 /* Define the format of the SIEFP register */ 106 union hv_synic_siefp { 107 u64 as_uint64; 108 struct { 109 u64 siefp_enabled:1; 110 u64 preserved:11; 111 u64 base_siefp_gpa:52; 112 }; 113 }; 114 115 /* Definitions for the monitored notification facility */ 116 union hv_monitor_trigger_group { 117 u64 as_uint64; 118 struct { 119 u32 pending; 120 u32 armed; 121 }; 122 }; 123 124 struct hv_monitor_parameter { 125 union hv_connection_id connectionid; 126 u16 flagnumber; 127 u16 rsvdz; 128 }; 129 130 union hv_monitor_trigger_state { 131 u32 asu32; 132 133 struct { 134 u32 group_enable:4; 135 u32 rsvdz:28; 136 }; 137 }; 138 139 /* struct hv_monitor_page Layout */ 140 /* ------------------------------------------------------ */ 141 /* | 0 | TriggerState (4 bytes) | Rsvd1 (4 bytes) | */ 142 /* | 8 | TriggerGroup[0] | */ 143 /* | 10 | TriggerGroup[1] | */ 144 /* | 18 | TriggerGroup[2] | */ 145 /* | 20 | TriggerGroup[3] | */ 146 /* | 28 | Rsvd2[0] | */ 147 /* | 30 | Rsvd2[1] | */ 148 /* | 38 | Rsvd2[2] | */ 149 /* | 40 | NextCheckTime[0][0] | NextCheckTime[0][1] | */ 150 /* | ... | */ 151 /* | 240 | Latency[0][0..3] | */ 152 /* | 340 | Rsvz3[0] | */ 153 /* | 440 | Parameter[0][0] | */ 154 /* | 448 | Parameter[0][1] | */ 155 /* | ... | */ 156 /* | 840 | Rsvd4[0] | */ 157 /* ------------------------------------------------------ */ 158 struct hv_monitor_page { 159 union hv_monitor_trigger_state trigger_state; 160 u32 rsvdz1; 161 162 union hv_monitor_trigger_group trigger_group[4]; 163 u64 rsvdz2[3]; 164 165 s32 next_checktime[4][32]; 166 167 u16 latency[4][32]; 168 u64 rsvdz3[32]; 169 170 struct hv_monitor_parameter parameter[4][32]; 171 172 u8 rsvdz4[1984]; 173 }; 174 175 #define HV_HYPERCALL_PARAM_ALIGN sizeof(u64) 176 177 /* Definition of the hv_post_message hypercall input structure. */ 178 struct hv_input_post_message { 179 union hv_connection_id connectionid; 180 u32 reserved; 181 u32 message_type; 182 u32 payload_size; 183 u64 payload[HV_MESSAGE_PAYLOAD_QWORD_COUNT]; 184 }; 185 186 187 enum { 188 VMBUS_MESSAGE_CONNECTION_ID = 1, 189 VMBUS_MESSAGE_PORT_ID = 1, 190 VMBUS_EVENT_CONNECTION_ID = 2, 191 VMBUS_EVENT_PORT_ID = 2, 192 VMBUS_MONITOR_CONNECTION_ID = 3, 193 VMBUS_MONITOR_PORT_ID = 3, 194 VMBUS_MESSAGE_SINT = 2, 195 }; 196 197 /* 198 * Per cpu state for channel handling 199 */ 200 struct hv_per_cpu_context { 201 void *synic_message_page; 202 void *synic_event_page; 203 /* 204 * buffer to post messages to the host. 205 */ 206 void *post_msg_page; 207 208 /* 209 * Starting with win8, we can take channel interrupts on any CPU; 210 * we will manage the tasklet that handles events messages on a per CPU 211 * basis. 212 */ 213 struct tasklet_struct msg_dpc; 214 215 /* 216 * To optimize the mapping of relid to channel, maintain 217 * per-cpu list of the channels based on their CPU affinity. 218 */ 219 struct list_head chan_list; 220 struct clock_event_device *clk_evt; 221 }; 222 223 struct hv_context { 224 /* We only support running on top of Hyper-V 225 * So at this point this really can only contain the Hyper-V ID 226 */ 227 u64 guestid; 228 229 void *tsc_page; 230 231 bool synic_initialized; 232 233 struct hv_per_cpu_context __percpu *cpu_context; 234 235 /* 236 * To manage allocations in a NUMA node. 237 * Array indexed by numa node ID. 238 */ 239 struct cpumask *hv_numa_map; 240 }; 241 242 extern struct hv_context hv_context; 243 244 /* Hv Interface */ 245 246 extern int hv_init(void); 247 248 extern int hv_post_message(union hv_connection_id connection_id, 249 enum hv_message_type message_type, 250 void *payload, size_t payload_size); 251 252 extern int hv_synic_alloc(void); 253 254 extern void hv_synic_free(void); 255 256 extern int hv_synic_init(unsigned int cpu); 257 258 extern int hv_synic_cleanup(unsigned int cpu); 259 260 extern void hv_synic_clockevents_cleanup(void); 261 262 /* Interface */ 263 264 265 int hv_ringbuffer_init(struct hv_ring_buffer_info *ring_info, 266 struct page *pages, u32 pagecnt); 267 268 void hv_ringbuffer_cleanup(struct hv_ring_buffer_info *ring_info); 269 270 int hv_ringbuffer_write(struct vmbus_channel *channel, 271 const struct kvec *kv_list, u32 kv_count); 272 273 int hv_ringbuffer_read(struct vmbus_channel *channel, 274 void *buffer, u32 buflen, u32 *buffer_actual_len, 275 u64 *requestid, bool raw); 276 277 /* 278 * Maximum channels is determined by the size of the interrupt page 279 * which is PAGE_SIZE. 1/2 of PAGE_SIZE is for send endpoint interrupt 280 * and the other is receive endpoint interrupt 281 */ 282 #define MAX_NUM_CHANNELS ((PAGE_SIZE >> 1) << 3) /* 16348 channels */ 283 284 /* The value here must be in multiple of 32 */ 285 /* TODO: Need to make this configurable */ 286 #define MAX_NUM_CHANNELS_SUPPORTED 256 287 288 289 enum vmbus_connect_state { 290 DISCONNECTED, 291 CONNECTING, 292 CONNECTED, 293 DISCONNECTING 294 }; 295 296 #define MAX_SIZE_CHANNEL_MESSAGE HV_MESSAGE_PAYLOAD_BYTE_COUNT 297 298 struct vmbus_connection { 299 /* 300 * CPU on which the initial host contact was made. 301 */ 302 int connect_cpu; 303 304 atomic_t offer_in_progress; 305 306 enum vmbus_connect_state conn_state; 307 308 atomic_t next_gpadl_handle; 309 310 struct completion unload_event; 311 /* 312 * Represents channel interrupts. Each bit position represents a 313 * channel. When a channel sends an interrupt via VMBUS, it finds its 314 * bit in the sendInterruptPage, set it and calls Hv to generate a port 315 * event. The other end receives the port event and parse the 316 * recvInterruptPage to see which bit is set 317 */ 318 void *int_page; 319 void *send_int_page; 320 void *recv_int_page; 321 322 /* 323 * 2 pages - 1st page for parent->child notification and 2nd 324 * is child->parent notification 325 */ 326 struct hv_monitor_page *monitor_pages[2]; 327 struct list_head chn_msg_list; 328 spinlock_t channelmsg_lock; 329 330 /* List of channels */ 331 struct list_head chn_list; 332 struct mutex channel_mutex; 333 334 struct workqueue_struct *work_queue; 335 }; 336 337 338 struct vmbus_msginfo { 339 /* Bookkeeping stuff */ 340 struct list_head msglist_entry; 341 342 /* The message itself */ 343 unsigned char msg[0]; 344 }; 345 346 347 extern struct vmbus_connection vmbus_connection; 348 349 static inline void vmbus_send_interrupt(u32 relid) 350 { 351 sync_set_bit(relid, vmbus_connection.send_int_page); 352 } 353 354 enum vmbus_message_handler_type { 355 /* The related handler can sleep. */ 356 VMHT_BLOCKING = 0, 357 358 /* The related handler must NOT sleep. */ 359 VMHT_NON_BLOCKING = 1, 360 }; 361 362 struct vmbus_channel_message_table_entry { 363 enum vmbus_channel_message_type message_type; 364 enum vmbus_message_handler_type handler_type; 365 void (*message_handler)(struct vmbus_channel_message_header *msg); 366 }; 367 368 extern const struct vmbus_channel_message_table_entry 369 channel_message_table[CHANNELMSG_COUNT]; 370 371 372 /* General vmbus interface */ 373 374 struct hv_device *vmbus_device_create(const uuid_le *type, 375 const uuid_le *instance, 376 struct vmbus_channel *channel); 377 378 int vmbus_device_register(struct hv_device *child_device_obj); 379 void vmbus_device_unregister(struct hv_device *device_obj); 380 int vmbus_add_channel_kobj(struct hv_device *device_obj, 381 struct vmbus_channel *channel); 382 383 struct vmbus_channel *relid2channel(u32 relid); 384 385 void vmbus_free_channels(void); 386 387 /* Connection interface */ 388 389 int vmbus_connect(void); 390 void vmbus_disconnect(void); 391 392 int vmbus_post_msg(void *buffer, size_t buflen, bool can_sleep); 393 394 void vmbus_on_event(unsigned long data); 395 void vmbus_on_msg_dpc(unsigned long data); 396 397 int hv_kvp_init(struct hv_util_service *srv); 398 void hv_kvp_deinit(void); 399 void hv_kvp_onchannelcallback(void *context); 400 401 int hv_vss_init(struct hv_util_service *srv); 402 void hv_vss_deinit(void); 403 void hv_vss_onchannelcallback(void *context); 404 405 int hv_fcopy_init(struct hv_util_service *srv); 406 void hv_fcopy_deinit(void); 407 void hv_fcopy_onchannelcallback(void *context); 408 void vmbus_initiate_unload(bool crash); 409 410 static inline void hv_poll_channel(struct vmbus_channel *channel, 411 void (*cb)(void *)) 412 { 413 if (!channel) 414 return; 415 416 if (in_interrupt() && (channel->target_cpu == smp_processor_id())) { 417 cb(channel); 418 return; 419 } 420 smp_call_function_single(channel->target_cpu, cb, channel, true); 421 } 422 423 enum hvutil_device_state { 424 HVUTIL_DEVICE_INIT = 0, /* driver is loaded, waiting for userspace */ 425 HVUTIL_READY, /* userspace is registered */ 426 HVUTIL_HOSTMSG_RECEIVED, /* message from the host was received */ 427 HVUTIL_USERSPACE_REQ, /* request to userspace was sent */ 428 HVUTIL_USERSPACE_RECV, /* reply from userspace was received */ 429 HVUTIL_DEVICE_DYING, /* driver unload is in progress */ 430 }; 431 432 #endif /* _HYPERV_VMBUS_H */ 433