aml.h 56.4 KB
Newer Older
Swann Perarnau's avatar
Swann Perarnau committed
1 2 3 4 5 6 7 8 9 10
/*******************************************************************************
 * Copyright 2019 UChicago Argonne, LLC.
 * (c.f. AUTHORS, LICENSE)
 *
 * This file is part of the AML project.
 * For more info, see https://xgitlab.cels.anl.gov/argo/aml
 *
 * SPDX-License-Identifier: BSD-3-Clause
*******************************************************************************/

11 12 13
#ifndef AML_H
#define AML_H 1

14
#include <assert.h>
15 16 17 18 19 20 21
#include <inttypes.h>
#include <numa.h>
#include <numaif.h>
#include <pthread.h>
#include <stdarg.h>
#include <stddef.h>
#include <stdio.h>
22
#include <stdlib.h>
23 24 25
#include <sys/mman.h>
#include <unistd.h>

26 27
/* Used by bindings, specifically in aml_binding_nbpages() and
 * aml_binding_pages().  */
28 29 30 31
#ifndef PAGE_SIZE
#define PAGE_SIZE 4096
#endif

32
#include <aml/utils/bitmap.h>
33 34
#include <aml/utils/vector.h>

35

36 37 38 39 40
/*******************************************************************************
 * Forward Declarations:
 ******************************************************************************/

struct aml_area;
41
struct aml_binding;
42 43 44

/*******************************************************************************
 * Arenas:
45 46
 * In-memory allocator implementation. Dispatches actual memory mappings back to
 * areas.
47 48
 ******************************************************************************/

49
/* Arena Flags: access to useful jemalloc flags, with the same values. */
50
/* If passed as a flag to arena's mallocx()/reallocx() routines, the newly
51 52
 * allocated memory will be 0-initialized. */
#define AML_ARENA_FLAG_ZERO ((int)0x40)
53 54
/* As a flag to arena mallocx/reallocx, will align on (1<<a). */
#define AML_ARENA_FLAG_ALIGN(a) ((int)(a))
55 56 57 58 59

/* opaque handle to configuration data */
struct aml_arena_data;

struct aml_arena_ops {
60 61 62 63 64 65 66
	int (*register_arena)(struct aml_arena_data *arena,
			      struct aml_area *area);
	int (*deregister_arena)(struct aml_arena_data *arena);
	void *(*mallocx)(struct aml_arena_data *arena, size_t size, int flags);
	void (*dallocx)(struct aml_arena_data *arena, void *ptr, int flags);
	void *(*reallocx)(struct aml_arena_data *arena, void *ptr, size_t size,
			  int flags);
67 68
};

69
struct aml_arena {
70 71
	struct aml_arena_ops *ops;
	struct aml_arena_data *data;
72 73
};

74 75 76 77 78 79 80
/*
 * Registers a new memory arena with the system.  After this call the arena
 * is ready for use.
 * "arena": an initialized arena structure (see aml_arena_jemalloc_create()).
 * "area": a memory area that will be used as the backing store.
 * Returns 0 if successful; an error code otherwise.
 */
81
int aml_arena_register(struct aml_arena *arena, struct aml_area *area);
82 83 84 85 86 87 88
/*
 * Unregisters a memory arena from the system.  Also purges the contents of
 * the memory, so any buffers allocated from the arena should be considered
 * invalid after this call.
 * "arena": a registered arena structure (see aml_arena_register()).
 * Returns 0 if successful; an error code otherwise.
 */
89
int aml_arena_deregister(struct aml_arena *arena);
90 91 92 93 94 95 96
/*
 * Allocates a new memory buffer from the arena.
 * "arena": a registered arena structure (see aml_arena_register()).
 * "size": the buffer size in bytes; if 0 is passed, NULL will be returned.
 * "flags": see AML_ARENA_FLAG_*.
 * Returns a pointer to the newly allocated memory buffer; NULL if unsuccessful.
 */
97
void *aml_arena_mallocx(struct aml_arena *arena, size_t size, int flags);
98 99 100 101 102 103
/*
 * Releases a memory buffer back to the arena.
 * "arena": a registered arena structure (see aml_arena_register()).
 * "ptr": a pointer to the memory buffer or NULL (resulting in a no-op).
 * "flags": see AML_ARENA_FLAG_* (currently unused).
 */
104
void aml_arena_dallocx(struct aml_arena *arena, void *ptr, int flags);
105 106 107 108 109 110 111 112 113 114
/*
 * Changes the size of a previously allocated memory buffer.
 * "arena": a registered arena structure (see aml_arena_register()).
 * "ptr": a pointer to the memory buffer; if NULL is passed, acts just like
 *        aml_arena_mallocx().
 * "size": the new buffer size in bytes; if 0 is passed, acts just like
 *         aml_arena_dallocx() and returns NULL.
 * "flags": see AML_ARENA_FLAG_*.
 * Returns a pointer to the resized memory buffer; NULL if unsuccessful.
 */
115 116
void *aml_arena_reallocx(struct aml_arena *arena, void *ptr, size_t size,
			 int flags);
117 118 119 120 121 122 123 124 125 126

/*******************************************************************************
 * Jemalloc Arena:
 ******************************************************************************/
extern struct aml_arena_ops aml_arena_jemalloc_ops;

struct aml_arena_jemalloc_data {
	unsigned int uid;
	int flags;
};
127

128 129 130 131 132 133 134 135 136 137 138
#define AML_ARENA_JEMALLOC_DECL(name) \
	struct aml_arena_jemalloc_data __ ##name## _inner_data; \
	struct aml_arena name = { \
		&aml_arena_jemalloc_ops, \
		(struct aml_arena_data *)&__ ## name ## _inner_data, \
	};

#define AML_ARENA_JEMALLOC_ALLOCSIZE \
	(sizeof(struct aml_arena_jemalloc_data) + \
	 sizeof(struct aml_arena))

139 140
/* Arena types passed to jemalloc arena's create()/init()/vinit() routines.  */
/* Standard arena type.  */
141
#define AML_ARENA_JEMALLOC_TYPE_REGULAR 0
142
/* Arena type allocating memory-aligned buffers.  */
143
#define AML_ARENA_JEMALLOC_TYPE_ALIGNED 1
144
/* Arena type identical to an existing arena.  */
145 146
#define AML_ARENA_JEMALLOC_TYPE_GENERIC 2

147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
/*
 * Allocates and initializes a new jemalloc arena.
 * "arena": an address where the pointer to the newly allocated arena structure
 *          will be stored.
 * "type": see AML_ARENA_JEMALLOC_TYPE_*.
 * Variadic arguments:
 * - if AML_ARENA_JEMALLOC_TYPE_REGULAR is passed as "type", no additional
 *   arguments are needed.
 * - if AML_ARENA_JEMALLOC_TYPE_ALIGNED is passed as "type", an alignment
 *   argument of type size_t and value that is a power of 2 must be provided.
 * - if AML_ARENA_JEMALLOC_TYPE_GENERIC is passed as "type", a pointer argument
 *   to type "aml_arena_data" (obtained from the "data" field of an existing
 *   jemalloc arena structure) must be provided.
 * Returns 0 if successful; an error code otherwise.
 */
162
int aml_arena_jemalloc_create(struct aml_arena **arena, int type, ...);
163 164
/*
 * Initializes a jemalloc arena.  This is a varargs-variant of the
165
 * aml_arena_jemalloc_vinit() routine.
166 167 168 169 170
 * "arena": an allocated jemalloc arena structure.
 * "type": see aml_arena_jemalloc_create().
 * Variadic arguments: see aml_arena_jemalloc_create().
 * Returns 0 if successful; an error code otherwise.
 */
171
int aml_arena_jemalloc_init(struct aml_arena *arena, int type, ...);
172 173 174 175 176 177 178
/*
 * Initializes a jemalloc arena.
 * "arena": an allocated jemalloc arena structure.
 * "type": see aml_arena_jemalloc_create().
 * "args": see the variadic arguments of aml_arena_jemalloc_create().
 * Returns 0 if successful; an error code otherwise.
 */
179
int aml_arena_jemalloc_vinit(struct aml_arena *arena, int type, va_list args);
180 181 182 183 184
/*
 * Tears down an initialized jemalloc arena.
 * "arena": an initialized jemalloc arena structure.
 * Returns 0 if successful; an error code otherwise.
 */
185
int aml_arena_jemalloc_destroy(struct aml_arena *arena);
186

