xref: /linux/drivers/gpu/drm/amd/amdkfd/kfd_priv.h (revision edbafe65eef2b58625db1e113fbbfb1fe10c0291)
1 /* SPDX-License-Identifier: GPL-2.0 OR MIT */
2 /*
3  * Copyright 2014-2022 Advanced Micro Devices, Inc.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
19  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21  * OTHER DEALINGS IN THE SOFTWARE.
22  */
23 
24 #ifndef KFD_PRIV_H_INCLUDED
25 #define KFD_PRIV_H_INCLUDED
26 
27 #include <linux/hashtable.h>
28 #include <linux/mmu_notifier.h>
29 #include <linux/memremap.h>
30 #include <linux/mutex.h>
31 #include <linux/types.h>
32 #include <linux/atomic.h>
33 #include <linux/workqueue.h>
34 #include <linux/spinlock.h>
35 #include <uapi/linux/kfd_ioctl.h>
36 #include <linux/idr.h>
37 #include <linux/kfifo.h>
38 #include <linux/seq_file.h>
39 #include <linux/kref.h>
40 #include <linux/sysfs.h>
41 #include <linux/device_cgroup.h>
42 #include <drm/drm_file.h>
43 #include <drm/drm_drv.h>
44 #include <drm/drm_device.h>
45 #include <drm/drm_ioctl.h>
46 #include <kgd_kfd_interface.h>
47 #include <linux/swap.h>
48 
49 #include "amd_shared.h"
50 #include "amdgpu.h"
51 
52 #define KFD_MAX_RING_ENTRY_SIZE	8
53 
54 #define KFD_SYSFS_FILE_MODE 0444
55 
56 /* GPU ID hash width in bits */
57 #define KFD_GPU_ID_HASH_WIDTH 16
58 
59 /* Use upper bits of mmap offset to store KFD driver specific information.
60  * BITS[63:62] - Encode MMAP type
61  * BITS[61:46] - Encode gpu_id. To identify to which GPU the offset belongs to
62  * BITS[45:0]  - MMAP offset value
63  *
64  * NOTE: struct vm_area_struct.vm_pgoff uses offset in pages. Hence, these
65  *  defines are w.r.t to PAGE_SIZE
66  */
67 #define KFD_MMAP_TYPE_SHIFT	62
68 #define KFD_MMAP_TYPE_MASK	(0x3ULL << KFD_MMAP_TYPE_SHIFT)
69 #define KFD_MMAP_TYPE_DOORBELL	(0x3ULL << KFD_MMAP_TYPE_SHIFT)
70 #define KFD_MMAP_TYPE_EVENTS	(0x2ULL << KFD_MMAP_TYPE_SHIFT)
71 #define KFD_MMAP_TYPE_RESERVED_MEM	(0x1ULL << KFD_MMAP_TYPE_SHIFT)
72 #define KFD_MMAP_TYPE_MMIO	(0x0ULL << KFD_MMAP_TYPE_SHIFT)
73 
74 #define KFD_MMAP_GPU_ID_SHIFT 46
75 #define KFD_MMAP_GPU_ID_MASK (((1ULL << KFD_GPU_ID_HASH_WIDTH) - 1) \
76 				<< KFD_MMAP_GPU_ID_SHIFT)
77 #define KFD_MMAP_GPU_ID(gpu_id) ((((uint64_t)gpu_id) << KFD_MMAP_GPU_ID_SHIFT)\
78 				& KFD_MMAP_GPU_ID_MASK)
79 #define KFD_MMAP_GET_GPU_ID(offset)    ((offset & KFD_MMAP_GPU_ID_MASK) \
80 				>> KFD_MMAP_GPU_ID_SHIFT)
81 
82 /*
83  * When working with cp scheduler we should assign the HIQ manually or via
84  * the amdgpu driver to a fixed hqd slot, here are the fixed HIQ hqd slot
85  * definitions for Kaveri. In Kaveri only the first ME queues participates
86  * in the cp scheduling taking that in mind we set the HIQ slot in the
87  * second ME.
88  */
89 #define KFD_CIK_HIQ_PIPE 4
90 #define KFD_CIK_HIQ_QUEUE 0
91 
92 /* Macro for allocating structures */
93 #define kfd_alloc_struct(ptr_to_struct)	\
94 	((typeof(ptr_to_struct)) kzalloc_obj(*ptr_to_struct))
95 
96 #define KFD_MAX_NUM_OF_PROCESSES 512
97 #define KFD_MAX_NUM_OF_QUEUES_PER_PROCESS 1024
98 
99 /*
100  * Size of the per-process TBA+TMA buffer: 2 pages
101  *
102  * The first chunk is the TBA used for the CWSR ISA code. The second
103  * chunk is used as TMA for user-mode trap handler setup in daisy-chain mode.
104  */
105 #define KFD_CWSR_TBA_TMA_SIZE (AMDGPU_GPU_PAGE_SIZE * 2)
106 #define KFD_CWSR_TMA_OFFSET (AMDGPU_GPU_PAGE_SIZE + 2048)
107 
108 #define KFD_MAX_NUM_OF_QUEUES_PER_DEVICE		\
109 	(KFD_MAX_NUM_OF_PROCESSES *			\
110 			KFD_MAX_NUM_OF_QUEUES_PER_PROCESS)
111 
112 #define KFD_KERNEL_QUEUE_SIZE 2048
113 
114 /*  KFD_UNMAP_LATENCY_MS is the timeout CP waiting for SDMA preemption. One XCC
115  *  can be associated to 2 SDMA engines. queue_preemption_timeout_ms is the time
116  *  driver waiting for CP returning the UNMAP_QUEUE fence. Thus the math is
117  *  queue_preemption_timeout_ms = sdma_preemption_time * 2 + cp workload
118  *  The format here makes CP workload 10% of total timeout
119  */
120 #define KFD_UNMAP_LATENCY_MS	\
121 	((queue_preemption_timeout_ms - queue_preemption_timeout_ms / 10) >> 1)
122 
123 #define KFD_MAX_SDMA_QUEUES	128
124 
125 /*
126  * 512 = 0x200
127  * The doorbell index distance between SDMA RLC (2*i) and (2*i+1) in the
128  * same SDMA engine on SOC15, which has 8-byte doorbells for SDMA.
129  * 512 8-byte doorbell distance (i.e. one page away) ensures that SDMA RLC
130  * (2*i+1) doorbells (in terms of the lower 12 bit address) lie exactly in
131  * the OFFSET and SIZE set in registers like BIF_SDMA0_DOORBELL_RANGE.
132  */
133 #define KFD_QUEUE_DOORBELL_MIRROR_OFFSET 512
134 
135 /**
136  * enum kfd_ioctl_flags - KFD ioctl flags
137  * Various flags that can be set in &amdkfd_ioctl_desc.flags to control how
138  * userspace can use a given ioctl.
139  */
140 enum kfd_ioctl_flags {
141 	/*
142 	 * @KFD_IOC_FLAG_CHECKPOINT_RESTORE:
143 	 * Certain KFD ioctls such as AMDKFD_IOC_CRIU_OP can potentially
144 	 * perform privileged operations and load arbitrary data into MQDs and
145 	 * eventually HQD registers when the queue is mapped by HWS. In order to
146 	 * prevent this we should perform additional security checks.
147 	 *
148 	 * This is equivalent to callers with the CHECKPOINT_RESTORE capability.
149 	 *
150 	 * Note: Since earlier versions of docker do not support CHECKPOINT_RESTORE,
151 	 * we also allow ioctls with SYS_ADMIN capability.
152 	 */
153 	KFD_IOC_FLAG_CHECKPOINT_RESTORE = BIT(0),
154 };
155 /*
156  * Kernel module parameter to specify maximum number of supported queues per
157  * device
158  */
159 extern int max_num_of_queues_per_device;
160 
161 
162 /* Kernel module parameter to specify the scheduling policy */
163 extern int sched_policy;
164 
165 /*
166  * Kernel module parameter to specify the maximum process
167  * number per HW scheduler
168  */
169 extern int hws_max_conc_proc;
170 
171 extern int cwsr_enable;
172 
173 /*
174  * Kernel module parameter to specify whether to send sigterm to HSA process on
175  * unhandled exception
176  */
177 extern int send_sigterm;
178 
179 /*
180  * This kernel module is used to simulate large bar machine on non-large bar
181  * enabled machines.
182  */
183 extern int debug_largebar;
184 
185 /* Set sh_mem_config.retry_disable on GFX v9 */
186 extern int amdgpu_noretry;
187 
188 /* Halt if HWS hang is detected */
189 extern int halt_if_hws_hang;
190 
191 /* Whether MEC FW support GWS barriers */
192 extern bool hws_gws_support;
193 
194 /* Queue preemption timeout in ms */
195 extern int queue_preemption_timeout_ms;
196 
197 /*
198  * Don't evict process queues on vm fault
199  */
200 extern int amdgpu_no_queue_eviction_on_vm_fault;
201 
202 /* Enable eviction debug messages */
203 extern bool debug_evictions;
204 
205 extern struct mutex kfd_processes_mutex;
206 
207 enum cache_policy {
208 	cache_policy_coherent,
209 	cache_policy_noncoherent
210 };
211 
212 #define KFD_GC_VERSION(dev) (amdgpu_ip_version((dev)->adev, GC_HWIP, 0))
213 #define KFD_IS_SOC15(dev)   ((KFD_GC_VERSION(dev)) >= (IP_VERSION(9, 0, 1)))
214 #define KFD_SUPPORT_XNACK_PER_PROCESS(dev)\
215 	((KFD_GC_VERSION(dev) == IP_VERSION(9, 4, 2)) ||	\
216 	 (KFD_GC_VERSION(dev) == IP_VERSION(9, 4, 3)) ||	\
217 	 (KFD_GC_VERSION(dev) == IP_VERSION(9, 4, 4)) ||	\
218 	 (KFD_GC_VERSION(dev) == IP_VERSION(9, 5, 0)))
219 
220 struct kfd_node;
221 
222 struct kfd_event_interrupt_class {
223 	bool (*interrupt_isr)(struct kfd_node *dev,
224 			const uint32_t *ih_ring_entry, uint32_t *patched_ihre,
225 			bool *patched_flag);
226 	void (*interrupt_wq)(struct kfd_node *dev,
227 			const uint32_t *ih_ring_entry);
228 };
229 
230 struct kfd_device_info {
231 	uint32_t gfx_target_version;
232 	const struct kfd_event_interrupt_class *event_interrupt_class;
233 	unsigned int max_pasid_bits;
234 	unsigned int max_no_of_hqd;
235 	unsigned int doorbell_size;
236 	size_t ih_ring_entry_size;
237 	uint8_t num_of_watch_points;
238 	uint16_t mqd_size_aligned;
239 	bool supports_cwsr;
240 	bool needs_pci_atomics;
241 	uint32_t no_atomic_fw_version;
242 	unsigned int num_sdma_queues_per_engine;
243 	unsigned int num_reserved_sdma_queues_per_engine;
244 };
245 
246 unsigned int kfd_get_num_sdma_engines(struct kfd_node *kdev);
247 unsigned int kfd_get_num_xgmi_sdma_engines(struct kfd_node *kdev);
248 
249 struct kfd_mem_obj {
250 	uint32_t range_start;
251 	uint32_t range_end;
252 	uint64_t gpu_addr;
253 	uint32_t *cpu_ptr;
254 	void *mem;
255 };
256 
257 struct kfd_vmid_info {
258 	uint32_t first_vmid_kfd;
259 	uint32_t last_vmid_kfd;
260 	uint32_t vmid_num_kfd;
261 };
262 
263 #define MAX_KFD_NODES	8
264 
265 struct kfd_dev;
266 
267 struct kfd_node {
268 	unsigned int node_id;
269 	struct amdgpu_device *adev;     /* Duplicated here along with keeping
270 					 * a copy in kfd_dev to save a hop
271 					 */
272 	const struct kfd2kgd_calls *kfd2kgd; /* Duplicated here along with
273 					      * keeping a copy in kfd_dev to
274 					      * save a hop
275 					      */
276 	struct kfd_vmid_info vm_info;
277 	unsigned int id;                /* topology stub index */
278 	uint32_t xcc_mask; /* Instance mask of XCCs present */
279 	struct amdgpu_xcp *xcp;
280 
281 	/* Interrupts */
282 	struct kfifo ih_fifo;
283 	struct work_struct interrupt_work;
284 	spinlock_t interrupt_lock;
285 
286 	/*
287 	 * Interrupts of interest to KFD are copied
288 	 * from the HW ring into a SW ring.
289 	 */
290 	bool interrupts_active;
291 	uint32_t interrupt_bitmap; /* Only used for GFX 9.4.3 */
292 
293 	/* QCM Device instance */
294 	struct device_queue_manager *dqm;
295 
296 	/* Global GWS resource shared between processes */
297 	void *gws;
298 
299 	/* Clients watching SMI events */
300 	struct list_head smi_clients;
301 	spinlock_t smi_lock;
302 	uint32_t reset_seq_num;
303 
304 	/* SRAM ECC flag */
305 	atomic_t sram_ecc_flag;
306 
307 	/*spm process id */
308 	unsigned int spm_pasid;
309 
310 	/* Maximum process number mapped to HW scheduler */
311 	unsigned int max_proc_per_quantum;
312 
313 	unsigned int compute_vmid_bitmap;
314 
315 	struct kfd_local_mem_info local_mem_info;
316 
317 	struct kfd_dev *kfd;
318 
319 	/* Track per device allocated watch points */
320 	uint32_t alloc_watch_ids;
321 	spinlock_t watch_points_lock;
322 };
323 
324 struct kfd_dev {
325 	struct amdgpu_device *adev;
326 
327 	struct kfd_device_info device_info;
328 
329 	u32 __iomem *doorbell_kernel_ptr; /* This is a pointer for a doorbells
330 					   * page used by kernel queue
331 					   */
332 
333 	struct kgd2kfd_shared_resources shared_resources;
334 
335 	const struct kfd2kgd_calls *kfd2kgd;
336 	struct mutex doorbell_mutex;
337 
338 	void *gtt_mem;
339 	uint64_t gtt_start_gpu_addr;
340 	void *gtt_start_cpu_ptr;
341 	void *gtt_sa_bitmap;
342 	struct mutex gtt_sa_lock;
343 	unsigned int gtt_sa_chunk_size;
344 	unsigned int gtt_sa_num_of_chunks;
345 
346 	bool init_complete;
347 
348 	/* Firmware versions */
349 	uint16_t mec_fw_version;
350 	uint16_t mec2_fw_version;
351 	uint16_t sdma_fw_version;
352 
353 	/* CWSR */
354 	bool cwsr_enabled;
355 	const void *cwsr_isa;
356 	unsigned int cwsr_isa_size;
357 
358 	/* xGMI */
359 	uint64_t hive_id;
360 
361 	bool pci_atomic_requested;
362 
363 	/* Compute Profile ref. count */
364 	atomic_t compute_profile;
365 
366 	struct ida doorbell_ida;
367 	unsigned int max_doorbell_slices;
368 
369 	int noretry;
370 
371 	struct kfd_node *nodes[MAX_KFD_NODES];
372 	unsigned int num_nodes;
373 
374 	struct workqueue_struct *ih_wq;
375 
376 	/* Kernel doorbells for KFD device */
377 	struct amdgpu_bo *doorbells;
378 
379 	/* bitmap for dynamic doorbell allocation from doorbell object */
380 	unsigned long *doorbell_bitmap;
381 
382 	/* for dynamic partitioning */
383 	int kfd_dev_lock;
384 
385 	atomic_t kfd_processes_count;
386 
387 	/* Lock for profiler process */
388 	struct mutex profiler_lock;
389 	/* Process currently holding the lock */
390 	struct kfd_process *profiler_process;
391 };
392 
393 enum kfd_mempool {
394 	KFD_MEMPOOL_SYSTEM_CACHEABLE = 1,
395 	KFD_MEMPOOL_SYSTEM_WRITECOMBINE = 2,
396 	KFD_MEMPOOL_FRAMEBUFFER = 3,
397 };
398 
399 /* Character device interface */
400 int kfd_chardev_init(void);
401 void kfd_chardev_exit(void);
402 void kfd_dev_unmap_mapping_range(loff_t const holebegin, loff_t const holelen);
403 
404 /**
405  * enum kfd_unmap_queues_filter - Enum for queue filters.
406  *
407  * @KFD_UNMAP_QUEUES_FILTER_ALL_QUEUES: Preempts all queues in the
408  *						running queues list.
409  *
410  * @KFD_UNMAP_QUEUES_FILTER_DYNAMIC_QUEUES: Preempts all non-static queues
411  *						in the run list.
412  *
413  * @KFD_UNMAP_QUEUES_FILTER_BY_PASID: Preempts queues that belongs to
414  *						specific process.
415  *
416  */
417 enum kfd_unmap_queues_filter {
418 	KFD_UNMAP_QUEUES_FILTER_ALL_QUEUES = 1,
419 	KFD_UNMAP_QUEUES_FILTER_DYNAMIC_QUEUES = 2,
420 	KFD_UNMAP_QUEUES_FILTER_BY_PASID = 3
421 };
422 
423 /**
424  * enum kfd_queue_type - Enum for various queue types.
425  *
426  * @KFD_QUEUE_TYPE_COMPUTE: Regular user mode queue type.
427  *
428  * @KFD_QUEUE_TYPE_SDMA: SDMA user mode queue type.
429  *
430  * @KFD_QUEUE_TYPE_HIQ: HIQ queue type.
431  *
432  * @KFD_QUEUE_TYPE_DIQ: DIQ queue type.
433  *
434  * @KFD_QUEUE_TYPE_SDMA_XGMI: Special SDMA queue for XGMI interface.
435  *
436  * @KFD_QUEUE_TYPE_SDMA_BY_ENG_ID:  SDMA user mode queue with target SDMA engine ID.
437  */
438 enum kfd_queue_type  {
439 	KFD_QUEUE_TYPE_COMPUTE,
440 	KFD_QUEUE_TYPE_SDMA,
441 	KFD_QUEUE_TYPE_HIQ,
442 	KFD_QUEUE_TYPE_SDMA_XGMI,
443 	KFD_QUEUE_TYPE_SDMA_BY_ENG_ID,
444 	KFD_QUEUE_TYPE_MAX,
445 };
446 
447 enum kfd_queue_format {
448 	KFD_QUEUE_FORMAT_PM4,
449 	KFD_QUEUE_FORMAT_AQL
450 };
451 
452 enum KFD_QUEUE_PRIORITY {
453 	KFD_QUEUE_PRIORITY_MINIMUM = 0,
454 	KFD_QUEUE_PRIORITY_MAXIMUM = 15
455 };
456 
457 /**
458  * struct queue_properties
459  *
460  * @type: The queue type.
461  *
462  * @queue_id: Queue identifier.
463  *
464  * @queue_address: Queue ring buffer address.
465  *
466  * @queue_size: Queue ring buffer size.
467  *
468  * @priority: Defines the queue priority relative to other queues in the
469  * process.
470  * This is just an indication and HW scheduling may override the priority as
471  * necessary while keeping the relative prioritization.
472  * the priority granularity is from 0 to f which f is the highest priority.
473  * currently all queues are initialized with the highest priority.
474  *
475  * @queue_percent: This field is partially implemented and currently a zero in
476  * this field defines that the queue is non active.
477  *
478  * @read_ptr: User space address which points to the number of dwords the
479  * cp read from the ring buffer. This field updates automatically by the H/W.
480  *
481  * @write_ptr: Defines the number of dwords written to the ring buffer.
482  *
483  * @doorbell_ptr: Notifies the H/W of new packet written to the queue ring
484  * buffer. This field should be similar to write_ptr and the user should
485  * update this field after updating the write_ptr.
486  *
487  * @doorbell_off: The doorbell offset in the doorbell pci-bar.
488  *
489  * @is_interop: Defines if this is a interop queue. Interop queue means that
490  * the queue can access both graphics and compute resources.
491  *
492  * @is_evicted: Defines if the queue is evicted. Only active queues
493  * are evicted, rendering them inactive.
494  *
495  * @is_active: Defines if the queue is active or not. @is_active and
496  * @is_evicted are protected by the DQM lock.
497  *
498  * @is_gws: Defines if the queue has been updated to be GWS-capable or not.
499  * @is_gws should be protected by the DQM lock, since changing it can yield the
500  * possibility of updating DQM state on number of GWS queues.
501  *
502  * @vmid: If the scheduling mode is no cp scheduling the field defines the vmid
503  * of the queue.
504  *
505  * This structure represents the queue properties for each queue no matter if
506  * it's user mode or kernel mode queue.
507  *
508  */
509 
510 struct queue_properties {
511 	enum kfd_queue_type type;
512 	enum kfd_queue_format format;
513 	unsigned int queue_id;
514 	uint64_t queue_address;
515 	uint64_t queue_size;
516 	uint64_t metadata_queue_size;
517 	uint32_t priority;
518 	uint32_t queue_percent;
519 	void __user *read_ptr;
520 	void __user *write_ptr;
521 	void __iomem *doorbell_ptr;
522 	uint32_t doorbell_off;
523 	bool is_interop;
524 	bool is_evicted;
525 	bool is_suspended;
526 	bool is_being_destroyed;
527 	bool is_active;
528 	bool is_gws;
529 	uint32_t pm4_target_xcc;
530 	bool is_dbg_wa;
531 	bool is_user_cu_masked;
532 	bool is_reset;
533 	/* Not relevant for user mode queues in cp scheduling */
534 	unsigned int vmid;
535 	/* Relevant only for sdma queues*/
536 	uint32_t sdma_engine_id;
537 	uint32_t sdma_queue_id;
538 	uint32_t sdma_vm_addr;
539 	/* Relevant only for VI */
540 	uint64_t eop_ring_buffer_address;
541 	uint32_t eop_ring_buffer_size;
542 	uint64_t ctx_save_restore_area_address;
543 	uint32_t ctx_save_restore_area_size;
544 	uint32_t ctl_stack_size;
545 	uint64_t tba_addr;
546 	uint64_t tma_addr;
547 	uint64_t exception_status;
548 
549 	struct amdgpu_bo *wptr_bo;
550 	struct amdgpu_bo *rptr_bo;
551 	struct amdgpu_bo *ring_bo;
552 	struct amdgpu_bo *eop_buf_bo;
553 	struct amdgpu_bo *cwsr_bo;
554 };
555 
556 #define QUEUE_IS_ACTIVE(q) ((q).queue_size > 0 &&	\
557 			    (q).queue_address != 0 &&	\
558 			    (q).queue_percent > 0 &&	\
559 			    !(q).is_evicted &&		\
560 			    !(q).is_suspended)
561 
562 enum mqd_update_flag {
563 	UPDATE_FLAG_DBG_WA_ENABLE = 1,
564 	UPDATE_FLAG_DBG_WA_DISABLE = 2,
565 	UPDATE_FLAG_IS_GWS = 4, /* quirk for gfx9 IP */
566 	UPDATE_FLAG_PERFCOUNT_ENABLE = 5,
567 	UPDATE_FLAG_PERFCOUNT_DISABLE = 6,
568 };
569 
570 struct mqd_update_info {
571 	union {
572 		struct {
573 			uint32_t count; /* Must be a multiple of 32 */
574 			uint32_t *ptr;
575 		} cu_mask;
576 	};
577 	enum mqd_update_flag update_flag;
578 };
579 
580 /**
581  * struct queue
582  *
583  * @list: Queue linked list.
584  *
585  * @mqd: The queue MQD (memory queue descriptor).
586  *
587  * @mqd_mem_obj: The MQD local gpu memory object.
588  *
589  * @gart_mqd_addr: The MQD gart mc address.
590  *
591  * @properties: The queue properties.
592  *
593  * @mec: Used only in no cp scheduling mode and identifies to micro engine id
594  *	 that the queue should be executed on.
595  *
596  * @pipe: Used only in no cp scheduling mode and identifies the queue's pipe
597  *	  id.
598  *
599  * @queue: Used only in no cp scheduliong mode and identifies the queue's slot.
600  *
601  * @process: The kfd process that created this queue.
602  *
603  * @device: The kfd device that created this queue.
604  *
605  * @gws: Pointing to gws kgd_mem if this is a gws control queue; NULL
606  * otherwise.
607  *
608  * This structure represents user mode compute queues.
609  * It contains all the necessary data to handle such queues.
610  *
611  */
612 
613 struct queue {
614 	struct list_head list;
615 	void *mqd;
616 	struct kfd_mem_obj *mqd_mem_obj;
617 	uint64_t gart_mqd_addr;
618 	struct queue_properties properties;
619 
620 	uint32_t mec;
621 	uint32_t pipe;
622 	uint32_t queue;
623 
624 	unsigned int sdma_id;
625 	unsigned int doorbell_id;
626 
627 	struct kfd_process	*process;
628 	struct kfd_node		*device;
629 	void *gws;
630 
631 	/* procfs */
632 	struct kobject kobj;
633 
634 	void *gang_ctx_bo;
635 	uint64_t gang_ctx_gpu_addr;
636 	void *gang_ctx_cpu_ptr;
637 
638 	struct amdgpu_bo *wptr_bo_gart;
639 };
640 
641 enum KFD_MQD_TYPE {
642 	KFD_MQD_TYPE_HIQ = 0,		/* for hiq */
643 	KFD_MQD_TYPE_CP,		/* for cp queues and diq */
644 	KFD_MQD_TYPE_SDMA,		/* for sdma queues */
645 	KFD_MQD_TYPE_DIQ,		/* for diq */
646 	KFD_MQD_TYPE_MAX
647 };
648 
649 enum KFD_PIPE_PRIORITY {
650 	KFD_PIPE_PRIORITY_CS_LOW = 0,
651 	KFD_PIPE_PRIORITY_CS_MEDIUM,
652 	KFD_PIPE_PRIORITY_CS_HIGH
653 };
654 
655 struct scheduling_resources {
656 	unsigned int vmid_mask;
657 	enum kfd_queue_type type;
658 	uint64_t queue_mask;
659 	uint64_t gws_mask;
660 	uint32_t oac_mask;
661 	uint32_t gds_heap_base;
662 	uint32_t gds_heap_size;
663 };
664 
665 struct process_queue_manager {
666 	/* data */
667 	struct kfd_process	*process;
668 	struct list_head	queues;
669 	unsigned long		*queue_slot_bitmap;
670 };
671 
672 struct qcm_process_device {
673 	/* The Device Queue Manager that owns this data */
674 	struct device_queue_manager *dqm;
675 	struct process_queue_manager *pqm;
676 	/* Queues list */
677 	struct list_head queues_list;
678 	struct list_head priv_queue_list;
679 
680 	unsigned int queue_count;
681 	unsigned int vmid;
682 	bool is_debug;
683 	unsigned int evicted; /* eviction counter, 0=active */
684 
685 	/* This flag tells if we should reset all wavefronts on
686 	 * process termination
687 	 */
688 	bool reset_wavefronts;
689 
690 	/* This flag tells us if this process has a GWS-capable
691 	 * queue that will be mapped into the runlist. It's
692 	 * possible to request a GWS BO, but not have the queue
693 	 * currently mapped, and this changes how the MAP_PROCESS
694 	 * PM4 packet is configured.
695 	 */
696 	bool mapped_gws_queue;
697 
698 	/* All the memory management data should be here too */
699 	uint64_t gds_context_area;
700 	/* Contains page table flags such as AMDGPU_PTE_VALID since gfx9 */
701 	uint64_t page_table_base;
702 	uint32_t sh_mem_config;
703 	uint32_t sh_mem_bases;
704 	uint32_t sh_mem_ape1_base;
705 	uint32_t sh_mem_ape1_limit;
706 	uint32_t gds_size;
707 	uint32_t num_gws;
708 	uint32_t num_oac;
709 	uint32_t sh_hidden_private_base;
710 	uint32_t vm_cntx_cntl;
711 
712 	/* CWSR memory */
713 	struct kgd_mem *cwsr_mem;
714 	void *cwsr_kaddr;
715 	uint64_t cwsr_base;
716 	uint64_t tba_addr;
717 	uint64_t tma_addr;
718 
719 	/* IB memory */
720 	struct kgd_mem *ib_mem;
721 	uint64_t ib_base;
722 	void *ib_kaddr;
723 
724 	/* doorbells for kfd process */
725 	struct amdgpu_bo *proc_doorbells;
726 
727 	/* bitmap for dynamic doorbell allocation from the bo */
728 	unsigned long *doorbell_bitmap;
729 };
730 
731 /* KFD Memory Eviction */
732 
733 /* Approx. wait time before attempting to restore evicted BOs */
734 #define PROCESS_RESTORE_TIME_MS 100
735 /* Approx. back off time if restore fails due to lack of memory */
736 #define PROCESS_BACK_OFF_TIME_MS 100
737 /* Approx. time before evicting the process again */
738 #define PROCESS_ACTIVE_TIME_MS 10
739 
740 /* 8 byte handle containing GPU ID in the most significant 4 bytes and
741  * idr_handle in the least significant 4 bytes
742  */
743 #define MAKE_HANDLE(gpu_id, idr_handle) \
744 	(((uint64_t)(gpu_id) << 32) + idr_handle)
745 #define GET_GPU_ID(handle) (handle >> 32)
746 #define GET_IDR_HANDLE(handle) (handle & 0xFFFFFFFF)
747 
748 enum kfd_pdd_bound {
749 	PDD_UNBOUND = 0,
750 	PDD_BOUND,
751 	PDD_BOUND_SUSPENDED,
752 };
753 
754 #define MAX_SYSFS_FILENAME_LEN 15
755 
756 /*
757  * SDMA counter runs at 100MHz frequency.
758  * We display SDMA activity in microsecond granularity in sysfs.
759  * As a result, the divisor is 100.
760  */
761 #define SDMA_ACTIVITY_DIVISOR  100
762 
763 /* Data that is per-process-per device. */
764 struct kfd_process_device {
765 	/* The device that owns this data. */
766 	struct kfd_node *dev;
767 
768 	/* The process that owns this kfd_process_device. */
769 	struct kfd_process *process;
770 
771 	/* per-process-per device QCM data structure */
772 	struct qcm_process_device qpd;
773 
774 	/*Apertures*/
775 	uint64_t lds_base;
776 	uint64_t lds_limit;
777 	uint64_t gpuvm_base;
778 	uint64_t gpuvm_limit;
779 	uint64_t scratch_base;
780 	uint64_t scratch_limit;
781 
782 	/* VM context for GPUVM allocations */
783 	struct file *drm_file;
784 	void *drm_priv;
785 
786 	/* GPUVM allocations storage */
787 	struct idr alloc_idr;
788 
789 	/* Flag used to tell the pdd has dequeued from the dqm.
790 	 * This is used to prevent dev->dqm->ops.process_termination() from
791 	 * being called twice when it is already called in IOMMU callback
792 	 * function.
793 	 */
794 	bool already_dequeued;
795 	bool runtime_inuse;
796 
797 	/* Is this process/pasid bound to this device? (amd_iommu_bind_pasid) */
798 	enum kfd_pdd_bound bound;
799 
800 	/* VRAM usage */
801 	atomic64_t vram_usage;
802 	struct attribute attr_vram;
803 	char vram_filename[MAX_SYSFS_FILENAME_LEN];
804 
805 	/* SDMA activity tracking */
806 	uint64_t sdma_past_activity_counter;
807 	struct attribute attr_sdma;
808 	char sdma_filename[MAX_SYSFS_FILENAME_LEN];
809 
810 	/* Eviction activity tracking */
811 	uint64_t last_evict_timestamp;
812 	atomic64_t evict_duration_counter;
813 	struct attribute attr_evict;
814 
815 	struct kobject *kobj_stats;
816 
817 	/*
818 	 * @cu_occupancy: Reports occupancy of Compute Units (CU) of a process
819 	 * that is associated with device encoded by "this" struct instance. The
820 	 * value reflects CU usage by all of the waves launched by this process
821 	 * on this device. A very important property of occupancy parameter is
822 	 * that its value is a snapshot of current use.
823 	 *
824 	 * Following is to be noted regarding how this parameter is reported:
825 	 *
826 	 *  The number of waves that a CU can launch is limited by couple of
827 	 *  parameters. These are encoded by struct amdgpu_cu_info instance
828 	 *  that is part of every device definition. For GFX9 devices this
829 	 *  translates to 40 waves (simd_per_cu * max_waves_per_simd) when waves
830 	 *  do not use scratch memory and 32 waves (max_scratch_slots_per_cu)
831 	 *  when they do use scratch memory. This could change for future
832 	 *  devices and therefore this example should be considered as a guide.
833 	 *
834 	 *  All CU's of a device are available for the process. This may not be true
835 	 *  under certain conditions - e.g. CU masking.
836 	 *
837 	 *  Finally number of CU's that are occupied by a process is affected by both
838 	 *  number of CU's a device has along with number of other competing processes
839 	 */
840 	struct attribute attr_cu_occupancy;
841 
842 	/* sysfs counters for GPU retry fault and page migration tracking */
843 	struct kobject *kobj_counters;
844 	struct attribute attr_faults;
845 	struct attribute attr_page_in;
846 	struct attribute attr_page_out;
847 	uint64_t faults;
848 	uint64_t page_in;
849 	uint64_t page_out;
850 
851 	/* Exception code status*/
852 	uint64_t exception_status;
853 	void *vm_fault_exc_data;
854 	size_t vm_fault_exc_data_size;
855 
856 	/* Tracks debug per-vmid request settings */
857 	uint32_t spi_dbg_override;
858 	uint32_t spi_dbg_launch_mode;
859 	uint32_t watch_points[4];
860 	uint32_t alloc_watch_ids;
861 
862 	/*
863 	 * If this process has been checkpointed before, then the user
864 	 * application will use the original gpu_id on the
865 	 * checkpointed node to refer to this device.
866 	 */
867 	uint32_t user_gpu_id;
868 
869 	void *proc_ctx_bo;
870 	uint64_t proc_ctx_gpu_addr;
871 	void *proc_ctx_cpu_ptr;
872 
873 	/* Tracks queue reset status */
874 	bool has_reset_queue;
875 
876 	u32 pasid;
877 	/* Indicates this process has requested PTL stay disabled */
878 	bool ptl_disable_req;
879 };
880 
881 #define qpd_to_pdd(x) container_of(x, struct kfd_process_device, qpd)
882 
883 struct svm_range_list {
884 	struct mutex			lock;
885 	struct rb_root_cached		objects;
886 	struct list_head		list;
887 	struct work_struct		deferred_list_work;
888 	struct list_head		deferred_range_list;
889 	struct list_head                criu_svm_metadata_list;
890 	spinlock_t			deferred_list_lock;
891 	atomic_t			evicted_ranges;
892 	atomic_t			drain_pagefaults;
893 	struct delayed_work		restore_work;
894 	DECLARE_BITMAP(bitmap_supported, MAX_GPU_INSTANCE);
895 	struct task_struct		*faulting_task;
896 	/* check point ts decides if page fault recovery need be dropped */
897 	uint64_t			checkpoint_ts[MAX_GPU_INSTANCE];
898 
899 	/* Default granularity to use in buffer migration
900 	 * and restoration of backing memory while handling
901 	 * recoverable page faults
902 	 */
903 	uint8_t default_granularity;
904 };
905 
906 /* Process data */
907 struct kfd_process {
908 	/*
909 	 * kfd_process are stored in an mm_struct*->kfd_process*
910 	 * hash table (kfd_processes in kfd_process.c)
911 	 */
912 	struct hlist_node kfd_processes;
913 
914 	/*
915 	 * Opaque pointer to mm_struct. We don't hold a reference to
916 	 * it so it should never be dereferenced from here. This is
917 	 * only used for looking up processes by their mm.
918 	 */
919 	void *mm;
920 
921 	struct kref ref;
922 	struct work_struct release_work;
923 
924 	struct mutex mutex;
925 
926 	/*
927 	 * In any process, the thread that started main() is the lead
928 	 * thread and outlives the rest.
929 	 * It is here because amd_iommu_bind_pasid wants a task_struct.
930 	 * It can also be used for safely getting a reference to the
931 	 * mm_struct of the process.
932 	 */
933 	struct task_struct *lead_thread;
934 
935 	/* We want to receive a notification when the mm_struct is destroyed */
936 	struct mmu_notifier mmu_notifier;
937 
938 	/*
939 	 * Array of kfd_process_device pointers,
940 	 * one for each device the process is using.
941 	 */
942 	struct kfd_process_device *pdds[MAX_GPU_INSTANCE];
943 	uint32_t n_pdds;
944 
945 	struct process_queue_manager pqm;
946 
947 	/*Is the user space process 32 bit?*/
948 	bool is_32bit_user_mode;
949 
950 	/* Event-related data */
951 	struct mutex event_mutex;
952 	/* Event ID allocator and lookup */
953 	struct idr event_idr;
954 	/* Event page */
955 	u64 signal_handle;
956 	struct kfd_signal_page *signal_page;
957 	size_t signal_mapped_size;
958 	size_t signal_event_count;
959 	bool signal_event_limit_reached;
960 
961 	/* Information used for memory eviction */
962 	void *kgd_process_info;
963 	/* Eviction fence that is attached to all the BOs of this process. The
964 	 * fence will be triggered during eviction and new one will be created
965 	 * during restore
966 	 */
967 	struct dma_fence __rcu *ef;
968 
969 	/* Work items for evicting and restoring BOs */
970 	struct delayed_work eviction_work;
971 	struct delayed_work restore_work;
972 	/* seqno of the last scheduled eviction */
973 	unsigned int last_eviction_seqno;
974 	/* Approx. the last timestamp (in jiffies) when the process was
975 	 * restored after an eviction
976 	 */
977 	unsigned long last_restore_timestamp;
978 
979 	/* Indicates device process is debug attached with reserved vmid. */
980 	bool debug_trap_enabled;
981 
982 	/* per-process-per device debug event fd file */
983 	struct file *dbg_ev_file;
984 
985 	/* If the process is a kfd debugger, we need to know so we can clean
986 	 * up at exit time.  If a process enables debugging on itself, it does
987 	 * its own clean-up, so we don't set the flag here.  We track this by
988 	 * counting the number of processes this process is debugging.
989 	 */
990 	atomic_t debugged_process_count;
991 
992 	/* If the process is a debugged, this is the debugger process */
993 	struct kfd_process *debugger_process;
994 
995 	/* Kobj for our procfs */
996 	struct kobject *kobj;
997 	struct kobject *kobj_queues;
998 	struct attribute attr_pasid;
999 
1000 	/* Exception code enable mask and status */
1001 	uint64_t exception_enable_mask;
1002 	uint64_t exception_status;
1003 
1004 	/* Used to drain stale interrupts */
1005 	wait_queue_head_t wait_irq_drain;
1006 	bool irq_drain_is_open;
1007 
1008 	/* shared virtual memory registered by this process */
1009 	struct svm_range_list svms;
1010 
1011 	bool xnack_enabled;
1012 
1013 	/* Work area for debugger event writer worker. */
1014 	struct work_struct debug_event_workarea;
1015 
1016 	/* Tracks debug per-vmid request for debug flags */
1017 	u32 dbg_flags;
1018 
1019 	atomic_t poison;
1020 	/* Queues are in paused stated because we are in the process of doing a CRIU checkpoint */
1021 	bool queues_paused;
1022 
1023 	/* Tracks runtime enable status */
1024 	struct semaphore runtime_enable_sema;
1025 	bool is_runtime_retry;
1026 	struct kfd_runtime_info runtime_info;
1027 
1028 	/* if gpu page fault sent to KFD */
1029 	bool gpu_page_fault;
1030 
1031 	/*kfd context id */
1032 	u16 context_id;
1033 
1034 	/* The primary kfd_process allocating IDs for its secondary kfd_process, 0 for primary kfd_process */
1035 	struct ida id_table;
1036 
1037 };
1038 
1039 #define KFD_PROCESS_TABLE_SIZE 8 /* bits: 256 entries */
1040 #define KFD_CONTEXT_ID_PRIMARY	0xFFFF
1041 #define KFD_CONTEXT_ID_MIN 0
1042 
1043 extern DECLARE_HASHTABLE(kfd_processes_table, KFD_PROCESS_TABLE_SIZE);
1044 extern struct srcu_struct kfd_processes_srcu;
1045 
1046 /**
1047  * typedef amdkfd_ioctl_t - typedef for ioctl function pointer.
1048  *
1049  * @filep: pointer to file structure.
1050  * @p: amdkfd process pointer.
1051  * @data: pointer to arg that was copied from user.
1052  *
1053  * Return: returns ioctl completion code.
1054  */
1055 typedef int amdkfd_ioctl_t(struct file *filep, struct kfd_process *p,
1056 				void *data);
1057 
1058 typedef int amdkfd_ioctl_validate_t(void *kdata, unsigned int usize);
1059 
1060 struct amdkfd_ioctl_desc {
1061 	unsigned int cmd;
1062 	int flags;
1063 	amdkfd_ioctl_t *func;
1064 	amdkfd_ioctl_validate_t *validate;
1065 	unsigned int cmd_drv;
1066 	const char *name;
1067 };
1068 bool kfd_dev_is_large_bar(struct kfd_node *dev);
1069 
1070 struct kfd_process *create_process(const struct task_struct *thread, bool primary);
1071 int kfd_process_create_wq(void);
1072 void kfd_process_destroy_wq(void);
1073 void kfd_cleanup_processes(void);
1074 struct kfd_process *kfd_create_process(struct task_struct *thread);
1075 int kfd_create_process_sysfs(struct kfd_process *process);
1076 struct kfd_process *kfd_lookup_process_by_pasid(u32 pasid,
1077 						 struct kfd_process_device **pdd);
1078 struct kfd_process *kfd_lookup_process_by_mm(const struct mm_struct *mm);
1079 struct kfd_process *kfd_lookup_process_by_id(const struct mm_struct *mm, u16 id);
1080 
1081 int kfd_process_gpuidx_from_gpuid(struct kfd_process *p, uint32_t gpu_id);
1082 int kfd_process_gpuid_from_node(struct kfd_process *p, struct kfd_node *node,
1083 				uint32_t *gpuid, uint32_t *gpuidx);
1084 static inline int kfd_process_gpuid_from_gpuidx(struct kfd_process *p,
1085 				uint32_t gpuidx, uint32_t *gpuid) {
1086 	return gpuidx < p->n_pdds ? p->pdds[gpuidx]->dev->id : -EINVAL;
1087 }
1088 static inline struct kfd_process_device *kfd_process_device_from_gpuidx(
1089 				struct kfd_process *p, uint32_t gpuidx) {
1090 	return gpuidx < p->n_pdds ? p->pdds[gpuidx] : NULL;
1091 }
1092 
1093 void kfd_unref_process(struct kfd_process *p);
1094 int kfd_process_evict_queues(struct kfd_process *p, uint32_t trigger);
1095 int kfd_process_restore_queues(struct kfd_process *p);
1096 void kfd_suspend_all_processes(void);
1097 int kfd_resume_all_processes(void);
1098 
1099 struct kfd_process_device *kfd_process_device_data_by_id(struct kfd_process *process,
1100 							 uint32_t gpu_id);
1101 
1102 int kfd_process_get_user_gpu_id(struct kfd_process *p, uint32_t actual_gpu_id);
1103 
1104 int kfd_process_device_init_vm(struct kfd_process_device *pdd,
1105 			       struct file *drm_file);
1106 struct kfd_process_device *kfd_bind_process_to_device(struct kfd_node *dev,
1107 						struct kfd_process *p);
1108 struct kfd_process_device *kfd_get_process_device_data(struct kfd_node *dev,
1109 							struct kfd_process *p);
1110 struct kfd_process_device *kfd_create_process_device_data(struct kfd_node *dev,
1111 							struct kfd_process *p);
1112 
1113 bool kfd_process_xnack_mode(struct kfd_process *p, bool supported);
1114 
1115 void kfd_process_notifier_release_internal(struct kfd_process *p);
1116 
1117 /* KFD process API for creating and translating handles */
1118 int kfd_process_device_create_obj_handle(struct kfd_process_device *pdd,
1119 					void *mem);
1120 void *kfd_process_device_translate_handle(struct kfd_process_device *p,
1121 					int handle);
1122 void kfd_process_device_remove_obj_handle(struct kfd_process_device *pdd,
1123 					int handle);
1124 struct kfd_process *kfd_lookup_process_by_pid(struct pid *pid);
1125 
1126 /* PASIDs */
1127 int kfd_pasid_init(void);
1128 void kfd_pasid_exit(void);
1129 u32 kfd_pasid_alloc(void);
1130 void kfd_pasid_free(u32 pasid);
1131 
1132 /* Doorbells */
1133 size_t kfd_doorbell_process_slice(struct kfd_dev *kfd);
1134 int kfd_doorbell_init(struct kfd_dev *kfd);
1135 void kfd_doorbell_fini(struct kfd_dev *kfd);
1136 int kfd_doorbell_mmap(struct kfd_node *dev, struct kfd_process *process,
1137 		      struct vm_area_struct *vma);
1138 void __iomem *kfd_get_kernel_doorbell(struct kfd_dev *kfd,
1139 					unsigned int *doorbell_off);
1140 void kfd_release_kernel_doorbell(struct kfd_dev *kfd, u32 __iomem *db_addr);
1141 u32 read_kernel_doorbell(u32 __iomem *db);
1142 void write_kernel_doorbell(void __iomem *db, u32 value);
1143 void write_kernel_doorbell64(void __iomem *db, u64 value);
1144 unsigned int kfd_get_doorbell_dw_offset_in_bar(struct kfd_dev *kfd,
1145 					struct kfd_process_device *pdd,
1146 					unsigned int doorbell_id);
1147 phys_addr_t kfd_get_process_doorbells(struct kfd_process_device *pdd);
1148 int kfd_alloc_process_doorbells(struct kfd_dev *kfd,
1149 				struct kfd_process_device *pdd);
1150 void kfd_free_process_doorbells(struct kfd_dev *kfd,
1151 				struct kfd_process_device *pdd);
1152 /* GTT Sub-Allocator */
1153 
1154 int kfd_gtt_sa_allocate(struct kfd_node *node, unsigned int size,
1155 			struct kfd_mem_obj **mem_obj);
1156 
1157 int kfd_gtt_sa_free(struct kfd_node *node, struct kfd_mem_obj *mem_obj);
1158 
1159 extern struct device *kfd_device;
1160 
1161 /* KFD's procfs */
1162 void kfd_procfs_init(void);
1163 void kfd_procfs_shutdown(void);
1164 int kfd_procfs_add_queue(struct queue *q);
1165 void kfd_procfs_del_queue(struct queue *q);
1166 
1167 /* Topology */
1168 int kfd_topology_init(void);
1169 void kfd_topology_shutdown(void);
1170 int kfd_topology_add_device(struct kfd_node *gpu);
1171 int kfd_topology_remove_device(struct kfd_node *gpu);
1172 struct kfd_topology_device *kfd_topology_device_by_proximity_domain(
1173 						uint32_t proximity_domain);
1174 struct kfd_topology_device *kfd_topology_device_by_proximity_domain_no_lock(
1175 						uint32_t proximity_domain);
1176 struct kfd_topology_device *kfd_topology_device_by_id(uint32_t gpu_id);
1177 struct kfd_node *kfd_device_by_id(uint32_t gpu_id);
1178 static inline bool kfd_irq_is_from_node(struct kfd_node *node, uint32_t node_id,
1179 					uint32_t vmid)
1180 {
1181 	return (node->interrupt_bitmap & (1 << node_id)) != 0 &&
1182 	       (node->compute_vmid_bitmap & (1 << vmid)) != 0;
1183 }
1184 static inline struct kfd_node *kfd_node_by_irq_ids(struct amdgpu_device *adev,
1185 					uint32_t node_id, uint32_t vmid) {
1186 	struct kfd_dev *dev = adev->kfd.dev;
1187 	uint32_t i;
1188 
1189 	/*
1190 	 * On multi-aid system, attempt per-node matching. Otherwise,
1191 	 * fall back to the first node.
1192 	 */
1193 	if (!amdgpu_is_multi_aid(adev))
1194 		return dev->nodes[0];
1195 
1196 	for (i = 0; i < dev->num_nodes; i++)
1197 		if (kfd_irq_is_from_node(dev->nodes[i], node_id, vmid))
1198 			return dev->nodes[i];
1199 
1200 	return NULL;
1201 }
1202 int kfd_topology_enum_kfd_devices(uint8_t idx, struct kfd_node **kdev);
1203 uint32_t kfd_topology_get_num_devices(void);
1204 int kfd_numa_node_to_apic_id(int numa_node_id);
1205 uint32_t kfd_gpu_node_num(void);
1206 
1207 /* Interrupts */
1208 #define	KFD_IRQ_FENCE_CLIENTID	0xff
1209 #define	KFD_IRQ_FENCE_SOURCEID	0xff
1210 #define	KFD_IRQ_IS_FENCE(client, source)				\
1211 				((client) == KFD_IRQ_FENCE_CLIENTID &&	\
1212 				(source) == KFD_IRQ_FENCE_SOURCEID)
1213 int kfd_interrupt_init(struct kfd_node *dev);
1214 void kfd_interrupt_exit(struct kfd_node *dev);
1215 bool enqueue_ih_ring_entry(struct kfd_node *kfd, const void *ih_ring_entry);
1216 bool interrupt_is_wanted(struct kfd_node *dev,
1217 				const uint32_t *ih_ring_entry,
1218 				uint32_t *patched_ihre, bool *flag);
1219 int kfd_process_drain_interrupts(struct kfd_process_device *pdd);
1220 void kfd_process_close_interrupt_drain(unsigned int pasid);
1221 
1222 /* amdkfd Apertures */
1223 int kfd_init_apertures(struct kfd_process *process);
1224 
1225 void kfd_process_set_trap_handler(struct qcm_process_device *qpd,
1226 				  uint64_t tba_addr,
1227 				  uint64_t tma_addr);
1228 void kfd_process_set_trap_debug_flag(struct qcm_process_device *qpd,
1229 				     bool enabled);
1230 
1231 /* CRIU */
1232 /*
1233  * Need to increment KFD_CRIU_PRIV_VERSION each time a change is made to any of the CRIU private
1234  * structures:
1235  * kfd_criu_process_priv_data
1236  * kfd_criu_device_priv_data
1237  * kfd_criu_bo_priv_data
1238  * kfd_criu_queue_priv_data
1239  * kfd_criu_event_priv_data
1240  * kfd_criu_svm_range_priv_data
1241  */
1242 
1243 #define KFD_CRIU_PRIV_VERSION 1
1244 
1245 struct kfd_criu_process_priv_data {
1246 	uint32_t version;
1247 	uint32_t xnack_mode;
1248 };
1249 
1250 struct kfd_criu_device_priv_data {
1251 	/* For future use */
1252 	uint64_t reserved;
1253 };
1254 
1255 struct kfd_criu_bo_priv_data {
1256 	uint64_t user_addr;
1257 	uint32_t idr_handle;
1258 	uint32_t mapped_gpuids[MAX_GPU_INSTANCE];
1259 };
1260 
1261 /*
1262  * The first 4 bytes of kfd_criu_queue_priv_data, kfd_criu_event_priv_data,
1263  * kfd_criu_svm_range_priv_data is the object type
1264  */
1265 enum kfd_criu_object_type {
1266 	KFD_CRIU_OBJECT_TYPE_QUEUE,
1267 	KFD_CRIU_OBJECT_TYPE_EVENT,
1268 	KFD_CRIU_OBJECT_TYPE_SVM_RANGE,
1269 };
1270 
1271 struct kfd_criu_svm_range_priv_data {
1272 	uint32_t object_type;
1273 	uint64_t start_addr;
1274 	uint64_t size;
1275 	/* Variable length array of attributes */
1276 	struct kfd_ioctl_svm_attribute attrs[];
1277 };
1278 
1279 struct kfd_criu_queue_priv_data {
1280 	uint32_t object_type;
1281 	uint64_t q_address;
1282 	uint64_t q_size;
1283 	uint64_t read_ptr_addr;
1284 	uint64_t write_ptr_addr;
1285 	uint64_t doorbell_off;
1286 	uint64_t eop_ring_buffer_address;
1287 	uint64_t ctx_save_restore_area_address;
1288 	uint32_t gpu_id;
1289 	uint32_t type;
1290 	uint32_t format;
1291 	uint32_t q_id;
1292 	uint32_t priority;
1293 	uint32_t q_percent;
1294 	uint32_t doorbell_id;
1295 	uint32_t gws;
1296 	uint32_t sdma_id;
1297 	uint32_t eop_ring_buffer_size;
1298 	uint32_t ctx_save_restore_area_size;
1299 	uint32_t ctl_stack_size;
1300 	uint32_t mqd_size;
1301 };
1302 
1303 struct kfd_criu_event_priv_data {
1304 	uint32_t object_type;
1305 	uint64_t user_handle;
1306 	uint32_t event_id;
1307 	uint32_t auto_reset;
1308 	uint32_t type;
1309 	uint32_t signaled;
1310 
1311 	union {
1312 		struct kfd_hsa_memory_exception_data memory_exception_data;
1313 		struct kfd_hsa_hw_exception_data hw_exception_data;
1314 	};
1315 };
1316 
1317 int kfd_process_get_queue_info(struct kfd_process *p,
1318 			       uint32_t *num_queues,
1319 			       uint64_t *priv_data_sizes);
1320 
1321 int kfd_criu_checkpoint_queues(struct kfd_process *p,
1322 			 uint8_t __user *user_priv_data,
1323 			 uint64_t *priv_data_offset);
1324 
1325 int kfd_criu_restore_queue(struct kfd_process *p,
1326 			   uint8_t __user *user_priv_data,
1327 			   uint64_t *priv_data_offset,
1328 			   uint64_t max_priv_data_size);
1329 
1330 int kfd_criu_checkpoint_events(struct kfd_process *p,
1331 			 uint8_t __user *user_priv_data,
1332 			 uint64_t *priv_data_offset);
1333 
1334 int kfd_criu_restore_event(struct file *devkfd,
1335 			   struct kfd_process *p,
1336 			   uint8_t __user *user_priv_data,
1337 			   uint64_t *priv_data_offset,
1338 			   uint64_t max_priv_data_size);
1339 /* CRIU - End */
1340 
1341 /* Queue Context Management */
1342 int init_queue(struct queue **q, const struct queue_properties *properties);
1343 void uninit_queue(struct queue *q);
1344 void print_queue_properties(struct queue_properties *q);
1345 void print_queue(struct queue *q);
1346 int kfd_queue_buffer_get(struct amdgpu_vm *vm, void __user *addr, struct amdgpu_bo **pbo,
1347 			 u64 expected_size);
1348 void kfd_queue_buffer_put(struct amdgpu_bo **bo);
1349 int kfd_queue_acquire_buffers(struct kfd_process_device *pdd, struct queue_properties *properties);
1350 int kfd_queue_release_buffers(struct kfd_process_device *pdd, struct queue_properties *properties);
1351 void kfd_queue_unref_bo_va(struct amdgpu_vm *vm, struct amdgpu_bo **bo);
1352 int kfd_queue_unref_bo_vas(struct kfd_process_device *pdd,
1353 			   struct queue_properties *properties);
1354 void kfd_queue_ctx_save_restore_size(struct kfd_topology_device *dev);
1355 
1356 struct mqd_manager *mqd_manager_init_cik(enum KFD_MQD_TYPE type,
1357 		struct kfd_node *dev);
1358 struct mqd_manager *mqd_manager_init_vi(enum KFD_MQD_TYPE type,
1359 		struct kfd_node *dev);
1360 struct mqd_manager *mqd_manager_init_v9(enum KFD_MQD_TYPE type,
1361 		struct kfd_node *dev);
1362 struct mqd_manager *mqd_manager_init_v10(enum KFD_MQD_TYPE type,
1363 		struct kfd_node *dev);
1364 struct mqd_manager *mqd_manager_init_v11(enum KFD_MQD_TYPE type,
1365 		struct kfd_node *dev);
1366 struct mqd_manager *mqd_manager_init_v12(enum KFD_MQD_TYPE type,
1367 		struct kfd_node *dev);
1368 struct mqd_manager *mqd_manager_init_v12_1(enum KFD_MQD_TYPE type,
1369 		struct kfd_node *dev);
1370 struct device_queue_manager *device_queue_manager_init(struct kfd_node *dev);
1371 void device_queue_manager_uninit(struct device_queue_manager *dqm);
1372 struct kernel_queue *kernel_queue_init(struct kfd_node *dev,
1373 					enum kfd_queue_type type);
1374 void kernel_queue_uninit(struct kernel_queue *kq);
1375 int kfd_evict_process_device(struct kfd_process_device *pdd);
1376 int kfd_dqm_suspend_bad_queue_mes(struct kfd_node *knode, u32 pasid, u32 doorbell_id);
1377 
1378 /* Process Queue Manager */
1379 struct process_queue_node {
1380 	struct queue *q;
1381 	struct kernel_queue *kq;
1382 	struct list_head process_queue_list;
1383 };
1384 
1385 void kfd_process_dequeue_from_device(struct kfd_process_device *pdd);
1386 void kfd_process_dequeue_from_all_devices(struct kfd_process *p);
1387 int pqm_init(struct process_queue_manager *pqm, struct kfd_process *p);
1388 void pqm_uninit(struct process_queue_manager *pqm);
1389 int pqm_create_queue(struct process_queue_manager *pqm,
1390 			    struct kfd_node *dev,
1391 			    struct queue_properties *properties,
1392 			    unsigned int *qid,
1393 			    const struct kfd_criu_queue_priv_data *q_data,
1394 			    const void *restore_mqd,
1395 			    const void *restore_ctl_stack,
1396 			    uint32_t *p_doorbell_offset_in_process);
1397 int pqm_destroy_queue(struct process_queue_manager *pqm, unsigned int qid);
1398 int pqm_update_queue_properties(struct process_queue_manager *pqm, unsigned int qid,
1399 			struct queue_properties *p);
1400 int pqm_update_mqd(struct process_queue_manager *pqm, unsigned int qid,
1401 			struct mqd_update_info *minfo);
1402 int pqm_set_gws(struct process_queue_manager *pqm, unsigned int qid,
1403 			void *gws);
1404 struct queue *pqm_get_user_queue(struct process_queue_manager *pqm,
1405 						unsigned int qid);
1406 int pqm_get_wave_state(struct process_queue_manager *pqm,
1407 		       unsigned int qid,
1408 		       void __user *ctl_stack,
1409 		       u32 *ctl_stack_used_size,
1410 		       u32 *save_area_used_size);
1411 int pqm_get_queue_snapshot(struct process_queue_manager *pqm,
1412 			   uint64_t exception_clear_mask,
1413 			   void __user *buf,
1414 			   int *num_qss_entries,
1415 			   uint32_t *entry_size);
1416 
1417 int amdkfd_fence_wait_timeout(struct device_queue_manager *dqm,
1418 			      uint64_t fence_value,
1419 			      unsigned int timeout_ms);
1420 
1421 int pqm_get_queue_checkpoint_info(struct process_queue_manager *pqm,
1422 				  unsigned int qid,
1423 				  u32 *mqd_size,
1424 				  u32 *ctl_stack_size);
1425 /* Packet Manager */
1426 
1427 #define KFD_FENCE_COMPLETED (100)
1428 #define KFD_FENCE_INIT   (10)
1429 
1430 /**
1431  * enum kfd_config_dequeue_wait_counts_cmd - Command for configuring
1432  *  dequeue wait counts.
1433  *
1434  * @KFD_DEQUEUE_WAIT_INIT: Set optimized dequeue wait counts for a
1435  *	certain ASICs. For these ASICs, this is default value used by RESET
1436  * @KFD_DEQUEUE_WAIT_RESET: Reset dequeue wait counts to the optimized value
1437  *	for certain ASICs. For others set it to default hardware reset value
1438  * @KFD_DEQUEUE_WAIT_SET_SCH_WAVE: Set context switch latency wait
1439  *
1440  */
1441 enum kfd_config_dequeue_wait_counts_cmd {
1442 	KFD_DEQUEUE_WAIT_INIT = 1,
1443 	KFD_DEQUEUE_WAIT_RESET = 2,
1444 	KFD_DEQUEUE_WAIT_SET_SCH_WAVE = 3
1445 };
1446 
1447 
1448 struct packet_manager {
1449 	struct device_queue_manager *dqm;
1450 	struct kernel_queue *priv_queue;
1451 	struct mutex lock;
1452 	bool allocated;
1453 	struct kfd_mem_obj *ib_buffer_obj;
1454 	unsigned int ib_size_bytes;
1455 	bool is_over_subscription;
1456 
1457 	const struct packet_manager_funcs *pmf;
1458 };
1459 
1460 struct packet_manager_funcs {
1461 	/* Support ASIC-specific packet formats for PM4 packets */
1462 	int (*map_process)(struct packet_manager *pm, uint32_t *buffer,
1463 			struct qcm_process_device *qpd);
1464 	int (*runlist)(struct packet_manager *pm, uint32_t *buffer,
1465 			uint64_t ib, size_t ib_size_in_dwords, bool chain);
1466 	int (*set_resources)(struct packet_manager *pm, uint32_t *buffer,
1467 			struct scheduling_resources *res);
1468 	int (*map_queues)(struct packet_manager *pm, uint32_t *buffer,
1469 			struct queue *q, bool is_static);
1470 	int (*unmap_queues)(struct packet_manager *pm, uint32_t *buffer,
1471 			enum kfd_unmap_queues_filter mode,
1472 			uint32_t filter_param, bool reset);
1473 	int (*config_dequeue_wait_counts)(struct packet_manager *pm, uint32_t *buffer,
1474 			enum kfd_config_dequeue_wait_counts_cmd cmd, uint32_t value);
1475 	int (*query_status)(struct packet_manager *pm, uint32_t *buffer,
1476 			uint64_t fence_address,	uint64_t fence_value);
1477 	int (*release_mem)(uint64_t gpu_addr, uint32_t *buffer);
1478 
1479 	/* Packet sizes */
1480 	int map_process_size;
1481 	int runlist_size;
1482 	int set_resources_size;
1483 	int map_queues_size;
1484 	int unmap_queues_size;
1485 	int config_dequeue_wait_counts_size;
1486 	int query_status_size;
1487 	int release_mem_size;
1488 };
1489 
1490 extern const struct packet_manager_funcs kfd_vi_pm_funcs;
1491 extern const struct packet_manager_funcs kfd_v9_pm_funcs;
1492 extern const struct packet_manager_funcs kfd_aldebaran_pm_funcs;
1493 
1494 int pm_init(struct packet_manager *pm, struct device_queue_manager *dqm);
1495 void pm_uninit(struct packet_manager *pm);
1496 int pm_send_set_resources(struct packet_manager *pm,
1497 				struct scheduling_resources *res);
1498 int pm_send_runlist(struct packet_manager *pm, struct list_head *dqm_queues);
1499 int pm_send_query_status(struct packet_manager *pm, uint64_t fence_address,
1500 				uint64_t fence_value);
1501 
1502 int pm_send_unmap_queue(struct packet_manager *pm,
1503 			enum kfd_unmap_queues_filter mode,
1504 			uint32_t filter_param, bool reset);
1505 
1506 void pm_release_ib(struct packet_manager *pm);
1507 
1508 int pm_config_dequeue_wait_counts(struct packet_manager *pm,
1509 			enum kfd_config_dequeue_wait_counts_cmd cmd,
1510 			uint32_t wait_counts_config);
1511 
1512 /* Following PM funcs can be shared among VI and AI */
1513 unsigned int pm_build_pm4_header(unsigned int opcode, size_t packet_size);
1514 
1515 uint64_t kfd_get_number_elems(struct kfd_dev *kfd);
1516 
1517 /* Events */
1518 extern const struct kfd_event_interrupt_class event_interrupt_class_cik;
1519 extern const struct kfd_event_interrupt_class event_interrupt_class_v9;
1520 extern const struct kfd_event_interrupt_class event_interrupt_class_v9_4_3;
1521 extern const struct kfd_event_interrupt_class event_interrupt_class_v10;
1522 extern const struct kfd_event_interrupt_class event_interrupt_class_v11;
1523 extern const struct kfd_event_interrupt_class event_interrupt_class_v12_1;
1524 
1525 extern const struct kfd_device_global_init_class device_global_init_class_cik;
1526 
1527 int kfd_event_init_process(struct kfd_process *p);
1528 void kfd_event_free_process(struct kfd_process *p);
1529 int kfd_event_mmap(struct kfd_process *process, struct vm_area_struct *vma);
1530 int kfd_wait_on_events(struct kfd_process *p,
1531 		       uint32_t num_events, void __user *data,
1532 		       bool all, uint32_t *user_timeout_ms,
1533 		       uint32_t *wait_result);
1534 void kfd_signal_event_interrupt(u32 pasid, uint32_t partial_id,
1535 				uint32_t valid_id_bits, bool signal_mailbox_updated);
1536 void kfd_signal_hw_exception_event(u32 pasid);
1537 int kfd_set_event(struct kfd_process *p, uint32_t event_id);
1538 int kfd_reset_event(struct kfd_process *p, uint32_t event_id);
1539 int kfd_kmap_event_page(struct kfd_process *p, uint64_t event_page_offset);
1540 
1541 int kfd_event_create(struct file *devkfd, struct kfd_process *p,
1542 		     uint32_t event_type, bool auto_reset, uint32_t node_id,
1543 		     uint32_t *event_id, uint32_t *event_trigger_data,
1544 		     uint64_t *event_page_offset, uint32_t *event_slot_index);
1545 
1546 int kfd_get_num_events(struct kfd_process *p);
1547 int kfd_event_destroy(struct kfd_process *p, uint32_t event_id);
1548 
1549 void kfd_signal_vm_fault_event_with_userptr(struct kfd_process *p, uint64_t gpu_va);
1550 
1551 void kfd_signal_vm_fault_event(struct kfd_process_device *pdd,
1552 				struct kfd_vm_fault_info *info,
1553 				struct kfd_hsa_memory_exception_data *data);
1554 
1555 void kfd_signal_reset_event(struct kfd_node *dev);
1556 
1557 void kfd_signal_poison_consumed_event(struct kfd_node *dev, u32 pasid);
1558 void kfd_signal_process_terminate_event(struct kfd_process *p);
1559 
1560 static inline void kfd_flush_tlb(struct kfd_process_device *pdd)
1561 {
1562 	struct amdgpu_device *adev = pdd->dev->adev;
1563 	struct amdgpu_vm *vm = drm_priv_to_vm(pdd->drm_priv);
1564 
1565 	amdgpu_vm_flush_compute_tlb(adev, vm, TLB_FLUSH_HEAVYWEIGHT,
1566 				    pdd->dev->xcc_mask);
1567 }
1568 
1569 static inline bool kfd_flush_tlb_after_unmap(struct kfd_dev *dev)
1570 {
1571 	return KFD_GC_VERSION(dev) >= IP_VERSION(9, 4, 2) ||
1572 	       (KFD_GC_VERSION(dev) == IP_VERSION(9, 4, 1) && dev->sdma_fw_version >= 18) ||
1573 	       KFD_GC_VERSION(dev) == IP_VERSION(9, 4, 0);
1574 }
1575 
1576 int kfd_send_exception_to_runtime(struct kfd_process *p,
1577 				unsigned int queue_id,
1578 				uint64_t error_reason);
1579 bool kfd_is_locked(struct kfd_dev *kfd);
1580 
1581 /* Compute profile */
1582 void kfd_inc_compute_active(struct kfd_node *dev);
1583 void kfd_dec_compute_active(struct kfd_node *dev);
1584 
1585 /* Cgroup Support */
1586 /* Check with device cgroup if @kfd device is accessible */
1587 static inline int kfd_devcgroup_check_permission(struct kfd_node *node)
1588 {
1589 #if defined(CONFIG_CGROUP_DEVICE) || defined(CONFIG_CGROUP_BPF)
1590 	struct drm_device *ddev;
1591 
1592 	if (node->xcp)
1593 		ddev = node->xcp->ddev;
1594 	else
1595 		ddev = adev_to_drm(node->adev);
1596 
1597 	return devcgroup_check_permission(DEVCG_DEV_CHAR, DRM_MAJOR,
1598 					  ddev->render->index,
1599 					  DEVCG_ACC_WRITE | DEVCG_ACC_READ);
1600 #else
1601 	return 0;
1602 #endif
1603 }
1604 
1605 static inline bool kfd_is_first_node(struct kfd_node *node)
1606 {
1607 	return (node == node->kfd->nodes[0]);
1608 }
1609 
1610 /* PTL support */
1611 int kfd_ptl_disable_request(struct kfd_process_device *pdd,
1612 		struct kfd_process *p);
1613 int kfd_ptl_disable_release(struct kfd_process_device *pdd,
1614 		struct kfd_process *p);
1615 
1616 /* Debugfs */
1617 #if defined(CONFIG_DEBUG_FS)
1618 
1619 void kfd_debugfs_init(void);
1620 void kfd_debugfs_fini(void);
1621 int kfd_debugfs_mqds_by_process(struct seq_file *m, void *data);
1622 int pqm_debugfs_mqds(struct seq_file *m, void *data);
1623 int kfd_debugfs_hqds_by_device(struct seq_file *m, void *data);
1624 int dqm_debugfs_hqds(struct seq_file *m, void *data);
1625 int kfd_debugfs_rls_by_device(struct seq_file *m, void *data);
1626 int pm_debugfs_runlist(struct seq_file *m, void *data);
1627 
1628 int kfd_debugfs_hang_hws(struct kfd_node *dev);
1629 int pm_debugfs_hang_hws(struct packet_manager *pm);
1630 int dqm_debugfs_hang_hws(struct device_queue_manager *dqm);
1631 
1632 void kfd_debugfs_add_process(struct kfd_process *p);
1633 void kfd_debugfs_remove_process(struct kfd_process *p);
1634 
1635 #else
1636 
1637 static inline void kfd_debugfs_init(void) {}
1638 static inline void kfd_debugfs_fini(void) {}
1639 static inline void kfd_debugfs_add_process(struct kfd_process *p) {}
1640 static inline void kfd_debugfs_remove_process(struct kfd_process *p) {}
1641 
1642 #endif
1643 
1644 #endif
1645