1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
/*
* Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2005 The University of Tennessee and The University
* of Tennessee Research Foundation. All rights
* reserved.
* Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
* University of Stuttgart. All rights reserved.
* Copyright (c) 2004-2005 The Regents of the University of California.
* All rights reserved.
* Copyright (c) 2015 Los Alamos National Security, LLC. All rights
* reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
/** @file
* A generic memory basic allocator.
**/
#ifndef ALLOCATOR_BASIC_H
#define ALLOCATOR_BASIC_H
#include "opal_config.h"
#include "opal/class/opal_free_list.h"
#include "opal/mca/allocator/allocator.h"
#include "opal/mca/threads/mutex.h"
#include <stdlib.h>
#include <string.h>
/*
* Free list of allocated segments
*/
struct mca_allocator_basic_segment_t {
opal_free_list_item_t seg_item;
unsigned char *seg_addr;
size_t seg_size;
};
typedef struct mca_allocator_basic_segment_t mca_allocator_basic_segment_t;
/*
* Basic allocator module
*/
struct mca_allocator_basic_module_t {
mca_allocator_base_module_t super;
mca_allocator_base_component_segment_alloc_fn_t seg_alloc;
mca_allocator_base_component_segment_free_fn_t seg_free;
opal_list_t seg_list;
opal_mutex_t seg_lock;
opal_free_list_t seg_descriptors;
};
typedef struct mca_allocator_basic_module_t mca_allocator_basic_module_t;
BEGIN_C_DECLS
/*
* Component open/cleanup.
*/
int mca_allocator_basic_component_open(void);
int mca_allocator_basic_component_close(void);
/**
* The function used to initialize the component.
*/
mca_allocator_base_module_t *mca_allocator_basic_component_init(
bool enable_mpi_threads, mca_allocator_base_component_segment_alloc_fn_t segment_alloc,
mca_allocator_base_component_segment_free_fn_t segment_free, void *ctx);
/**
* Accepts a request for memory in a specific region defined by the
* mca_allocator_basic_options_t struct and returns a pointer to memory in that
* region or NULL if there was an error
*
* @param mem A pointer to the appropriate struct for the area of memory.
* @param size The size of the requested area of memory
*
* @retval Pointer to the area of memory if the allocation was successful
* @retval NULL if the allocation was unsuccessful
*/
void *mca_allocator_basic_alloc(mca_allocator_base_module_t *mem, size_t size, size_t align);
/**
* Attempts to resize the passed region of memory into a larger or a smaller
* region. If it is unsuccessful, it will return NULL and the passed area of
* memory will be untouched.
*
* @param mem A pointer to the appropriate struct for the area of
* memory.
* @param size The size of the requested area of memory
* @param ptr A pointer to the region of memory to be resized
*
* @retval Pointer to the area of memory if the reallocation was successful
* @retval NULL if the allocation was unsuccessful
*
*/
void *mca_allocator_basic_realloc(mca_allocator_base_module_t *mem, void *ptr, size_t size);
/**
* Frees the passed region of memory
*
* @param mem A pointer to the appropriate struct for the area of
* memory.
* @param ptr A pointer to the region of memory to be freed
*
* @retval None
*
*/
void mca_allocator_basic_free(mca_allocator_base_module_t *mem, void *ptr);
/**
* Frees all the memory from all the basics back to the system. Note that
* this function only frees memory that was previously freed with
* mca_allocator_basic_free().
*
* @param mem A pointer to the appropriate struct for the area of
* memory.
*
* @retval None
*
*/
int mca_allocator_basic_compact(mca_allocator_base_module_t *mem);
/**
* Cleanup all resources held by this allocator.
*
* @param mem A pointer to the appropriate struct for the area of
* memory.
*
* @retval None
*
*/
int mca_allocator_basic_finalize(mca_allocator_base_module_t *mem);
OPAL_DECLSPEC extern mca_allocator_base_component_t mca_allocator_basic_component;
END_C_DECLS
#endif /* ALLOCATOR_BUCKET_ALLOC_H */
|
