File: reg_cache.h

package info (click to toggle)
ga 5.9.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 18,472 kB
  • sloc: ansic: 192,963; fortran: 53,761; f90: 11,218; cpp: 5,784; makefile: 2,248; sh: 1,945; python: 1,734; perl: 534; csh: 134; asm: 106
file content (71 lines) | stat: -rw-r--r-- 1,811 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
#ifndef _REG_CACHE_H_
#define _REG_CACHE_H_

#if USE_SICM
#include <sicm_low.h>
//#include <sicm_impl.h>
#endif
#include <stddef.h>
// #define ENABLE_SYSV
#if ENABLE_SYSV
#include <sys/ipc.h>
#endif

/**
 * Enumerate the return codes for registration cache functions.
 */
typedef enum _reg_return_t {
    RR_SUCCESS=0,   /**< success */
    RR_FAILURE      /**< non-specific failure */
} reg_return_t;

/**
 * A registered contiguous memory region.
 */
typedef struct _reg_entry_t {
    struct _reg_entry_t *next;  /**< next memory region in list */
    void *buf;                  /**< starting address of region */
    size_t len;                 /**< length of region */
    void *mapped;               /**< starting address of mmap'd region */
    int rank;                   /**< rank where this region lives */
    int use_dev;                /**< memory is on a device */
#if ENABLE_SYSV
    char name[2*SHM_NAME_SIZE];   /**< name of region */
    key_t key;
#else
    char name[SHM_NAME_SIZE];   /**< name of region */
#endif
#if USE_SICM
#if SICM_OLD
    sicm_device *device;         /**< pointer to SICM device */
#else
    sicm_device_list device;         /**< pointer to SICM device */
#endif
#endif
} reg_entry_t;

/* functions
 *
 * documentation is in the *.c file
 */

reg_return_t reg_cache_init(int nprocs);
reg_return_t reg_cache_destroy();
reg_entry_t *reg_cache_find(int rank, void *buf, size_t len);
reg_entry_t *reg_cache_insert(int rank, void *buf, size_t len, const char *name,
#if ENABLE_SYSV
    key_t key,
#endif
    void *mapped, int use_dev
#if USE_SICM
#if SICM_OLD
    ,sicm_device *device
#else
    ,sicm_device_list device
#endif
#endif
    );
reg_return_t reg_cache_delete(int rank, void *buf);
reg_return_t reg_cache_nullify(reg_entry_t *entry);

#endif /* _REG_CACHE_H_ */