187 188
/*******************************************************************************
 * Areas:
189
 * embeds information about a byte-addressable physical memory location as well
190 191
 * as binding policies over it.
 ******************************************************************************/
192

193 194 195 196
/* opaque handle to configuration data */
struct aml_area_data;

struct aml_area_ops {
197 198 199
	void *(*malloc)(struct aml_area_data *area, size_t size);
	void (*free)(struct aml_area_data *area, void *ptr);
	void *(*calloc)(struct aml_area_data *area, size_t num, size_t size);
200
	void *(*memalign)(struct aml_area_data *area, size_t align, size_t size);
201 202 203 204
	void *(*realloc)(struct aml_area_data *area, void *ptr, size_t size);
	void *(*acquire)(struct aml_area_data *area, size_t size);
	void (*release)(struct aml_area_data *area, void *ptr);
	void *(*mmap)(struct aml_area_data *area, void *ptr, size_t size);
Kamil Iskra's avatar
Kamil Iskra committed
205 206
	int (*available)(const struct aml_area_data *area);
	int (*binding)(const struct aml_area_data *area,
207
		       struct aml_binding **binding);
208 209
};

210
struct aml_area {
211 212
	struct aml_area_ops *ops;
	struct aml_area_data *data;
213 214
};

215 216 217 218 219 220 221 222
/*******************************************************************************
 * POSIX Area:
 ******************************************************************************/

extern struct aml_area_ops aml_area_posix_ops;

struct aml_area_posix_data {
};
223

224 225 226 227 228 229 230 231 232 233 234
#define AML_AREA_POSIX_DECL(name) \
	struct aml_area_posix_data __ ##name## _inner_data; \
	struct aml_area name = { \
		&aml_area_posix_ops, \
		(struct aml_area_data *)&__ ## name ## _inner_data, \
	};

#define AML_AREA_POSIX_ALLOCSIZE \
	(sizeof(struct aml_area_posix_data) + \
	 sizeof(struct aml_area))

235 236 237 238 239 240
/*
 * Allocates and initializes a new POSIX memory area.
 * "area": an address where the pointer to the newly allocated area structure
 *         will be stored.
 * Returns 0 if successful; an error code otherwise.
 */
241
int aml_area_posix_create(struct aml_area **area);
242 243 244 245 246
/*
 * Initializes a POSIX memory area.
 * "area": an allocated POSIX memory area structure.
 * Returns 0 if successful; an error code otherwise.
 */
247
int aml_area_posix_vinit(struct aml_area *area);
248 249 250 251 252 253
/*
 * Initializes a POSIX memory area.  This is identical to the
 * aml_area_posix_vinit() routine.
 * "area": an allocated POSIX memory area structure.
 * Returns 0 if successful; an error code otherwise.
 */
254
int aml_area_posix_init(struct aml_area *area);
255 256 257 258 259
/*
 * Tears down an initialized POSIX memory area.
 * "area": an initialized POSIX memory area structure.
 * Returns 0 if successful; an error code otherwise.
 */
260
int aml_area_posix_destroy(struct aml_area *area);
261 262

/*******************************************************************************
263 264 265 266 267 268 269 270 271 272 273
 * Linux Area:
 ******************************************************************************/

extern struct aml_area_ops aml_area_linux_ops;

struct aml_area_linux_manager_data {
	struct aml_arena *pool;
	size_t pool_size;
};

struct aml_area_linux_manager_ops {
Kamil Iskra's avatar
Kamil Iskra committed
274
	struct aml_arena *(*get_arena)(const struct aml_area_linux_manager_data *data);
275 276 277 278
};

extern struct aml_area_linux_manager_ops aml_area_linux_manager_single_ops;

279 280 281 282 283 284 285
/*
 * Initializes a Linux memory area manager.  A manager determines which arena
 * to use for allocations.
 * "data": an allocated Linux manager structure.
 * "arena": an arena to use for future allocations.
 * Returns 0 if successful; an error code otherwise.
 */
286 287
int aml_area_linux_manager_single_init(struct aml_area_linux_manager_data *data,
				       struct aml_arena *arena);
288 289 290 291 292
/*
 * Tears down an initialized Linux memory area manager.
 * "data": an initialized Linux manager structure.
 * Returns 0 if successful; an error code otherwise.
 */
293
int aml_area_linux_manager_single_destroy(struct aml_area_linux_manager_data *data);
294 295

struct aml_area_linux_mbind_data {
296
	struct aml_bitmap nodemask;
297 298 299 300
	int policy;
};

struct aml_area_linux_mbind_ops {
301 302 303
	int (*pre_bind)(struct aml_area_linux_mbind_data *data);
	int (*post_bind)(struct aml_area_linux_mbind_data *data, void *ptr,
			 size_t size);
Kamil Iskra's avatar
Kamil Iskra committed
304
	int (*binding)(const struct aml_area_linux_mbind_data *data,
305 306 307
		       struct aml_binding **binding);
};

308 309 310
/*
 * Sets memory policy of a Linux memory area.
 * "data": an initialized Linux memory policy structure.
311
 * "policy", "nodemask": see aml_area_linux_mbind_init().
312 313
 * Returns 0 if successful; an error code otherwise.
 */
314
int aml_area_linux_mbind_setdata(struct aml_area_linux_mbind_data *data,
315
				 int policy, const struct aml_bitmap *nodemask);
316 317 318 319 320 321 322 323
/*
 * Creates a new binding structure based on an existing Linux memory policy
 * structure.
 * "data": an initialized Linux memory policy structure.
 * "binding": an address where the pointer to the newly allocated binding
 *            structure will be stored.
 * Returns 0 if successful; an error code otherwise.
 */
Kamil Iskra's avatar
Kamil Iskra committed
324
int aml_area_linux_mbind_generic_binding(const struct aml_area_linux_mbind_data *data,
325
					 struct aml_binding **binding);
326 327 328 329 330 331 332 333
/*
 * Sets current memory policy before memory allocation using the Linux memory
 * area.
 * This variant is used with AML_AREA_LINUX_MBIND_TYPE_REGULAR mbind type (see
 * aml_area_linux_create()) and is basically a no-op.
 * "data": an initialized Linux memory policy structure.
 * Returns 0 if successful; an error code otherwise.
 */
334
int aml_area_linux_mbind_regular_pre_bind(struct aml_area_linux_mbind_data *data);
335 336 337 338 339 340 341 342 343 344
/*
 * Sets current memory policy on a new memory region allocated using the Linux
 * memory area.
 * This variant is used with AML_AREA_LINUX_MBIND_TYPE_REGULAR mbind type (see
 * aml_area_linux_create()).
 * "data": an initialized Linux memory policy structure.
 * "ptr": an address of the newly allocated memory region.
 * "size": the size of the newly allocated memory region.
 * Returns 0 if successful; an error code otherwise.
 */
345 346
int aml_area_linux_mbind_regular_post_bind(struct aml_area_linux_mbind_data *data,
					   void *ptr, size_t size);
347 348 349 350 351 352 353 354
/*
 * Sets current memory policy before memory allocation using the Linux memory
 * area.
 * This variant is used with AML_AREA_LINUX_MBIND_TYPE_MEMPOLICY mbind type (see
 * aml_area_linux_create()).
 * "data": an initialized Linux memory policy structure.
 * Returns 0 if successful; an error code otherwise.
 */
355
int aml_area_linux_mbind_mempolicy_pre_bind(struct aml_area_linux_mbind_data *data);
356 357 358 359 360 361 362 363 364 365
/*
 * Sets current memory policy on a new memory region allocated using the Linux
 * memory area.
 * This variant is used with AML_AREA_LINUX_MBIND_TYPE_MEMPOLICY mbind type (see
 * aml_area_linux_create()).
 * "data": an initialized Linux memory policy structure.
 * "ptr": an address of the newly allocated memory region.
 * "size": the size of the newly allocated memory region.
 * Returns 0 if successful; an error code otherwise.
 */
366 367
int aml_area_linux_mbind_mempolicy_post_bind(struct aml_area_linux_mbind_data *data,
					   void *ptr, size_t size);
368 369 370 371 372 373 374 375 376
/*
 * Initializes memory policy of a Linux memory area.
 * "data": an allocated Linux memory policy structure.
 * "policy": see MPOL_* in mbind(2).
 * "nodemask": an AML_MAX_NUMA_NODES-bit array (a AML_NODEMASK_SZ-element array)
 *             containing the NUMA node mask to use (see mbind(2) for more
 *             information).
 * Returns 0 if successful; an error code otherwise.
 */
