mutex.h File Reference

#include <uacpi/internal/types.h>
#include <uacpi/kernel_api.h>

Include dependency graph for mutex.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	uacpi_recursive_lock
struct	uacpi_rw_lock

Functions
uacpi_bool	uacpi_this_thread_owns_aml_mutex (uacpi_mutex *)
uacpi_status	uacpi_acquire_aml_mutex (uacpi_mutex *, uacpi_u16 timeout)
uacpi_status	uacpi_release_aml_mutex (uacpi_mutex *)
static uacpi_status	uacpi_acquire_native_mutex (uacpi_handle mtx)
uacpi_status	uacpi_acquire_native_mutex_with_timeout (uacpi_handle mtx, uacpi_u16 timeout)
static uacpi_status	uacpi_release_native_mutex (uacpi_handle mtx)
static uacpi_status	uacpi_acquire_native_mutex_may_be_null (uacpi_handle mtx)
static uacpi_status	uacpi_release_native_mutex_may_be_null (uacpi_handle mtx)
uacpi_status	uacpi_recursive_lock_init (struct uacpi_recursive_lock *lock)
uacpi_status	uacpi_recursive_lock_deinit (struct uacpi_recursive_lock *lock)
uacpi_status	uacpi_recursive_lock_acquire (struct uacpi_recursive_lock *lock)
uacpi_status	uacpi_recursive_lock_release (struct uacpi_recursive_lock *lock)
uacpi_status	uacpi_rw_lock_init (struct uacpi_rw_lock *lock)
uacpi_status	uacpi_rw_lock_deinit (struct uacpi_rw_lock *lock)
uacpi_status	uacpi_rw_lock_read (struct uacpi_rw_lock *lock)
uacpi_status	uacpi_rw_unlock_read (struct uacpi_rw_lock *lock)
uacpi_status	uacpi_rw_lock_write (struct uacpi_rw_lock *lock)
uacpi_status	uacpi_rw_unlock_write (struct uacpi_rw_lock *lock)

Function Documentation

uacpi_acquire_aml_mutex()

uacpi_status uacpi_acquire_aml_mutex	(	uacpi_mutex *	mutex,
		uacpi_u16	timeout
	)

Definition at line 201 of file mutex.c.

{
    uacpi_thread_id this_id;
    uacpi_status ret = UACPI_STATUS_OK;
 
    this_id = uacpi_kernel_get_thread_id();
    if (UACPI_ATOMIC_LOAD_THREAD_ID(&mutex->owner) == this_id) {
        if (uacpi_unlikely(mutex->depth == 0xFFFF)) {
            uacpi_warn(
                "failing an attempt to acquire mutex @%p, too many recursive "
                "acquires\n", mutex
            );
            return UACPI_STATUS_DENIED;
        }
 
        mutex->depth++;
        return ret;
    }
 
    uacpi_namespace_write_unlock();
    ret = uacpi_acquire_native_mutex_with_timeout(mutex->handle, timeout);
    if (ret != UACPI_STATUS_OK)
        goto out;
 
    if (mutex->handle == g_uacpi_rt_ctx.global_lock_mutex->handle) {
        ret = uacpi_acquire_global_lock_from_firmware();
        if (uacpi_unlikely_error(ret)) {
            uacpi_release_native_mutex(mutex->handle);
            goto out;
        }
    }
 
    UACPI_ATOMIC_STORE_THREAD_ID(&mutex->owner, this_id);
    mutex->depth = 1;
 
out:
    uacpi_namespace_write_lock();
    return ret;
}

Referenced by access_field_unit(), enter_method(), and handle_mutex_ctl().

uacpi_acquire_native_mutex()

static uacpi_status uacpi_acquire_native_mutex ( uacpi_handle  mtx )

inlinestatic

Definition at line 13 of file mutex.h.

{
    if (uacpi_unlikely(mtx == UACPI_NULL))
        return UACPI_STATUS_INVALID_ARGUMENT;
 
    return uacpi_kernel_acquire_mutex(mtx, 0xFFFF);
}

