epoll_create1(2)

1EPOLL_CREATE(2)            Linux Programmer's Manual           EPOLL_CREATE(2)
2
3
4

NAME

6       epoll_create, epoll_create1 - open an epoll file descriptor
7

SYNOPSIS

9       #include <sys/epoll.h>
10
11       int epoll_create(int size);
12       int epoll_create1(int flags);
13

DESCRIPTION

15       epoll_create()  creates  an  epoll(7) instance.  Since Linux 2.6.8, the
16       size argument is ignored, but must be  greater  than  zero;  see  NOTES
17       below.
18
19       epoll_create()  returns  a  file  descriptor referring to the new epoll
20       instance.  This file descriptor is used for all the subsequent calls to
21       the  epoll  interface.   When  no  longer required, the file descriptor
22       returned by epoll_create() should be closed by  using  close(2).   When
23       all  file  descriptors referring to an epoll instance have been closed,
24       the kernel destroys the instance and releases the associated  resources
25       for reuse.
26
27   epoll_create1()
28       If  flags  is 0, then, other than the fact that the obsolete size argu‐
29       ment is dropped, epoll_create1() is the same  as  epoll_create().   The
30       following value can be included in flags to obtain different behavior:
31
32       EPOLL_CLOEXEC
33              Set the close-on-exec (FD_CLOEXEC) flag on the new file descrip‐
34              tor.  See the description of the O_CLOEXEC flag in  open(2)  for
35              reasons why this may be useful.
36

RETURN VALUE

38       On  success,  these  system calls return a nonnegative file descriptor.
39       On error, -1 is returned, and errno is set to indicate the error.
40

ERRORS

42       EINVAL size is not positive.
43
44       EINVAL (epoll_create1()) Invalid value specified in flags.
45
46       EMFILE The per-user limit on the number of epoll instances  imposed  by
47              /proc/sys/fs/epoll/max_user_instances   was   encountered.   See
48              epoll(7) for further details.
49
50       ENFILE The system limit on the total number  of  open  files  has  been
51              reached.
52
53       ENOMEM There was insufficient memory to create the kernel object.
54

VERSIONS

56       epoll_create() was added to the kernel in version 2.6.  Library support
57       is provided in glibc starting with version 2.3.2.
58
59       epoll_create1() was added to the kernel  in  version  2.6.27.   Library
60       support is provided in glibc starting with version 2.9.
61

CONFORMING TO

63       epoll_create() is Linux-specific.
64

NOTES

66       In   the  initial  epoll_create()  implementation,  the  size  argument
67       informed the kernel of the number of file descriptors that  the  caller
68       expected  to  add to the epoll instance.  The kernel used this informa‐
69       tion as a hint for the amount of space to initially allocate in  inter‐
70       nal data structures describing events.  (If necessary, the kernel would
71       allocate more space if the caller's usage exceeded the  hint  given  in
72       size.)   Nowadays,  this hint is no longer required (the kernel dynami‐
73       cally sizes the required data structures without needing the hint), but
74       size  must still be greater than zero, in order to ensure backward com‐
75       patibility when new epoll applications are run on older kernels.
76

COLOPHON

81       This page is part of release 3.53 of the Linux  man-pages  project.   A
82       description  of  the project, and information about reporting bugs, can
83       be found at http://www.kernel.org/doc/man-pages/.
84
85
86
87Linux                             2012-04-15                   EPOLL_CREATE(2)