377
int aml_area_linux_mbind_init(struct aml_area_linux_mbind_data *data,
378
			      int policy, const struct aml_bitmap *nodemask);
379 380 381 382 383
/*
 * Tears down an initialized Linx memory policy.
 * "data": an initialized Linux memory policy structure.
 * Returns 0 if successful; an error code otherwise.
 */
384
int aml_area_linux_mbind_destroy(struct aml_area_linux_mbind_data *data);
385 386 387 388 389 390 391 392 393 394 395 396

extern struct aml_area_linux_mbind_ops aml_area_linux_mbind_regular_ops;
extern struct aml_area_linux_mbind_ops aml_area_linux_mbind_mempolicy_ops;

struct aml_area_linux_mmap_data {
	int prot;
	int flags;
	int fildes;
	off_t off;
};

struct aml_area_linux_mmap_ops {
397 398
	void *(*mmap)(struct aml_area_linux_mmap_data *data, void *ptr,
		      size_t size);
399 400
};

401 402 403 404 405 406 407 408 409
/*
 * Allocates a memory region from a Linux memory area.
 * "data": an initialized Linux memory map structure.
 * "ptr": an address where the new memory region should be allocated (hint only;
 *        can be NULL to let the kernel decide).
 * "size": the requested size of thew new memory region to allocate.
 * Returns the address of the newly allocated region or MAP_FAILED (see mmap(2))
 * if unsuccessful.
 */
410 411
void *aml_area_linux_mmap_generic(struct aml_area_linux_mmap_data *data,
				  void *ptr, size_t size);
412 413 414 415 416 417 418 419
/*
 * Initializes memory map of a Linux memory area to use an anonymous
 * (0-initialized) mapping.
 * This variant is used with AML_AREA_LINUX_MMAP_TYPE_ANONYMOUS map type (see
 * aml_area_linux_create()).
 * "data": an allocated Linux memory map structure.
 * Returns 0 if successful; an error code otherwise.
 */
420
int aml_area_linux_mmap_anonymous_init(struct aml_area_linux_mmap_data *data);
421 422 423 424 425 426 427 428 429 430
/*
 * Initializes memory map of a Linux memory area to use an existing file
 * mapping.
 * This variant is used with AML_AREA_LINUX_MMAP_TYPE_FD map type (see
 * aml_area_linux_create()).
 * "data": an allocated Linux memory map structure.
 * "fd": an open file descriptor.
 * "offset": the offset within the file to allocate from.
 * Returns 0 if successful; an error code otherwise.
 */
431
int aml_area_linux_mmap_fd_init(struct aml_area_linux_mmap_data *data, int fd,
432
				off_t offset);
433 434 435 436 437 438 439 440 441 442 443 444
/*
 * Initializes memory map of a Linux memory area to use a newly created,
 * temporary file mapping.
 * This variant is used with AML_AREA_LINUX_MMAP_TYPE_TMPFILE map type (see
 * aml_area_linux_create()).
 * "data": an allocated Linux memory map structure.
 * "template": a file name template, ending in "XXXXXX"; the last six characters
 *             will be replaced with the actual name on successful file creation
 *             (see mkstemp(3) for more information).
 * "max": the size of the temporary file to create.
 * Returns 0 if successful; an error code otherwise.
 */
445 446
int aml_area_linux_mmap_tmpfile_init(struct aml_area_linux_mmap_data *data,
				     char *template, size_t max);
447 448 449 450 451 452 453
/*
 * Tears down an initialized Linux memory map.
 * This variant is used with AML_AREA_LINUX_MMAP_TYPE_ANONYMOUS map type (see
 * aml_area_linux_create()).
 * "data": an initialized Linux memory map structure.
 * Returns 0 if successful; an error code otherwise.
 */
454
int aml_area_linux_mmap_anonymous_destroy(struct aml_area_linux_mmap_data *data);
455 456 457 458 459 460 461
/*
 * Tears down an initialized Linux memory map.
 * This variant is used with AML_AREA_LINUX_MMAP_TYPE_FD map type (see
 * aml_area_linux_create()).
 * "data": an initialized Linux memory map structure.
 * Returns 0 if successful; an error code otherwise.
 */
462
int aml_area_linux_mmap_fd_destroy(struct aml_area_linux_mmap_data *data);
463 464 465 466 467 468 469
/*
 * Tears down an initialized Linux memory map.
 * This variant is used with AML_AREA_LINUX_MMAP_TYPE_TMPFILE map type (see
 * aml_area_linux_create()).
 * "data": an initialized Linux memory map structure.
 * Returns 0 if successful; an error code otherwise.
 */
470
int aml_area_linux_mmap_tmpfile_destroy(struct aml_area_linux_mmap_data *data);
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490

extern struct aml_area_linux_mmap_ops aml_area_linux_mmap_generic_ops;

struct aml_area_linux_data {
	struct aml_area_linux_manager_data manager;
	struct aml_area_linux_mbind_data mbind;
	struct aml_area_linux_mmap_data mmap;
};

struct aml_area_linux_ops {
	struct aml_area_linux_manager_ops manager;
	struct aml_area_linux_mbind_ops mbind;
	struct aml_area_linux_mmap_ops mmap;
};

struct aml_area_linux {
	struct aml_area_linux_data data;
	struct aml_area_linux_ops ops;
};

491 492 493 494 495 496 497 498 499 500 501
#define AML_AREA_LINUX_DECL(name) \
	struct aml_area_linux __ ##name## _inner_data; \
	struct aml_area name = { \
		&aml_area_linux_ops, \
		(struct aml_area_data *)&__ ## name ## _inner_data, \
	};

#define AML_AREA_LINUX_ALLOCSIZE \
	(sizeof(struct aml_area_linux) + \
	 sizeof(struct aml_area))

502 503 504
/* Linux memory area manager types, passed to Linux memory area's
   create()/init()/vinit() routines.  */
/* Single-arena manager.  */
505 506
#define AML_AREA_LINUX_MANAGER_TYPE_SINGLE 0

507 508 509
/* Linux memory area mbind types, passed to Linux memory area's
   create()/init()/vinit() routines.  */
/* Regular type using mbind() after mmap().  */
510
#define AML_AREA_LINUX_MBIND_TYPE_REGULAR 0
511 512
/* Calls set_mempolicy() before and after mmap() to change the memory policy
   globally.  */
513 514
#define AML_AREA_LINUX_MBIND_TYPE_MEMPOLICY 1

515 516 517
/* Linux memory area map types, passed to Linux memory area's
   create()/init()/vinit() routines.  */
/* Zero-initialized, anonymous mapping.  */
518
#define AML_AREA_LINUX_MMAP_TYPE_ANONYMOUS 0
519
/* Mapping using an existing file.  */
520
#define AML_AREA_LINUX_MMAP_TYPE_FD 1
521
/* Mapping using a newly created temporary file.  */
522 523
#define AML_AREA_LINUX_MMAP_TYPE_TMPFILE 2

524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
/*
 * Allocates and initializes a new Linux memory area.
 * "area": an address where the pointer to the newly allocated Linux memory area
 *         will be stored.
 * "manager_type": see AML_AREA_LINUX_MANAGER_TYPE_*.
 * "mbind_type": see AML_AREA_LINUX_MBIND_TYPE_*.
 * "mmap_type": see AML_AREA_LINUX_MMAP_TYPE_*.
 * Variadic arguments:
 * - "policy": an argument of type int; see aml_area_linux_mbind_init().
 * - "nodemask": an argument of type const unsigned long*;
 *               see aml_area_linux_mbind_init().
 * - if AML_AREA_LINUX_MMAP_TYPE_ANONYMOUS is passed as "mmap_type", no
 *   additional arguments are needed.
 * - if AML_AREA_LINUX_MMAP_TYPE_FD is passed as "mmap_type", two additional
 *   arguments are needed:
 *   - "fd": an argument of type int; see aml_area_linux_mmap_fd_init().
 *   - "offset": an argument of type off_t; see aml_area_linux_mmap_fd_init().
 * - if AML_AREA_LINUX_MMAP_TYPE_TMPFILE is passed as "mmap_type", two
 *   additional arguments are needed:
 *   - template: an argument of type char*; see
 *     aml_area_linux_mmap_tmpfile_init().
 *   - max: an argument of type size_t; see aml_area_linux_mmap_tmpfile_init().
 * Returns 0 if successful; an error code otherwise.
 */
548 549
int aml_area_linux_create(struct aml_area **area, int manager_type,
			  int mbind_type, int mmap_type, ...);
