Использование семафоров (semaphore.h)

API определен в заголовочном файле sysroot-*-kos/include/kos/semaphore.h из состава KasperskyOS SDK. Также в составе KasperskyOS SDK поставляется заголовочный файл sysroot-*-kos/include/kos/sync_api.h, который дает возможность транзитивно включить в исходный код программы заголовочный файл semaphore.h и заголовочные файлы для использования других примитивов синхронизации.

API предназначен для синхронизации потоков исполнения на основе семафоров. Семафор – примитив синхронизации, основанный на счетчике, значение которого может быть атомарно изменено. Значение счетчика обычно отражает число доступных разделяемых между потоками исполнения ресурсов. Для исполнения критической секции поток ожидает, пока значение счетчика не станет больше нуля. Если значение счетчика больше нуля, то оно уменьшается на единицу, и поток исполняет критическую секцию. После исполнения критической секции поток исполнения сигнализирует семафор, в результате чего значение счетчика увеличивается.

Сведения о функциях API приведены в таблице ниже.

Использование API

Типовой сценарий использования API включает следующие шаги:

  1. Инициализация семафора вызовом функции KosSemaphoreInit().
  2. Использование семафора потоками исполнения:
    1. Ожидание семафора вызовом функции KosSemaphoreWait(), KosSemaphoreWaitTimeout() или KosSemaphoreTryWait().
    2. Сигнализация семафора вызовом функции KosSemaphoreSignal() или KosSemaphoreSignalN().
  3. Освобождение ресурсов семафора вызовом функции KosSemaphoreDeinit().

Сведения о функциях API

Функции semaphore.h

Функция

Сведения о функции

KosSemaphoreInit()

Назначение

Инициализирует семафор.

Параметры

  • [out] semaphore – указатель на семафор. Тип семафора определен в заголовочном файле sysroot-*-kos/include/kos/sync_types.h из состава KasperskyOS SDK.
  • [in] count – значение счетчика.

Возвращаемые значения

В случае успеха возвращает rcOk, иначе возвращает код ошибки.

Если значение в параметре count превышает константу KOS_SEMAPHORE_VALUE_MAX, возвращает rcInvalidArgument. (Константа KOS_SEMAPHORE_VALUE_MAX определена в заголовочном файле sysroot-*-kos/include/kos/sync_types.h из состава KasperskyOS SDK.)

KosSemaphoreDeinit()

Назначение

Освобождает ресурсы семафора.

Параметры

  • [in] semaphore – указатель на семафор. Тип семафора определен в заголовочном файле sysroot-*-kos/include/kos/sync_types.h из состава KasperskyOS SDK.

Возвращаемые значения

В случае успеха возвращает rcOk, иначе возвращает код ошибки.

Если есть потоки исполнения, ожидающие семафор, возвращает rcBusy.

KosSemaphoreSignal()

Назначение

Сигнализирует семафор с увеличением счетчика на единицу.

Параметры

  • [in,out] semaphore – указатель на семафор. Тип семафора определен в заголовочном файле sysroot-*-kos/include/kos/sync_types.h из состава KasperskyOS SDK.

Возвращаемые значения

В случае успеха возвращает rcOk, иначе возвращает код ошибки.

KosSemaphoreSignalN()

Назначение

Сигнализирует семафор с увеличением счетчика на заданное число.

Параметры

  • [in,out] semaphore – указатель на семафор. Тип семафора определен в заголовочном файле sysroot-*-kos/include/kos/sync_types.h из состава KasperskyOS SDK.
  • [in] n – натуральное число, на которое нужно увеличить счетчик.

Возвращаемые значения

В случае успеха возвращает rcOk, иначе возвращает код ошибки.

KosSemaphoreWaitTimeout()

Назначение

Ожидает семафор не дольше заданного времени.

Параметры

  • [in,out] semaphore – указатель на семафор. Тип семафора определен в заголовочном файле sysroot-*-kos/include/kos/sync_types.h из состава KasperskyOS SDK.
  • [in] mdelay – время ожидания семафора в миллисекундах или INFINITE_TIMEOUT, чтобы задать неограниченное время ожидания. Константа INFINITE_TIMEOUT определена в заголовочном файле sysroot-*-kos/include/rtl/rtc.h из состава KasperskyOS SDK.

Возвращаемые значения

В случае успеха возвращает rcOk, иначе возвращает код ошибки.

Если время ожидания истекло, возвращает rcTimeout.

Дополнительные сведения

Неблокирующий вызов, если в параметре mdelay указан 0.

KosSemaphoreWait()

Назначение

Ожидает семафор сколь угодно долго.

Параметры

  • [in,out] semaphore – указатель на семафор. Тип семафора определен в заголовочном файле sysroot-*-kos/include/kos/sync_types.h из состава KasperskyOS SDK.

Возвращаемые значения

В случае успеха возвращает rcOk, иначе возвращает код ошибки.

KosSemaphoreTryWait()

Назначение

Ожидает семафор.

Если счетчик семафора имеет нулевое значение, не ожидает увеличения счетчика этого семафора, а возвращает управление.

Параметры

  • [in,out] semaphore – указатель на семафор. Тип семафора определен в заголовочном файле sysroot-*-kos/include/kos/sync_types.h из состава KasperskyOS SDK.

Возвращаемые значения

В случае успеха возвращает rcOk, иначе возвращает код ошибки.

Если счетчик семафора имеет нулевое значение, возвращает rcBusy.

В начало