buffer_pool_internal.h

Go to the documentation of this file.

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Distributed under BSD 3-Clause license.                                   *
 * Copyright by The HDF Group.                                               *
 * Copyright by the Illinois Institute of Technology.                        *
 * All rights reserved.                                                      *
 *                                                                           *
 * This file is part of Hermes. The full Hermes copyright notice, including  *
 * terms governing use, modification, and redistribution, is contained in    *
 * the COPYING file, which can be found at the top directory. If you do not  *
 * have access to the file, you may request a copy from help@hdfgroup.org.   *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
#ifndef HERMES_BUFFER_POOL_INTERNAL_H_
#define HERMES_BUFFER_POOL_INTERNAL_H_
 
#include "buffer_pool.h"
#include "memory_management.h"
 
namespace hermes {
 
ptrdiff_t InitBufferPool(u8 *hermes_memory, Arena *buffer_pool_arena,
                         Arena *scratch_arena, i32 node_id, Config *config);
 
BufferPool *GetBufferPoolFromContext(SharedMemoryContext *context);
 
Device *GetDeviceById(SharedMemoryContext *context, DeviceID device_id);
 
BufferHeader *GetHeadersBase(SharedMemoryContext *context);
 
BufferHeader *GetHeaderByBufferId(SharedMemoryContext *context, BufferID id);
 
bool HeaderIsDormant(BufferHeader *header);
 
void SplitRamBufferFreeList(SharedMemoryContext *context, int slab_index);
 
void MergeRamBufferFreeList(SharedMemoryContext *context, int slab_index);
 
BufferID PeekFirstFreeBufferId(SharedMemoryContext *context, DeviceID device_id,
                               int slab_index);
 
void LocalReleaseBuffer(SharedMemoryContext *context, BufferID buffer_id);
 
void LocalReleaseBuffers(SharedMemoryContext *context,
                         const std::vector<BufferID> &buffer_ids);
i32 GetSlabUnitSize(SharedMemoryContext *context, DeviceID device_id,
                    int slab_index);
 
u32 LocalGetBufferSize(SharedMemoryContext *context, BufferID id);
i32 GetSlabBufferSize(SharedMemoryContext *context, DeviceID device_id,
                      int slab_index);
 
void SerializeBufferPoolToFile(SharedMemoryContext *context, FILE *file);
 
void ParseConfig(Arena *arena, const char *path, Config *config);
 
u8 *InitSharedMemory(const char *shmem_name, size_t total_size);
 
u8 *GetRamBufferPtr(SharedMemoryContext *context, BufferID buffer_id);
 
Target *GetTarget(SharedMemoryContext *context, int index);
 
Target *GetTargetFromId(SharedMemoryContext *context, TargetID id);
 
std::atomic<u32> *GetAvailableBuffersArray(SharedMemoryContext *context,
                                           DeviceID device_id);
}  // namespace hermes
 
#endif  // HERMES_BUFFER_POOL_INTERNAL_H_