lib/cloexec.h

   1 /* cloexec.c - set or clear the close-on-exec descriptor flag
   2
   3    Copyright (C) 2004, 2009-2024 Free Software Foundation, Inc.
   4
   5    This file is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU Lesser General Public License as
   7    published by the Free Software Foundation; either version 2.1 of the
   8    License, or (at your option) any later version.
   9
  10    This file is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public License
  16    along with this program.  If not, see <https://www.gnu.org/licenses/>.  */
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif
  21
  22
  23 /* Set the 'FD_CLOEXEC' flag of DESC if VALUE is true,
  24    or clear the flag if VALUE is false.
  25    Return 0 on success, or -1 on error with 'errno' set.
  26
  27    Note that on MingW, this function does NOT protect DESC from being
  28    inherited into spawned children.  Instead, either use dup_cloexec
  29    followed by closing the original DESC, or use interfaces such as
  30    open or pipe2 that accept flags like O_CLOEXEC to create DESC
  31    non-inheritable in the first place.  */
  32
  33 int set_cloexec_flag (int desc, bool value);
  34
  35 /* Duplicates a file handle FD, while marking the copy to be closed
  36    prior to exec or spawn.  Returns -1 and sets errno if FD could not
  37    be duplicated.  */
  38
  39 int dup_cloexec (int fd);
  40
  41
  42 #ifdef __cplusplus
  43 }
  44 #endif