aml.h 50.1 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/version.h>
33
#include <aml/utils/bitmap.h>
34 35
#include <aml/utils/vector.h>

36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
/*******************************************************************************
 * General functions:
 * Initialize internal structures, cleanup everything at the end.
 ******************************************************************************/

/*
 * 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.
 */
int aml_init(int *argc, char **argv[]);
/*
 * Terminates the library.
 * Returns 0 if successful; an error code otherwise.
 */
int aml_finalize(void);
53

54 55 56 57 58
/*******************************************************************************
 * Forward Declarations:
 ******************************************************************************/

struct aml_area;
59
struct aml_binding;
60 61 62

/*******************************************************************************
 * Arenas:
63 64
 * In-memory allocator implementation. Dispatches actual memory mappings back to
 * areas.
65 66
 ******************************************************************************/

67
/* Arena Flags: access to useful jemalloc flags, with the same values. */
68
/* If passed as a flag to arena's mallocx()/reallocx() routines, the newly
69 70
 * allocated memory will be 0-initialized. */
#define AML_ARENA_FLAG_ZERO ((int)0x40)
71 72
/* As a flag to arena mallocx/reallocx, will align on (1<<a). */
#define AML_ARENA_FLAG_ALIGN(a) ((int)(a))
73 74 75 76 77

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

struct aml_arena_ops {
78 79 80 81 82 83 84
	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);
85 86
};

87
struct aml_arena {
88 89
	struct aml_arena_ops *ops;
	struct aml_arena_data *data;
90 91
};

92 93 94 95 96 97 98
/*
 * 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.
 */
99
int aml_arena_register(struct aml_arena *arena, struct aml_area *area);
100 101 102 103 104 105 106
/*
 * 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.
 */
107
int aml_arena_deregister(struct aml_arena *arena);
108 109 110 111 112 113 114
/*
 * 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.
 */
115
void *aml_arena_mallocx(struct aml_arena *arena, size_t size, int flags);
116 117 118 119 120 121
/*
 * 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).
 */
122
void aml_arena_dallocx(struct aml_arena *arena, void *ptr, int flags);
123 124 125 126 127 128 129 130 131 132
/*
 * 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.
 */
133 134
void *aml_arena_reallocx(struct aml_arena *arena, void *ptr, size_t size,
			 int flags);
135 136 137 138 139 140 141 142 143 144

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

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

146 147 148 149 150 151 152 153 154 155 156
#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))

157 158
/* Arena types passed to jemalloc arena's create()/init()/vinit() routines.  */
/* Standard arena type.  */
159
#define AML_ARENA_JEMALLOC_TYPE_REGULAR 0
160
/* Arena type allocating memory-aligned buffers.  */
161
#define AML_ARENA_JEMALLOC_TYPE_ALIGNED 1
162
/* Arena type identical to an existing arena.  */
163 164
#define AML_ARENA_JEMALLOC_TYPE_GENERIC 2

165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
/*
 * 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.
 */
180
int aml_arena_jemalloc_create(struct aml_arena **arena, int type, ...);
181 182
/*
 * Initializes a jemalloc arena.  This is a varargs-variant of the
183
 * aml_arena_jemalloc_vinit() routine.
184 185 186 187 188
 * "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.
 */
189
int aml_arena_jemalloc_init(struct aml_arena *arena, int type, ...);
190 191 192 193 194 195 196
/*
 * 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.
 */
197
int aml_arena_jemalloc_vinit(struct aml_arena *arena, int type, va_list args);
198 199 200 201 202
/*
 * Tears down an initialized jemalloc arena.
 * "arena": an initialized jemalloc arena structure.
 * Returns 0 if successful; an error code otherwise.
 */
203
int aml_arena_jemalloc_destroy(struct aml_arena *arena);
204

205 206
/*******************************************************************************
 * Areas:
207
 * embeds information about a byte-addressable physical memory location as well
208 209
 * as binding policies over it.
 ******************************************************************************/
210

211 212 213 214
/* opaque handle to configuration data */
struct aml_area_data;

struct aml_area_ops {
215 216 217
	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);
