STRUCT HL_CS_PARSER(9)

💅 struct hl_cs_parser(9)

okay so this is a page from the Kernel API Manual, section 9 — welcome bestie, come learn about struct hl_cs_parser with me 🫶

---

✨ NAME ✨

struct hl_cs_parser — the properties of a command submission parser. that's it, that's the whole vibe 💖

---

🌸 SYNOPSIS 🌸

struct hl_cs_parser {
    struct hl_cb            *user_cb;
    struct hl_cb            *patched_cb;
    struct list_head        *job_userptr_list;
    u64 cs_sequence;
    enum hl_queue_type      queue_type;
    u32 ctx_id;
    u32 hw_queue_id;
    u32 user_cb_size;
    u32 patched_cb_size;
    u8 job_id;
    u8 is_kernel_allocated_cb;
    u8 contains_dma_pkt;
    u8 completion;
 };

literally copy this exactly, no cap 🎀

---

🦋 MEMBERS 🦋

okay bestie, field by field, here we go — every single one, i'm not skipping a thing 👑

• user_cb — the CB we got from the user. that's the one. 👈
• patched_cb — when patching happens, this is the internal CB, and it's the one actually submitted on the queue instead of the CB we got from the IOCTL. so like, the understudy that goes on stage instead 💅
• job_userptr_list — a linked-list of userptr mappings that belong to the related job and are waiting for completion. they're just chilling in line, lowkey 😭
• cs_sequence — the sequence number of the related CS. 🔢
• queue_type — the type of the H/W queue this job gets submitted to. (enum hl_queue_type, iykyk)
• ctx_id — the ID of the context the related CS belongs to. 🎀
• hw_queue_id — the id of the H/W queue this job is submitted to. yes, different thing from queue_type, don't come for me 🙈
• user_cb_size — the actual size of the CB we got from the user. the real one, fr fr.
• patched_cb_size — the size of the CB after parsing. post-glow-up size ✨
• is_kernel_allocated_cb — true if the CB handle we got from the user holds a handle to a kernel-allocated CB object, false otherwise (that's SRAM/DRAM/host address). true/false moment 🫶
• contains_dma_pkt — whether the JOB contains at least one DMA packet. this info is needed later, when adding the 2xMSG_PROT at the end of the JOB, so we know which barriers to put in the MSG_PROT packets. relevant only for GAUDI — GOYA doesn't have streams, so the engine can't be busy by another stream. GAUDI girlies only 💀
• completion — true if we need completion for this CS. are we done or are we done done ✅

---

🔥 SEE ALSO 🔥

the whole friend group, no one left behind 🌈 — kernel file ./drivers/accel/habanalabs/common/habanalabs.h, plus:

enum hl_mmu_page_table_location(9), struct iterate_module_ctx(9), struct hl_gen_wait_properties(9), struct pgt_info(9), enum hl_pci_match_mode(9), enum hl_fw_component(9), enum hl_fw_types(9), enum hl_queue_type(9), struct hw_queue_properties(9), enum vm_type(9), enum mmu_op_flags(9), enum hl_device_hw_state(9), struct hl_mmu_properties(9), struct hl_hints_range(9), struct asic_fixed_properties(9), struct hl_fence(9), struct hl_cs_compl(9), struct hl_ts_buff(9), struct hl_mem_mgr(9), struct hl_mem_mgr_fini_stats(9), struct hl_mmap_mem_buf_behavior(9), struct hl_mmap_mem_buf(9), struct hl_cb(9), struct hl_sync_stream_properties(9), struct hl_encaps_signals_mgr(9), struct hl_hw_queue(9), struct hl_cq(9), struct hl_ts_free_jobs(9), struct hl_user_interrupt(9), struct timestamp_reg_free_node(9), struct hl_user_pending_interrupt(9), struct hl_eq(9), struct hl_dec(9), enum hl_asic_type(9), enum hl_pm_mng_profile(9), enum hl_pll_frequency(9), struct pci_mem_region(9), struct static_fw_load_mgr(9), struct fw_response(9), struct dynamic_fw_load_mgr(9), struct pre_fw_load_props(9), struct fw_image_props(9), struct fw_load_mgr(9), struct engines_data(9), struct hl_asic_funcs(9), enum hl_va_range_type(9), struct hl_va_range(9), struct hl_cs_counters_atomic(9), struct hl_dmabuf_priv(9), struct hl_cs_outcome(9), struct hl_cs_outcome_store(9), struct hl_ctx(9), struct hl_ctx_mgr(9), struct hl_userptr(9), struct hl_cs(9), struct hl_cs_job(9), struct hl_vm_hash_node(9), struct hl_vm_hw_block_list_node(9), struct hl_vm_phys_pg_pack(9), struct hl_vm_va_block(9), struct hl_vm(9), struct hl_debug_params(9), struct hl_notifier_event(9), struct hl_fpriv(9), struct hl_info_list(9), struct hl_debugfs_entry(9), struct hl_dbg_device_entry(9), struct hl_debugfs_cfg_access_entry(9), struct hl_debugfs_cfg_access(9), struct hl_hw_obj_name_entry(9), struct hl_mon_state_dump(9), struct hl_sync_to_engine_map_entry(9), struct hl_sync_to_engine_map(9), struct hl_state_dump_specs_funcs(9), struct hl_state_dump_specs(9), struct hl_device_reset_work(9), struct hl_mmu_priv(9), struct hl_mmu_per_hop_info(9), struct hl_mmu_hop_info(9), struct hl_hr_mmu_funcs(9), struct hl_mmu_funcs(9), struct hl_prefetch_work(9), struct multi_cs_completion(9), struct multi_cs_data(9), struct hl_clk_throttle_timestamp(9), struct hl_clk_throttle(9), struct user_mapped_block(9), struct cs_timeout_info(9), struct undefined_opcode_info(9), struct page_fault_info(9), struct razwi_info(9), struct hw_err_info(9), struct fw_err_info(9), struct engine_err_info(9), struct hl_error_info(9), struct hl_reset_info(9), struct eq_heartbeat_debug_info(9), struct hl_device(9), struct hl_cs_encaps_sig_handle(9), struct hl_info_fw_err_info(9), hl_ioctl_t(9), struct hl_ioctl_desc(9), hl_get_sg_info(9), hl_mem_area_inside_range(9), hl_mem_area_crosses_range(9)

like i said. everyone. 🫶✨

---

ok one tiny thing before you go — this whole page lives under ./drivers/accel/habanalabs/common, and the source/version date stamped on it is October 2026 📅 so if you're reading this in the future… hi, bestie, you're right on time 💜

and that's the page!! struct hl_cs_parser(9), fully understood, ate, no crumbs 💅👑🌟