1MEMKIND_HBW(3)                    MEMKIND_HBW                   MEMKIND_HBW(3)
2
3
4

NAME

6       memkind_hbw - high bandwidth memory memkind operations.
7       Note:  This  is EXPERIMENTAL API. The functionality and the header file
8       itself can be changed (including non-backward  compatible  changes)  or
9       removed.
10

SYNOPSIS

12       int memkind_hbw_check_available(struct memkind *kind);
13       int memkind_hbw_hugetlb_check_available(struct memkind *kind);
14       int memkind_hbw_get_mbind_nodemask(struct memkind *kind, unsigned long *nodemask, unsigned long maxnode);
15       int memkind_hbw_all_get_mbind_nodemask(struct memkind *kind, unsigned long *nodemask, unsigned long maxnode);
16       void memkind_hbw_init_once(void);
17       void memkind_hbw_hugetlb_init_once(void);
18       void memkind_hbw_all_hugetlb_init_once(void);
19       void memkind_hbw_preferred_init_once(void);
20       void memkind_hbw_preferred_hugetlb_init_once(void);
21       void memkind_hbw_interleave_init_once(void);
22

DESCRIPTION

24       High bandwidth memory memkind operations.
25
26       memkind_hbw_check_available()  returns  zero  if  library  was  able to
27       detect    heterogeneous     NUMA     node     bandwidths.       Returns
28       MEMKIND_ERROR_UNAVAILABLE if the detection mechanism failed.  Detection
29       mechanism  can  be  also  overridden  by   the   environment   variable
30       MEMKIND_HBW_NODES as described in the memkind(3) man page.
31
32       memkind_hbw_hugetlb_check_available()  In addition to checking for high
33       bandwidth memory as is done by memkind_hbw_check_available(), this also
34       checks  for  2MB  huge pages as is done by memkind_hugetlb_check_avail‐
35       able_2mb().
36
37       memkind_hbw_get_mbind_nodemask() sets the nodemask bit to one that cor‐
38       responds to the high bandwidth NUMA node that has the closest NUMA dis‐
39       tance to the CPU of the calling process.  All other bits up to  maxnode
40       are  set  to  zero.   The  nodemask can be used in conjunction with the
41       mbind(2) system call.
42
43       memkind_hbw_all_get_mbind_nodemask() sets the nodemask bits to one that
44       correspond  to  the  all  high  bandwidth NUMA nodes in the system. All
45       other bits up to maxnode are set to zero.  The nodemask can be used  in
46       conjunction with the mbind(2) system call.
47
48       memkind_hbw_init_once()  This function initializes MEMKIND_HBW kind and
49       it should not be called more than once.  Note:  memkind_hbw_init_once()
50       may reserve some extra memory.
51
52       memkind_hbw_hugetlb_init_once()      This      function     initializes
53       MEMKIND_HBW_HUGETLB kind and it should not be called  more  than  once.
54       Note: memkind_hbw_hugetlb_init_once() may reserve some extra memory.
55
56       memkind_hbw_preferred_init_once()     This     function     initializes
57       MEMKIND_HBW_PREFERRED kind and it should not be called more than  once.
58       Note: memkind_hbw_preferred_init_once() may reserve some extra memory.
59
60       memkind_hbw_preferred_hugetlb_init_once()   This  function  initializes
61       MEMKIND_HBW_PREFERRED_HUGETLB kind and it should  not  be  called  more
62       than once.  Note: memkind_hbw_preferred_hugetlb_init_once() may reserve
63       some extra memory.
64
65       memkind_hbw_all_hugetlb_init_once()    This    function     initializes
66       MEMKIND_HBW_ALL_HUGETLB  kind  and  it  should  not be called more than
67       once.  Note: memkind_hbw_all_hugetlb_init_once() may reserve some extra
68       memory.
69
70       memkind_hbw_interleave_init_once()     This     function    initializes
71       MEMKIND_HBW_INTERLEAVE kind and it should not be called more than once.
72       Note: memkind_hbw_interleave_init_once() may reserve some extra memory.
73

75       Copyright (C) 2014 - 2019 Intel Corporation. All rights reserved.
76

SEE ALSO

78       memkind(3),  memkind_arena(3),  memkind_default(3), memkind_hugetlb(3),
79       memkind_pmem(3), jemalloc(3), mbind(2), mmap(2)
80
81
82
83Intel Corporation                 2016-06-13                    MEMKIND_HBW(3)
Impressum