Referenced by configure_host_interface(), uacpi_bulk_configure_interfaces(), uacpi_handle_osi(), uacpi_install_interface(), uacpi_install_notify_handler(), uacpi_notify_all(), uacpi_recursive_lock_acquire(), uacpi_rw_lock_read(), uacpi_rw_lock_write(), uacpi_rw_unlock_read(), uacpi_set_interface_query_handler(), uacpi_uninstall_interface(), and uacpi_uninstall_notify_handler().

uacpi_acquire_native_mutex_may_be_null()

static uacpi_status uacpi_acquire_native_mutex_may_be_null ( uacpi_handle  mtx )

inlinestatic

Definition at line 34 of file mutex.h.

{
    if (mtx == UACPI_NULL)
        return UACPI_STATUS_OK;
 
    return uacpi_kernel_acquire_mutex(mtx, 0xFFFF);
}

Referenced by table_ctl(), uacpi_for_each_table(), uacpi_set_table_installation_handler(), uacpi_table_install_physical_with_origin(), and uacpi_table_install_with_origin().

uacpi_acquire_native_mutex_with_timeout()

uacpi_status uacpi_acquire_native_mutex_with_timeout	(	uacpi_handle	mtx,
		uacpi_u16	timeout
	)

Referenced by uacpi_acquire_aml_mutex(), and uacpi_acquire_global_lock().

uacpi_recursive_lock_acquire()

uacpi_status uacpi_recursive_lock_acquire

(

struct uacpi_recursive_lock *

lock

)

Definition at line 287 of file mutex.c.

{
    uacpi_thread_id this_id;
    uacpi_status ret = UACPI_STATUS_OK;
 
    this_id = uacpi_kernel_get_thread_id();
    if (UACPI_ATOMIC_LOAD_THREAD_ID(&lock->owner) == this_id) {
        lock->depth++;
        return ret;
    }
 
    ret = uacpi_acquire_native_mutex(lock->mutex);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    UACPI_ATOMIC_STORE_THREAD_ID(&lock->owner, this_id);
    lock->depth = 1;
    return ret;
}

Referenced by do_install_gpe_handler(), for_all_gpes_locked(), gpe_enable_disable_for_wake(), gpe_get_mask_unmask(), gpe_suspend_resume(), uacpi_clear_all_events(), uacpi_clear_gpe(), uacpi_disable_fixed_event(), uacpi_disable_gpe(), uacpi_enable_fixed_event(), uacpi_enable_gpe(), uacpi_events_match_post_dynamic_table_load(), uacpi_finalize_gpe_initialization(), uacpi_finish_handling_gpe(), uacpi_fixed_event_info(), uacpi_gpe_info(), uacpi_install_address_space_handler_with_flags(), uacpi_install_fixed_event_handler(), uacpi_install_gpe_block(), uacpi_reg_all_opregions(), uacpi_setup_gpe_for_wake(), uacpi_uninstall_address_space_handler(), uacpi_uninstall_fixed_event_handler(), uacpi_uninstall_gpe_block(), uacpi_uninstall_gpe_handler(), and upgrade_to_opregion_lock().

uacpi_recursive_lock_deinit()

uacpi_status uacpi_recursive_lock_deinit

(

struct uacpi_recursive_lock *

lock

)

Definition at line 267 of file mutex.c.

{
    if (uacpi_unlikely(lock->depth)) {
        uacpi_warn(
            "de-initializing active recursive lock %p with depth=%zu\n",
            lock, lock->depth
        );
        lock->depth = 0;
    }
 
    lock->owner = UACPI_THREAD_ID_NONE;
 
    if (lock->mutex != UACPI_NULL) {
        uacpi_kernel_free_mutex(lock->mutex);
        lock->mutex = UACPI_NULL;
    }
 
    return UACPI_STATUS_OK;
}

Referenced by uacpi_deinitialize_events(), and uacpi_deinitialize_opregion().

uacpi_recursive_lock_init()

uacpi_status uacpi_recursive_lock_init

(

struct uacpi_recursive_lock *

lock

)

Definition at line 255 of file mutex.c.

