bionic (3) memkind_hugetlb.3.gz

Provided by: libmemkind-dev_1.1.0-0ubuntu1_amd64 bug

NAME
       memkind_hugetlb.h - hugetlb memory memkind operations.
       Note:  This  is  EXEPRIMENTAL API. The functionality and the header file itself can be changed (including
       non-backward compatible changes), or remove.


SYNOPSIS
       #include <memkind/internal/memkind_hugetlb.h>

       Link with -lmemkind

       int memkind_hugetlb_check_available_2mb(struct memkind *kind);
       int memkind_hugetlb_check_available_1gb(struct memkind *kind);
       int memkind_hugetlb_get_mmap_flags(struct memkind *kind, int *flags);
       void memkind_hugetlb_init_once(void);


DESCRIPTION
       The hugetlb memory memkind operations enable memory kinds which use the Linux hugetlbfs file system.  For
       more information about the hugetlbfs see link below.
       https://www.kernel.org/doc/Documentation/vm/hugetlbpage.txt

       memkind_hugetlb_check_available_2mb() Check if there are 2MB pages reserved in the default hugetlbfs.  If
       the kind implements ops.get_mbind_nodemask(), then only the NUMA nodes set by the nodemask  are  checked,
       otherwise every NUMA node is checked.

       memkind_hugetlb_check_available_1gb()  Similar  to  memkind_hugetlb_check_available_2mb() except that the
       check is for 1GB pages instead of 2MB pages.

       memkind_hugetlb_get_mmap_flags() Sets the flags for the mmap() system call such  that  the  hugetlbfs  is
       utilized for allocations.

       memkind_hugetlb_init_once()  This  function  initializes MEMKIND_HUGETLB kind and it should not be called
       more than once.  Note: memkind_hugetlb_init_once() may reserve some extra memory.


       Copyright (C) 2014 - 2016 Intel Corporation. All rights reserved.


SEE ALSO
       memkind(3),  memkind_arena(3),  memkind_default(3),  memkind_gbtlb(3),  memkind_hbw(3),  memkind_pmem(3),
       jemalloc(3), mbind(2), mmap(2)