1 /* SPDX-License-Identifier: GPL-2.0 */ 2 3 /* 4 * Linux-specific definitions for managing interactions with Microsoft's 5 * Hyper-V hypervisor. The definitions in this file are architecture 6 * independent. See arch/<arch>/include/asm/mshyperv.h for definitions 7 * that are specific to architecture <arch>. 8 * 9 * Definitions that are derived from Hyper-V code or headers should not go in 10 * this file, but should instead go in the relevant files in include/hyperv. 11 * 12 * Copyright (C) 2019, Microsoft, Inc. 13 * 14 * Author : Michael Kelley <mikelley@microsoft.com> 15 */ 16 17 #ifndef _ASM_GENERIC_MSHYPERV_H 18 #define _ASM_GENERIC_MSHYPERV_H 19 20 #include <linux/types.h> 21 #include <linux/atomic.h> 22 #include <linux/bitops.h> 23 #include <acpi/acpi_numa.h> 24 #include <linux/cpumask.h> 25 #include <linux/nmi.h> 26 #include <asm/ptrace.h> 27 #include <hyperv/hvhdk.h> 28 29 #define VTPM_BASE_ADDRESS 0xfed40000 30 31 enum hv_partition_type { 32 HV_PARTITION_TYPE_GUEST, 33 HV_PARTITION_TYPE_ROOT, 34 HV_PARTITION_TYPE_L1VH, 35 }; 36 37 struct ms_hyperv_info { 38 u32 features; 39 u32 priv_high; 40 u32 ext_features; 41 u32 misc_features; 42 u32 hints; 43 u32 nested_features; 44 u32 max_vp_index; 45 u32 max_lp_index; 46 u8 vtl; 47 union { 48 u32 isolation_config_a; 49 struct { 50 u32 paravisor_present : 1; 51 u32 reserved_a1 : 31; 52 }; 53 }; 54 union { 55 u32 isolation_config_b; 56 struct { 57 u32 cvm_type : 4; 58 u32 reserved_b1 : 1; 59 u32 shared_gpa_boundary_active : 1; 60 u32 shared_gpa_boundary_bits : 6; 61 u32 reserved_b2 : 20; 62 }; 63 }; 64 u64 shared_gpa_boundary; 65 bool msi_ext_dest_id; 66 bool confidential_vmbus_available; 67 }; 68 extern struct ms_hyperv_info ms_hyperv; 69 extern bool hv_nested; 70 extern u64 hv_current_partition_id; 71 extern enum hv_partition_type hv_curr_partition_type; 72 73 extern void * __percpu *hyperv_pcpu_input_arg; 74 extern void * __percpu *hyperv_pcpu_output_arg; 75 76 int hv_pci_register_dev_id(int pci_domain_nr, u32 logical_dev_id_prefix); 77 void hv_pci_unregister_dev_id(int pci_domain_nr); 78 int hv_pci_lookup_dev_id(int pci_domain_nr, u32 *prefix); 79 80 u64 hv_do_hypercall(u64 control, void *inputaddr, void *outputaddr); 81 u64 hv_do_fast_hypercall8(u16 control, u64 input8); 82 u64 hv_do_fast_hypercall16(u16 control, u64 input1, u64 input2); 83 84 bool hv_isolation_type_snp(void); 85 bool hv_isolation_type_tdx(void); 86 87 /* 88 * On architectures where Hyper-V doesn't support AEOI (e.g., ARM64), 89 * it doesn't provide a recommendation flag and AEOI must be disabled. 90 */ 91 static inline bool hv_recommend_using_aeoi(void) 92 { 93 #ifdef HV_DEPRECATING_AEOI_RECOMMENDED 94 return !(ms_hyperv.hints & HV_DEPRECATING_AEOI_RECOMMENDED); 95 #else 96 return false; 97 #endif 98 } 99 100 static inline struct hv_proximity_domain_info hv_numa_node_to_pxm_info(int node) 101 { 102 struct hv_proximity_domain_info pxm_info = {}; 103 104 if (node != NUMA_NO_NODE) { 105 pxm_info.domain_id = node_to_pxm(node); 106 pxm_info.flags.proximity_info_valid = 1; 107 pxm_info.flags.proximity_preferred = 1; 108 } 109 110 return pxm_info; 111 } 112 113 /* Helper functions that provide a consistent pattern for checking Hyper-V hypercall status. */ 114 static inline int hv_result(u64 status) 115 { 116 return status & HV_HYPERCALL_RESULT_MASK; 117 } 118 119 static inline bool hv_result_success(u64 status) 120 { 121 return hv_result(status) == HV_STATUS_SUCCESS; 122 } 123 124 static inline unsigned int hv_repcomp(u64 status) 125 { 126 /* Bits [43:32] of status have 'Reps completed' data. */ 127 return (status & HV_HYPERCALL_REP_COMP_MASK) >> 128 HV_HYPERCALL_REP_COMP_OFFSET; 129 } 130 131 /* 132 * Rep hypercalls. Callers of this functions are supposed to ensure that 133 * rep_count, varhead_size, and rep_start comply with Hyper-V hypercall 134 * definition. 135 */ 136 static inline u64 hv_do_rep_hypercall_ex(u16 code, u16 rep_count, 137 u16 varhead_size, u16 rep_start, 138 void *input, void *output) 139 { 140 u64 control = code; 141 u64 status; 142 u16 rep_comp; 143 144 control |= (u64)varhead_size << HV_HYPERCALL_VARHEAD_OFFSET; 145 control |= (u64)rep_count << HV_HYPERCALL_REP_COMP_OFFSET; 146 control |= (u64)rep_start << HV_HYPERCALL_REP_START_OFFSET; 147 148 do { 149 status = hv_do_hypercall(control, input, output); 150 if (!hv_result_success(status)) 151 return status; 152 153 rep_comp = hv_repcomp(status); 154 155 control &= ~HV_HYPERCALL_REP_START_MASK; 156 control |= (u64)rep_comp << HV_HYPERCALL_REP_START_OFFSET; 157 158 touch_nmi_watchdog(); 159 } while (rep_comp < rep_count); 160 161 return status; 162 } 163 164 /* For the typical case where rep_start is 0 */ 165 static inline u64 hv_do_rep_hypercall(u16 code, u16 rep_count, u16 varhead_size, 166 void *input, void *output) 167 { 168 return hv_do_rep_hypercall_ex(code, rep_count, varhead_size, 0, 169 input, output); 170 } 171 172 /* Generate the guest OS identifier as described in the Hyper-V TLFS */ 173 static inline u64 hv_generate_guest_id(u64 kernel_version) 174 { 175 u64 guest_id; 176 177 guest_id = (((u64)HV_LINUX_VENDOR_ID) << 48); 178 guest_id |= (kernel_version << 16); 179 180 return guest_id; 181 } 182 183 int hv_get_hypervisor_version(union hv_hypervisor_version_info *info); 184 185 void hv_setup_vmbus_handler(void (*handler)(void)); 186 void hv_remove_vmbus_handler(void); 187 void hv_setup_stimer0_handler(void (*handler)(void)); 188 void hv_remove_stimer0_handler(void); 189 190 void hv_setup_kexec_handler(void (*handler)(void)); 191 void hv_remove_kexec_handler(void); 192 void hv_setup_crash_handler(void (*handler)(struct pt_regs *regs)); 193 void hv_remove_crash_handler(void); 194 void hv_setup_mshv_handler(void (*handler)(void)); 195 196 #if IS_ENABLED(CONFIG_HYPERV) 197 /* 198 * Hypervisor's notion of virtual processor ID is different from 199 * Linux' notion of CPU ID. This information can only be retrieved 200 * in the context of the calling CPU. Setup a map for easy access 201 * to this information. 202 */ 203 extern u32 *hv_vp_index; 204 extern u32 hv_max_vp_index; 205 206 extern u64 (*hv_read_reference_counter)(void); 207 208 /* Sentinel value for an uninitialized entry in hv_vp_index array */ 209 #define VP_INVAL U32_MAX 210 211 int __init hv_common_init(void); 212 void __init hv_get_partition_id(void); 213 void __init hv_common_free(void); 214 void __init ms_hyperv_late_init(void); 215 int hv_common_cpu_init(unsigned int cpu); 216 int hv_common_cpu_die(unsigned int cpu); 217 void hv_identify_partition_type(void); 218 219 /** 220 * hv_cpu_number_to_vp_number() - Map CPU to VP. 221 * @cpu_number: CPU number in Linux terms 222 * 223 * This function returns the mapping between the Linux processor 224 * number and the hypervisor's virtual processor number, useful 225 * in making hypercalls and such that talk about specific 226 * processors. 227 * 228 * Return: Virtual processor number in Hyper-V terms 229 */ 230 static inline int hv_cpu_number_to_vp_number(int cpu_number) 231 { 232 return hv_vp_index[cpu_number]; 233 } 234 235 static inline int __cpumask_to_vpset(struct hv_vpset *vpset, 236 const struct cpumask *cpus, 237 bool (*func)(int cpu)) 238 { 239 int cpu, vcpu, vcpu_bank, vcpu_offset, nr_bank = 1; 240 int max_vcpu_bank = hv_max_vp_index / HV_VCPUS_PER_SPARSE_BANK; 241 242 /* vpset.valid_bank_mask can represent up to HV_MAX_SPARSE_VCPU_BANKS banks */ 243 if (max_vcpu_bank >= HV_MAX_SPARSE_VCPU_BANKS) 244 return 0; 245 246 /* 247 * Clear all banks up to the maximum possible bank as hv_tlb_flush_ex 248 * structs are not cleared between calls, we risk flushing unneeded 249 * vCPUs otherwise. 250 */ 251 for (vcpu_bank = 0; vcpu_bank <= max_vcpu_bank; vcpu_bank++) 252 vpset->bank_contents[vcpu_bank] = 0; 253 254 /* 255 * Some banks may end up being empty but this is acceptable. 256 */ 257 for_each_cpu(cpu, cpus) { 258 if (func && func(cpu)) 259 continue; 260 vcpu = hv_cpu_number_to_vp_number(cpu); 261 if (vcpu == VP_INVAL) 262 return -1; 263 vcpu_bank = vcpu / HV_VCPUS_PER_SPARSE_BANK; 264 vcpu_offset = vcpu % HV_VCPUS_PER_SPARSE_BANK; 265 __set_bit(vcpu_offset, (unsigned long *) 266 &vpset->bank_contents[vcpu_bank]); 267 if (vcpu_bank >= nr_bank) 268 nr_bank = vcpu_bank + 1; 269 } 270 vpset->valid_bank_mask = GENMASK_ULL(nr_bank - 1, 0); 271 return nr_bank; 272 } 273 274 /* 275 * Convert a Linux cpumask into a Hyper-V VPset. In the _skip variant, 276 * 'func' is called for each CPU present in cpumask. If 'func' returns 277 * true, that CPU is skipped -- i.e., that CPU from cpumask is *not* 278 * added to the Hyper-V VPset. If 'func' is NULL, no CPUs are 279 * skipped. 280 */ 281 static inline int cpumask_to_vpset(struct hv_vpset *vpset, 282 const struct cpumask *cpus) 283 { 284 return __cpumask_to_vpset(vpset, cpus, NULL); 285 } 286 287 static inline int cpumask_to_vpset_skip(struct hv_vpset *vpset, 288 const struct cpumask *cpus, 289 bool (*func)(int cpu)) 290 { 291 return __cpumask_to_vpset(vpset, cpus, func); 292 } 293 294 #define _hv_status_fmt(fmt) "%s: Hyper-V status: %#x = %s: " fmt 295 #define hv_status_printk(level, status, fmt, ...) \ 296 do { \ 297 u64 __status = (status); \ 298 pr_##level(_hv_status_fmt(fmt), __func__, hv_result(__status), \ 299 hv_result_to_string(__status), ##__VA_ARGS__); \ 300 } while (0) 301 #define hv_status_err(status, fmt, ...) \ 302 hv_status_printk(err, status, fmt, ##__VA_ARGS__) 303 #define hv_status_debug(status, fmt, ...) \ 304 hv_status_printk(debug, status, fmt, ##__VA_ARGS__) 305 306 const char *hv_result_to_string(u64 hv_status); 307 int hv_result_to_errno(u64 status); 308 void hyperv_report_panic(struct pt_regs *regs, long err, bool in_die); 309 bool hv_is_hyperv_initialized(void); 310 bool hv_is_hibernation_supported(void); 311 enum hv_isolation_type hv_get_isolation_type(void); 312 bool hv_is_isolation_supported(void); 313 bool hv_isolation_type_snp(void); 314 u64 hv_ghcb_hypercall(u64 control, void *input, void *output, u32 input_size); 315 u64 hv_tdx_hypercall(u64 control, u64 param1, u64 param2); 316 void hv_enable_coco_interrupt(unsigned int cpu, unsigned int vector, bool set); 317 void hv_para_set_sint_proxy(bool enable); 318 u64 hv_para_get_synic_register(unsigned int reg); 319 void hv_para_set_synic_register(unsigned int reg, u64 val); 320 void hyperv_cleanup(void); 321 bool hv_query_ext_cap(u64 cap_query); 322 void hv_setup_dma_ops(struct device *dev, bool coherent); 323 #else /* CONFIG_HYPERV */ 324 static inline void hv_identify_partition_type(void) {} 325 static inline bool hv_is_hyperv_initialized(void) { return false; } 326 static inline bool hv_is_hibernation_supported(void) { return false; } 327 static inline void hyperv_cleanup(void) {} 328 static inline void ms_hyperv_late_init(void) {} 329 static inline bool hv_is_isolation_supported(void) { return false; } 330 static inline enum hv_isolation_type hv_get_isolation_type(void) 331 { 332 return HV_ISOLATION_TYPE_NONE; 333 } 334 #endif /* CONFIG_HYPERV */ 335 336 #if IS_ENABLED(CONFIG_MSHV_ROOT) 337 static inline bool hv_root_partition(void) 338 { 339 return hv_curr_partition_type == HV_PARTITION_TYPE_ROOT; 340 } 341 static inline bool hv_l1vh_partition(void) 342 { 343 return hv_curr_partition_type == HV_PARTITION_TYPE_L1VH; 344 } 345 static inline bool hv_parent_partition(void) 346 { 347 return hv_root_partition() || hv_l1vh_partition(); 348 } 349 350 bool hv_result_needs_memory(u64 status); 351 int hv_deposit_memory_node(int node, u64 partition_id, u64 status); 352 int hv_call_deposit_pages(int node, u64 partition_id, u32 num_pages); 353 int hv_call_add_logical_proc(int node, u32 lp_index, u32 acpi_id); 354 int hv_call_notify_all_processors_started(void); 355 bool hv_lp_exists(u32 lp_index); 356 int hv_call_create_vp(int node, u64 partition_id, u32 vp_index, u32 flags); 357 358 #else /* CONFIG_MSHV_ROOT */ 359 static inline bool hv_root_partition(void) { return false; } 360 static inline bool hv_l1vh_partition(void) { return false; } 361 static inline bool hv_parent_partition(void) { return false; } 362 static inline bool hv_result_needs_memory(u64 status) { return false; } 363 static inline int hv_deposit_memory_node(int node, u64 partition_id, u64 status) 364 { 365 return -EOPNOTSUPP; 366 } 367 static inline int hv_call_deposit_pages(int node, u64 partition_id, u32 num_pages) 368 { 369 return -EOPNOTSUPP; 370 } 371 static inline int hv_call_add_logical_proc(int node, u32 lp_index, u32 acpi_id) 372 { 373 return -EOPNOTSUPP; 374 } 375 static inline int hv_call_notify_all_processors_started(void) 376 { 377 return -EOPNOTSUPP; 378 } 379 static inline bool hv_lp_exists(u32 lp_index) 380 { 381 return false; 382 } 383 static inline int hv_call_create_vp(int node, u64 partition_id, u32 vp_index, u32 flags) 384 { 385 return -EOPNOTSUPP; 386 } 387 #endif /* CONFIG_MSHV_ROOT */ 388 389 static inline int hv_deposit_memory(u64 partition_id, u64 status) 390 { 391 return hv_deposit_memory_node(NUMA_NO_NODE, partition_id, status); 392 } 393 394 #if IS_ENABLED(CONFIG_HYPERV_VTL_MODE) 395 u8 __init get_vtl(void); 396 #else 397 static inline u8 get_vtl(void) { return 0; } 398 #endif 399 400 #endif 401