550 551 552 553 554 555 556 557
/*
 * Initializes a Linux memory area.  This is a varargs-variant of the
 * aml_area_linux_vinit() routine.
 * "area": an allocated Linux memory area structure.
 * "manager_type", "mbind_type", "mmap_type": see aml_area_linux_create().
 * Variadic arguments: see aml_area_linux_create().
 * Returns 0 if successful; an error code otherwise.
 */
558 559
int aml_area_linux_init(struct aml_area *area, int manager_type, int mbind_type,
			int mmap_type, ...);
560 561 562 563 564 565 566
/*
 * Initializes a Linux memory area.
 * "area": an allocated Linux memory area structure.
 * "manager_type", "mbind_type", "mmap_type": see aml_area_linux_create().
 * "args": see the variadic arguments of aml_area_linux_create().
 * Returns 0 if successful; an error code otherwise.
 */
567 568
int aml_area_linux_vinit(struct aml_area *area, int manager_type,
			 int mbind_type, int mmap_type, va_list args);
569 570 571 572 573
/*
 * Tears down an initialized Linux memory area.
 * "area": an initialized Linux memory area structure.
 * Returns 0 if successful; an error code otherwise.
 */
574
int aml_area_linux_destroy(struct aml_area *area);
575 576 577 578 579

/*******************************************************************************
 * Generic Area API:
 * Low-level, direct access to area logic.
 * For memory allocation function, follows the POSIX spec.
580
 ******************************************************************************/
581

582 583 584 585 586 587
/*
 * Allocates a new memory buffer from a memory area.
 * "area": an initialized memory area structure.
 * "size": the buffer size in bytes; if 0 is passed, NULL will be returned.
 * Returns a pointer to the newly allocated memory buffer; NULL if unsuccessful.
 */
588
void *aml_area_malloc(struct aml_area *area, size_t size);
589 590 591 592 593
/*
 * Releases a memory buffer back to the memory area.
 * "area": an initialized memory area structure.
 * "ptr": a pointer to the memory buffer or NULL (resulting in a no-op).
 */
594
void aml_area_free(struct aml_area *area, void *ptr);
595 596 597 598 599 600 601 602 603
/*
 * Allocates a new, zero-initialized memory buffer from a memory area.
 * "area": an initialized memory area structure.
 * "num": the number of elements of size "size" to allocate; if 0 is passed,
 *        NULL will be returned
 * "size": the size of each individual element to allocate, in bytes; if 0 is
 *         passed, NULL will be returned.
 * Returns a pointer to the newly allocated memory buffer; NULL if unsuccessful.
 */
604
void *aml_area_calloc(struct aml_area *area, size_t num, size_t size);
605 606 607 608 609 610 611 612
/*
 * Allocates a new, aligned, memory buffer from a memory area.
 * "area": an initialized memory area structure.
 * "align": an alignment for the returned pointer.
 * "size": the buffer size in bytes; if 0 is passed, NULL will be returned.
 * Returns a pointer to the newly allocated memory buffer; NULL if unsuccessful.
 */
void *aml_area_memalign(struct aml_area *area, size_t align, size_t size);
613 614 615 616 617 618 619 620 621
/*
 * Changes the size of a previously allocated memory buffer.
 * "area": an initialized memory area structure.
 * "ptr": a pointer to the memory buffer; if NULL is passed, acts just like
 *        aml_area_malloc().
 * "size": the new buffer size in bytes; if 0 is passed, acts just like
 *         aml_area_free() and returns NULL.
 * Returns a pointer to the resized memory buffer; NULL if unsuccessful.
 */
622
void *aml_area_realloc(struct aml_area *area, void *ptr, size_t size);
623
/* FIXME! */
624
void *aml_area_acquire(struct aml_area *area, size_t size);
625
/* FIXME! */
626
void aml_area_release(struct aml_area *area, void *ptr);
627 628 629 630 631 632 633 634 635 636
/*
 * Allocates a memory region from a Linux memory area, respecting memory policy
 * settings (see aml_area_linux_mbind_init()).
 * "area": an initialized memory area structure.
 * "ptr": an address where the new memory region should be allocated (hint only;
 *        can be NULL to let the kernel decide).
 * "size": the requested size of thew new memory region to allocate.
 * Returns the address of the newly allocated region or MAP_FAILED (see mmap(2))
 * if unsuccessful.
 */
637
void *aml_area_mmap(struct aml_area *area, void *ptr, size_t size);
638
/* FIXME! */
Kamil Iskra's avatar
Kamil Iskra committed
639
int aml_area_available(const struct aml_area *area);
640 641 642 643 644 645 646
/*
 * Creates a new binding structure based on an existing Linux memory area.
 * "area": an initialized memory area structure.
 * "binding": an address where the pointer to the newly allocated binding
 *            structure will be stored.
 * Returns 0 if successful; an error code otherwise.
 */
Kamil Iskra's avatar
Kamil Iskra committed
647
int aml_area_binding(const struct aml_area *area, struct aml_binding **binding);
648

649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
/*******************************************************************************
 * Tiling:
 * Representation of a data structure organization in memory.
 ******************************************************************************/

/* opaque handle to all tilings */
struct aml_tiling_data;
struct aml_tiling_iterator_data;

/*forward declarations */
struct aml_tiling_iterator_ops;
struct aml_tiling_iterator;


struct aml_tiling_ops {
664 665 666 667 668 669 670
	int (*create_iterator)(struct aml_tiling_data *tiling,
			       struct aml_tiling_iterator **iterator,
			       int flags);
	int (*init_iterator)(struct aml_tiling_data *tiling,
			     struct aml_tiling_iterator *iterator, int flags);
	int (*destroy_iterator)(struct aml_tiling_data *tiling,
				struct aml_tiling_iterator *iterator);
671
	int (*tileid)(const struct aml_tiling_data *tiling, va_list);
Kamil Iskra's avatar
Kamil Iskra committed
672 673 674
	size_t (*tilesize)(const struct aml_tiling_data *tiling, int tileid);
	void* (*tilestart)(const struct aml_tiling_data *tiling,
			   const void *ptr, int tileid);
675
	int (*ndims)(const struct aml_tiling_data *tiling, va_list);
676 677 678 679 680 681 682
};

struct aml_tiling {
	struct aml_tiling_ops *ops;
	struct aml_tiling_data *data;
};

683 684 685 686 687 688 689 690 691 692 693
/*
 * Provides the tile id of a tile.
 * "tiling": an initialized tiling structure.
 * Variadic arguments:
 *  - a list of size_t coordinates, one per dimension of the tiling.
 * Returns the id of the tile (that is, its order in memory), to use with other
 * functions.
 * Returns -1 in case of invalid coordinates.
 */
int aml_tiling_tileid(const struct aml_tiling *tiling, ...);

694 695 696 697 698 699 700
/*
 * Provides the information on the size of a tile.
 * "tiling": an initialized tiling structure.
 * "tileid": an identifier of a tile (a value between 0 and the number of tiles
 *           minus 1).
 * Returns the size of a tile.
 */
Kamil Iskra's avatar
Kamil Iskra committed
701
size_t aml_tiling_tilesize(const struct aml_tiling *tiling, int tileid);
702

703 704 705 706 707 708 709 710 711 712
/*
 * Provides the information on the location of a tile in memory.
 * "tiling": an initialized tiling structure.
 * "ptr": an address of the start of the complete user data structure that this
 *        tiling describes.
 * "tileid": an identifier of a tile (a value between 0 and the number of tiles
 *           minus 1).
 * Returns the address of the start of the tile identified by "tileid", within
 * the provided user data structure.
 */
Kamil Iskra's avatar
Kamil Iskra committed
713 714
void* aml_tiling_tilestart(const struct aml_tiling *tiling, const void *ptr,
			   int tileid);
715

716 717 718 719 720 721 722 723 724 725
/*
 * Provides the dimensions of the entire tiling in tiles.
 * "tiling": an initialized tiling structure.
 * Variadic arguments:
 *  - a list of (size_t *), one per dimension of the tiling.
 *  Will contain the size of each dimension in tiles upon return.
 * Returns 0 if successful, an error code otherwise.
 */
int aml_tiling_ndims(const struct aml_tiling *tiling, ...);

726 727 728 729 730 731 732 733
/*
 * Allocates and initializes a new tiling iterator.
 * "tiling": an initialized tiling structure.
 * "iterator": an address where the pointer to the newly allocated iterator
 *             structure will be stored.
 * "flags": reserved for future use; pass 0 for now.
 * Returns 0 if successful; an error code otherwise.
 */