218
	void *(*memalign)(struct aml_area_data *area, size_t align, size_t size);
219 220 221 222
	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
223 224
	int (*available)(const struct aml_area_data *area);
	int (*binding)(const struct aml_area_data *area,
225
		       struct aml_binding **binding);
226 227
};

228
struct aml_area {
229 230
	struct aml_area_ops *ops;
	struct aml_area_data *data;
231 232
};

233 234 235 236 237 238 239 240
/*******************************************************************************
 * POSIX Area:
 ******************************************************************************/

extern struct aml_area_ops aml_area_posix_ops;

struct aml_area_posix_data {
};
241

242 243 244 245 246 247 248 249 250 251 252
#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))

253 254 255 256 257 258
/*
 * 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.
 */
259
int aml_area_posix_create(struct aml_area **area);
260 261 262 263 264
/*
 * Initializes a POSIX memory area.
 * "area": an allocated POSIX memory area structure.
 * Returns 0 if successful; an error code otherwise.
 */
265
int aml_area_posix_vinit(struct aml_area *area);
266 267 268 269 270 271
/*
 * 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.
 */
272
int aml_area_posix_init(struct aml_area *area);
273 274 275 276 277
/*
 * Tears down an initialized POSIX memory area.
 * "area": an initialized POSIX memory area structure.
 * Returns 0 if successful; an error code otherwise.
 */
278
int aml_area_posix_destroy(struct aml_area *area);
279 280

/*******************************************************************************
281 282 283 284 285 286 287 288 289 290 291
 * 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
292
	struct aml_arena *(*get_arena)(const struct aml_area_linux_manager_data *data);
293 294 295 296
};

extern struct aml_area_linux_manager_ops aml_area_linux_manager_single_ops;

297 298 299 300 301 302 303
/*
 * 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.
 */
304 305
int aml_area_linux_manager_single_init(struct aml_area_linux_manager_data *data,
				       struct aml_arena *arena);
306 307 308 309 310
/*
 * Tears down an initialized Linux memory area manager.
 * "data": an initialized Linux manager structure.
 * Returns 0 if successful; an error code otherwise.
 */
311
int aml_area_linux_manager_single_destroy(struct aml_area_linux_manager_data *data);
312 313

struct aml_area_linux_mbind_data {
314
	struct aml_bitmap nodemask;
315 316 317 318
	int policy;
};

struct aml_area_linux_mbind_ops {
319 320 321
	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
322
	int (*binding)(const struct aml_area_linux_mbind_data *data,
323 324 325
		       struct aml_binding **binding);
};

326 327 328
/*
 * Sets memory policy of a Linux memory area.
 * "data": an initialized Linux memory policy structure.
329
 * "policy", "nodemask": see aml_area_linux_mbind_init().
330 331
 * Returns 0 if successful; an error code otherwise.
 */
332
int aml_area_linux_mbind_setdata(struct aml_area_linux_mbind_data *data,
333
				 int policy, const struct aml_bitmap *nodemask);
334 335 336 337 338 339 340 341
/*
 * 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
342
int aml_area_linux_mbind_generic_binding(const struct aml_area_linux_mbind_data *data,
343
					 struct aml_binding **binding);
344 345 346 347 348 349 350 351
/*
 * 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.
 */
352
int aml_area_linux_mbind_regular_pre_bind(struct aml_area_linux_mbind_data *data);
353 354 355 356 357 358 359 360 361 362
/*
 * 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.
 */
363 364
int aml_area_linux_mbind_regular_post_bind(struct aml_area_linux_mbind_data *data,
					   void *ptr, size_t size);
365 366 367 368 369 370 371 372
/*
 * 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.
 */
373
int aml_area_linux_mbind_mempolicy_pre_bind(struct aml_area_linux_mbind_data *data);
374 375 376 377 378 379 380 381 382 383
/*
 * 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.
 */
384 385
int aml_area_linux_mbind_mempolicy_post_bind(struct aml_area_linux_mbind_data *data,
					   void *ptr, size_t size);
386 387 388 389 390 391 392 393 394
/*
 * 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.
 */
