include/grpc/support/alloc.h

   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 /** malloc.
  31  * If size==0, always returns NULL. Otherwise this function never returns NULL.
  32  * The pointer returned is suitably aligned for any kind of variable it could
  33  * contain.
  34  */
  35 GPRAPI void* gpr_malloc(size_t size);
  36 /** like malloc, but zero all bytes before returning them */
  37 GPRAPI void* gpr_zalloc(size_t size);
  38 /** free */
  39 GPRAPI void gpr_free(void* ptr);
  40 /** realloc, never returns NULL */
  41 GPRAPI void* gpr_realloc(void* p, size_t size);
  42 /** aligned malloc, never returns NULL, will align to alignment, which
  43  * must be a power of 2. */
  44 GPRAPI void* gpr_malloc_aligned(size_t size, size_t alignment);
  45 /** free memory allocated by gpr_malloc_aligned */
  46 GPRAPI void gpr_free_aligned(void* ptr);
  47
  48 #ifdef __cplusplus
  49 }
  50 #endif
  51
  52 #endif /* GRPC_SUPPORT_ALLOC_H */