734 735 736
int aml_tiling_create_iterator(struct aml_tiling *tiling,
			       struct aml_tiling_iterator **iterator,
			       int flags);
737 738 739 740 741 742 743
/*
 * Initializes a tiling iterator.
 * "tiling": an initialized tiling structure.
 * "iterator": an allocated tiling iterator structure.
 * "flags": reserved for future use; pass 0 for now.
 * Returns 0 if successful; an error code otherwise.
 */
744 745
int aml_tiling_init_iterator(struct aml_tiling *tiling,
			     struct aml_tiling_iterator *iterator, int flags);
746 747 748
/*
 * Tears down an initialized tiling iterator.
 * "tiling": an initialized tiling structure.
749
 * "iterator": an initialized tiling iterator structure.
750 751
 * Returns 0 if successful; an error code otherwise.
 */
752 753
int aml_tiling_destroy_iterator(struct aml_tiling *tiling,
				struct aml_tiling_iterator *iterator);
754 755

struct aml_tiling_iterator_ops {
756 757
	int (*reset)(struct aml_tiling_iterator_data *iterator);
	int (*next)(struct aml_tiling_iterator_data *iterator);
Kamil Iskra's avatar
Kamil Iskra committed
758 759 760
	int (*end)(const struct aml_tiling_iterator_data *iterator);
	int (*get)(const struct aml_tiling_iterator_data *iterator,
		   va_list args);
761 762 763 764 765 766 767
};

struct aml_tiling_iterator {
	struct aml_tiling_iterator_ops *ops;
	struct aml_tiling_iterator_data *data;
};

768 769
/*
 * Resets a tiling iterator to the first tile.
770
 * "iterator": an initialized tiling iterator structure.
771 772
 * Returns 0 if successful; an error code otherwise.
 */
773
int aml_tiling_iterator_reset(struct aml_tiling_iterator *iterator);
774 775
/*
 * Advances a tiling iterator to the next tile.
776
 * "iterator": an initialized tiling iterator structure.
777 778
 * Returns 0 if successful; an error code otherwise.
 */
779
int aml_tiling_iterator_next(struct aml_tiling_iterator *iterator);
780 781
/*
 * Checks whether the iterator is past the last tile.
782
 * "iterator": an initialized tiling iterator structure.
783 784 785
 * Returns 0 if the iterator points at a valid tile; 1 if it's past the last
 * tile.
 */
Kamil Iskra's avatar
Kamil Iskra committed
786
int aml_tiling_iterator_end(const struct aml_tiling_iterator *iterator);
787 788
/*
 * Queries the iterator.
789
 * "iterator": an initialized tiling iterator structure.
790 791 792 793 794
 * Variadic arguments:
 * - "x": an argument of type unsigned long*; on return gets filled with the
 *        identifier of the tile currently pointed to.
 * Returns 0 if successful; an error code otherwise.
 */
Kamil Iskra's avatar
Kamil Iskra committed
795
int aml_tiling_iterator_get(const struct aml_tiling_iterator *iterator, ...);
796

797 798
/* Tiling types passed to the tiling create()/init()/vinit() routines.  */
/* Regular, linear tiling with uniform tile sizes.  */
799
#define AML_TILING_TYPE_1D 0
800 801
#define AML_TILING_TYPE_2D_ROWMAJOR 1
#define AML_TILING_TYPE_2D_COLMAJOR 2
802

803 804 805 806 807 808 809 810 811 812
/*
 * Allocates and initializes a new tiling.
 * "tiling": an address where the pointer to the newly allocated tiling
 *           structure will be stored.
 * "type": see AML_TILING_TYPE_*.
 * Variadic arguments:
 * - if "type" equals AML_TILING_TYPE_1D, two additional arguments are needed:
 *   - "tilesize": an argument of type size_t; provides the size of each tile.
 *   - "totalsize": an argument of type size_t; provides the size of the
 *                  complete user data structure to be tiled.
813 814
 * - if "type" equals AML_TILING_TYPE_2D, four additional arguments are needed:
 *   - "tilesize": an argument of type size_t; provides the size of a tile.
815 816
 *   - "totalsize": an argument of type size_t; provides the size of the
 *                  complete user data structure to be tiled.
817 818
 *   - "rowsize": an argument of type size_t; the number of tiles in a row
 *   - "colsize": an argument of type size_t; the number of tiles in a column
819 820
 * Returns 0 if successful; an error code otherwise.
 */
821
int aml_tiling_create(struct aml_tiling **tiling, int type, ...);
822 823 824 825 826 827 828 829
/*
 * Initializes a tiling.  This is a varargs-variant of the aml_tiling_vinit()
 * routine.
 * "tiling": an allocated tiling structure.
 * "type": see aml_tiling_create().
 * Variadic arguments: see aml_tiling_create().
 * Returns 0 if successful; an error code otherwise.
 */
830
int aml_tiling_init(struct aml_tiling *tiling, int type, ...);
831 832 833 834 835 836 837
/*
 * Initializes a tiling.
 * "tiling": an allocated tiling structure.
 * "type": see aml_tiling_create().
 * "args": see the variadic arguments of aml_tiling_create().
 * Returns 0 if successful; an error code otherwise.
 */
838
int aml_tiling_vinit(struct aml_tiling *tiling, int type, va_list args);
839 840 841 842 843 844
/*
 * Tears down an initialized tiling.
 * "tiling": an initialized tiling structure.
 * "type": see aml_tiling_create().
 * Returns 0 if successful; an error code otherwise.
 */
845
int aml_tiling_destroy(struct aml_tiling *tiling, int type);
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884

/*******************************************************************************
 * Tiling 1D:
 ******************************************************************************/

extern struct aml_tiling_ops aml_tiling_1d_ops;
extern struct aml_tiling_iterator_ops aml_tiling_iterator_1d_ops;

struct aml_tiling_1d_data {
	size_t blocksize;
	size_t totalsize;
};

struct aml_tiling_iterator_1d_data {
	size_t i;
	struct aml_tiling_1d_data *tiling;
};

#define AML_TILING_1D_DECL(name) \
	struct aml_tiling_1d_data __ ##name## _inner_data; \
	struct aml_tiling name = { \
		&aml_tiling_1d_ops, \
		(struct aml_tiling_data *)&__ ## name ## _inner_data, \
	};

#define AML_TILING_ITERATOR_1D_DECL(name) \
	struct aml_tiling_iterator_1d_data __ ##name## _inner_data; \
	struct aml_tiling_iterator name = { \
		&aml_tiling_iterator_1d_ops, \
		(struct aml_tiling_iterator_data *)&__ ## name ## _inner_data, \
	};

#define AML_TILING_1D_ALLOCSIZE (sizeof(struct aml_tiling_1d_data) + \
				 sizeof(struct aml_tiling))

#define AML_TILING_ITERATOR_1D_ALLOCSIZE \
	(sizeof(struct aml_tiling_iterator_1d_data) + \
	 sizeof(struct aml_tiling_iterator))

885 886
/*******************************************************************************
 * Tiling 2D:
887
 * a contiguous memory area composed of contiguous tiles arranged in 2D grid.
888 889
 ******************************************************************************/

890 891
extern struct aml_tiling_ops aml_tiling_2d_rowmajor_ops;
extern struct aml_tiling_ops aml_tiling_2d_colmajor_ops;
892 893 894 895 896
extern struct aml_tiling_iterator_ops aml_tiling_iterator_2d_ops;

struct aml_tiling_2d_data {
	size_t blocksize;
	size_t totalsize;
897
	size_t ndims[2]; /* # number of rows, # number of cols (in tiles) */
898 899 900 901 902 903 904
};

struct aml_tiling_iterator_2d_data {
	size_t i;
	struct aml_tiling_2d_data *tiling;
};

905 906 907 908 909 910 911 912
#define AML_TILING_2D_ROWMAJOR_DECL(name) \
	struct aml_tiling_2d_data __ ##name## _inner_data; \
	struct aml_tiling name = { \
		&aml_tiling_2d_rowmajor_ops, \
		(struct aml_tiling_data *)&__ ## name ## _inner_data, \
	};

#define AML_TILING_2D_COLMAJOR_DECL(name) \
913 914
	struct aml_tiling_2d_data __ ##name## _inner_data; \
	struct aml_tiling name = { \
915
		&aml_tiling_2d_colmajor_ops, \
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
		(struct aml_tiling_data *)&__ ## name ## _inner_data, \
	};

