stack.h - Man Page

#include 'bee2/defs.h'

Локальные переменные функций могут размещаться в контролируемом стеке -- области памяти, указатель на которую передается как дополнительный параметр функции.

Контролируемый стек создается в высокоуровневой функции, передается по цепочке в низкоуровневые функции, очищается и разрушается при завершении высокоуровневой функции.

Низкоуровневые функции могут не заботиться об утечке данных через контролируемый стек и размещать в этом стеке критические объекты.

Низкоуровневые функции могут размещать критические объекты не только в контролируемом стеке, но еще в переменных, объявленных с ключевым словом register. При завершении низкоуровневой функции такие переменные должны быть обнулены.

Значения критических переменных могут определяться через возвращаемые функциями значения (как правило, значения возвращаются через регистр).

Критические переменные не должны передаваться через обычный стек как параметры функций.

Пример работы с контролируемым стеком и критической переменной:

void f2(octet a[], size_t n, octet b[], size_t m, void* stack)
{
    register word sensitive;
    octet* tmp1 = (octet*)stack;
    octet* tmp2 = tmp1 + 2 * n;
    stack = tmp2 + m;
    ...
    sensitive = f1(tmp1, 2 * n, stack);
    ...
    sensitive = 0;
}

Определение функции f, которая использует контролируемый стек, должно сопровождаться определением функции f_deep, которая определяет максимальную глубину стека f. Функция f_deep берет на вход произвольное число аргументов типа size_t (размерностей) или других типов и возвращает глубину стека в октетах.

Значение f_deep не должно уменьшаться при увеличении любого ее аргумента.

В описании функции f, использующей вспомогательный стек, должен быть описаны параметры f_deep (схема расчета глубины стека). Схему рекомендуется описывать следующим образом:

f_deep(     // функция
    dim1,   // первая размерность
    dim2,   // вторая размерность
    ...
    dimX    // последняя размерность
);

Например, f1_deep(n), f2_deep2(n, m), f3_deep().

Локальные переменные, размещаемые в контролируемом стеке, могут использоваться не в одной, а в нескольких функциях. Эти функции образуют, так называемую, связку. Общие локальные переменные функций связки образуют состояние. Указатель на состояние передается как дополнительный параметр функций связки. Определение связки g должно сопровождаться функцией g_keep, которая возвращает захват стека -- длину состояния в октетах. Функции типа _keep имеют такой же интерфейс, как и функции типа _deep.

Состояние функции связки и ее стек могут размещаться в одном буфере памяти. Тем не менее, указатель на состояние (state) рекомендуется отделять от указателя на стек (stack). Тогда высокоуровневые функции могут более точно рассчитывать суммарный объем контролируемого стека (состояния различных связок надо поддерживать неизменными, а стек -- не обязательно).

Для стандартизированного оформления описаний в doxygen предусмотрены окружения \deep, \deep{stack}, \keep, \keep{state}.

Автоматически создано Doxygen для Библиотека Bee2 из исходного текста.