スケーラブル・アロケーターの C インターフェイス

概要

スケーラブルなメモリー割り当て用の低水準インターフェイス。

構文

        extern "C" {
            // C メモリー・アロケーターのスケーラブル・バージョン
            void* scalable_malloc( size_t size );
            void  scalable_free( void* ptr );
            void* scalable_calloc( size_t nobj, size_t size );
            void* scalable_realloc( void* ptr, size_t size );
         
            // _msize/malloc_size/malloc_usable_size のスケーラブル・バージョン
            size_t scalable_msize( void* ptr );
         
            // posix_memalign のスケーラブル・バージョン
            int scalable_posix_memalign( void** memptr, size_t alignment, 
                                         size_t size );
         
            // アラインして割り当て
            void* scalable_aligned_malloc( size_t size, 
                                           size_t alignment);
            void scalable_aligned_free( void* ptr ); 
            void* scalable_aligned_realloc( void* ptr, size_t size, 
                                            size_t alignment );

            // scalable_allocation_* functions の戻り値
            typedef enum {
                TBBMALLOC_OK,
                TBBMALLOC_INVALID_PARAM,
                TBBMALLOC_UNSUPPORTED,
                TBBMALLOC_NO_MEMORY,
                TBBMALLOC_NO_EFFECT
            } ScalableAllocationResult;

            typedef enum {
                // ラージ・メモリー・ページの使用のオン/オフ
                TBBMALLOC_USE_HUGE_PAGES,
                // アロケーターのメモリー使用量のしきい値を設定
                // しきい値を超えると内部メモリーバッファーをクリーン
                TBBMALLOC_SET_SOFT_HEAP_LIMIT
            } AllocationModeParam;

            // アロケーター固有のアロケーション・モードを設定
            int scalable_allocation_mode(int param, intptr_t value);

            typedef enum {
                // すべてのスレッドの内部アロケーター・バッファーをクリーン
                TBBMALLOC_CLEAN_ALL_BUFFERS,
                // 現在のスレッドの内部アロケーター・バッファーをクリーン
                TBBMALLOC_CLEAN_THREAD_BUFFERS
            } ScalableAllocationCmd;

            // アロケーター固有のコマンドを呼び出す
            int scalable_allocation_command(int cmd, void *param);


        }

ヘッダー

#include "tbb/scalable_allocator.h"

説明

これらの関数は、スケーラブル・アロケーターに C 水準のインターフェイスを提供します。scalable_allocation_mode および scalable_allocation_command を除き、scalable_x ルーチンはそれぞれ、x ライブラリー関数に似た動作を行います。下記の表に示されているように、ルーチンには 2 つのファミリーがあります。あるファミリーの scalable_x 関数で割り当てた記憶領域は、C 標準ライブラリー関数ではなく、同じファミリーの scalable_x 関数で解放またはサイズ変更してください。同様に、C 標準ライブラリー関数で割り当てた記憶領域は、scalable_x 関数で解放またはサイズ変更しないでください。

size_t scalable_msize( void* ptr )

戻り値:

ptr がスケーラブル・アロケーターで割り当てたメモリーブロックを指している場合、メモリーブロックの使用可能なサイズ。ptr がそのようなブロックを指していない場合は 0。

int scalable_allocation_mode(int mode, intptr_t value)

int scalable_allocation_command(int cmd, void *reserved)