1 /* 2 * 3 * Copyright 2015 gRPC authors. 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 * 17 */ 18 19 #ifndef GRPC_SUPPORT_ALLOC_H 20 #define GRPC_SUPPORT_ALLOC_H 21 22 #include <grpc/support/port_platform.h> 23 24 #include <stddef.h> 25 26 #ifdef __cplusplus 27 extern "C" { 28 #endif 29 30 typedef struct gpr_allocation_functions { 31 void* (*malloc_fn)(size_t size); 32 void* (*zalloc_fn)(size_t size); /** if NULL, uses malloc_fn then memset */ 33 void* (*realloc_fn)(void* ptr, size_t size); 34 void (*free_fn)(void* ptr); 35 } gpr_allocation_functions; 36 37 /** malloc. 38 * If size==0, always returns NULL. Otherwise this function never returns NULL. 39 * The pointer returned is suitably aligned for any kind of variable it could 40 * contain. 41 */ 42 GPRAPI void* gpr_malloc(size_t size); 43 /** like malloc, but zero all bytes before returning them */ 44 GPRAPI void* gpr_zalloc(size_t size); 45 /** free */ 46 GPRAPI void gpr_free(void* ptr); 47 /** realloc, never returns NULL */ 48 GPRAPI void* gpr_realloc(void* p, size_t size); 49 /** aligned malloc, never returns NULL, will align to alignment, which 50 * must be a power of 2. */ 51 GPRAPI void* gpr_malloc_aligned(size_t size, size_t alignment); 52 /** free memory allocated by gpr_malloc_aligned */ 53 GPRAPI void gpr_free_aligned(void* ptr); 54 55 /** Request the family of allocation functions in \a functions be used. NOTE 56 * that this request will be honored in a *best effort* basis and that no 57 * guarantees are made about the default functions (eg, malloc) being called. 58 * The functions.free_fn implementation must be a no-op for NULL input. */ 59 GPRAPI void gpr_set_allocation_functions(gpr_allocation_functions functions); 60 61 /** Return the family of allocation functions currently in effect. */ 62 GPRAPI gpr_allocation_functions gpr_get_allocation_functions(void); 63 64 #ifdef __cplusplus 65 } 66 #endif 67 68 #endif /* GRPC_SUPPORT_ALLOC_H */ 69