GDBserver

filestuff.h
Go to the documentation of this file.
1 /* Low-level file-handling.
2 Copyright (C) 2012-2018 Free Software Foundation, Inc.
3
4 This file is part of GDB.
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
18
19 #ifndef FILESTUFF_H
20 #define FILESTUFF_H
21
22 /* Note all the file descriptors which are open when this is called.
23 These file descriptors will not be closed by close_most_fds. */
24
25 extern void notice_open_fds (void);
26
27 /* Mark a file descriptor as inheritable across an exec. */
28
29 extern void mark_fd_no_cloexec (int fd);
30
31 /* Mark a file descriptor as no longer being inheritable across an
32 exec. This is only meaningful when FD was previously passed to
33 mark_fd_no_cloexec. */
34
35 extern void unmark_fd_no_cloexec (int fd);
36
37 /* Close all open file descriptors other than those marked by
38 'notice_open_fds', and stdin, stdout, and stderr. Errors that
39 occur while closing are ignored. */
40
41 extern void close_most_fds (void);
42
43 /* Like 'open', but ensures that the returned file descriptor has the
44 close-on-exec flag set. */
45
46 extern int gdb_open_cloexec (const char *filename, int flags,
47 /* mode_t */ unsigned long mode);
48
49 struct gdb_file_deleter
50 {
51 void operator() (FILE *file) const
52 {
53 fclose (file);
54 }
55 };
56
57 /* A unique pointer to a FILE. */
58
59 typedef std::unique_ptr<FILE, gdb_file_deleter> gdb_file_up;
60
61 /* Like 'fopen', but ensures that the returned file descriptor has the
62 close-on-exec flag set. */
63
64 extern gdb_file_up gdb_fopen_cloexec (const char *filename,
65 const char *opentype);
66
67 /* Like 'socketpair', but ensures that the returned file descriptors
68 have the close-on-exec flag set. */
69
70 extern int gdb_socketpair_cloexec (int domain, int style, int protocol,
71 int filedes[2]);
72
73 /* Like 'socket', but ensures that the returned file descriptor has
74 the close-on-exec flag set. */
75
76 extern int gdb_socket_cloexec (int domain, int style, int protocol);
77
78 /* Like 'pipe', but ensures that the returned file descriptors have
79 the close-on-exec flag set. */
80
81 extern int gdb_pipe_cloexec (int filedes[2]);
82
83 /* Return a new cleanup that closes FD. */
84
85 extern struct cleanup *make_cleanup_close (int fd);
86
87 #endif /* FILESTUFF_H */
mark_fd_no_cloexec
void mark_fd_no_cloexec(int fd)
Definition: filestuff.c:176
gdb_socketpair_cloexec
int gdb_socketpair_cloexec(int domain, int style, int protocol, int filedes[2])
gdb_socket_cloexec
int gdb_socket_cloexec(int domain, int style, int protocol)
notice_open_fds
void notice_open_fds(void)
Definition: filestuff.c:168
cleanup
Definition: cleanups.c:38
gdb_file_deleter::operator()
void operator()(FILE *file) const
Definition: filestuff.h:51
gdb_file_up
std::unique_ptr< FILE, gdb_file_deleter > gdb_file_up
Definition: filestuff.h:59
gdb_fopen_cloexec
gdb_file_up gdb_fopen_cloexec(const char *filename, const char *opentype)
Definition: filestuff.c:296
gdb_file_deleter
Definition: filestuff.h:49
make_cleanup_close
struct cleanup * make_cleanup_close(int fd)
Definition: filestuff.c:413
gdb_pipe_cloexec
int gdb_pipe_cloexec(int filedes[2])
Definition: filestuff.c:373
gdb_open_cloexec
int gdb_open_cloexec(const char *filename, int flags, unsigned long mode)
Definition: filestuff.c:283
unmark_fd_no_cloexec
void unmark_fd_no_cloexec(int fd)
Definition: filestuff.c:184
close_most_fds
void close_most_fds(void)
Definition: filestuff.c:216