#define AML_TILING_ITERATOR_2D_DECL(name) \
	struct aml_tiling_iterator_2d_data __ ##name## _inner_data; \
	struct aml_tiling_iterator name = { \
		&aml_tiling_iterator_2d_ops, \
		(struct aml_tiling_iterator_data *)&__ ## name ## _inner_data, \
	};

#define AML_TILING_2D_ALLOCSIZE (sizeof(struct aml_tiling_2d_data) + \
				 sizeof(struct aml_tiling))

#define AML_TILING_ITERATOR_2D_ALLOCSIZE \
	(sizeof(struct aml_tiling_iterator_2d_data) + \
	 sizeof(struct aml_tiling_iterator))

933 934 935 936 937 938 939 940 941
/*******************************************************************************
 * Binding:
 * Representation of page bindings in an area
 ******************************************************************************/

/* opaque handle to all bindings */
struct aml_binding_data;

struct aml_binding_ops {
Kamil Iskra's avatar
Kamil Iskra committed
942 943 944 945 946 947 948 949 950
	int (*nbpages)(const struct aml_binding_data *binding,
		       const struct aml_tiling *tiling, const void *ptr,
		       int tileid);
	int (*pages)(const struct aml_binding_data *binding, void **pages,
		     const struct aml_tiling *tiling, const void *ptr,
		     int tileid);
	int (*nodes)(const struct aml_binding_data *binding, int *nodes,
		     const struct aml_tiling *tiling, const void *ptr,
		     int tileid);
951 952 953 954 955 956 957
};

struct aml_binding {
	struct aml_binding_ops *ops;
	struct aml_binding_data *data;
};

958 959
/*
 * Provides the size of a tile in memory, in pages.
960
 * "binding": an initialized binding structure.
961 962 963 964 965
 * "tiling": an initialized tiling structure.
 * "ptr", "tileid": see aml_tiling_tilestart().
 * Returns the total number of pages that a tile occupies, including partial
 * pages.
 */
Kamil Iskra's avatar
Kamil Iskra committed
966 967 968
int aml_binding_nbpages(const struct aml_binding *binding,
			const struct aml_tiling *tiling,
			const void *ptr, int tileid);
969 970
/*
 * Provides the addresses of pages that a tile occupies.
971
 * "binding": an initialized binding structure.
972 973 974 975 976 977 978
 * "pages": an array that will be filled with start addresses of all pages
 *          that a tile occupies.  The array must be at least
 *          aml_binding_nbpages() elements long.
 * "tiling": an initialized tiling structure.
 * "ptr", "tileid": see aml_tiling_tilestart().
 * Returns 0 if successful; an error code otherwise.
 */
Kamil Iskra's avatar
Kamil Iskra committed
979 980 981
int aml_binding_pages(const struct aml_binding *binding, void **pages,
		      const struct aml_tiling *tiling, const void *ptr,
		      int tileid);
982 983
/*
 * Provides the NUMA node information of pages that a tile occupies.
984
 * "binding": an initialized binding structure.
985 986 987 988 989 990 991
 * "nodes": an array that will be filled with NUMA node id's of all pages
 *          that a tile occupies.  The array must be at least
 *          aml_binding_nbpages() elements long.
 * "tiling": an initialized tiling structure.
 * "ptr", "tileid": see aml_tiling_tilestart().
 * Returns 0 if successful; an error code otherwise.
 */
Kamil Iskra's avatar
Kamil Iskra committed
992 993 994
int aml_binding_nodes(const struct aml_binding *binding, int *nodes,
		      const struct aml_tiling *tiling, const void *ptr,
		      int tileid);
995

996 997
/* Binding types passed to the binding create()/init()/vinit() routines.  */
/* Binding where all pages are bound to the same NUMA node.  */
998
#define AML_BINDING_TYPE_SINGLE 0
999
/* Binding where pages are interleaved among multiple NUMA nodes.  */
1000 1001
#define AML_BINDING_TYPE_INTERLEAVE 1

1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
/*
 * Allocates and initializes a new binding.
 * "binding": an address where the pointer to the newly allocated binding
 *            structure will be stored.
 * "type": see AML_BINDING_TYPE_*.
 * Variadic arguments:
 * - if "type" equals AML_BINDING_TYPE_SINGLE, one additional argument is
 *   needed:
 *   - "node": an argument of type int; provides a NUMA node id where pages
 *             will be allocated from.
 * - if "type" equals AML_BINDING_TYPE_INTERLEAVE, one additional argument is
 *   needed:
1014
 *   - "mask": an argument of type const struct aml_bitmap*; storing a bitmask of
1015
 *             NUMA node ids where pages will be allocated from.  See
1016
 *             aml_bitmap for more information.
1017 1018
 * Returns 0 if successful; an error code otherwise.
 */
1019
int aml_binding_create(struct aml_binding **binding, int type, ...);
1020 1021 1022 1023 1024 1025 1026 1027
/*
 * Initializes a new binding.  This is a varags-variant of the
 * aml_binding_vinit() routine.
 * "binding": an allocated binding structure.
 * "type": see aml_binding_create().
 * Variadic arguments: see aml_binding_create().
 * Returns 0 if successful; an error code otherwise.
 */
1028
int aml_binding_init(struct aml_binding *binding, int type, ...);
1029 1030 1031 1032 1033 1034 1035
/*
 * Initializes a new binding.
 * "binding": an allocated binding structure.
 * "type": see aml_binding_create().
 * "args": see the variadic arguments of aml_binding_create().
 * Returns 0 if successful; an error code otherwise.
 */
1036
int aml_binding_vinit(struct aml_binding *binding, int type, va_list args);
1037 1038 1039 1040 1041 1042
/*
 * Tears down an initialized binding.
 * "binding": an initialized binding structure.
 * "type": see aml_binding_create().
 * Returns 0 if successful; an error code otherwise.
 */
1043
int aml_binding_destroy(struct aml_binding *binding, int type);
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070

/*******************************************************************************
 * Single Binding:
 * All pages on the same node
 ******************************************************************************/

extern struct aml_binding_ops aml_binding_single_ops;

struct aml_binding_single_data {
	int node;
};

#define AML_BINDING_SINGLE_DECL(name) \
	struct aml_binding_single_data __ ##name## _inner_data; \
	struct aml_binding name = { \
		&aml_binding_single_ops, \
		(struct aml_binding_data *)&__ ## name ## _inner_data, \
	};

#define AML_BINDING_SINGLE_ALLOCSIZE (sizeof(struct aml_binding_single_data) + \
				      sizeof(struct aml_binding))

/*******************************************************************************
 * Interleave Binding:
 * each page, of each tile, interleaved across nodes.
 ******************************************************************************/

1071 1072
#define AML_MAX_NUMA_NODES AML_BITMAP_MAX

1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
extern struct aml_binding_ops aml_binding_interleave_ops;

struct aml_binding_interleave_data {
	int nodes[AML_MAX_NUMA_NODES];
	int count;
};

#define AML_BINDING_INTERLEAVE_DECL(name) \
	struct aml_binding_interleave_data __ ##name## _inner_data; \
	struct aml_binding name = { \
		&aml_binding_interleave_ops, \
		(struct aml_binding_data *)&__ ## name ## _inner_data, \
	};

#define AML_BINDING_INTERLEAVE_ALLOCSIZE \
	(sizeof(struct aml_binding_interleave_data) + \
	 sizeof(struct aml_binding))

1091 1092 1093 1094 1095
/*******************************************************************************
 * DMA:
 * Management of low-level movement of memory.
 ******************************************************************************/

1096 1097
/* Internal macros used for tracking DMA request types.  */
/* Invalid request type.  Used for marking inactive requests in the vector.  */
1098
#define AML_DMA_REQUEST_TYPE_INVALID -1
1099
/* Copy request type.  Uses memcpy() for data migration.  */
1100
#define AML_DMA_REQUEST_TYPE_COPY 0
1101
/* Move request type.  Uses move_pages() for data migration.  */
1102 1103
#define AML_DMA_REQUEST_TYPE_MOVE 1

1104
struct aml_dma_request;
1105 1106 1107
struct aml_dma_data;

struct aml_dma_ops {
1108
	int (*create_request)(struct aml_dma_data *dma,
1109
			      struct aml_dma_request **req, int type,
1110 1111 1112 1113 1114
			      va_list args);
	int (*destroy_request)(struct aml_dma_data *dma,
			       struct aml_dma_request *req);
	int (*wait_request)(struct aml_dma_data *dma,
			    struct aml_dma_request *req);
1115 1116 1117 1118 1119 1120 1121
};

