1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
/* file descriptor functions
*
* Copyright (C) 1997 Angelos D. Keromytis.
* Copyright (C) 1998-2002,2013 D. Hugh Redelmeier <hugh@mimosa.com>
* Copyright (C) 2004-2008 Michael Richardson <mcr@xelerance.com>
* Copyright (C) 2004-2009 Paul Wouters <paul@xelerance.com>
* Copyright (C) 2008 Antony Antony <antony@xelerance.com>
* Copyright (C) 2009 Avesh Agarwal <avagarwa@redhat.com>
* Copyright (C) 2012 Paul Wouters <paul@libreswan.org>
* Copyright (C) 2013 Tuomo Soini <tis@foobar.fi>
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <https://www.gnu.org/licenses/gpl2.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
*/
#ifndef FD_H
#define FD_H
#include <stdbool.h>
#include <stddef.h> /* for size_t */
#include <sys/types.h> /* for ssize_t */
struct msghdr;
struct logger;
struct where;
/* opaque and reference counted */
struct fd;
/*
* A magic value such that: fd_p(null_fd)==false
*/
#define null_fd ((struct fd *) NULL)
struct fd *fd_accept(int socket, const struct where *where, struct logger *logger);
struct fd *fd_addref_where(struct fd *fd, const struct where *where);
void fd_delref_where(struct fd **fd, const struct where *where);
#define fd_addref(FD) fd_addref_where(FD, HERE)
#define fd_delref(FD) fd_delref_where(FD, HERE)
void fd_leak(struct fd *fd, const struct where *where);
/* return nr-bytes, or -ERRNO */
ssize_t fd_sendmsg(const struct fd *fd, const struct msghdr *msg, int flags);
ssize_t fd_read(const struct fd *fd, void *buf, size_t nbytes);
/*
* Is FD valid (as in something non-negative)?
*
* Use fd_p() to check the wrapped return value from functions like
* open(2) (which return -1 on failure).
*/
bool fd_p(const struct fd *fd);
bool same_fd(const struct fd *l, const struct fd *r);
/*
* dbg("fd "PRI_FD, pri_fd(whackfd))
*
* PRI_... names are consistent with shunk_t and hopefully avoid
* clashes with reserved PRI* names.
*/
#define PRI_FD "fd@%p"
#define pri_fd(FD) (FD)
#endif
|
