/usr/include/memkind.h is in libmemkind-dev 1.1.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 | /*
* Copyright (C) 2014 - 2016 Intel Corporation.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice(s),
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice(s),
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#ifdef __cplusplus
extern "C" {
#endif
#include <sys/types.h>
/*
* Header file for the memkind heap manager.
* More details in memkind(3) man page.
*
* API standards are described in memkind(3) man page.
*/
/*EXPERIMENTAL API*/
enum memkind_const {
MEMKIND_MAX_KIND = 512,
MEMKIND_ERROR_MESSAGE_SIZE = 128,
MEMKIND_NAME_LENGTH = 64
};
/*EXPERIMENTAL API*/
enum memkind_error {
MEMKIND_ERROR_UNAVAILABLE = -1,
MEMKIND_ERROR_MBIND = -2,
MEMKIND_ERROR_MMAP = -3,
MEMKIND_ERROR_MEMALIGN = -4,
MEMKIND_ERROR_MALLCTL = -5,
MEMKIND_ERROR_MALLOC = -6,
MEMKIND_ERROR_GETCPU = -7,
MEMKIND_ERROR_PMTT = -8,
MEMKIND_ERROR_TIEDISTANCE = -9,
MEMKIND_ERROR_ALIGNMENT = -10,
MEMKIND_ERROR_MALLOCX = -11,
MEMKIND_ERROR_ENVIRON = -12,
MEMKIND_ERROR_INVALID = -13,
MEMKIND_ERROR_REPNAME = -14,
MEMKIND_ERROR_TOOMANY = -15,
MEMKIND_ERROR_PTHREAD = -16,
MEMKIND_ERROR_BADOPS = -17,
MEMKIND_ERROR_HUGETLB = -18,
MEMKIND_ERROR_BADPOLICY = -19,
MEMKIND_ERROR_REPPOLICY = -20,
MEMKIND_ERROR_RUNTIME = -255
};
/*EXPERIMENTAL API*/
enum memkind_base_partition {
MEMKIND_PARTITION_DEFAULT = 0,
MEMKIND_PARTITION_HBW = 1,
MEMKIND_PARTITION_HBW_HUGETLB = 2,
MEMKIND_PARTITION_HBW_PREFERRED = 3,
MEMKIND_PARTITION_HBW_PREFERRED_HUGETLB = 4,
MEMKIND_PARTITION_HUGETLB = 5,
MEMKIND_PARTITION_HBW_GBTLB = 6,
MEMKIND_PARTITION_HBW_PREFERRED_GBTLB = 7,
MEMKIND_PARTITION_GBTLB = 8,
MEMKIND_PARTITION_HBW_INTERLEAVE = 9,
MEMKIND_PARTITION_INTERLEAVE = 10,
MEMKIND_NUM_BASE_KIND
};
/*EXPERIMENTAL API*/
struct memkind;
/*EXPERIMENTAL API*/
struct memkind_ops {
int (* create)(struct memkind *kind, const struct memkind_ops *ops, const char *name);
int (* destroy)(struct memkind *kind);
void *(* malloc)(struct memkind *kind, size_t size);
void *(* calloc)(struct memkind *kind, size_t num, size_t size);
int (* posix_memalign)(struct memkind *kind, void **memptr, size_t alignment, size_t size);
void *(* realloc)(struct memkind *kind, void *ptr, size_t size);
void (* free)(struct memkind *kind, void *ptr);
void *(* mmap)(struct memkind *kind, void *addr, size_t size);
int (* mbind)(struct memkind *kind, void *ptr, size_t size);
int (* madvise)(struct memkind *kind, void *addr, size_t size);
int (* get_mmap_flags)(struct memkind *kind, int *flags);
int (* get_mbind_mode)(struct memkind *kind, int *mode);
int (* get_mbind_nodemask)(struct memkind *kind, unsigned long *nodemask, unsigned long maxnode);
int (* get_arena)(struct memkind *kind, unsigned int *arena, size_t size);
int (* get_size)(struct memkind *kind, size_t *total, size_t *free);
int (* check_available)(struct memkind *kind);
int (* check_addr)(struct memkind *kind, void *addr);
void (*init_once)(void);
};
typedef struct memkind * memkind_t;
/*EXPERIMENTAL API*/
extern memkind_t MEMKIND_DEFAULT;
/*EXPERIMENTAL API*/
extern memkind_t MEMKIND_HUGETLB;
/*EXPERIMENTAL API*/
extern memkind_t MEMKIND_HBW;
/*EXPERIMENTAL API*/
extern memkind_t MEMKIND_HBW_PREFERRED;
/*EXPERIMENTAL API*/
extern memkind_t MEMKIND_HBW_HUGETLB;
/*EXPERIMENTAL API*/
extern memkind_t MEMKIND_HBW_PREFERRED_HUGETLB;
/*EXPERIMENTAL API*/
extern memkind_t MEMKIND_HBW_GBTLB;
/*EXPERIMENTAL API*/
extern memkind_t MEMKIND_HBW_PREFERRED_GBTLB;
/*EXPERIMENTAL API*/
extern memkind_t MEMKIND_GBTLB;
/*EXPERIMENTAL API*/
extern memkind_t MEMKIND_HBW_INTERLEAVE;
/*EXPERIMENTAL API*/
extern memkind_t MEMKIND_INTERLEAVE;
/*STANDARD API*/
/* API versioning */
int memkind_get_version();
/*EXPERIMENTAL API*/
/* Convert error number into an error message */
void memkind_error_message(int err, char *msg, size_t size);
/*EXPERIMENTAL API*/
/* Free all resources allocated by the library (must be last call to library by the process) */
int memkind_finalize(void);
/* KIND MANAGEMENT INTERFACE */
/*EXPERIMENTAL API*/
/* Create a new kind */
int memkind_create(const struct memkind_ops *ops, const char *name, memkind_t *kind);
/*EXPERIMENTAL API*/
/* Create a new PMEM (file-backed) kind of given size on top of a temporary file */
int memkind_create_pmem(const char *dir, size_t max_size, memkind_t *kind);
/*EXPERIMENTAL API*/
/* Query the number of kinds instantiated */
int memkind_get_num_kind(int *num_kind);
/*EXPERIMENTAL API*/
/* Get kind associated with a partition (index from 0 to num_kind - 1) */
int memkind_get_kind_by_partition(int partition, memkind_t *kind);
/*EXPERIMENTAL API*/
/* Get kind given the name of the kind */
int memkind_get_kind_by_name(const char *name, memkind_t *kind);
/*EXPERIMENTAL API*/
/* Get the amount in bytes of total and free memory of the NUMA nodes associated with the kind */
int memkind_get_size(memkind_t kind, size_t *total, size_t *free);
/*EXPERIMENTAL API*/
/* returns 0 if memory kind is available else returns error code */
int memkind_check_available(memkind_t kind);
/* HEAP MANAGEMENT INTERFACE */
/*EXPERIMENTAL API*/
/* malloc from the numa nodes of the specified kind */
void *memkind_malloc(memkind_t kind, size_t size);
/*EXPERIMENTAL API*/
/* calloc from the numa nodes of the specified kind */
void *memkind_calloc(memkind_t kind, size_t num, size_t size);
/*EXPERIMENTAL API*/
/* posix_memalign from the numa nodes of the specified kind */
int memkind_posix_memalign(memkind_t kind, void **memptr, size_t alignment,
size_t size);
/*EXPERIMENTAL API*/
/* realloc from the numa nodes of the specified kind */
void *memkind_realloc(memkind_t kind, void *ptr, size_t size);
/*EXPERIMENTAL API*/
/* Free memory allocated with the memkind API */
void memkind_free(memkind_t kind, void *ptr);
/*EXPERIMENTAL API*/
/* ALLOCATOR CALLBACK FUNCTION */
void *memkind_partition_mmap(int partition, void *addr, size_t size);
#ifdef __cplusplus
}
#endif
|