struct aml_dma {
	struct aml_dma_ops *ops;
	struct aml_dma_data *data;
};

1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
/*
 * Requests a synchronous data copy between two different tiles, using
 * memcpy() or equivalent.
 * "dma": an initialized DMA structure.
 * Variadic arguments:
 * - "dt": an argument of type struct aml_tiling*; the destination tiling
 *         structure.
 * - "dptr": an argument of type void*; the start address of the complete
 *           destination user data structure.
 * - "dtid": an argument of type int; the destination tile identifier.
 * - "st": an argument of type struct aml_tiling*; the source tiling structure.
 * - "sptr": an argument of type void*; the start address of the complete
 *           source user data structure.
 * - "stid": an argument of type int; the source tile identifier.
 * Returns 0 if successful; an error code otherwise.
 */
1138
int aml_dma_copy(struct aml_dma *dma, ...);
1139 1140 1141 1142 1143 1144 1145 1146 1147
/*
 * Requests a data copy between two different tiles.  This is an asynchronous
 * version of aml_dma_copy().
 * "dma": an initialized DMA structure.
 * "req": an address where the pointer to the newly assigned DMA request will be
 *        stored.
 * Variadic arguments: see aml_dma_copy().
 * Returns 0 if successful; an error code otherwise.
 */
1148
int aml_dma_async_copy(struct aml_dma *dma, struct aml_dma_request **req, ...);
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
/*
 * Requests a synchronous data move of a tile to a new memory area, using
 * move_pages() or equivalent.
 * "dma": an initialized DMA structure.
 * Variadic arguments:
 * - "darea": an argument of type struct aml_area*; the destination memory area
 *         structure.
 * - "st": an argument of type struct aml_tiling*; the tiling structure.
 * - "sptr": an argument of type void*; the start address of the complete
 *           user data structure.
 * - "stid": an argument of type int; the tile identifier.
 * Returns 0 if successful; an error code otherwise.
 */
1162
int aml_dma_move(struct aml_dma *dma, ...);
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
/*
 * Requests a data move of a tile to a new memory area.  This is an asynchronous
 * version of aml_dma_move().
 * "dma": an initialized DMA structure.
 * "req": an address where the pointer to the newly assigned DMA request will be
 *        stored.
 * Variadic arguments: see aml_dma_move().
 * Returns 0 if successful; an error code otherwise.
 *
 */
1173
int aml_dma_async_move(struct aml_dma *dma, struct aml_dma_request **req, ...);
1174 1175 1176 1177 1178 1179
/*
 * Waits for an asynchronous DMA request to complete.
 * "dma": an initialized DMA structure.
 * "req": a DMA request obtained using aml_dma_async_*() calls.
 * Returns 0 if successful; an error code otherwise.
 */
1180
int aml_dma_wait(struct aml_dma *dma, struct aml_dma_request *req);
1181 1182 1183 1184 1185 1186
/*
 * Tears down an asynchronous DMA request before it completes.
 * "dma": an initialized DMA structure.
 * "req": a DMA request obtained using aml_dma_async_*() calls.
 * Returns 0 if successful; an error code otherwise.
 */
1187
int aml_dma_cancel(struct aml_dma *dma, struct aml_dma_request *req);
1188

1189 1190
/*******************************************************************************
 * Scratchpad:
1191
 * Use an area to stage data from another area in and out.
1192 1193 1194 1195 1196 1197
 * A dma handles the movement itself.
 ******************************************************************************/

struct aml_scratch_request;
struct aml_scratch_data;

1198 1199
/* Internal macros used for tracking scratchpad request types.  */
/* Invalid request type.  Used for marking inactive requests in the vector.  */
1200
#define AML_SCRATCH_REQUEST_TYPE_INVALID -1
1201
/* Push from the scratchpad to regular memory.  */
1202
#define AML_SCRATCH_REQUEST_TYPE_PUSH 0
1203
/* Pull from regular memory to the scratchpad.  */
1204
#define AML_SCRATCH_REQUEST_TYPE_PULL 1
1205 1206
/* No-op/empty request */
#define AML_SCRATCH_REQUEST_TYPE_NOOP 2
1207 1208 1209 1210 1211 1212 1213 1214 1215

struct aml_scratch_ops {
	int (*create_request)(struct aml_scratch_data *scratch,
			      struct aml_scratch_request **req, int type,
			      va_list args);
	int (*destroy_request)(struct aml_scratch_data *scratch,
			       struct aml_scratch_request *req);
	int (*wait_request)(struct aml_scratch_data *scratch,
			    struct aml_scratch_request *req);
1216
	void *(*baseptr)(const struct aml_scratch_data *scratch);
1217
	int (*release)(struct aml_scratch_data *scratch, int scratchid);
1218 1219 1220 1221 1222 1223 1224
};

struct aml_scratch {
	struct aml_scratch_ops *ops;
	struct aml_scratch_data *data;
};

1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
/*
 * Requests a synchronous pull from regular memory to the scratchpad.
 * "scratch": an initialized scratchpad structure.
 * Variadic arguments:
 * - "scratchptr": an argument of type void*; the scratchpad base pointer (see
 *                 aml_scratch_baseptr()).
 * - "scratchid": an argument of type int*; gets filled with the scratch tile
 *                identifier where the data will be pulled into.
 * - "srcptr": an argument of type void*; the start address of the complete
 *             source user data structure.
 * - "srcid": an argument of type int; the source tile identifier.
 * Returns 0 if successful; an error code otherwise.
 */
1238
int aml_scratch_pull(struct aml_scratch *scratch, ...);
1239 1240 1241 1242 1243 1244 1245 1246 1247
/*
 * Requests a pull from regular memory to the scratchpad.  This is an
 * asynchronous version of aml_scratch_pull().
 * "scratch": an initialized scratchpad structure.
 * "req": an address where the pointer to the newly assigned scratch request
 *        will be stored.
 * Variadic arguments: see aml_scratch_pull().
 * Returns 0 if successful; an error code otherwise.
 */
1248 1249
int aml_scratch_async_pull(struct aml_scratch *scratch,
			   struct aml_scratch_request **req, ...);
1250 1251 1252 1253
/*
 * Requests a synchronous push from the scratchpad to regular memory.
 * "scratch": an initialized scratchpad structure.
 * Variadic arguments:
1254 1255 1256
 * - "dstptr": an argument of type void*; the start address of the complete
 *             destination user data structure.
 * - "dstid": an argument of type int*; gets filled with the destination tile
1257 1258 1259 1260 1261 1262 1263
 *            identifier where the data will be pushed into (and where it was
 *            pulled from in the first place).
 * - "scratchptr": an argument of type void*; the scratchpad base pointer (see
 *                 aml_scratch_baseptr()).
 * - "scratchid": an argument of type int; the scratchpad tile identifier.
 * Returns 0 if successful; an error code otherwise.
 */
1264
int aml_scratch_push(struct aml_scratch *scratch, ...);
1265 1266 1267 1268 1269 1270 1271 1272 1273
/*
 * Requests a push from the scratchpad to regular memory.  This is an
 * asynchronous version of aml_scratch_push().
 * "scratch": an initialized scratchpad structure.
 * "req": an address where the pointer to the newly assigned scratch request
 *        will be stored.
 * Variadic arguments: see aml_scratch_push().
 * Returns 0 if successful; an error code otherwise.
 */
1274 1275
int aml_scratch_async_push(struct aml_scratch *scratch,
			   struct aml_scratch_request **req, ...);
1276 1277 1278 1279 1280 1281
/*
 * Waits for an asynchronous scratch request to complete.
 * "scratch": an initialized scratchpad structure.
 * "req": a scratch request obtained using aml_scratch_async_*() calls.
 * Returns 0 if successful; an error code otherwise.
 */
1282 1283
int aml_scratch_wait(struct aml_scratch *scratch,
		     struct aml_scratch_request *req);
1284

1285 1286
/*
 * Tears down an asynchronous scratch request before it completes.
1287
 * "scratch": an initialized scratchpad structure.
1288 1289 1290
 * "req": a scratch request obtained using aml_scratch_async_*() calls.
 * Returns 0 if successful; an error code otherwise.
 */
1291 1292
int aml_scratch_cancel(struct aml_scratch *scratch,
		       struct aml_scratch_request *req);
