AXL

Modules

  • AxlMem – Memory Allocation
    • Overview
      • Debug vs. Release
      • RAII Auto-Cleanup
      • Quick Reference
    • API Reference
      • AXL_OK
      • AXL_ERR
      • AXL_AUTO_FREE
      • AXL_HAVE_AUTOPTR
      • AXL_DEFINE_AUTOPTR_CLEANUP
      • AXL_AUTOPTR
      • AXL_ARRAY_SIZE
      • AXL_SIGNATURE_32
      • AXL_CONTAINER_OF
      • axl_malloc()
      • axl_calloc()
      • axl_realloc()
      • axl_free()
      • axl_strdup()
      • axl_memdup()
      • axl_new()
      • axl_new_array()
      • axl_free_impl()
      • _axl_auto_free_func()
      • axl_alloc_pages()
      • axl_free_pages()
      • axl_mem_get_stats()
      • axl_mem_dump_leaks()
      • axl_mem_check()
      • AxlMemStats
  • AxlStr – String Utilities
    • Overview
      • UTF-8 vs UCS-2
      • Case-Insensitive Operations
      • Common Patterns
      • Memory Ownership
    • API Reference
      • axl_strlen()
      • axl_strcmp()
      • axl_streql()
      • axl_strncmp()
      • axl_strcasecmp()
      • axl_memcpy()
      • axl_memset()
      • axl_memmove()
      • axl_memcmp()
      • axl_snprintf()
      • axl_strlcpy()
      • axl_strlcat()
      • axl_strndup()
      • axl_strsplit()
      • axl_strfreev()
      • axl_strjoin()
      • axl_strstrip()
      • axl_strchr()
      • axl_strstr()
      • axl_strncpy()
      • axl_strstr_len()
      • axl_strrstr()
      • axl_strrstr_len()
      • axl_strcasestr()
      • axl_fnmatch()
      • axl_str_has_prefix()
      • axl_str_has_suffix()
      • axl_str_is_ascii()
      • axl_strcmp0()
      • axl_str_equal()
      • axl_strncasecmp()
      • axl_strv_contains()
      • axl_strv_equal()
      • axl_utf8_to_ucs2()
      • axl_ucs2_to_utf8()
      • axl_base64_encode()
      • axl_base64_decode()
      • axl_strtou64()
      • axl_wcslen()
      • axl_wcscmp()
      • axl_wcseql()
      • axl_wcscpy()
      • axl_str_dup_w()
      • axl_str_format_w()
      • axl_str_trim_w()
      • axl_str_split_w()
      • axl_str_freev_w()
      • axl_str_join_w()
      • axl_str_cmp_nocase_w()
      • axl_str_contains_w()
  • AxlString – String Builder
    • Overview
      • Stealing the Buffer
      • Error Handling
    • API Reference
      • AxlString
      • axl_string_new()
      • axl_string_new_size()
      • axl_string_append()
      • axl_string_append_len()
      • axl_string_printf()
      • axl_string_append_c()
      • axl_string_str()
      • axl_string_len()
      • axl_string_steal()
      • axl_string_clear()
      • axl_string_free()
      • axl_asprintf()
  • AxlIO – Stream I/O
    • Overview
      • Console Output
      • File Read/Write
      • Stream I/O
      • Buffer Streams
      • File Operations
    • API Reference
      • axl_printf
      • AXL_SEEK_SET
      • AXL_SEEK_CUR
      • AXL_SEEK_END
      • AxlStream
      • axl_ssize_t
      • AxlProgressFunc
      • AxlDir
      • axl_io_init()
      • axl_print()
      • axl_printerr()
      • axl_file_is_dir()
      • axl_file_info()
      • axl_fopen()
      • axl_fclose()
      • axl_fread()
      • axl_fwrite()
      • axl_fprintf()
      • axl_readline()
      • axl_fseek()
      • axl_ftell()
      • axl_feof()
      • axl_fflush()
      • axl_bufopen()
      • axl_bufdata()
      • axl_bufsteal()
      • axl_read()
      • axl_write()
      • axl_pread()
      • axl_pwrite()
      • axl_file_delete()
      • axl_file_rename()
      • axl_dir_mkdir()
      • axl_dir_rmdir()
      • axl_dir_open()
      • axl_dir_read()
      • axl_dir_close()
      • axl_dir_list_json()
      • axl_volume_get_label()
      • axl_volume_get_label_by_handle()
      • axl_volume_enumerate()
      • axl_stdout
      • axl_stderr
      • AxlFileInfo
      • AxlDirEntry
      • AxlVolume
  • AxlLog – Logging
    • Overview
      • Basic Usage
      • Log Levels
      • Level Filtering
      • Custom Handlers
      • Ring Buffer
      • File Logging
    • API Reference
      • AXL_LOG_ERROR
      • AXL_LOG_WARNING
      • AXL_LOG_INFO
      • AXL_LOG_DEBUG
      • AXL_LOG_TRACE
      • AXL_LOG_DOMAIN
      • axl_error
      • axl_warning
      • axl_info
      • axl_debug
      • axl_trace
      • AxlLogHandler
      • AxlLogRing
      • axl_log_full()
      • axl_log()
      • axl_log_set_level()
      • axl_log_set_domain_level()
      • axl_log_add_handler()
      • axl_log_add_domain_handler()
      • axl_log_remove_handler()
      • axl_log_suppress_console()
      • axl_log_set_console_timestamp()
      • axl_log_set_fatal_level()
      • axl_log_set_fatal_image_handle()
      • axl_log_ring_new()
      • axl_log_ring_free()
      • axl_log_ring_attach()
      • axl_log_ring_count()
      • axl_log_ring_get()
      • axl_log_file_attach()
      • axl_log_flush()
      • AxlLogEntry
  • AxlData – Data Structures
    • Choosing a Collection
    • AxlHashTable
      • AxlHashTable
      • AxlHashTableForeachFunc
      • AxlHashTableForeachWFunc
      • axl_hash_table_new()
      • axl_hash_table_free()
      • axl_hash_table_set()
      • axl_hash_table_get()
      • axl_hash_table_remove()
      • axl_hash_table_foreach()
      • axl_hash_table_size()
      • axl_hash_table_new_w()
      • axl_hash_table_set_w()
      • axl_hash_table_get_w()
      • axl_hash_table_remove_w()
      • axl_hash_table_foreach_w()
    • AxlArray
      • AxlArray
      • AxlCompareFunc
      • axl_array_new()
      • axl_array_free()
      • axl_array_append()
      • axl_array_get()
      • axl_array_len()
      • axl_array_clear()
      • axl_array_append_ptr()
      • axl_array_get_ptr()
      • axl_array_sort()
    • AxlList
      • AxlFunc
      • AxlDestroyNotify
      • axl_list_append()
      • axl_list_prepend()
      • axl_list_insert()
      • axl_list_insert_sorted()
      • axl_list_remove()
      • axl_list_reverse()
      • axl_list_concat()
      • axl_list_sort()
      • axl_list_copy()
      • axl_list_free()
      • axl_list_free_full()
      • axl_list_length()
      • axl_list_nth()
      • axl_list_nth_data()
      • axl_list_first()
      • axl_list_last()
      • axl_list_find()
      • axl_list_find_custom()
      • axl_list_foreach()
      • AxlList
    • AxlSList
      • axl_slist_append()
      • axl_slist_prepend()
      • axl_slist_insert()
      • axl_slist_insert_sorted()
      • axl_slist_remove()
      • axl_slist_reverse()
      • axl_slist_concat()
      • axl_slist_sort()
      • axl_slist_copy()
      • axl_slist_free()
      • axl_slist_free_full()
      • axl_slist_length()
      • axl_slist_nth()
      • axl_slist_nth_data()
      • axl_slist_last()
      • axl_slist_find()
      • axl_slist_find_custom()
      • axl_slist_foreach()
      • AxlSList
    • AxlQueue
      • AXL_QUEUE_INIT
      • axl_queue_new()
      • axl_queue_init()
      • axl_queue_free()
      • axl_queue_free_full()
      • axl_queue_clear()
      • axl_queue_is_empty()
      • axl_queue_get_length()
      • axl_queue_push_head()
      • axl_queue_push_tail()
      • axl_queue_pop_head()
      • axl_queue_pop_tail()
      • axl_queue_peek_head()
      • axl_queue_peek_tail()
      • axl_queue_peek_nth()
      • axl_queue_foreach()
      • axl_queue_copy()
      • axl_queue_reverse()
      • axl_queue_sort()
      • AxlQueue
  • AxlJson – JSON
    • Overview
      • Parsing JSON
      • Building JSON
      • Iterating Arrays
    • API Reference
      • axl_json_parse()
      • axl_json_free()
      • axl_json_get_string()
      • axl_json_get_int()
      • axl_json_get_uint()
      • axl_json_get_bool()
      • axl_json_extract_string()
      • axl_json_array_begin()
      • axl_json_root_array_begin()
      • axl_json_array_next()
      • axl_json_escape_string()
      • axl_json_init()
      • axl_json_object_start()
      • axl_json_object_end()
      • axl_json_object_start_named()
      • axl_json_array_start()
      • axl_json_array_end()
      • axl_json_array_object_start()
      • axl_json_array_add_string()
      • axl_json_add_string()
      • axl_json_add_uint()
      • axl_json_add_int()
      • axl_json_add_bool()
      • axl_json_add_hex()
      • axl_json_add_null()
      • axl_json_finish()
      • axl_json_pretty_print()
      • axl_json_print_raw()
      • AxlJsonCtx
      • AxlJsonArrayIter
      • AxlJsonBuilder
  • AxlCache – TTL Cache
    • Overview
    • API Reference
      • AxlCache
      • axl_cache_new()
      • axl_cache_put()
      • axl_cache_get()
      • axl_cache_invalidate()
      • axl_cache_free()
  • AxlConfig – Configuration
    • Overview
      • Defining Options
      • Creating and Querying
      • Command-Line Integration
      • Multi-Value Options
      • Parent Inheritance
    • API Reference
      • AXL_CFG_BOOL
      • AXL_CFG_INT
      • AXL_CFG_UINT
      • AXL_CFG_STRING
      • AXL_CFG_MULTI
      • AxlConfig
      • AxlConfigApplyFunc
      • axl_config_new()
      • axl_config_free()
      • axl_config_set()
      • axl_config_setv()
      • axl_config_get()
      • axl_config_get_bool()
      • axl_config_get_int()
      • axl_config_get_uint()
      • axl_config_get_multi_count()
      • axl_config_get_multi()
      • axl_config_parse_args()
      • axl_config_pos()
      • axl_config_pos_count()
      • axl_config_usage()
      • axl_config_set_parent()
      • AxlConfigDesc
  • AxlPath – Path Manipulation
    • Overview
    • API Reference
      • axl_path_get_basename()
      • axl_path_get_dirname()
      • axl_path_extension()
      • axl_path_join()
      • axl_path_resolve()
      • axl_path_build_uefi()
      • axl_get_current_dir()
      • axl_chdir()
  • AxlArgs – Argument Parser
    • Overview
      • Option Types
    • API Reference
      • AxlArgs
      • AxlOptType
      • axl_args_parse()
      • axl_args_flag()
      • axl_args_flag_long()
      • axl_args_value()
      • axl_args_value_long()
      • axl_args_multi_count()
      • axl_args_multi()
      • axl_args_pos_count()
      • axl_args_pos()
      • axl_args_usage()
      • axl_args_free()
      • AxlOpt
  • AxlLoop – Event Loop
    • Overview
      • Basic Pattern
      • Source Types
      • Run vs. Next+Dispatch
    • AxlDefer
    • AxlSignal
    • API Reference
      • AxlLoop
      • AxlDefer
      • AxlSignal
  • AxlTask – Task Pool and Arena
    • Overview
      • Arena Allocator
      • Task Pool
      • AxlBufPool
      • AxlAsync
    • API Reference
      • AxlTask
      • AxlBufPool
      • AxlAsync
  • AxlNet – Networking
    • Overview
      • Network Initialization
    • TCP Sockets
    • UDP Sockets
    • HTTP Server
    • HTTP Client
    • TLS (HTTPS)
    • Network Utilities
      • axl_net_get_ip_address()
      • axl_net_ping()
      • axl_net_resolve()
      • axl_net_is_available()
      • axl_net_auto_init()
      • axl_net_set_static_ip()
      • axl_ipv4_parse()
      • axl_ipv4_format()
      • axl_net_list_interfaces()
      • AxlIPv4Address
      • AxlNetInterface
    • AxlTcp
      • AxlLoop
      • AxlTcp
      • AxlTcpCallback
      • axl_tcp_connect()
      • axl_tcp_listen()
      • axl_tcp_accept()
      • axl_tcp_send()
      • axl_tcp_recv()
      • axl_tcp_poll()
      • axl_tcp_close()
      • axl_tcp_get_local_addr()
      • axl_tcp_get_remote_addr()
      • axl_tcp_connect_async()
      • axl_tcp_accept_async()
      • axl_tcp_recv_start()
      • axl_tcp_recv_get_size()
      • axl_tcp_send_start()
    • AxlUdp
      • AxlUdpSocket
      • AxlUdpRecvCallback
      • axl_udp_open()
      • axl_udp_close()
      • axl_udp_send()
      • axl_udp_sendrecv()
      • axl_udp_recv_start()
      • axl_udp_recv_stop()
    • AxlUrl
      • axl_url_parse()
      • axl_url_free()
      • axl_url_build()
      • axl_url_encode()
      • axl_url_decode()
      • AxlUrl
    • AxlHttpServer
      • AXL_WS_CONNECT
      • AXL_WS_TEXT
      • AXL_WS_BINARY
      • AXL_WS_DISCONNECT
      • AXL_ROUTE_NO_AUTH
      • AXL_ROUTE_AUTH
      • AXL_ROUTE_ADMIN
      • AXL_CACHE_FOREVER
      • AxlHttpHandler
      • AxlHttpMiddleware
      • AxlHttpServer
      • AxlWsHandler
      • AxlAuthCallback
      • AxlUploadHandler
      • axl_http_server_new()
      • axl_http_server_free()
      • axl_http_server_set()
      • axl_http_server_get()
      • axl_http_server_set_max_connections()
      • axl_http_server_set_max_routes()
      • axl_http_server_set_body_limit()
      • axl_http_server_set_keep_alive()
      • axl_http_server_use()
      • axl_http_server_add_route()
      • axl_http_server_add_static()
      • axl_http_server_attach()
      • axl_http_server_run()
      • axl_http_response_set_json()
      • axl_http_response_set_text()
      • axl_http_response_set_status()
      • axl_http_response_set_file()
      • axl_http_response_set_range()
      • axl_http_parse_range()
      • axl_http_accepts()
      • axl_http_server_use_tls()
      • axl_http_server_add_websocket()
      • axl_http_server_ws_broadcast()
      • axl_http_server_use_auth()
      • axl_http_server_add_route_auth()
      • axl_http_server_use_cache()
      • axl_http_server_set_route_ttl()
      • axl_http_server_cache_invalidate()
      • axl_http_server_add_upload_route()
      • AxlHttpRequest
      • AxlHttpResponse
      • AxlHttpRange
      • AxlAuthInfo
    • AxlHttpClient
      • AxlHttpClient
      • axl_http_client_new()
      • axl_http_client_free()
      • axl_http_client_set()
      • axl_http_client_get()
      • axl_http_get()
      • axl_http_post()
      • axl_http_put()
      • axl_http_delete()
      • axl_http_request()
      • axl_http_client_response_free()
      • axl_http_download()
      • AxlHttpClientResponse
  • AxlTls – TLS Support
    • Overview
      • HTTPS Server
      • HTTPS Client
      • Certificate Generation
      • Entropy
      • Security Considerations
    • API Reference
      • AxlTlsContext
      • AxlTcp
      • AxlLoop
      • axl_tls_available()
      • axl_tls_init()
      • axl_tls_cleanup()
      • axl_tls_generate_self_signed()
      • axl_tls_server_set_cert()
      • axl_tls_accept()
      • axl_tls_connect()
      • axl_tls_handshake()
      • axl_tls_read()
      • axl_tls_write()
      • axl_tls_stage_data()
      • axl_tls_free()
  • AxlSys – System Utilities
    • Overview
      • GUIDs
      • Firmware Globals
      • NVRAM Variables
      • Driver Lifecycle
    • AxlSys
      • AXL_GUID
      • AXL_RESET_COLD
      • AXL_RESET_WARM
      • AXL_RESET_SHUTDOWN
      • axl_guid_cmp()
      • axl_device_path_has_vendor()
      • axl_reset()
      • axl_map_refresh()
      • axl_sys_get_firmware_info()
      • axl_sys_get_memory_size()
      • axl_handle_get_service()
      • axl_stall()
      • axl_service_find()
      • axl_service_enumerate()
      • axl_service_register()
      • axl_service_unregister()
      • axl_service_register_multiple()
      • AxlGuid
      • AxlFirmwareInfo
    • AxlEnv
      • axl_getenv()
      • axl_setenv()
      • axl_unsetenv()
    • AxlTime
      • axl_time_format()
      • axl_sleep()
      • axl_msleep()
      • axl_usleep()
      • axl_spin_sleep()
      • axl_spin_msleep()
      • axl_spin_usleep()
      • axl_time_get_ms()
    • AxlNvStore
      • AXL_NV_VOLATILE
      • AXL_NV_PERSISTENT
      • AXL_NV_BOOT
      • AXL_NV_RUNTIME
      • axl_nvstore_get()
      • axl_nvstore_set()
    • AxlDriver
      • AxlDriverHandle
      • axl_driver_load()
      • axl_driver_start()
      • axl_driver_connect()
      • axl_driver_disconnect()
      • axl_driver_unload()
      • axl_driver_set_load_options()
      • axl_driver_init()
      • axl_driver_set_unload()
      • axl_driver_get_load_options()
      • axl_driver_get_image_path()
      • axl_driver_connect_handle()
      • axl_driver_load_dir()
    • AxlHexdump
      • AXL_HEX_GROUP_BYTE
      • AXL_HEX_GROUP_WORD
      • AXL_HEX_GROUP_DWORD
      • AXL_HEX_GROUP_QWORD
      • AXL_HEXDUMP_MAX_SIZE
      • AxlHexDumpLog
      • axl_hexdump()
      • axl_hexdump_to_log()
  • AxlGfx – Graphics
    • Overview
      • Pixel Format
    • API Reference
      • axl_gfx_available()
      • axl_gfx_get_info()
      • axl_gfx_fill_rect()
      • axl_gfx_blit()
      • axl_gfx_capture()
      • axl_gfx_draw_text()
      • AxlGfxInfo
      • AxlGfxPixel