395
int aml_area_linux_mbind_init(struct aml_area_linux_mbind_data *data,
396
			      int policy, const struct aml_bitmap *nodemask);
397 398 399 400 401
/*
 * Tears down an initialized Linx memory policy.
 * "data": an initialized Linux memory policy structure.
 * Returns 0 if successful; an error code otherwise.
 */
402
int aml_area_linux_mbind_destroy(struct aml_area_linux_mbind_data *data);
403 404 405 406 407 408 409 410 411 412 413 414

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 {
415 416
	void *(*mmap)(struct aml_area_linux_mmap_data *data, void *ptr,
		      size_t size);
417 418
};

419 420 421 422 423 424 425 426 427
/*
 * 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.
 */
428 429
void *aml_area_linux_mmap_generic(struct aml_area_linux_mmap_data *data,
				  void *ptr, size_t size);
430 431 432 433 434 435 436 437
/*
 * 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.
 */
438
int aml_area_linux_mmap_anonymous_init(struct aml_area_linux_mmap_data *data);
439 440 441 442 443 444 445 446 447 448
/*
 * 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.
 */
449
int aml_area_linux_mmap_fd_init(struct aml_area_linux_mmap_data *data, int fd,
450
				off_t offset);
451 452 453 454 455 456 457 458 459 460 461 462
/*
 * 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.
 */
463 464
int aml_area_linux_mmap_tmpfile_init(struct aml_area_linux_mmap_data *data,
				     char *template, size_t max);
465 466 467 468 469 470 471
/*
 * 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.
 */
472
int aml_area_linux_mmap_anonymous_destroy(struct aml_area_linux_mmap_data *data);
473 474 475 476 477 478 479
/*
 * 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.
 */
480
int aml_area_linux_mmap_fd_destroy(struct aml_area_linux_mmap_data *data);
481 482 483 484 485 486 487
/*
 * 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.
 */
488
int aml_area_linux_mmap_tmpfile_destroy(struct aml_area_linux_mmap_data *data);
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508

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;
};

509 510 511 512 513 514 515 516 517 518 519
#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))

520 521 522
/* Linux memory area manager types, passed to Linux memory area's
   create()/init()/vinit() routines.  */
/* Single-arena manager.  */
523 524
#define AML_AREA_LINUX_MANAGER_TYPE_SINGLE 0

525 526 527
/* Linux memory area mbind types, passed to Linux memory area's
   create()/init()/vinit() routines.  */
/* Regular type using mbind() after mmap().  */
528
#define AML_AREA_LINUX_MBIND_TYPE_REGULAR 0
529 530
/* Calls set_mempolicy() before and after mmap() to change the memory policy
   globally.  */
531 532
#define AML_AREA_LINUX_MBIND_TYPE_MEMPOLICY 1

533 534 535
/* Linux memory area map types, passed to Linux memory area's
   create()/init()/vinit() routines.  */
/* Zero-initialized, anonymous mapping.  */
536
#define AML_AREA_LINUX_MMAP_TYPE_ANONYMOUS 0
537
/* Mapping using an existing file.  */
538
#define AML_AREA_LINUX_MMAP_TYPE_FD 1
539
/* Mapping using a newly created temporary file.  */
540 541
#define AML_AREA_LINUX_MMAP_TYPE_TMPFILE 2

542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
/*
 * 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.
 */
566 567
int aml_area_linux_create(struct aml_area **area, int manager_type,
			  int mbind_type, int mmap_type, ...);
568 569 570 571 572 573 574 575
/*
 * 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.
 */
576 577
int aml_area_linux_init(struct aml_area *area, int manager_type, int mbind_type,
			int mmap_type, ...);
578 579 580 581 582 583 584
/*
 * 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.
 */
585 586
int aml_area_linux_vinit(struct aml_area *area, int manager_type,
			 int mbind_type, int mmap_type, va_list args);
587 588 589 590 591
/*
 * Tears down an initialized Linux memory area.
 * "area": an initialized Linux memory area structure.
 * Returns 0 if successful; an error code otherwise.
 */
592
int aml_area_linux_destroy(struct aml_area *area);
593 594 595 596 597

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

