Buffer pool service. More...
Go to the source code of this file.
Data Structures | |
| struct | wsfBufPoolDesc_t |
| Buffer pool descriptor structure. More... | |
| struct | WsfBufPoolStat_t |
| Pool statistics. More... | |
| struct | wsfBufDiagAllocFail_t |
| WSF buffer diagnostics - buffer allocation failure. More... | |
| struct | WsfBufDiag_t |
| WSF buffer diagnostics message. More... | |
Macros | |
| #define | WSF_BUF_FREE_CHECK_ASSERT TRUE |
| Check if trying to free a buffer that is already free. More... | |
| #define | WSF_BUF_ALLOC_BEST_FIT_FAIL_ASSERT FALSE |
| Assert on best-fit buffer allocation failure. More... | |
| #define | WSF_BUF_ALLOC_FAIL_ASSERT TRUE |
| Assert on buffer allocation failure. More... | |
| #define | WSF_BUF_STATS_HIST FALSE |
| Buffer histogram stats. More... | |
| #define | WSF_BUF_STATS_MAX_LEN 128 |
| Length of the buffer statistics array. More... | |
| #define | WSF_BUF_STATS_MAX_POOL 32 |
| Max number of pools can allocate. More... | |
| #define | WSF_BUF_ALLOC_FAILED 1 |
| Failure Codes. More... | |
| #define | WSF_BUF_STATS FALSE |
| Enable buffer allocation statistics. More... | |
Typedefs | |
| typedef void(* | WsfBufDiagCback_t) (WsfBufDiag_t *pInfo) |
| Callback providing WSF buffer diagnostic messages. More... | |
Functions | |
| uint32_t | WsfBufCalcSize (uint8_t numPools, wsfBufPoolDesc_t *pDesc) |
| Calculate size required by the buffer pool. More... | |
| uint32_t | WsfBufInit (uint8_t numPools, wsfBufPoolDesc_t *pDesc) |
| Initialize the buffer pool service. This function should only be called once upon system initialization. More... | |
| void * | WsfBufAlloc (uint16_t len) |
| Allocate a buffer. More... | |
| void | WsfBufFree (void *pBuf) |
| Free a buffer. More... | |
| uint8_t * | WsfBufGetAllocStats (void) |
| Diagnostic function to get the buffer allocation statistics. More... | |
| uint8_t * | WsfBufGetPoolOverFlowStats (void) |
| Diagnostic function to get the number of overflow times for each pool. More... | |
| uint8_t | WsfBufGetNumPool (void) |
| Get number of pools. More... | |
| void | WsfBufGetPoolStats (WsfBufPoolStat_t *pStat, uint8_t numPool) |
| Get statistics for each pool. More... | |
| void | WsfBufDiagRegister (WsfBufDiagCback_t callback) |
| Called to register the buffer diagnostics callback function. More... | |
Buffer pool service.
Copyright (c) 2009-2018 Arm Ltd. All Rights Reserved.
Copyright (c) 2019-2020 Packetcraft, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Definition in file wsf_buf.h.