Reference

  • UEFI Glossary
AXL
  • AXL SDK API Reference
  • View page source

AXL SDK API Reference

AXL is a GLib-inspired C library for UEFI. The public API uses standard C types, snake_case naming, and UTF-8 strings throughout. No EDK2 headers leak through the public API.

Include <axl.h> for the full API, or individual headers for specific modules.

Modules

  • AxlMem – Memory Allocation
    • Overview
    • API Reference
  • AxlStr – String Utilities
    • Overview
    • API Reference
  • AxlString – String Builder
    • Overview
    • API Reference
  • AxlIO – Stream I/O
    • Overview
    • API Reference
  • AxlLog – Logging
    • Overview
    • API Reference
  • AxlData – Data Structures
    • Choosing a Collection
    • AxlHashTable
    • AxlArray
    • AxlList
    • AxlSList
    • AxlQueue
  • AxlJson – JSON
    • Overview
    • API Reference
  • AxlCache – TTL Cache
    • Overview
    • API Reference
  • AxlConfig – Configuration
    • Overview
    • API Reference
  • AxlPath – Path Manipulation
    • Overview
    • API Reference
  • AxlArgs – Argument Parser
    • Overview
    • API Reference
  • AxlLoop – Event Loop
    • Overview
    • AxlDefer
    • AxlSignal
    • API Reference
  • AxlTask – Task Pool and Arena
    • Overview
    • API Reference
  • AxlNet – Networking
    • Overview
    • TCP Sockets
    • UDP Sockets
    • HTTP Server
    • HTTP Client
    • TLS (HTTPS)
    • Network Utilities
    • AxlTcp
    • AxlUdp
    • AxlUrl
    • AxlHttpServer
    • AxlHttpClient
  • AxlTls – TLS Support
    • Overview
    • API Reference
  • AxlSys – System Utilities
    • Overview
    • AxlSys
    • AxlEnv
    • AxlTime
    • AxlNvStore
    • AxlDriver
    • AxlHexdump
  • AxlGfx – Graphics
    • Overview
    • API Reference

Reference

  • UEFI Glossary
Next

© Copyright 2025-2026, AximCode.

Built with Sphinx using a theme provided by Read the Docs.