src/fd_util.h

   1 /*
   2  * Copyright (C) 2003-2010 The Music Player Daemon Project
   3  * http://www.musicpd.org
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  * notice, this list of conditions and the following disclaimer.
  11  *
  12  * - Redistributions in binary form must reproduce the above copyright
  13  * notice, this list of conditions and the following disclaimer in the
  14  * documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
  20  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  21  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  24  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  25  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  26  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /*
  30  * This library provides easy helper functions for working with file
  31  * descriptors.  It has wrappers for taking advantage of Linux 2.6
  32  * specific features like O_CLOEXEC.
  33  *
  34  */
  35
  36 #ifndef FD_UTIL_H
  37 #define FD_UTIL_H
  38
  39 #include <stdbool.h>
  40 #include <stddef.h>
  41
  42 struct sockaddr;
  43
  44 /**
  45  * Wrapper for open(), which sets the CLOEXEC flag (atomically if
  46  * supported by the OS).
  47  */
  48 int
  49 open_cloexec(const char *path_fs, int flags, int mode);
  50
  51 /**
  52  * Wrapper for pipe(), which sets the CLOEXEC flag (atomically if
  53  * supported by the OS).
  54  */
  55 int
  56 pipe_cloexec(int fd[2]);
  57
  58 /**
  59  * Wrapper for pipe(), which sets the CLOEXEC flag (atomically if
  60  * supported by the OS).
  61  *
  62  * On systems that supports it (everybody except for Windows), it also
  63  * sets the NONBLOCK flag.
  64  */
  65 int
  66 pipe_cloexec_nonblock(int fd[2]);
  67
  68 /**
  69  * Wrapper for socket(), which sets the CLOEXEC and the NONBLOCK flag
  70  * (atomically if supported by the OS).
  71  */
  72 int
  73 socket_cloexec_nonblock(int domain, int type, int protocol);
  74
  75 /**
  76  * Wrapper for accept(), which sets the CLOEXEC and the NONBLOCK flags
  77  * (atomically if supported by the OS).
  78  */
  79 int
  80 accept_cloexec_nonblock(int fd, struct sockaddr *address,
  81                         size_t *address_length_r);
  82
  83 /**
  84  * Wrapper for inotify_init(), which sets the CLOEXEC flag (atomically
  85  * if supported by the OS).
  86  */
  87 int
  88 inotify_init_cloexec(void);
  89
  90 #endif