{
    lock->mutex = uacpi_kernel_create_mutex();
    if (uacpi_unlikely(lock->mutex == UACPI_NULL))
        return UACPI_STATUS_OUT_OF_MEMORY;
 
    lock->owner = UACPI_THREAD_ID_NONE;
    lock->depth = 0;
 
    return UACPI_STATUS_OK;
}

Referenced by uacpi_initialize_events_early(), and uacpi_initialize_opregion().

uacpi_recursive_lock_release()

uacpi_status uacpi_recursive_lock_release

(

struct uacpi_recursive_lock *

lock

)

Definition at line 307 of file mutex.c.

{
    if (lock->depth-- > 1)
        return UACPI_STATUS_OK;
 
    UACPI_ATOMIC_STORE_THREAD_ID(&lock->owner, UACPI_THREAD_ID_NONE);
    return uacpi_release_native_mutex(lock->mutex);
}

Referenced by do_install_gpe_handler(), for_all_gpes_locked(), gpe_enable_disable_for_wake(), gpe_get_mask_unmask(), gpe_suspend_resume(), uacpi_clear_all_events(), uacpi_clear_gpe(), uacpi_disable_fixed_event(), uacpi_disable_gpe(), uacpi_dispatch_opregion_io(), uacpi_enable_fixed_event(), uacpi_enable_gpe(), uacpi_events_match_post_dynamic_table_load(), uacpi_finalize_gpe_initialization(), uacpi_finish_handling_gpe(), uacpi_fixed_event_info(), uacpi_gpe_info(), uacpi_initialize_opregion_node(), uacpi_install_address_space_handler_with_flags(), uacpi_install_fixed_event_handler(), uacpi_install_gpe_block(), uacpi_opregion_uninstall_handler(), uacpi_reg_all_opregions(), uacpi_setup_gpe_for_wake(), uacpi_uninstall_address_space_handler(), uacpi_uninstall_fixed_event_handler(), uacpi_uninstall_gpe_block(), and uacpi_uninstall_gpe_handler().

uacpi_release_aml_mutex()

uacpi_status uacpi_release_aml_mutex

(

uacpi_mutex *

mutex

)

Definition at line 241 of file mutex.c.

{
    if (mutex->depth-- > 1)
        return UACPI_STATUS_OK;
 
    if (mutex->handle == g_uacpi_rt_ctx.global_lock_mutex->handle)
        uacpi_release_global_lock_to_firmware();
 
    UACPI_ATOMIC_STORE_THREAD_ID(&mutex->owner, UACPI_THREAD_ID_NONE);
    uacpi_release_native_mutex(mutex->handle);
 
    return UACPI_STATUS_OK;
}

Referenced by access_field_unit(), enter_method(), handle_mutex_ctl(), and held_mutexes_array_remove_and_release().

uacpi_release_native_mutex()

static uacpi_status uacpi_release_native_mutex ( uacpi_handle  mtx )

inlinestatic

Definition at line 25 of file mutex.h.

{
    if (uacpi_unlikely(mtx == UACPI_NULL))
        return UACPI_STATUS_INVALID_ARGUMENT;
 
    uacpi_kernel_release_mutex(mtx);
    return UACPI_STATUS_OK;
}

Referenced by configure_host_interface(), uacpi_acquire_aml_mutex(), uacpi_acquire_global_lock(), uacpi_bulk_configure_interfaces(), uacpi_handle_osi(), uacpi_install_interface(), uacpi_install_notify_handler(), uacpi_notify_all(), uacpi_recursive_lock_release(), uacpi_release_aml_mutex(), uacpi_release_global_lock(), uacpi_rw_unlock_read(), uacpi_rw_unlock_write(), uacpi_set_interface_query_handler(), uacpi_uninstall_interface(), and uacpi_uninstall_notify_handler().

uacpi_release_native_mutex_may_be_null()

static uacpi_status uacpi_release_native_mutex_may_be_null ( uacpi_handle  mtx )

inlinestatic

Definition at line 44 of file mutex.h.

{
    if (mtx == UACPI_NULL)
        return UACPI_STATUS_OK;
 
    uacpi_kernel_release_mutex(mtx);
    return UACPI_STATUS_OK;
}

