1 /******************************************************************************
2  *
3  *  Copyright 2014 Google, Inc.
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 #pragma once
20 
21 #include <stddef.h>
22 #include <stdint.h>
23 #include <stdlib.h>
24 
25 typedef void* (*alloc_fn)(size_t size);
26 typedef void (*free_fn)(void* ptr);
27 
28 typedef struct {
29   alloc_fn alloc;
30   free_fn free;
31 } allocator_t;
32 
33 // allocator_t abstractions for the osi_*alloc and osi_free functions
34 extern const allocator_t allocator_malloc;
35 extern const allocator_t allocator_calloc;
36 
37 char* osi_strdup(const char* str);
38 char* osi_strndup(const char* str, size_t len);
39 
40 void* osi_malloc(size_t size);
41 void* osi_calloc(size_t size);
42 void osi_free(void* ptr);
43 
44 // Free a buffer that was previously allocated with function |osi_malloc|
45 // or |osi_calloc| and reset the pointer to that buffer to NULL.
46 // |p_ptr| is a pointer to the buffer pointer to be reset.
47 // |p_ptr| cannot be NULL.
48 void osi_free_and_reset(void** p_ptr);
49 
50 // Dump allocation-related statistics and debug info to the |fd| file
51 // descriptor.
52 // The information is in user-readable text format. The |fd| must be valid.
53 void osi_allocator_debug_dump(int fd);
54