600 601 602 603 604 605
/*
 * 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.
 */
606
void *aml_area_malloc(struct aml_area *area, size_t size);
607 608 609 610 611
/*
 * 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).
 */
612
void aml_area_free(struct aml_area *area, void *ptr);
613 614 615 616 617 618 619 620 621
/*
 * 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.
 */
622
void *aml_area_calloc(struct aml_area *area, size_t num, size_t size);
623 624 625 626 627 628 629 630
/*
 * 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);
631 632 633 634 635 636 637 638 639
/*
 * 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.
 */
640
void *aml_area_realloc(struct aml_area *area, void *ptr, size_t size);
641
/* FIXME! */
642
void *aml_area_acquire(struct aml_area *area, size_t size);
643
/* FIXME! */
644
void aml_area_release(struct aml_area *area, void *ptr);
645 646 647 648 649 650 651 652 653 654
/*
 * 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.
 */
655
void *aml_area_mmap(struct aml_area *area, void *ptr, size_t size);
656
/* FIXME! */
Kamil Iskra's avatar
Kamil Iskra committed
657
int aml_area_available(const struct aml_area *area);
658 659 660 661 662 663 664
/*
 * 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
665
int aml_area_binding(const struct aml_area *area, struct aml_binding **binding);
666

667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
/*******************************************************************************
 * 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 {
682 683 684 685 686 687 688
	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);
689
	int (*tileid)(const struct aml_tiling_data *tiling, va_list);
Kamil Iskra's avatar
Kamil Iskra committed
690 691 692
	size_t (*tilesize)(const struct aml_tiling_data *tiling, int tileid);
	void* (*tilestart)(const struct aml_tiling_data *tiling,
			   const void *ptr, int tileid);
693
	int (*ndims)(const struct aml_tiling_data *tiling, va_list);
694 695 696 697 698 699 700
};

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

701 702 703 704 705 706 707 708 709 710 711
/*
 * 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, ...);

712 713 714 715 716 717 718
/*
 * 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
719
size_t aml_tiling_tilesize(const struct aml_tiling *tiling, int tileid);
720

721 722 723 724 725 726 727 728 729 730
/*
 * 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
731 732
void* aml_tiling_tilestart(const struct aml_tiling *tiling, const void *ptr,
			   int tileid);
733

734 735 736 737 738 739 740 741 742 743
/*
 * 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, ...);

744 745 746 747 748 749 750 751
/*
 * 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.
 */
752 753 754
int aml_tiling_create_iterator(struct aml_tiling *tiling,
			       struct aml_tiling_iterator **iterator,
			       int flags);
755 756 757 758 759 760 761
/*
 * 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.
 */
762 763
int aml_tiling_init_iterator(struct aml_tiling *tiling,
			     struct aml_tiling_iterator *iterator, int flags);
764 765 766
/*
 * Tears down an initialized tiling iterator.
 * "tiling": an initialized tiling structure.
767
 * "iterator": an initialized tiling iterator structure.
768 769
 * Returns 0 if successful; an error code otherwise.
 */
770 771
int aml_tiling_destroy_iterator(struct aml_tiling *tiling,
				struct aml_tiling_iterator *iterator);
772 773

struct aml_tiling_iterator_ops {
774 775
	int (*reset)(struct aml_tiling_iterator_data *iterator);
	int (*next)(struct aml_tiling_iterator_data *iterator);
Kamil Iskra's avatar
Kamil Iskra committed
776 777 778
	int (*end)(const struct aml_tiling_iterator_data *iterator);
	int (*get)(const struct aml_tiling_iterator_data *iterator,
		   va_list args);
779 780 781 782 783 784 785
};

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

786 787
/*
 * Resets a tiling iterator to the first tile.
788
 * "iterator": an initialized tiling iterator structure.
789 790
 * Returns 0 if successful; an error code otherwise.
 */
791
int aml_tiling_iterator_reset(struct aml_tiling_iterator *iterator);
792 793
/*
 * Advances a tiling iterator to the next tile.
794
 * "iterator": an initialized tiling iterator structure.
795 796
 * Returns 0 if successful; an error code otherwise.
 */
