2 * Copyright 2014 Advanced Micro Devices, Inc.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
23 #ifndef KFD_PRIV_H_INCLUDED
24 #define KFD_PRIV_H_INCLUDED
26 #include <linux/hashtable.h>
27 #include <linux/mmu_notifier.h>
28 #include <linux/mutex.h>
29 #include <linux/types.h>
30 #include <linux/atomic.h>
31 #include <linux/workqueue.h>
32 #include <linux/spinlock.h>
33 #include <linux/kfd_ioctl.h>
34 #include <linux/idr.h>
35 #include <linux/kfifo.h>
36 #include <linux/seq_file.h>
37 #include <linux/kref.h>
38 #include <linux/sysfs.h>
39 #include <linux/device_cgroup.h>
40 #include <drm/drm_file.h>
41 #include <drm/drm_drv.h>
42 #include <drm/drm_device.h>
43 #include <drm/drm_ioctl.h>
44 #include <kgd_kfd_interface.h>
45 #include <linux/swap.h>
47 #include "amd_shared.h"
50 #define KFD_MAX_RING_ENTRY_SIZE 8
52 #define KFD_SYSFS_FILE_MODE 0444
54 /* GPU ID hash width in bits */
55 #define KFD_GPU_ID_HASH_WIDTH 16
57 /* Use upper bits of mmap offset to store KFD driver specific information.
58 * BITS[63:62] - Encode MMAP type
59 * BITS[61:46] - Encode gpu_id. To identify to which GPU the offset belongs to
60 * BITS[45:0] - MMAP offset value
62 * NOTE: struct vm_area_struct.vm_pgoff uses offset in pages. Hence, these
63 * defines are w.r.t to PAGE_SIZE
65 #define KFD_MMAP_TYPE_SHIFT 62
66 #define KFD_MMAP_TYPE_MASK (0x3ULL << KFD_MMAP_TYPE_SHIFT)
67 #define KFD_MMAP_TYPE_DOORBELL (0x3ULL << KFD_MMAP_TYPE_SHIFT)
68 #define KFD_MMAP_TYPE_EVENTS (0x2ULL << KFD_MMAP_TYPE_SHIFT)
69 #define KFD_MMAP_TYPE_RESERVED_MEM (0x1ULL << KFD_MMAP_TYPE_SHIFT)
70 #define KFD_MMAP_TYPE_MMIO (0x0ULL << KFD_MMAP_TYPE_SHIFT)
72 #define KFD_MMAP_GPU_ID_SHIFT 46
73 #define KFD_MMAP_GPU_ID_MASK (((1ULL << KFD_GPU_ID_HASH_WIDTH) - 1) \
74 << KFD_MMAP_GPU_ID_SHIFT)
75 #define KFD_MMAP_GPU_ID(gpu_id) ((((uint64_t)gpu_id) << KFD_MMAP_GPU_ID_SHIFT)\
76 & KFD_MMAP_GPU_ID_MASK)
77 #define KFD_MMAP_GET_GPU_ID(offset) ((offset & KFD_MMAP_GPU_ID_MASK) \
78 >> KFD_MMAP_GPU_ID_SHIFT)
81 * When working with cp scheduler we should assign the HIQ manually or via
82 * the amdgpu driver to a fixed hqd slot, here are the fixed HIQ hqd slot
83 * definitions for Kaveri. In Kaveri only the first ME queues participates
84 * in the cp scheduling taking that in mind we set the HIQ slot in the
87 #define KFD_CIK_HIQ_PIPE 4
88 #define KFD_CIK_HIQ_QUEUE 0
90 /* Macro for allocating structures */
91 #define kfd_alloc_struct(ptr_to_struct) \
92 ((typeof(ptr_to_struct)) kzalloc(sizeof(*ptr_to_struct), GFP_KERNEL))
94 #define KFD_MAX_NUM_OF_PROCESSES 512
95 #define KFD_MAX_NUM_OF_QUEUES_PER_PROCESS 1024
98 * Size of the per-process TBA+TMA buffer: 2 pages
100 * The first page is the TBA used for the CWSR ISA code. The second
101 * page is used as TMA for user-mode trap handler setup in daisy-chain mode.
103 #define KFD_CWSR_TBA_TMA_SIZE (PAGE_SIZE * 2)
104 #define KFD_CWSR_TMA_OFFSET PAGE_SIZE
106 #define KFD_MAX_NUM_OF_QUEUES_PER_DEVICE \
107 (KFD_MAX_NUM_OF_PROCESSES * \
108 KFD_MAX_NUM_OF_QUEUES_PER_PROCESS)
110 #define KFD_KERNEL_QUEUE_SIZE 2048
112 #define KFD_UNMAP_LATENCY_MS (4000)
116 * The doorbell index distance between SDMA RLC (2*i) and (2*i+1) in the
117 * same SDMA engine on SOC15, which has 8-byte doorbells for SDMA.
118 * 512 8-byte doorbell distance (i.e. one page away) ensures that SDMA RLC
119 * (2*i+1) doorbells (in terms of the lower 12 bit address) lie exactly in
120 * the OFFSET and SIZE set in registers like BIF_SDMA0_DOORBELL_RANGE.
122 #define KFD_QUEUE_DOORBELL_MIRROR_OFFSET 512
126 * Kernel module parameter to specify maximum number of supported queues per
129 extern int max_num_of_queues_per_device;
132 /* Kernel module parameter to specify the scheduling policy */
133 extern int sched_policy;
136 * Kernel module parameter to specify the maximum process
137 * number per HW scheduler
139 extern int hws_max_conc_proc;
141 extern int cwsr_enable;
144 * Kernel module parameter to specify whether to send sigterm to HSA process on
145 * unhandled exception
147 extern int send_sigterm;
150 * This kernel module is used to simulate large bar machine on non-large bar
153 extern int debug_largebar;
156 * Ignore CRAT table during KFD initialization, can be used to work around
157 * broken CRAT tables on some AMD systems
159 extern int ignore_crat;
161 /* Set sh_mem_config.retry_disable on GFX v9 */
162 extern int amdgpu_noretry;
164 /* Halt if HWS hang is detected */
165 extern int halt_if_hws_hang;
167 /* Whether MEC FW support GWS barriers */
168 extern bool hws_gws_support;
170 /* Queue preemption timeout in ms */
171 extern int queue_preemption_timeout_ms;
174 * Don't evict process queues on vm fault
176 extern int amdgpu_no_queue_eviction_on_vm_fault;
178 /* Enable eviction debug messages */
179 extern bool debug_evictions;
182 cache_policy_coherent,
183 cache_policy_noncoherent
186 #define KFD_GC_VERSION(dev) ((dev)->adev->ip_versions[GC_HWIP][0])
187 #define KFD_IS_SOC15(dev) ((KFD_GC_VERSION(dev)) >= (IP_VERSION(9, 0, 1)))
189 struct kfd_event_interrupt_class {
190 bool (*interrupt_isr)(struct kfd_dev *dev,
191 const uint32_t *ih_ring_entry, uint32_t *patched_ihre,
193 void (*interrupt_wq)(struct kfd_dev *dev,
194 const uint32_t *ih_ring_entry);
197 struct kfd_device_info {
198 const char *asic_name;
199 uint32_t gfx_target_version;
200 const struct kfd_event_interrupt_class *event_interrupt_class;
201 unsigned int max_pasid_bits;
202 unsigned int max_no_of_hqd;
203 unsigned int doorbell_size;
204 size_t ih_ring_entry_size;
205 uint8_t num_of_watch_points;
206 uint16_t mqd_size_aligned;
208 bool needs_iommu_device;
209 bool needs_pci_atomics;
210 uint32_t no_atomic_fw_version;
211 unsigned int num_sdma_engines;
212 unsigned int num_xgmi_sdma_engines;
213 unsigned int num_sdma_queues_per_engine;
216 unsigned int kfd_get_num_sdma_engines(struct kfd_dev *kdev);
217 unsigned int kfd_get_num_xgmi_sdma_engines(struct kfd_dev *kdev);
220 uint32_t range_start;
227 struct kfd_vmid_info {
228 uint32_t first_vmid_kfd;
229 uint32_t last_vmid_kfd;
230 uint32_t vmid_num_kfd;
234 struct amdgpu_device *adev;
236 const struct kfd_device_info *device_info;
237 struct pci_dev *pdev;
238 struct drm_device *ddev;
240 unsigned int id; /* topology stub index */
242 phys_addr_t doorbell_base; /* Start of actual doorbells used by
243 * KFD. It is aligned for mapping
246 size_t doorbell_base_dw_offset; /* Offset from the start of the PCI
247 * doorbell BAR to the first KFD
248 * doorbell in dwords. GFX reserves
249 * the segment before this offset.
251 u32 __iomem *doorbell_kernel_ptr; /* This is a pointer for a doorbells
252 * page used by kernel queue
255 struct kgd2kfd_shared_resources shared_resources;
256 struct kfd_vmid_info vm_info;
258 const struct kfd2kgd_calls *kfd2kgd;
259 struct mutex doorbell_mutex;
260 DECLARE_BITMAP(doorbell_available_index,
261 KFD_MAX_NUM_OF_QUEUES_PER_PROCESS);
264 uint64_t gtt_start_gpu_addr;
265 void *gtt_start_cpu_ptr;
267 struct mutex gtt_sa_lock;
268 unsigned int gtt_sa_chunk_size;
269 unsigned int gtt_sa_num_of_chunks;
272 struct kfifo ih_fifo;
273 struct workqueue_struct *ih_wq;
274 struct work_struct interrupt_work;
275 spinlock_t interrupt_lock;
277 /* QCM Device instance */
278 struct device_queue_manager *dqm;
282 * Interrupts of interest to KFD are copied
283 * from the HW ring into a SW ring.
285 bool interrupts_active;
288 struct kfd_dbgmgr *dbgmgr;
290 /* Firmware versions */
291 uint16_t mec_fw_version;
292 uint16_t mec2_fw_version;
293 uint16_t sdma_fw_version;
295 /* Maximum process number mapped to HW scheduler */
296 unsigned int max_proc_per_quantum;
300 const void *cwsr_isa;
301 unsigned int cwsr_isa_size;
306 bool pci_atomic_requested;
308 /* Use IOMMU v2 flag */
312 atomic_t sram_ecc_flag;
314 /* Compute Profile ref. count */
315 atomic_t compute_profile;
317 /* Global GWS resource shared between processes */
320 /* Clients watching SMI events */
321 struct list_head smi_clients;
324 uint32_t reset_seq_num;
326 struct ida doorbell_ida;
327 unsigned int max_doorbell_slices;
331 /* HMM page migration MEMORY_DEVICE_PRIVATE mapping */
332 struct dev_pagemap pgmap;
336 KFD_MEMPOOL_SYSTEM_CACHEABLE = 1,
337 KFD_MEMPOOL_SYSTEM_WRITECOMBINE = 2,
338 KFD_MEMPOOL_FRAMEBUFFER = 3,
341 /* Character device interface */
342 int kfd_chardev_init(void);
343 void kfd_chardev_exit(void);
344 struct device *kfd_chardev(void);
347 * enum kfd_unmap_queues_filter - Enum for queue filters.
349 * @KFD_UNMAP_QUEUES_FILTER_SINGLE_QUEUE: Preempts single queue.
351 * @KFD_UNMAP_QUEUES_FILTER_ALL_QUEUES: Preempts all queues in the
352 * running queues list.
354 * @KFD_UNMAP_QUEUES_FILTER_BY_PASID: Preempts queues that belongs to
358 enum kfd_unmap_queues_filter {
359 KFD_UNMAP_QUEUES_FILTER_SINGLE_QUEUE,
360 KFD_UNMAP_QUEUES_FILTER_ALL_QUEUES,
361 KFD_UNMAP_QUEUES_FILTER_DYNAMIC_QUEUES,
362 KFD_UNMAP_QUEUES_FILTER_BY_PASID
366 * enum kfd_queue_type - Enum for various queue types.
368 * @KFD_QUEUE_TYPE_COMPUTE: Regular user mode queue type.
370 * @KFD_QUEUE_TYPE_SDMA: SDMA user mode queue type.
372 * @KFD_QUEUE_TYPE_HIQ: HIQ queue type.
374 * @KFD_QUEUE_TYPE_DIQ: DIQ queue type.
376 * @KFD_QUEUE_TYPE_SDMA_XGMI: Special SDMA queue for XGMI interface.
378 enum kfd_queue_type {
379 KFD_QUEUE_TYPE_COMPUTE,
383 KFD_QUEUE_TYPE_SDMA_XGMI
386 enum kfd_queue_format {
387 KFD_QUEUE_FORMAT_PM4,
391 enum KFD_QUEUE_PRIORITY {
392 KFD_QUEUE_PRIORITY_MINIMUM = 0,
393 KFD_QUEUE_PRIORITY_MAXIMUM = 15
397 * struct queue_properties
399 * @type: The queue type.
401 * @queue_id: Queue identifier.
403 * @queue_address: Queue ring buffer address.
405 * @queue_size: Queue ring buffer size.
407 * @priority: Defines the queue priority relative to other queues in the
409 * This is just an indication and HW scheduling may override the priority as
410 * necessary while keeping the relative prioritization.
411 * the priority granularity is from 0 to f which f is the highest priority.
412 * currently all queues are initialized with the highest priority.
414 * @queue_percent: This field is partially implemented and currently a zero in
415 * this field defines that the queue is non active.
417 * @read_ptr: User space address which points to the number of dwords the
418 * cp read from the ring buffer. This field updates automatically by the H/W.
420 * @write_ptr: Defines the number of dwords written to the ring buffer.
422 * @doorbell_ptr: Notifies the H/W of new packet written to the queue ring
423 * buffer. This field should be similar to write_ptr and the user should
424 * update this field after updating the write_ptr.
426 * @doorbell_off: The doorbell offset in the doorbell pci-bar.
428 * @is_interop: Defines if this is a interop queue. Interop queue means that
429 * the queue can access both graphics and compute resources.
431 * @is_evicted: Defines if the queue is evicted. Only active queues
432 * are evicted, rendering them inactive.
434 * @is_active: Defines if the queue is active or not. @is_active and
435 * @is_evicted are protected by the DQM lock.
437 * @is_gws: Defines if the queue has been updated to be GWS-capable or not.
438 * @is_gws should be protected by the DQM lock, since changing it can yield the
439 * possibility of updating DQM state on number of GWS queues.
441 * @vmid: If the scheduling mode is no cp scheduling the field defines the vmid
444 * This structure represents the queue properties for each queue no matter if
445 * it's user mode or kernel mode queue.
448 struct queue_properties {
449 enum kfd_queue_type type;
450 enum kfd_queue_format format;
451 unsigned int queue_id;
452 uint64_t queue_address;
455 uint32_t queue_percent;
458 void __iomem *doorbell_ptr;
459 uint32_t doorbell_off;
464 /* Not relevant for user mode queues in cp scheduling */
466 /* Relevant only for sdma queues*/
467 uint32_t sdma_engine_id;
468 uint32_t sdma_queue_id;
469 uint32_t sdma_vm_addr;
470 /* Relevant only for VI */
471 uint64_t eop_ring_buffer_address;
472 uint32_t eop_ring_buffer_size;
473 uint64_t ctx_save_restore_area_address;
474 uint32_t ctx_save_restore_area_size;
475 uint32_t ctl_stack_size;
480 #define QUEUE_IS_ACTIVE(q) ((q).queue_size > 0 && \
481 (q).queue_address != 0 && \
482 (q).queue_percent > 0 && \
485 enum mqd_update_flag {
486 UPDATE_FLAG_CU_MASK = 0,
489 struct mqd_update_info {
492 uint32_t count; /* Must be a multiple of 32 */
496 enum mqd_update_flag update_flag;
502 * @list: Queue linked list.
504 * @mqd: The queue MQD (memory queue descriptor).
506 * @mqd_mem_obj: The MQD local gpu memory object.
508 * @gart_mqd_addr: The MQD gart mc address.
510 * @properties: The queue properties.
512 * @mec: Used only in no cp scheduling mode and identifies to micro engine id
513 * that the queue should be executed on.
515 * @pipe: Used only in no cp scheduling mode and identifies the queue's pipe
518 * @queue: Used only in no cp scheduliong mode and identifies the queue's slot.
520 * @process: The kfd process that created this queue.
522 * @device: The kfd device that created this queue.
524 * @gws: Pointing to gws kgd_mem if this is a gws control queue; NULL
527 * This structure represents user mode compute queues.
528 * It contains all the necessary data to handle such queues.
533 struct list_head list;
535 struct kfd_mem_obj *mqd_mem_obj;
536 uint64_t gart_mqd_addr;
537 struct queue_properties properties;
543 unsigned int sdma_id;
544 unsigned int doorbell_id;
546 struct kfd_process *process;
547 struct kfd_dev *device;
555 KFD_MQD_TYPE_HIQ = 0, /* for hiq */
556 KFD_MQD_TYPE_CP, /* for cp queues and diq */
557 KFD_MQD_TYPE_SDMA, /* for sdma queues */
558 KFD_MQD_TYPE_DIQ, /* for diq */
562 enum KFD_PIPE_PRIORITY {
563 KFD_PIPE_PRIORITY_CS_LOW = 0,
564 KFD_PIPE_PRIORITY_CS_MEDIUM,
565 KFD_PIPE_PRIORITY_CS_HIGH
568 struct scheduling_resources {
569 unsigned int vmid_mask;
570 enum kfd_queue_type type;
574 uint32_t gds_heap_base;
575 uint32_t gds_heap_size;
578 struct process_queue_manager {
580 struct kfd_process *process;
581 struct list_head queues;
582 unsigned long *queue_slot_bitmap;
585 struct qcm_process_device {
586 /* The Device Queue Manager that owns this data */
587 struct device_queue_manager *dqm;
588 struct process_queue_manager *pqm;
590 struct list_head queues_list;
591 struct list_head priv_queue_list;
593 unsigned int queue_count;
596 unsigned int evicted; /* eviction counter, 0=active */
598 /* This flag tells if we should reset all wavefronts on
599 * process termination
601 bool reset_wavefronts;
603 /* This flag tells us if this process has a GWS-capable
604 * queue that will be mapped into the runlist. It's
605 * possible to request a GWS BO, but not have the queue
606 * currently mapped, and this changes how the MAP_PROCESS
607 * PM4 packet is configured.
609 bool mapped_gws_queue;
611 /* All the memory management data should be here too */
612 uint64_t gds_context_area;
613 /* Contains page table flags such as AMDGPU_PTE_VALID since gfx9 */
614 uint64_t page_table_base;
615 uint32_t sh_mem_config;
616 uint32_t sh_mem_bases;
617 uint32_t sh_mem_ape1_base;
618 uint32_t sh_mem_ape1_limit;
622 uint32_t sh_hidden_private_base;
625 struct kgd_mem *cwsr_mem;
632 struct kgd_mem *ib_mem;
636 /* doorbell resources per process per device */
637 unsigned long *doorbell_bitmap;
640 /* KFD Memory Eviction */
642 /* Approx. wait time before attempting to restore evicted BOs */
643 #define PROCESS_RESTORE_TIME_MS 100
644 /* Approx. back off time if restore fails due to lack of memory */
645 #define PROCESS_BACK_OFF_TIME_MS 100
646 /* Approx. time before evicting the process again */
647 #define PROCESS_ACTIVE_TIME_MS 10
649 /* 8 byte handle containing GPU ID in the most significant 4 bytes and
650 * idr_handle in the least significant 4 bytes
652 #define MAKE_HANDLE(gpu_id, idr_handle) \
653 (((uint64_t)(gpu_id) << 32) + idr_handle)
654 #define GET_GPU_ID(handle) (handle >> 32)
655 #define GET_IDR_HANDLE(handle) (handle & 0xFFFFFFFF)
663 #define MAX_SYSFS_FILENAME_LEN 15
666 * SDMA counter runs at 100MHz frequency.
667 * We display SDMA activity in microsecond granularity in sysfs.
668 * As a result, the divisor is 100.
670 #define SDMA_ACTIVITY_DIVISOR 100
672 /* Data that is per-process-per device. */
673 struct kfd_process_device {
674 /* The device that owns this data. */
677 /* The process that owns this kfd_process_device. */
678 struct kfd_process *process;
680 /* per-process-per device QCM data structure */
681 struct qcm_process_device qpd;
687 uint64_t gpuvm_limit;
688 uint64_t scratch_base;
689 uint64_t scratch_limit;
691 /* VM context for GPUVM allocations */
692 struct file *drm_file;
695 /* GPUVM allocations storage */
696 struct idr alloc_idr;
698 /* Flag used to tell the pdd has dequeued from the dqm.
699 * This is used to prevent dev->dqm->ops.process_termination() from
700 * being called twice when it is already called in IOMMU callback
703 bool already_dequeued;
706 /* Is this process/pasid bound to this device? (amd_iommu_bind_pasid) */
707 enum kfd_pdd_bound bound;
711 struct attribute attr_vram;
712 char vram_filename[MAX_SYSFS_FILENAME_LEN];
714 /* SDMA activity tracking */
715 uint64_t sdma_past_activity_counter;
716 struct attribute attr_sdma;
717 char sdma_filename[MAX_SYSFS_FILENAME_LEN];
719 /* Eviction activity tracking */
720 uint64_t last_evict_timestamp;
721 atomic64_t evict_duration_counter;
722 struct attribute attr_evict;
724 struct kobject *kobj_stats;
725 unsigned int doorbell_index;
728 * @cu_occupancy: Reports occupancy of Compute Units (CU) of a process
729 * that is associated with device encoded by "this" struct instance. The
730 * value reflects CU usage by all of the waves launched by this process
731 * on this device. A very important property of occupancy parameter is
732 * that its value is a snapshot of current use.
734 * Following is to be noted regarding how this parameter is reported:
736 * The number of waves that a CU can launch is limited by couple of
737 * parameters. These are encoded by struct amdgpu_cu_info instance
738 * that is part of every device definition. For GFX9 devices this
739 * translates to 40 waves (simd_per_cu * max_waves_per_simd) when waves
740 * do not use scratch memory and 32 waves (max_scratch_slots_per_cu)
741 * when they do use scratch memory. This could change for future
742 * devices and therefore this example should be considered as a guide.
744 * All CU's of a device are available for the process. This may not be true
745 * under certain conditions - e.g. CU masking.
747 * Finally number of CU's that are occupied by a process is affected by both
748 * number of CU's a device has along with number of other competing processes
750 struct attribute attr_cu_occupancy;
752 /* sysfs counters for GPU retry fault and page migration tracking */
753 struct kobject *kobj_counters;
754 struct attribute attr_faults;
755 struct attribute attr_page_in;
756 struct attribute attr_page_out;
762 #define qpd_to_pdd(x) container_of(x, struct kfd_process_device, qpd)
764 struct svm_range_list {
766 struct rb_root_cached objects;
767 struct list_head list;
768 struct work_struct deferred_list_work;
769 struct list_head deferred_range_list;
770 spinlock_t deferred_list_lock;
771 atomic_t evicted_ranges;
772 bool drain_pagefaults;
773 struct delayed_work restore_work;
774 DECLARE_BITMAP(bitmap_supported, MAX_GPU_INSTANCE);
775 struct task_struct *faulting_task;
781 * kfd_process are stored in an mm_struct*->kfd_process*
782 * hash table (kfd_processes in kfd_process.c)
784 struct hlist_node kfd_processes;
787 * Opaque pointer to mm_struct. We don't hold a reference to
788 * it so it should never be dereferenced from here. This is
789 * only used for looking up processes by their mm.
794 struct work_struct release_work;
799 * In any process, the thread that started main() is the lead
800 * thread and outlives the rest.
801 * It is here because amd_iommu_bind_pasid wants a task_struct.
802 * It can also be used for safely getting a reference to the
803 * mm_struct of the process.
805 struct task_struct *lead_thread;
807 /* We want to receive a notification when the mm_struct is destroyed */
808 struct mmu_notifier mmu_notifier;
813 * Array of kfd_process_device pointers,
814 * one for each device the process is using.
816 struct kfd_process_device *pdds[MAX_GPU_INSTANCE];
819 struct process_queue_manager pqm;
821 /*Is the user space process 32 bit?*/
822 bool is_32bit_user_mode;
824 /* Event-related data */
825 struct mutex event_mutex;
826 /* Event ID allocator and lookup */
827 struct idr event_idr;
830 struct kfd_signal_page *signal_page;
831 size_t signal_mapped_size;
832 size_t signal_event_count;
833 bool signal_event_limit_reached;
835 /* Information used for memory eviction */
836 void *kgd_process_info;
837 /* Eviction fence that is attached to all the BOs of this process. The
838 * fence will be triggered during eviction and new one will be created
841 struct dma_fence *ef;
843 /* Work items for evicting and restoring BOs */
844 struct delayed_work eviction_work;
845 struct delayed_work restore_work;
846 /* seqno of the last scheduled eviction */
847 unsigned int last_eviction_seqno;
848 /* Approx. the last timestamp (in jiffies) when the process was
849 * restored after an eviction
851 unsigned long last_restore_timestamp;
853 /* Kobj for our procfs */
854 struct kobject *kobj;
855 struct kobject *kobj_queues;
856 struct attribute attr_pasid;
858 /* shared virtual memory registered by this process */
859 struct svm_range_list svms;
864 #define KFD_PROCESS_TABLE_SIZE 5 /* bits: 32 entries */
865 extern DECLARE_HASHTABLE(kfd_processes_table, KFD_PROCESS_TABLE_SIZE);
866 extern struct srcu_struct kfd_processes_srcu;
869 * typedef amdkfd_ioctl_t - typedef for ioctl function pointer.
871 * @filep: pointer to file structure.
872 * @p: amdkfd process pointer.
873 * @data: pointer to arg that was copied from user.
875 * Return: returns ioctl completion code.
877 typedef int amdkfd_ioctl_t(struct file *filep, struct kfd_process *p,
880 struct amdkfd_ioctl_desc {
883 amdkfd_ioctl_t *func;
884 unsigned int cmd_drv;
887 bool kfd_dev_is_large_bar(struct kfd_dev *dev);
889 int kfd_process_create_wq(void);
890 void kfd_process_destroy_wq(void);
891 struct kfd_process *kfd_create_process(struct file *filep);
892 struct kfd_process *kfd_get_process(const struct task_struct *);
893 struct kfd_process *kfd_lookup_process_by_pasid(u32 pasid);
894 struct kfd_process *kfd_lookup_process_by_mm(const struct mm_struct *mm);
896 int kfd_process_gpuidx_from_gpuid(struct kfd_process *p, uint32_t gpu_id);
897 int kfd_process_gpuid_from_adev(struct kfd_process *p,
898 struct amdgpu_device *adev, uint32_t *gpuid,
900 static inline int kfd_process_gpuid_from_gpuidx(struct kfd_process *p,
901 uint32_t gpuidx, uint32_t *gpuid) {
902 return gpuidx < p->n_pdds ? p->pdds[gpuidx]->dev->id : -EINVAL;
904 static inline struct kfd_process_device *kfd_process_device_from_gpuidx(
905 struct kfd_process *p, uint32_t gpuidx) {
906 return gpuidx < p->n_pdds ? p->pdds[gpuidx] : NULL;
909 void kfd_unref_process(struct kfd_process *p);
910 int kfd_process_evict_queues(struct kfd_process *p);
911 int kfd_process_restore_queues(struct kfd_process *p);
912 void kfd_suspend_all_processes(void);
913 int kfd_resume_all_processes(void);
915 int kfd_process_device_init_vm(struct kfd_process_device *pdd,
916 struct file *drm_file);
917 struct kfd_process_device *kfd_bind_process_to_device(struct kfd_dev *dev,
918 struct kfd_process *p);
919 struct kfd_process_device *kfd_get_process_device_data(struct kfd_dev *dev,
920 struct kfd_process *p);
921 struct kfd_process_device *kfd_create_process_device_data(struct kfd_dev *dev,
922 struct kfd_process *p);
924 bool kfd_process_xnack_mode(struct kfd_process *p, bool supported);
926 int kfd_reserved_mem_mmap(struct kfd_dev *dev, struct kfd_process *process,
927 struct vm_area_struct *vma);
929 /* KFD process API for creating and translating handles */
930 int kfd_process_device_create_obj_handle(struct kfd_process_device *pdd,
932 void *kfd_process_device_translate_handle(struct kfd_process_device *p,
934 void kfd_process_device_remove_obj_handle(struct kfd_process_device *pdd,
938 int kfd_pasid_init(void);
939 void kfd_pasid_exit(void);
940 bool kfd_set_pasid_limit(unsigned int new_limit);
941 unsigned int kfd_get_pasid_limit(void);
942 u32 kfd_pasid_alloc(void);
943 void kfd_pasid_free(u32 pasid);
946 size_t kfd_doorbell_process_slice(struct kfd_dev *kfd);
947 int kfd_doorbell_init(struct kfd_dev *kfd);
948 void kfd_doorbell_fini(struct kfd_dev *kfd);
949 int kfd_doorbell_mmap(struct kfd_dev *dev, struct kfd_process *process,
950 struct vm_area_struct *vma);
951 void __iomem *kfd_get_kernel_doorbell(struct kfd_dev *kfd,
952 unsigned int *doorbell_off);
953 void kfd_release_kernel_doorbell(struct kfd_dev *kfd, u32 __iomem *db_addr);
954 u32 read_kernel_doorbell(u32 __iomem *db);
955 void write_kernel_doorbell(void __iomem *db, u32 value);
956 void write_kernel_doorbell64(void __iomem *db, u64 value);
957 unsigned int kfd_get_doorbell_dw_offset_in_bar(struct kfd_dev *kfd,
958 struct kfd_process_device *pdd,
959 unsigned int doorbell_id);
960 phys_addr_t kfd_get_process_doorbells(struct kfd_process_device *pdd);
961 int kfd_alloc_process_doorbells(struct kfd_dev *kfd,
962 unsigned int *doorbell_index);
963 void kfd_free_process_doorbells(struct kfd_dev *kfd,
964 unsigned int doorbell_index);
965 /* GTT Sub-Allocator */
967 int kfd_gtt_sa_allocate(struct kfd_dev *kfd, unsigned int size,
968 struct kfd_mem_obj **mem_obj);
970 int kfd_gtt_sa_free(struct kfd_dev *kfd, struct kfd_mem_obj *mem_obj);
972 extern struct device *kfd_device;
975 void kfd_procfs_init(void);
976 void kfd_procfs_shutdown(void);
977 int kfd_procfs_add_queue(struct queue *q);
978 void kfd_procfs_del_queue(struct queue *q);
981 int kfd_topology_init(void);
982 void kfd_topology_shutdown(void);
983 int kfd_topology_add_device(struct kfd_dev *gpu);
984 int kfd_topology_remove_device(struct kfd_dev *gpu);
985 struct kfd_topology_device *kfd_topology_device_by_proximity_domain(
986 uint32_t proximity_domain);
987 struct kfd_topology_device *kfd_topology_device_by_id(uint32_t gpu_id);
988 struct kfd_dev *kfd_device_by_id(uint32_t gpu_id);
989 struct kfd_dev *kfd_device_by_pci_dev(const struct pci_dev *pdev);
990 struct kfd_dev *kfd_device_by_adev(const struct amdgpu_device *adev);
991 int kfd_topology_enum_kfd_devices(uint8_t idx, struct kfd_dev **kdev);
992 int kfd_numa_node_to_apic_id(int numa_node_id);
993 void kfd_double_confirm_iommu_support(struct kfd_dev *gpu);
996 int kfd_interrupt_init(struct kfd_dev *dev);
997 void kfd_interrupt_exit(struct kfd_dev *dev);
998 bool enqueue_ih_ring_entry(struct kfd_dev *kfd, const void *ih_ring_entry);
999 bool interrupt_is_wanted(struct kfd_dev *dev,
1000 const uint32_t *ih_ring_entry,
1001 uint32_t *patched_ihre, bool *flag);
1003 /* amdkfd Apertures */
1004 int kfd_init_apertures(struct kfd_process *process);
1006 void kfd_process_set_trap_handler(struct qcm_process_device *qpd,
1010 /* Queue Context Management */
1011 int init_queue(struct queue **q, const struct queue_properties *properties);
1012 void uninit_queue(struct queue *q);
1013 void print_queue_properties(struct queue_properties *q);
1014 void print_queue(struct queue *q);
1016 struct mqd_manager *mqd_manager_init_cik(enum KFD_MQD_TYPE type,
1017 struct kfd_dev *dev);
1018 struct mqd_manager *mqd_manager_init_cik_hawaii(enum KFD_MQD_TYPE type,
1019 struct kfd_dev *dev);
1020 struct mqd_manager *mqd_manager_init_vi(enum KFD_MQD_TYPE type,
1021 struct kfd_dev *dev);
1022 struct mqd_manager *mqd_manager_init_vi_tonga(enum KFD_MQD_TYPE type,
1023 struct kfd_dev *dev);
1024 struct mqd_manager *mqd_manager_init_v9(enum KFD_MQD_TYPE type,
1025 struct kfd_dev *dev);
1026 struct mqd_manager *mqd_manager_init_v10(enum KFD_MQD_TYPE type,
1027 struct kfd_dev *dev);
1028 struct device_queue_manager *device_queue_manager_init(struct kfd_dev *dev);
1029 void device_queue_manager_uninit(struct device_queue_manager *dqm);
1030 struct kernel_queue *kernel_queue_init(struct kfd_dev *dev,
1031 enum kfd_queue_type type);
1032 void kernel_queue_uninit(struct kernel_queue *kq, bool hanging);
1033 int kfd_process_vm_fault(struct device_queue_manager *dqm, u32 pasid);
1035 /* Process Queue Manager */
1036 struct process_queue_node {
1038 struct kernel_queue *kq;
1039 struct list_head process_queue_list;
1042 void kfd_process_dequeue_from_device(struct kfd_process_device *pdd);
1043 void kfd_process_dequeue_from_all_devices(struct kfd_process *p);
1044 int pqm_init(struct process_queue_manager *pqm, struct kfd_process *p);
1045 void pqm_uninit(struct process_queue_manager *pqm);
1046 int pqm_create_queue(struct process_queue_manager *pqm,
1047 struct kfd_dev *dev,
1049 struct queue_properties *properties,
1051 uint32_t *p_doorbell_offset_in_process);
1052 int pqm_destroy_queue(struct process_queue_manager *pqm, unsigned int qid);
1053 int pqm_update_queue_properties(struct process_queue_manager *pqm, unsigned int qid,
1054 struct queue_properties *p);
1055 int pqm_update_mqd(struct process_queue_manager *pqm, unsigned int qid,
1056 struct mqd_update_info *minfo);
1057 int pqm_set_gws(struct process_queue_manager *pqm, unsigned int qid,
1059 struct kernel_queue *pqm_get_kernel_queue(struct process_queue_manager *pqm,
1061 struct queue *pqm_get_user_queue(struct process_queue_manager *pqm,
1063 int pqm_get_wave_state(struct process_queue_manager *pqm,
1065 void __user *ctl_stack,
1066 u32 *ctl_stack_used_size,
1067 u32 *save_area_used_size);
1069 int amdkfd_fence_wait_timeout(uint64_t *fence_addr,
1070 uint64_t fence_value,
1071 unsigned int timeout_ms);
1073 /* Packet Manager */
1075 #define KFD_FENCE_COMPLETED (100)
1076 #define KFD_FENCE_INIT (10)
1078 struct packet_manager {
1079 struct device_queue_manager *dqm;
1080 struct kernel_queue *priv_queue;
1083 struct kfd_mem_obj *ib_buffer_obj;
1084 unsigned int ib_size_bytes;
1085 bool is_over_subscription;
1087 const struct packet_manager_funcs *pmf;
1090 struct packet_manager_funcs {
1091 /* Support ASIC-specific packet formats for PM4 packets */
1092 int (*map_process)(struct packet_manager *pm, uint32_t *buffer,
1093 struct qcm_process_device *qpd);
1094 int (*runlist)(struct packet_manager *pm, uint32_t *buffer,
1095 uint64_t ib, size_t ib_size_in_dwords, bool chain);
1096 int (*set_resources)(struct packet_manager *pm, uint32_t *buffer,
1097 struct scheduling_resources *res);
1098 int (*map_queues)(struct packet_manager *pm, uint32_t *buffer,
1099 struct queue *q, bool is_static);
1100 int (*unmap_queues)(struct packet_manager *pm, uint32_t *buffer,
1101 enum kfd_queue_type type,
1102 enum kfd_unmap_queues_filter mode,
1103 uint32_t filter_param, bool reset,
1104 unsigned int sdma_engine);
1105 int (*query_status)(struct packet_manager *pm, uint32_t *buffer,
1106 uint64_t fence_address, uint64_t fence_value);
1107 int (*release_mem)(uint64_t gpu_addr, uint32_t *buffer);
1110 int map_process_size;
1112 int set_resources_size;
1113 int map_queues_size;
1114 int unmap_queues_size;
1115 int query_status_size;
1116 int release_mem_size;
1119 extern const struct packet_manager_funcs kfd_vi_pm_funcs;
1120 extern const struct packet_manager_funcs kfd_v9_pm_funcs;
1121 extern const struct packet_manager_funcs kfd_aldebaran_pm_funcs;
1123 int pm_init(struct packet_manager *pm, struct device_queue_manager *dqm);
1124 void pm_uninit(struct packet_manager *pm, bool hanging);
1125 int pm_send_set_resources(struct packet_manager *pm,
1126 struct scheduling_resources *res);
1127 int pm_send_runlist(struct packet_manager *pm, struct list_head *dqm_queues);
1128 int pm_send_query_status(struct packet_manager *pm, uint64_t fence_address,
1129 uint64_t fence_value);
1131 int pm_send_unmap_queue(struct packet_manager *pm, enum kfd_queue_type type,
1132 enum kfd_unmap_queues_filter mode,
1133 uint32_t filter_param, bool reset,
1134 unsigned int sdma_engine);
1136 void pm_release_ib(struct packet_manager *pm);
1138 /* Following PM funcs can be shared among VI and AI */
1139 unsigned int pm_build_pm4_header(unsigned int opcode, size_t packet_size);
1141 uint64_t kfd_get_number_elems(struct kfd_dev *kfd);
1144 extern const struct kfd_event_interrupt_class event_interrupt_class_cik;
1145 extern const struct kfd_event_interrupt_class event_interrupt_class_v9;
1147 extern const struct kfd_device_global_init_class device_global_init_class_cik;
1149 void kfd_event_init_process(struct kfd_process *p);
1150 void kfd_event_free_process(struct kfd_process *p);
1151 int kfd_event_mmap(struct kfd_process *process, struct vm_area_struct *vma);
1152 int kfd_wait_on_events(struct kfd_process *p,
1153 uint32_t num_events, void __user *data,
1154 bool all, uint32_t user_timeout_ms,
1155 uint32_t *wait_result);
1156 void kfd_signal_event_interrupt(u32 pasid, uint32_t partial_id,
1157 uint32_t valid_id_bits);
1158 void kfd_signal_iommu_event(struct kfd_dev *dev,
1159 u32 pasid, unsigned long address,
1160 bool is_write_requested, bool is_execute_requested);
1161 void kfd_signal_hw_exception_event(u32 pasid);
1162 int kfd_set_event(struct kfd_process *p, uint32_t event_id);
1163 int kfd_reset_event(struct kfd_process *p, uint32_t event_id);
1164 int kfd_event_page_set(struct kfd_process *p, void *kernel_address,
1166 int kfd_event_create(struct file *devkfd, struct kfd_process *p,
1167 uint32_t event_type, bool auto_reset, uint32_t node_id,
1168 uint32_t *event_id, uint32_t *event_trigger_data,
1169 uint64_t *event_page_offset, uint32_t *event_slot_index);
1170 int kfd_event_destroy(struct kfd_process *p, uint32_t event_id);
1172 void kfd_signal_vm_fault_event(struct kfd_dev *dev, u32 pasid,
1173 struct kfd_vm_fault_info *info);
1175 void kfd_signal_reset_event(struct kfd_dev *dev);
1177 void kfd_signal_poison_consumed_event(struct kfd_dev *dev, u32 pasid);
1179 void kfd_flush_tlb(struct kfd_process_device *pdd, enum TLB_FLUSH_TYPE type);
1181 int dbgdev_wave_reset_wavefronts(struct kfd_dev *dev, struct kfd_process *p);
1183 bool kfd_is_locked(void);
1185 /* Compute profile */
1186 void kfd_inc_compute_active(struct kfd_dev *dev);
1187 void kfd_dec_compute_active(struct kfd_dev *dev);
1189 /* Cgroup Support */
1190 /* Check with device cgroup if @kfd device is accessible */
1191 static inline int kfd_devcgroup_check_permission(struct kfd_dev *kfd)
1193 #if defined(CONFIG_CGROUP_DEVICE) || defined(CONFIG_CGROUP_BPF)
1194 struct drm_device *ddev = kfd->ddev;
1196 return devcgroup_check_permission(DEVCG_DEV_CHAR, DRM_MAJOR,
1197 ddev->render->index,
1198 DEVCG_ACC_WRITE | DEVCG_ACC_READ);
1205 #if defined(CONFIG_DEBUG_FS)
1207 void kfd_debugfs_init(void);
1208 void kfd_debugfs_fini(void);
1209 int kfd_debugfs_mqds_by_process(struct seq_file *m, void *data);
1210 int pqm_debugfs_mqds(struct seq_file *m, void *data);
1211 int kfd_debugfs_hqds_by_device(struct seq_file *m, void *data);
1212 int dqm_debugfs_hqds(struct seq_file *m, void *data);
1213 int kfd_debugfs_rls_by_device(struct seq_file *m, void *data);
1214 int pm_debugfs_runlist(struct seq_file *m, void *data);
1216 int kfd_debugfs_hang_hws(struct kfd_dev *dev);
1217 int pm_debugfs_hang_hws(struct packet_manager *pm);
1218 int dqm_debugfs_hang_hws(struct device_queue_manager *dqm);
1222 static inline void kfd_debugfs_init(void) {}
1223 static inline void kfd_debugfs_fini(void) {}