1 // descriptors.cc -- manage file descriptors for gold
3 // Copyright 2008, 2009 Free Software Foundation, Inc.
4 // Written by Ian Lance Taylor <iant@google.com>.
6 // This file is part of gold.
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 3 of the License, or
11 // (at your option) any later version.
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
21 // MA 02110-1301, USA.
31 #include "parameters.h"
33 #include "gold-threads.h"
34 #include "descriptors.h"
35 #include "binary-io.h"
37 // Very old systems may not define FD_CLOEXEC.
42 // O_CLOEXEC is only available on newer systems.
52 // The default for limit_ is meant to simply be large. It gets
53 // adjusted downward if we run out of file descriptors.
55 Descriptors::Descriptors()
56 : lock_(NULL
), initialize_lock_(&this->lock_
), open_descriptors_(),
57 stack_top_(-1), current_(0), limit_(8192 - 16)
59 this->open_descriptors_
.reserve(128);
65 Descriptors::open(int descriptor
, const char* name
, int flags
, int mode
)
67 // We don't initialize this until we are called, because we can't
68 // initialize a Lock until we have parsed the options to find out
69 // whether we are running with threads. We can be called before
70 // options are valid when reading a linker script.
71 bool lock_initialized
= this->initialize_lock_
.initialize();
73 gold_assert(lock_initialized
|| descriptor
< 0);
77 Hold_lock
hl(*this->lock_
);
79 gold_assert(static_cast<size_t>(descriptor
)
80 < this->open_descriptors_
.size());
81 Open_descriptor
* pod
= &this->open_descriptors_
[descriptor
];
83 || (pod
->name
!= NULL
&& strcmp(pod
->name
, name
) == 0))
85 gold_assert(!pod
->inuse
);
87 if (descriptor
== this->stack_top_
)
89 this->stack_top_
= pod
->stack_next
;
91 pod
->is_on_stack
= false;
99 // We always want to set the close-on-exec flag; we don't
100 // require callers to pass it.
103 // Always open the file as a binary file.
106 int new_descriptor
= ::open(name
, flags
, mode
);
107 if (new_descriptor
< 0
111 if (descriptor
>= 0 && errno
== ENOENT
)
114 Hold_lock
hl(*this->lock_
);
116 gold_error(_("file %s was removed during the link"),
117 this->open_descriptors_
[descriptor
].name
);
123 return new_descriptor
;
126 if (new_descriptor
>= 0)
128 // If we have any plugins, we really do need to set the
129 // close-on-exec flag, even if O_CLOEXEC is not defined.
130 // FIXME: In some cases O_CLOEXEC may be defined in the
131 // header file but not supported by the kernel.
132 // Unfortunately there doesn't seem to be any obvious way to
133 // detect that, as unknown flags passed to open are ignored.
135 && parameters
->options_valid()
136 && parameters
->options().has_plugins())
137 fcntl(new_descriptor
, F_SETFD
, FD_CLOEXEC
);
140 Hold_optional_lock
hl(this->lock_
);
142 if (static_cast<size_t>(new_descriptor
)
143 >= this->open_descriptors_
.size())
144 this->open_descriptors_
.resize(new_descriptor
+ 64);
146 Open_descriptor
* pod
= &this->open_descriptors_
[new_descriptor
];
148 pod
->stack_next
= -1;
150 pod
->is_write
= (flags
& O_ACCMODE
) != O_RDONLY
;
151 pod
->is_on_stack
= false;
154 if (this->current_
>= this->limit_
)
155 this->close_some_descriptor();
157 return new_descriptor
;
161 // We ran out of file descriptors.
163 Hold_optional_lock
hl(this->lock_
);
165 this->limit_
= this->current_
- 16;
166 if (this->limit_
< 8)
168 if (!this->close_some_descriptor())
169 gold_fatal(_("out of file descriptors and couldn't close any"));
174 // Release a descriptor.
177 Descriptors::release(int descriptor
, bool permanent
)
179 Hold_optional_lock
hl(this->lock_
);
181 gold_assert(descriptor
>= 0
182 && (static_cast<size_t>(descriptor
)
183 < this->open_descriptors_
.size()));
184 Open_descriptor
* pod
= &this->open_descriptors_
[descriptor
];
187 || (this->current_
> this->limit_
&& !pod
->is_write
))
189 if (::close(descriptor
) < 0)
190 gold_warning(_("while closing %s: %s"), pod
->name
, strerror(errno
));
197 if (!pod
->is_write
&& !pod
->is_on_stack
)
199 pod
->stack_next
= this->stack_top_
;
200 this->stack_top_
= descriptor
;
201 pod
->is_on_stack
= true;
206 // Close some descriptor. The lock is held when this is called. We
207 // close the descriptor on the top of the free stack. Note that this
208 // is the opposite of an LRU algorithm--we close the most recently
209 // used descriptor. That is because the linker tends to cycle through
210 // all the files; after we release a file, we are unlikely to need it
211 // again until we have looked at all the other files. Return true if
212 // we closed a descriptor.
215 Descriptors::close_some_descriptor()
218 int i
= this->stack_top_
;
221 gold_assert(static_cast<size_t>(i
) < this->open_descriptors_
.size());
222 Open_descriptor
* pod
= &this->open_descriptors_
[i
];
223 if (!pod
->inuse
&& !pod
->is_write
)
226 gold_warning(_("while closing %s: %s"), pod
->name
, strerror(errno
));
230 this->stack_top_
= pod
->stack_next
;
232 this->open_descriptors_
[last
].stack_next
= pod
->stack_next
;
233 pod
->stack_next
= -1;
234 pod
->is_on_stack
= false;
241 // We couldn't find any descriptors to close. This is weird but not
242 // necessarily an error.
246 // The single global variable which manages descriptors.
248 Descriptors descriptors
;
250 } // End namespace gold.