797
int aml_tiling_iterator_next(struct aml_tiling_iterator *iterator);
798 799
/*
 * Checks whether the iterator is past the last tile.
800
 * "iterator": an initialized tiling iterator structure.
801 802 803
 * 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
804
int aml_tiling_iterator_end(const struct aml_tiling_iterator *iterator);
805 806
/*
 * Queries the iterator.
807
 * "iterator": an initialized tiling iterator structure.
808 809 810 811 812
 * 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
813
int aml_tiling_iterator_get(const struct aml_tiling_iterator *iterator, ...);
814

815 816
/* Tiling types passed to the tiling create()/init()/vinit() routines.  */
/* Regular, linear tiling with uniform tile sizes.  */
817
#define AML_TILING_TYPE_1D 0
818 819
#define AML_TILING_TYPE_2D_ROWMAJOR 1
#define AML_TILING_TYPE_2D_COLMAJOR 2
820

821 822 823 824 825 826 827 828 829 830
/*
 * 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.
831 832
 * - 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.
833 834
 *   - "totalsize": an argument of type size_t; provides the size of the
 *                  complete user data structure to be tiled.
835 836
 *   - "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
837 838
 * Returns 0 if successful; an error code otherwise.
 */
839
int aml_tiling_create(struct aml_tiling **tiling, int type, ...);
840 841 842 843 844 845 846 847
/*
 * 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.
 */
848
int aml_tiling_init(struct aml_tiling *tiling, int type, ...);
849 850 851 852 853 854 855
/*
 * 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.
 */
856
int aml_tiling_vinit(struct aml_tiling *tiling, int type, va_list args);
857 858 859 860 861 862
/*
 * Tears down an initialized tiling.
 * "tiling": an initialized tiling structure.
 * "type": see aml_tiling_create().
 * Returns 0 if successful; an error code otherwise.
 */
863
int aml_tiling_destroy(struct aml_tiling *tiling, int type);
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902

/*******************************************************************************
 * 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))

903 904
/*******************************************************************************
 * Tiling 2D:
905
 * a contiguous memory area composed of contiguous tiles arranged in 2D grid.
906 907
 ******************************************************************************/

908 909
extern struct aml_tiling_ops aml_tiling_2d_rowmajor_ops;
extern struct aml_tiling_ops aml_tiling_2d_colmajor_ops;
910 911 912 913 914
extern struct aml_tiling_iterator_ops aml_tiling_iterator_2d_ops;

struct aml_tiling_2d_data {
	size_t blocksize;
	size_t totalsize;
915
	size_t ndims[2]; /* # number of rows, # number of cols (in tiles) */
916 917 918 919 920 921 922
};

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

923 924 925 926 927 928 929 930
#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) \
931 932
	struct aml_tiling_2d_data __ ##name## _inner_data; \
	struct aml_tiling name = { \
933
		&aml_tiling_2d_colmajor_ops, \
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
		(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))

951 952 953 954 955 956 957 958 959
/*******************************************************************************
 * 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
960 961 962 963 964 965 966 967 968
	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);
969 970 971 972 973 974 975
};

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

976 977
/*
 * Provides the size of a tile in memory, in pages.
978
 * "binding": an initialized binding structure.
979 980 981 982 983
 * "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
984 985 986
int aml_binding_nbpages(const struct aml_binding *binding,
			const struct aml_tiling *tiling,
			const void *ptr, int tileid);
987 988
/*
 * Provides the addresses of pages that a tile occupies.
989
 * "binding": an initialized binding structure.
990 991 992 993 994 995 996
 * "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
997 998 999
int aml_binding_pages(const struct aml_binding *binding, void **pages,
		      const struct aml_tiling *tiling, const void *ptr,
		      int tileid);
1000 1001
/*
 * Provides the NUMA node information of pages that a tile occupies.
1002
 * "binding": an initialized binding structure.
1003 1004 1005 1006 1007 1008 1009
 * "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
1010 1011 1012
int aml_binding_nodes(const struct aml_binding *binding, int *nodes,
		      const struct aml_tiling *tiling, const void *ptr,
		      int tileid);
1013

1014 1015
/* Binding types passed to the binding create()/init()/vinit() routines.  */
/* Binding where all pages are bound to the same NUMA node.  */
1016
#define AML_BINDING_TYPE_SINGLE 0
1017
/* Binding where pages are interleaved among multiple NUMA nodes.  */
1018 1019
#define AML_BINDING_TYPE_INTERLEAVE 1

