STRUCT HL_CS_OUTCOME_STORE(9)

πŸ“¦ version 7.3.1, in nixpkgs unstable

πŸŽ€ NAME πŸŽ€

Okay bestie, welcome to the Kernel API Manual, section 9. Today's main character is struct hl_cs_outcome_store(9); the struct itself is struct hl_cs_outcome_store, and she represents a limited store of completed CS outcomes. That's the whole vibe. Periodt. πŸ’…

✨ SYNOPSIS ✨

Here's the struct in all her glory, exactly as written:

struct hl_cs_outcome_store {
    unsigned long outcome_map[1 << (( 8) - 1)];
    struct list_head used_list;
    struct list_head free_list;
    struct hl_cs_outcome nodes_pool[HL_CS_OUTCOME_HISTORY_LEN];
    spinlock_t db_lock;
};

Lowkey obsessed with the 1 << (( 8) - 1) spacing β€” keep it exactly like that, bestie. 🫢

🧚 Members 🧚

  • outcome_map β€” the index of completed CS searchable by sequence number. Think receipts folder, but make it fabulous. πŸ’–
  • used_list β€” the list of outcome objects currently in use. These ones are booked and busy. πŸ‘‘
  • free_list β€” the list of outcome objects currently not in use. Bench warmers, waiting for their moment. 🌈
  • nodes_pool β€” a static pool of pre-allocated outcome objects. Pre-allocated? We been knew. ✨
  • db_lock β€” any operation on the store must take this lock. Like, every single operation. No sneaking around it. πŸ’…

🌸 SEE ALSO 🌸

The kernel file is literally ./drivers/accel/habanalabs/common/habanalabs.h, and the whole friend group is huge. Go say hi:

  • 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_ctx(9), struct hl_ctx_mgr(9), struct hl_userptr(9), struct hl_cs(9), struct hl_cs_job(9)
  • struct hl_cs_parser(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)

Mwah πŸ’‹ β€” source/version: ./drivers/accel/habanalabs/common, date: October 2026, star: struct hl_cs_outcome_store(9). That's the footer, bestie; we're done. πŸŽ€

πŸ“¦ where this page comes from