GCC Code Coverage Report

Directory: cvmfs/
File: cvmfs/fd_table.h
Date: 2025-06-22 02:36:02
Exec Total Coverage
Lines: 62 63 98.4%
Branches: 40 59 67.8%
Line Branch Exec Source
1 /**
2 * This file is part of the CernVM File System.
3 */
4
5 #ifndef CVMFS_FD_TABLE_H_
6 #define CVMFS_FD_TABLE_H_
7
8 #include <errno.h>
9 #include <inttypes.h>
10 #include <stdint.h>
11
12 #include <cassert>
13 #include <vector>
14
15 #include "util/single_copy.h"
16
17 /**
18 * Maintains integers mapped to custom open file descriptors. File descriptors
19 * can be added, removed, and accessed. All operations take constant time. The
20 * maximum file descriptor number needs to be known upfront.
21 *
22 * Note that new file descriptors do not necessarily have the smallest available
23 * number but any number between 0..max_open_fds.
24 *
25 * This class is used by a couple of cache managers.
26 */
27 template<class HandleT>
28 class FdTable : SingleCopy {
29 public:
30 1873 FdTable(unsigned max_open_fds, const HandleT &invalid_handle)
31 1873 : invalid_handle_(invalid_handle)
32 1873 , fd_pivot_(0)
33
1/2
✓ Branch 2 taken 1873 times.
✗ Branch 3 not taken.
 1873 , fd_index_(max_open_fds)
34
4/7
✓ Branch 3 taken 98 times.
✓ Branch 4 taken 1775 times.
✗ Branch 5 not taken.
✓ Branch 6 taken 98 times.
✗ Branch 7 not taken.
✓ Branch 9 taken 98 times.
✗ Branch 10 not taken.
 3746 , open_fds_(max_open_fds, FdWrapper(invalid_handle_, 0)) {
35
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1873 times.
 1873 assert(max_open_fds > 0);
36
2/2
✓ Branch 0 taken 4297736 times.
✓ Branch 1 taken 1873 times.
 4299609 for (unsigned i = 0; i < max_open_fds; ++i) {
37 4297736 fd_index_[i] = i;
38 4297736 open_fds_[i].index = i;
39 }
40 1873 }
41
42 /**
43 * Used to restore the state.
44 */
45 30 void AssignFrom(const FdTable<HandleT> &other) {
46 30 invalid_handle_ = other.invalid_handle_;
47 30 fd_pivot_ = other.fd_pivot_;
48 30 fd_index_.resize(other.fd_index_.size());
49
1/5
✗ Branch 2 not taken.
✓ Branch 3 taken 30 times.
✗ Branch 4 not taken.
✗ Branch 6 not taken.
✗ Branch 7 not taken.
 30 open_fds_.resize(other.open_fds_.size(), FdWrapper(invalid_handle_, 0));
50
2/2
✓ Branch 1 taken 3840 times.
✓ Branch 2 taken 30 times.
 3870 for (unsigned i = 0; i < fd_index_.size(); ++i) {
51 3840 fd_index_[i] = other.fd_index_[i];
52 3840 open_fds_[i] = other.open_fds_[i];
53 }
54 30 }
55
56 /**
57 * Used to save the state.
58 */
59 30 FdTable<HandleT> *Clone() {
60 30 FdTable<HandleT> *result = new FdTable<HandleT>(open_fds_.size(),
61
1/2
✓ Branch 1 taken 30 times.
✗ Branch 2 not taken.
 30 invalid_handle_);
62 30 result->fd_pivot_ = fd_pivot_;
63
2/2
✓ Branch 1 taken 3840 times.
✓ Branch 2 taken 30 times.
 3870 for (unsigned i = 0; i < fd_index_.size(); ++i) {
64 3840 result->fd_index_[i] = fd_index_[i];
65 3840 result->open_fds_[i] = open_fds_[i];
66 }
67 30 return result;
68 }
69
70
71 /**
72 * Registers fd with a currently unused number. If the table is full,
73 * returns -ENFILE;
74 */
75 10546921 int OpenFd(const HandleT &handle) {
76
2/3
✗ Branch 0 not taken.
✓ Branch 1 taken 10012280 times.
✓ Branch 2 taken 534641 times.
 10546921 if (handle == invalid_handle_)
77 ✗ return -EINVAL;
78
2/2
✓ Branch 1 taken 1677158 times.
✓ Branch 2 taken 8869763 times.
 10546921 if (fd_pivot_ >= fd_index_.size())
79 1677158 return -ENFILE;
80
81 8869763 size_t next_fd = fd_index_[fd_pivot_];
82
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 8869763 times.
 8869763 assert(next_fd < open_fds_.size());
83
2/3
✗ Branch 1 not taken.
✓ Branch 2 taken 8335200 times.
✓ Branch 3 taken 534563 times.
 8869763 assert(open_fds_[next_fd].handle == invalid_handle_);
84
1/2
✓ Branch 2 taken 98 times.
✗ Branch 3 not taken.
 8869763 open_fds_[next_fd] = FdWrapper(handle, fd_pivot_);
85 8869763 ++fd_pivot_;
86 8869763 return next_fd;
87 }
88
89 /**
90 * For invalid and unused numbers, the invalid handle is returned.
91 */
92 11058724 HandleT GetHandle(int fd) {
93
2/2
✓ Branch 1 taken 9401836 times.
✓ Branch 2 taken 1656903 times.
 11058724 return IsValid(fd) ? open_fds_[fd].handle : invalid_handle_;
94 }
95
96
97 /**
98 * Releases fd back to the set of available numbers. Gracefully handles
99 * invalid handles (-EBADFD)
100 */
101 10522255 int CloseFd(int fd) {
102
2/2
✓ Branch 1 taken 1652940 times.
✓ Branch 2 taken 8869315 times.
 10522255 if (!IsValid(fd))
103 1652940 return -EBADF;
104
105 8869315 unsigned index = open_fds_[fd].index;
106
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 8869315 times.
 8869315 assert(index < fd_index_.size());
107
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 8869315 times.
 8869315 assert(fd_pivot_ <= fd_index_.size());
108
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 8869315 times.
 8869315 assert(fd_pivot_ > 0);
109 8869315 open_fds_[fd].handle = invalid_handle_;
110 8869315 --fd_pivot_;
111
2/2
✓ Branch 0 taken 5058987 times.
✓ Branch 1 taken 3810328 times.
 8869315 if (index < fd_pivot_) {
112 5058987 unsigned other = fd_index_[fd_pivot_];
113
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 5058987 times.
 5058987 assert(other < open_fds_.size());
114
2/3
✗ Branch 1 not taken.
✓ Branch 2 taken 4528620 times.
✓ Branch 3 taken 530367 times.
 5058987 assert(open_fds_[other].handle != invalid_handle_);
115 5058987 open_fds_[other].index = index;
116 5058987 fd_index_[index] = other;
117 5058987 fd_index_[fd_pivot_] = fd;
118 }
119 8869315 return 0;
120 }
121
122 3840 unsigned GetMaxFds() const { return fd_index_.size(); }
123
124 private:
125 struct FdWrapper {
126 8871666 FdWrapper(HandleT h, unsigned i) : handle(h), index(i) { }
127
128 HandleT handle;
129 /**
130 * Back-pointer into fd_index_, which is needed when closing a file.
131 */
132 unsigned index;
133 };
134
135
136 21580979 inline bool IsValid(int fd) {
137
6/6
✓ Branch 0 taken 21580939 times.
✓ Branch 1 taken 40 times.
✓ Branch 3 taken 40 times.
✓ Branch 4 taken 21580899 times.
✓ Branch 5 taken 80 times.
✓ Branch 6 taken 21580899 times.
 21580979 if ((fd < 0) || (static_cast<unsigned>(fd) >= open_fds_.size()))
138 80 return false;
139 21580899 return open_fds_[fd].handle != invalid_handle_;
140 }
141
142 /**
143 * An unused (available) file descriptor.
144 */
145 HandleT invalid_handle_;
146 /**
147 * The index of the first available file descriptor in fd_index_.
148 */
149 unsigned fd_pivot_;
150 /**
151 * Maps into open_fds_. Until fd_pivot_, file descriptors are used. As of
152 * fd_pivot_, points to free file descriptors. Used to acquire new file
153 * descriptors in constant time.
154 */
155 std::vector<unsigned> fd_index_;
156 /**
157 * The file descriptor number mapped to a user-defined file descriptor
158 * (struct). The fd integer passed to users of the file descriptor table
159 * points into this array.
160 */
161 std::vector<FdWrapper> open_fds_;
162 }; // class FdTable
163
164 #endif // CVMFS_FD_TABLE_H_
165