Referenced by table_ctl(), uacpi_for_each_table(), uacpi_set_table_installation_handler(), uacpi_table_install_physical_with_origin(), and uacpi_table_install_with_origin().

uacpi_rw_lock_deinit()

uacpi_status uacpi_rw_lock_deinit

(

struct uacpi_rw_lock *

lock

)

Definition at line 333 of file mutex.c.

{
    if (uacpi_unlikely(lock->num_readers)) {
        uacpi_warn("de-initializing rw_lock %p with %zu active readers\n",
                   lock, lock->num_readers);
        lock->num_readers = 0;
    }
 
    if (lock->read_mutex != UACPI_NULL) {
        uacpi_kernel_free_mutex(lock->read_mutex);
        lock->read_mutex = UACPI_NULL;
    }
    if (lock->write_mutex != UACPI_NULL) {
        uacpi_kernel_free_mutex(lock->write_mutex);
        lock->write_mutex = UACPI_NULL;
    }
 
    return UACPI_STATUS_OK;
}

Referenced by uacpi_deinitialize_namespace().

uacpi_rw_lock_init()

uacpi_status uacpi_rw_lock_init

(

struct uacpi_rw_lock *

lock

)

Definition at line 316 of file mutex.c.

{
    lock->read_mutex = uacpi_kernel_create_mutex();
    if (uacpi_unlikely(lock->read_mutex == UACPI_NULL))
        return UACPI_STATUS_OUT_OF_MEMORY;
 
    lock->write_mutex = uacpi_kernel_create_mutex();
    if (uacpi_unlikely(lock->write_mutex == UACPI_NULL)) {
        uacpi_kernel_free_mutex(lock->read_mutex);
        lock->read_mutex = UACPI_NULL;
        return UACPI_STATUS_OUT_OF_MEMORY;
    }
 
    lock->num_readers = 0;
    return UACPI_STATUS_OK;
}

Referenced by uacpi_initialize_namespace().

uacpi_rw_lock_read()

uacpi_status uacpi_rw_lock_read

(

struct uacpi_rw_lock *

lock

)

Definition at line 353 of file mutex.c.

{
    uacpi_status ret;
 
    ret = uacpi_acquire_native_mutex(lock->read_mutex);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    if (lock->num_readers++ == 0) {
        ret = uacpi_acquire_native_mutex(lock->write_mutex);
        if (uacpi_unlikely_error(ret))
            lock->num_readers = 0;
    }
 
    uacpi_kernel_release_mutex(lock->read_mutex);
    return ret;
}

Referenced by uacpi_namespace_read_lock().

uacpi_rw_lock_write()

uacpi_status uacpi_rw_lock_write

(

struct uacpi_rw_lock *

lock

)

Definition at line 386 of file mutex.c.

{
    return uacpi_acquire_native_mutex(lock->write_mutex);
}

Referenced by uacpi_namespace_write_lock().

uacpi_rw_unlock_read()

uacpi_status uacpi_rw_unlock_read

(

struct uacpi_rw_lock *

lock

)

Definition at line 371 of file mutex.c.

{
    uacpi_status ret;
 
    ret = uacpi_acquire_native_mutex(lock->read_mutex);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    if (lock->num_readers-- == 1)
        uacpi_release_native_mutex(lock->write_mutex);
 
    uacpi_kernel_release_mutex(lock->read_mutex);
    return ret;
}

Referenced by uacpi_namespace_read_unlock().

uacpi_rw_unlock_write()

uacpi_status uacpi_rw_unlock_write

(

struct uacpi_rw_lock *

lock

)

Definition at line 391 of file mutex.c.

{
    return uacpi_release_native_mutex(lock->write_mutex);
}

Referenced by uacpi_namespace_write_unlock().

uacpi_this_thread_owns_aml_mutex()

uacpi_bool uacpi_this_thread_owns_aml_mutex

(

uacpi_mutex *

mutex

)

Definition at line 193 of file mutex.c.

{
    uacpi_thread_id id;
 
    id = UACPI_ATOMIC_LOAD_THREAD_ID(&mutex->owner);
    return id == uacpi_kernel_get_thread_id();
}

Referenced by enter_method(), and handle_mutex_ctl().