.\"                                      Hey, EMACS: -*- nroff -*-
.\" Copyright 2012 Cray Inc.
.\" All rights reserved.
.\" Licensed under LGPL 2.1 by Cray Inc.
.\"
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH HUGETLBFS_UNLINKED_FD 3 "March 7, 2012"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
hugetlbfs_unlinked_fd, hugetlbfs_unlinked_fd_for_size - Obtain a file descriptor for a new unlinked file in hugetlbfs
.SH SYNOPSIS
.B #include <hugetlbfs.h>

.br
.B int hugetlbfs_unlinked_fd(void);
.br
.B int hugetlbfs_unlinked_fd_for_size(long page_size);

.SH DESCRIPTION

These functions return an open file descriptor for a unique, newly-created
file in a hugetlbfs filesystem.  To avoid leaking hugepages, the file
is unlinked automatically before the function returns.

For hugetlbfs_unlinked_fd, the default huge page size is used (see
gethugepagesize(3)).  For hugetlbfs_unlinked_fd_for_size, a valid huge
page size must be specified (see gethugepagesizes(3)).

.SH RETURN VALUE

On success, a valid open file descriptor is returned.  On failure,
-1 is returned and errno may be set appropriately.

.SH SEE ALSO
.I gethugepagesize(3),
.I gethugepagesizes(3),
.I mkstemp(3),
.I libhugetlbfs(7)

.SH AUTHORS
libhugetlbfs was written by various people on the libhugetlbfs-devel
mailing list.