1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
/*
 * 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:
1032
 *   - "mask": an argument of type const struct aml_bitmap*; storing a bitmask of
1033
 *             NUMA node ids where pages will be allocated from.  See
1034
 *             aml_bitmap for more information.
1035 1036
 * Returns 0 if successful; an error code otherwise.
 */
1037
int aml_binding_create(struct aml_binding **binding, int type, ...);
1038 1039 1040 1041 1042 1043 1044 1045
/*
 * 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.
 */
1046
int aml_binding_init(struct aml_binding *binding, int type, ...);
1047 1048 1049 1050 1051 1052 1053
/*
 * 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.
 */
1054
int aml_binding_vinit(struct aml_binding *binding, int type, va_list args);
1055 1056 1057 1058 1059 1060
/*
 * Tears down an initialized binding.
 * "binding": an initialized binding structure.
 * "type": see aml_binding_create().
 * Returns 0 if successful; an error code otherwise.
 */
1061
int aml_binding_destroy(struct aml_binding *binding, int type);
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088

/*******************************************************************************
 * 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.
 ******************************************************************************/

1089 1090
#define AML_MAX_NUMA_NODES AML_BITMAP_MAX

1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
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))

1109 1110 1111 1112 1113
/*******************************************************************************
 * DMA:
 * Management of low-level movement of memory.
 ******************************************************************************/

1114 1115
/* Internal macros used for tracking DMA request types.  */
/* Invalid request type.  Used for marking inactive requests in the vector.  */
1116
#define AML_DMA_REQUEST_TYPE_INVALID -1
1117
/* Copy request type.  Uses memcpy() for data migration.  */
1118
#define AML_DMA_REQUEST_TYPE_COPY 0
1119
/* Move request type.  Uses move_pages() for data migration.  */
1120 1121
#define AML_DMA_REQUEST_TYPE_MOVE 1

1122
struct aml_dma_request;
1123 1124 1125
struct aml_dma_data;

struct aml_dma_ops {
1126
	int (*create_request)(struct aml_dma_data *dma,
1127
			      struct aml_dma_request **req, int type,
1128 1129 1130 1131 1132
			      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);
1133 1134 1135 1136 1137 1138 1139
};

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

1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
/*
 * 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.
 */
1156
int aml_dma_copy(struct aml_dma *dma, ...);
1157 1158 1159 1160 1161 1162 1163 1164 1165
/*
 * 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.
 */
1166
int aml_dma_async_copy(struct aml_dma *dma, struct aml_dma_request **req, ...);
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179
/*
 * 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.
 */
1180
int aml_dma_move(struct aml_dma *dma, ...);
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
/*
 * 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.
 *
 */
1191
int aml_dma_async_move(struct aml_dma *dma, struct aml_dma_request **req, ...);
1192 1193 1194 1195 1196 1197
/*
 * 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.
 */
1198
int aml_dma_wait(struct aml_dma *dma, struct aml_dma_request *req);
1199 1200 1201 1202 1203 1204
/*
 * 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.
 */
1205
int aml_dma_cancel(struct aml_dma *dma, struct aml_dma_request *req);
1206

1207 1208
/*******************************************************************************
 * Scratchpad:
1209
 * Use an area to stage data from another area in and out.
1210 1211 1212 1213 1214 1215
 * A dma handles the movement itself.
 ******************************************************************************/

struct aml_scratch_request;
struct aml_scratch_data;

1216 1217
/* Internal macros used for tracking scratchpad request types.  */
/* Invalid request type.  Used for marking inactive requests in the vector.  */
1218
#define AML_SCRATCH_REQUEST_TYPE_INVALID -1
1219
/* Push from the scratchpad to regular memory.  */
1220