1 // SPDX-License-Identifier: GPL-2.0
4 * Copyright 2016-2019 HabanaLabs, Ltd.
8 #include <uapi/misc/habanalabs.h>
9 #include "habanalabs.h"
12 #include <linux/slab.h>
14 static void cb_fini(struct hl_device *hdev, struct hl_cb *cb)
16 hdev->asic_funcs->asic_dma_free_coherent(hdev, cb->size,
17 (void *) (uintptr_t) cb->kernel_address,
22 static void cb_do_release(struct hl_device *hdev, struct hl_cb *cb)
25 spin_lock(&hdev->cb_pool_lock);
26 list_add(&cb->pool_list, &hdev->cb_pool);
27 spin_unlock(&hdev->cb_pool_lock);
33 static void cb_release(struct kref *ref)
35 struct hl_device *hdev;
38 cb = container_of(ref, struct hl_cb, refcount);
41 hl_debugfs_remove_cb(cb);
43 cb_do_release(hdev, cb);
46 static struct hl_cb *hl_cb_alloc(struct hl_device *hdev, u32 cb_size,
53 * We use of GFP_ATOMIC here because this function can be called from
54 * the latency-sensitive code path for command submission. Due to H/W
55 * limitations in some of the ASICs, the kernel must copy the user CB
56 * that is designated for an external queue and actually enqueue
57 * the kernel's copy. Hence, we must never sleep in this code section
58 * and must use GFP_ATOMIC for all memory allocations.
60 if (ctx_id == HL_KERNEL_ASID_ID)
61 cb = kzalloc(sizeof(*cb), GFP_ATOMIC);
63 cb = kzalloc(sizeof(*cb), GFP_KERNEL);
68 if (ctx_id == HL_KERNEL_ASID_ID)
69 p = hdev->asic_funcs->asic_dma_alloc_coherent(hdev, cb_size,
70 &cb->bus_address, GFP_ATOMIC);
72 p = hdev->asic_funcs->asic_dma_alloc_coherent(hdev, cb_size,
74 GFP_USER | __GFP_ZERO);
77 "failed to allocate %d of dma memory for CB\n",
83 cb->kernel_address = (u64) (uintptr_t) p;
89 int hl_cb_create(struct hl_device *hdev, struct hl_cb_mgr *mgr,
90 u32 cb_size, u64 *handle, int ctx_id)
93 bool alloc_new_cb = true;
97 * Can't use generic function to check this because of special case
98 * where we create a CB as part of the reset process
100 if ((hdev->disabled) || ((atomic_read(&hdev->in_reset)) &&
101 (ctx_id != HL_KERNEL_ASID_ID))) {
102 dev_warn_ratelimited(hdev->dev,
103 "Device is disabled or in reset. Can't create new CBs\n");
108 if (cb_size > SZ_2M) {
109 dev_err(hdev->dev, "CB size %d must be less than %d\n",
115 /* Minimum allocation must be PAGE SIZE */
116 if (cb_size < PAGE_SIZE)
119 if (ctx_id == HL_KERNEL_ASID_ID &&
120 cb_size <= hdev->asic_prop.cb_pool_cb_size) {
122 spin_lock(&hdev->cb_pool_lock);
123 if (!list_empty(&hdev->cb_pool)) {
124 cb = list_first_entry(&hdev->cb_pool, typeof(*cb),
126 list_del(&cb->pool_list);
127 spin_unlock(&hdev->cb_pool_lock);
128 alloc_new_cb = false;
130 spin_unlock(&hdev->cb_pool_lock);
131 dev_dbg(hdev->dev, "CB pool is empty\n");
136 cb = hl_cb_alloc(hdev, cb_size, ctx_id);
146 spin_lock(&mgr->cb_lock);
147 rc = idr_alloc(&mgr->cb_handles, cb, 1, 0, GFP_ATOMIC);
148 spin_unlock(&mgr->cb_lock);
151 dev_err(hdev->dev, "Failed to allocate IDR for a new CB\n");
157 kref_init(&cb->refcount);
158 spin_lock_init(&cb->lock);
161 * idr is 32-bit so we can safely OR it with a mask that is above
164 *handle = cb->id | HL_MMAP_CB_MASK;
165 *handle <<= PAGE_SHIFT;
167 hl_debugfs_add_cb(cb);
172 cb_do_release(hdev, cb);
179 int hl_cb_destroy(struct hl_device *hdev, struct hl_cb_mgr *mgr, u64 cb_handle)
186 * handle was given to user to do mmap, I need to shift it back to
187 * how the idr module gave it to me
189 cb_handle >>= PAGE_SHIFT;
190 handle = (u32) cb_handle;
192 spin_lock(&mgr->cb_lock);
194 cb = idr_find(&mgr->cb_handles, handle);
196 idr_remove(&mgr->cb_handles, handle);
197 spin_unlock(&mgr->cb_lock);
198 kref_put(&cb->refcount, cb_release);
200 spin_unlock(&mgr->cb_lock);
202 "CB destroy failed, no match to handle 0x%x\n", handle);
209 int hl_cb_ioctl(struct hl_fpriv *hpriv, void *data)
211 union hl_cb_args *args = data;
212 struct hl_device *hdev = hpriv->hdev;
216 if (hl_device_disabled_or_in_reset(hdev)) {
217 dev_warn_ratelimited(hdev->dev,
218 "Device is %s. Can't execute CB IOCTL\n",
219 atomic_read(&hdev->in_reset) ? "in_reset" : "disabled");
223 switch (args->in.op) {
224 case HL_CB_OP_CREATE:
225 if (args->in.cb_size > HL_MAX_CB_SIZE) {
227 "User requested CB size %d must be less than %d\n",
228 args->in.cb_size, HL_MAX_CB_SIZE);
231 rc = hl_cb_create(hdev, &hpriv->cb_mgr,
232 args->in.cb_size, &handle,
236 memset(args, 0, sizeof(*args));
237 args->out.cb_handle = handle;
240 case HL_CB_OP_DESTROY:
241 rc = hl_cb_destroy(hdev, &hpriv->cb_mgr,
253 static void cb_vm_close(struct vm_area_struct *vma)
255 struct hl_cb *cb = (struct hl_cb *) vma->vm_private_data;
258 new_mmap_size = cb->mmap_size - (vma->vm_end - vma->vm_start);
260 if (new_mmap_size > 0) {
261 cb->mmap_size = new_mmap_size;
265 spin_lock(&cb->lock);
267 spin_unlock(&cb->lock);
270 vma->vm_private_data = NULL;
273 static const struct vm_operations_struct cb_vm_ops = {
277 int hl_cb_mmap(struct hl_fpriv *hpriv, struct vm_area_struct *vma)
279 struct hl_device *hdev = hpriv->hdev;
285 handle = vma->vm_pgoff;
287 /* reference was taken here */
288 cb = hl_cb_get(hdev, &hpriv->cb_mgr, handle);
291 "CB mmap failed, no match to handle 0x%x\n", handle);
295 /* Validation check */
296 if ((vma->vm_end - vma->vm_start) != ALIGN(cb->size, PAGE_SIZE)) {
298 "CB mmap failed, mmap size 0x%lx != 0x%x cb size\n",
299 vma->vm_end - vma->vm_start, cb->size);
304 spin_lock(&cb->lock);
308 "CB mmap failed, CB already mmaped to user\n");
315 spin_unlock(&cb->lock);
317 vma->vm_ops = &cb_vm_ops;
320 * Note: We're transferring the cb reference to
321 * vma->vm_private_data here.
324 vma->vm_private_data = cb;
326 /* Calculate address for CB */
327 address = virt_to_phys((void *) (uintptr_t) cb->kernel_address);
329 rc = hdev->asic_funcs->cb_mmap(hdev, vma, cb->kernel_address,
333 spin_lock(&cb->lock);
338 cb->mmap_size = cb->size;
343 spin_unlock(&cb->lock);
349 struct hl_cb *hl_cb_get(struct hl_device *hdev, struct hl_cb_mgr *mgr,
354 spin_lock(&mgr->cb_lock);
355 cb = idr_find(&mgr->cb_handles, handle);
358 spin_unlock(&mgr->cb_lock);
360 "CB get failed, no match to handle 0x%x\n", handle);
364 kref_get(&cb->refcount);
366 spin_unlock(&mgr->cb_lock);
372 void hl_cb_put(struct hl_cb *cb)
374 kref_put(&cb->refcount, cb_release);
377 void hl_cb_mgr_init(struct hl_cb_mgr *mgr)
379 spin_lock_init(&mgr->cb_lock);
380 idr_init(&mgr->cb_handles);
383 void hl_cb_mgr_fini(struct hl_device *hdev, struct hl_cb_mgr *mgr)
389 idp = &mgr->cb_handles;
391 idr_for_each_entry(idp, cb, id) {
392 if (kref_put(&cb->refcount, cb_release) != 1)
394 "CB %d for CTX ID %d is still alive\n",
398 idr_destroy(&mgr->cb_handles);
401 struct hl_cb *hl_cb_kernel_create(struct hl_device *hdev, u32 cb_size)
407 rc = hl_cb_create(hdev, &hdev->kernel_cb_mgr, cb_size, &cb_handle,
411 "Failed to allocate CB for the kernel driver %d\n", rc);
415 cb_handle >>= PAGE_SHIFT;
416 cb = hl_cb_get(hdev, &hdev->kernel_cb_mgr, (u32) cb_handle);
417 /* hl_cb_get should never fail here so use kernel WARN */
418 WARN(!cb, "Kernel CB handle invalid 0x%x\n", (u32) cb_handle);
425 hl_cb_destroy(hdev, &hdev->kernel_cb_mgr, cb_handle << PAGE_SHIFT);
430 int hl_cb_pool_init(struct hl_device *hdev)
435 INIT_LIST_HEAD(&hdev->cb_pool);
436 spin_lock_init(&hdev->cb_pool_lock);
438 for (i = 0 ; i < hdev->asic_prop.cb_pool_cb_cnt ; i++) {
439 cb = hl_cb_alloc(hdev, hdev->asic_prop.cb_pool_cb_size,
443 list_add(&cb->pool_list, &hdev->cb_pool);
445 hl_cb_pool_fini(hdev);
453 int hl_cb_pool_fini(struct hl_device *hdev)
455 struct hl_cb *cb, *tmp;
457 list_for_each_entry_safe(cb, tmp, &hdev->cb_pool, pool_list) {
458 list_del(&cb->pool_list);