1293 1294
/*
 * Provides the location of the scratchpad.
1295
 * "scratch": an initialized scratchpad structure.
1296 1297
 * Returns a base pointer to the scratchpad memory buffer.
 */
1298
void* aml_scratch_baseptr(const struct aml_scratch *scratch);
1299

1300 1301 1302
/*
 * Release a scratch tile for immediate reuse.
 * "scratch": an initialized scratchpad structure.
1303 1304
 * "scratchid": a scratchpad tile identifier.
 * Returns 0 if successful; an error code otherwise.
1305 1306 1307
 */
int aml_scratch_release(struct aml_scratch *scratch, int scratchid);

1308 1309
/*******************************************************************************
 * Sequential scratchpad API:
1310
 * Scratchpad uses calling thread to trigger asynchronous dma movements.
1311 1312 1313 1314 1315 1316
 ******************************************************************************/

extern struct aml_scratch_ops aml_scratch_seq_ops;

struct aml_scratch_request_seq {
	int type;
1317
	struct aml_tiling *tiling;
1318 1319 1320 1321 1322 1323 1324 1325
	void *srcptr;
	int srcid;
	void *dstptr;
	int dstid;
	struct aml_dma_request *dma_req;
};

struct aml_scratch_seq_data {
1326 1327
	struct aml_area *src_area, *sch_area;
	struct aml_tiling *tiling;
1328
	struct aml_dma *dma;
1329
	void * sch_ptr;
1330 1331
	struct aml_vector tilemap;
	struct aml_vector requests;
1332
	pthread_mutex_t lock;
1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
};

struct aml_scratch_seq_ops {
	int (*doit)(struct aml_scratch_seq_data *scratch,
		    struct aml_scratch_request_seq *req);
};

struct aml_scratch_seq {
	struct aml_scratch_seq_ops ops;
	struct aml_scratch_seq_data data;
};

#define AML_SCRATCH_SEQ_DECL(name) \
	struct aml_scratch_seq __ ##name## _inner_data; \
	struct aml_scratch name = { \
		&aml_scratch_seq_ops, \
		(struct aml_scratch_data *)&__ ## name ## _inner_data, \
	};

#define AML_SCRATCH_SEQ_ALLOCSIZE \
	(sizeof(struct aml_scratch_seq) + \
	 sizeof(struct aml_scratch))

1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
/*
 * Allocates and initializes a new sequential scratchpad.
 * "scratch": an address where the pointer to the newly allocated scratchpad
 *            structure will be stored.
 * Variadic arguments:
 * - "scratch_area": an argument of type struct aml_area*; the memory area
 *                   where the scratchpad will be allocated from.
 * - "source_area": an argument of type struct aml_area*; the memory area
 *                  containing the user data structure.
 * - "dma": an argument of type struct aml_dma*; the DMA that will be used for
 *          migrating data to and from the scratchpad.
 * - "tiling": an argument of type struct aml_tiling*; the tiling to use on the
 *             user data structure and the scratchpad.
 * - "nbtiles": an argument of type size_t; number of tiles to divide the
 *              scratchpad into.
 * - "nbreqs": an argument of type size_t; the initial number of slots for
 *             asynchronous request that are in-flight (will be increased
 *             automatically if necessary).
 * Returns 0 if successful; an error code otherwise.
 */
1376
int aml_scratch_seq_create(struct aml_scratch **scratch, ...);
1377 1378
/*
 * Initializes a new sequential scratchpad.  This is a varargs-variant of the
1379
 * aml_scratch_seq_vinit() routine.
1380 1381 1382 1383
 * "scratch": an allocated scratchpad structure.
 * Variadic arguments: see aml_scratch_seq_create().
 * Returns 0 if successful; an error code otherwise.
 */
1384
int aml_scratch_seq_init(struct aml_scratch *scratch, ...);
1385 1386 1387 1388 1389 1390
/*
 * Initializes a new sequential scratchpad.
 * "scratch": an allocated scratchpad structure.
 * "args": see the variadic arguments of see aml_scratch_seq_create().
 * Returns 0 if successful; an error code otherwise.
 */
1391
int aml_scratch_seq_vinit(struct aml_scratch *scratch, va_list args);
1392 1393 1394 1395 1396
/*
 * Tears down an initialized sequential scratchpad.
 * "scratch": an initialized scratchpad structure.
 * Returns 0 if successful; an error code otherwise.
 */
1397
int aml_scratch_seq_destroy(struct aml_scratch *scratch);
1398

1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
/*******************************************************************************
 * Parallel scratchpad API:
 * Scratchpad creates one thread to trigger synchronous dma movements.
 ******************************************************************************/

extern struct aml_scratch_ops aml_scratch_par_ops;

struct aml_scratch_request_par {
	int type;
	void *srcptr;
	int srcid;
	void *dstptr;
	int dstid;
	struct aml_scratch_par *scratch;
	pthread_t thread;
};

struct aml_scratch_par_data {
	struct aml_area *src_area, *sch_area;
	struct aml_tiling *tiling;
	struct aml_dma *dma;
	void * sch_ptr;
	struct aml_vector tilemap;
	struct aml_vector requests;
1423
	pthread_mutex_t lock;
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445
};

struct aml_scratch_par_ops {
	void *(*do_thread)(void *);
};

struct aml_scratch_par {
	struct aml_scratch_par_ops ops;
	struct aml_scratch_par_data data;
};

#define AML_SCRATCH_PAR_DECL(name) \
	struct aml_scratch_par __ ##name## _inner_data; \
	struct aml_scratch name = { \
		&aml_scratch_par_ops, \
		(struct aml_scratch_data *)&__ ## name ## _inner_data, \
	};

#define AML_SCRATCH_PAR_ALLOCSIZE \
	(sizeof(struct aml_scratch_par) + \
	 sizeof(struct aml_scratch))

1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465
/*
 * Allocates and initializes a new parallel scratchpad.
 * "scratch": an address where the pointer to the newly allocated scratchpad
 *            structure will be stored.
 * Variadic arguments:
 * - "scratch_area": an argument of type struct aml_area*; the memory area
 *                   where the scratchpad will be allocated from.
 * - "source_area": an argument of type struct aml_area*; the memory area
 *                  containing the user data structure.
 * - "dma": an argument of type struct aml_dma*; the DMA that will be used for
 *          migrating data to and from the scratchpad.
 * - "tiling": an argument of type struct aml_tiling*; the tiling to use on the
 *             user data structure and the scratchpad.
 * - "nbtiles": an argument of type size_t; number of tiles to divide the
 *              scratchpad into.
 * - "nbreqs": an argument of type size_t; the initial number of slots for
 *             asynchronous request that are in-flight (will be increased
 *             automatically if necessary).
 * Returns 0 if successful; an error code otherwise.
 */
1466
int aml_scratch_par_create(struct aml_scratch **scratch, ...);
1467 1468
/*
 * Initializes a new parallel scratchpad.  This is a varargs-variant of the
1469
 * aml_scratch_par_vinit() routine.
1470 1471 1472 1473
 * "scratch": an allocated scratchpad structure.
 * Variadic arguments: see aml_scratch_par_create().
 * Returns 0 if successful; an error code otherwise.
 */
1474
int aml_scratch_par_init(struct aml_scratch *scratch, ...);
1475 1476 1477 1478 1479 1480
/*
 * Initializes a new parallel scratchpad.
 * "scratch": an allocated scratchpad structure.
 * "args": see the variadic arguments of see aml_scratch_par_create().
 * Returns 0 if successful; an error code otherwise.
 */
1481
int aml_scratch_par_vinit(struct aml_scratch *scratch, va_list args);
1482 1483 1484 1485 1486
/*
 * Tears down an initialized parallel scratchpad.
 * "scratch": an initialized scratchpad structure.
 * Returns 0 if successful; an error code otherwise.
 */
1487 1488
int aml_scratch_par_destroy(struct aml_scratch *scratch);

1489 1490 1491 1492
/*******************************************************************************
 * General functions:
 * Initialize internal structures, cleanup everything at the end.
 ******************************************************************************/
1493

1494 1495 1496 1497 1498 1499
/*
 * Initializes the library.
 * "argc": pointer to the main()'s argc argument; contents can get modified.
 * "argv": pointer to the main()'s argv argument; contents can get modified.
 * Returns 0 if successful; an error code otherwise.
 */
1500
int aml_init(int *argc, char **argv[]);
1501 1502 1503 1504
/*
 * Terminates the library.
 * Returns 0 if successful; an error code otherwise.
 */
1505
int aml_finalize(void);
1506

1507
#endif