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