Burst Buffer API¶
The burst buffer API is the interface between users and the burst buffer service. It allows users to define, start, cancel, and query information on their transfers. The API is also intended to be consistent with the bbCmd utility component that executes on the front-end nodes, allowing for inspection and modification of the burst buffer transfers during all stages of the job.
Burst Buffer Shared Checkpoint File System (BSCFS) uses the Burst Buffer APIs to allow shared (N:1 or N:M) checkpoints across multiple nodes to leverage node-local non-volatile storage.
Compilation¶
Adding the following options to the compile command-line should include bbAPI headers and library, as well as setting rpath to point to the bbAPI library. -I/opt/ibm -Wl,–rpath /opt/ibm/bb/lib -L/opt/ibm/bb/lib -lbbAPI
An example testcase can be built via: $ mpicc /opt/ibm/bb/tests/test_basic_xfer.c -o test_basic_xfer -I/opt/ibm -L/opt/ibm/bb/lib -Wl,–rpath=/opt/ibm/bb/lib -lbbAPI
Burst Buffer
- BB_AddFiles
- BB_AddKeys
- BB_CancelTransfer
- BB_CreateTransferDef
- BB_FreeTransferDef
- BB_GetDeviceUsage
- BB_GetLastErrorDetails
- BB_GetThrottleRate
- BB_GetTransferHandle
- BB_GetTransferInfo
- BB_GetTransferKeys
- BB_GetTransferList
- BB_GetUsage
- BB_GetVersion
- BB_InitLibrary
- BB_SetThrottleRate
- BB_SetUsageLimit
- BB_StartTransfer
- BB_TerminateLibrary
Burst Buffer Shared Checkpoint File System (BSCFS) APIs