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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/* Compatibility read-write lock
(C) 2016-2017 Niall Douglas <http://www.nedproductions.biz/> (11 commits)
File Created: April 2016
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License in the accompanying file
Licence.txt or at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Distributed under the Boost Software License, Version 1.0.
(See accompanying file Licence.txt or copy at
http://www.boost.org/LICENSE_1_0.txt)
*/
#ifndef BOOST_AFIO_SHARED_FS_MUTEX_LOCK_FILES_HPP
#define BOOST_AFIO_SHARED_FS_MUTEX_LOCK_FILES_HPP
#include "../../file_handle.hpp"
#include "base.hpp"
#include "../../small_prng.hpp"
//! \file lock_files.hpp Provides algorithm::shared_fs_mutex::lock_files
BOOST_AFIO_V2_NAMESPACE_BEGIN
namespace algorithm
{
namespace shared_fs_mutex
{
/*! \class lock_files
\brief Many entity exclusive compatibility file system based lock
This is a very simple many entity shared mutex likely to work almost anywhere without surprises.
It works by trying to exclusively create a file called the hex of the entity id. If it fails to
exclusively create any file, it deletes all previously created files, randomises the order
and tries locking them again until success. The only real reason to use this implementation
is its excellent compatibility with almost everything, most users will want byte_ranges instead.
- Compatible with all networked file systems.
- Linear complexity to number of concurrent users.
- Exponential complexity to number of contended entities being concurrently locked.
- Requests for shared locks are treated as if for exclusive locks.
Caveats:
- No ability to sleep until a lock becomes free, so CPUs are spun at 100%.
- On POSIX only sudden process exit with locks held will deadlock all other users by leaving stale
files around.
- Costs a file descriptor per entity locked.
- Sudden power loss during use will deadlock first user after reboot, again due to stale files.
- Currently this implementation does not permit more than one lock() per instance as the lock
information is stored as member data. Creating multiple instances referring to the same path
works fine. This could be fixed easily, but it would require a memory allocation per lock and
user demand that this is actually a problem in practice.
- Leaves many 16 character long hexadecimal named files in the supplied directory which may
confuse users. Tip: create a hidden lockfile directory.
Fixing the stale lock file problem could be quite trivial - simply byte range lock the first byte
in the lock file to detect when a lock file is stale. However in this situation using the
byte_ranges algorithm would be far superior, so implementing stale lock file clean up is left up
to the user.
*/
class lock_files : public shared_fs_mutex
{
file_handle::path_type _path;
std::vector<file_handle> _hs;
lock_files(file_handle::path_type &&o)
: _path(std::move(o))
{
}
lock_files(const lock_files &) = delete;
lock_files &operator=(const lock_files &) = delete;
public:
//! The type of an entity id
using entity_type = shared_fs_mutex::entity_type;
//! The type of a sequence of entities
using entities_type = shared_fs_mutex::entities_type;
//! Move constructor
lock_files(lock_files &&o) noexcept : _path(std::move(o._path)), _hs(std::move(o._hs)) {}
//! Move assign
lock_files &operator=(lock_files &&o) noexcept
{
_path = std::move(o._path);
_hs = std::move(o._hs);
return *this;
}
//! Initialises a shared filing system mutex using the directory at \em lockdir
//[[bindlib::make_free]]
static result<lock_files> fs_mutex_lock_files(file_handle::path_type lockdir) noexcept
{
BOOST_AFIO_LOG_FUNCTION_CALL(0);
return lock_files(std::move(lockdir));
}
//! Return the path to the directory being used for this lock
const file_handle::path_type &path() const noexcept { return _path; }
protected:
virtual result<void> _lock(entities_guard &out, deadline d, bool spin_not_sleep) noexcept override final
{
BOOST_AFIO_LOG_FUNCTION_CALL(this);
stl11::chrono::steady_clock::time_point began_steady;
stl11::chrono::system_clock::time_point end_utc;
if(d)
{
if((d).steady)
began_steady = stl11::chrono::steady_clock::now();
else
end_utc = (d).to_time_point();
}
size_t n;
// Create a set of paths to files to exclusively create
std::vector<fixme_path> entity_paths(out.entities.size());
for(n = 0; n < out.entities.size(); n++)
{
auto v = out.entities[n].value;
entity_paths[n] = _path / boost_lite::algorithm::string::to_hex_string(span<char>((char *) &v, 8));
}
_hs.resize(out.entities.size());
do
{
size_t was_contended = (size_t) -1;
{
auto undo = undoer([&] {
// 0 to (n-1) need to be closed
if(n > 0)
{
--n;
// Now 0 to n needs to be closed
for(; n > 0; n--)
{
(void) _hs[n].close(); // delete on close semantics deletes the file
}
(void) _hs[0].close();
}
});
for(n = 0; n < out.entities.size(); n++)
{
auto ret = file_handle::file(entity_paths[n], file_handle::mode::write, file_handle::creation::only_if_not_exist, file_handle::caching::temporary, file_handle::flag::unlink_on_close);
if(ret.has_error())
{
const auto &ec = ret.get_error();
if(ec.category() != std::generic_category() || (ec.value() != EAGAIN && ec.value() != EEXIST))
return ret.get_error();
// Collided with another locker
was_contended = n;
break;
}
_hs[n] = std::move(ret.get());
}
if(n == out.entities.size())
undo.dismiss();
}
if(n != out.entities.size())
{
if(d)
{
if((d).steady)
{
if(stl11::chrono::steady_clock::now() >= (began_steady + stl11::chrono::nanoseconds((d).nsecs)))
return make_errored_result<void>(stl11::errc::timed_out);
}
else
{
if(stl11::chrono::system_clock::now() >= end_utc)
return make_errored_result<void>(stl11::errc::timed_out);
}
}
// Move was_contended to front and randomise rest of out.entities
std::swap(out.entities[was_contended], out.entities[0]);
auto front = out.entities.begin();
++front;
boost_lite::algorithm::small_prng::random_shuffle(front, out.entities.end());
// Sleep for a very short time
if(!spin_not_sleep)
std::this_thread::yield();
}
} while(n < out.entities.size());
return make_valued_result<void>();
}
public:
virtual void unlock(entities_type, unsigned long long) noexcept override final
{
BOOST_AFIO_LOG_FUNCTION_CALL(this);
for(auto &i : _hs)
{
(void) i.close(); // delete on close semantics deletes the file
}
}
};
} // namespace
} // namespace
BOOST_AFIO_V2_NAMESPACE_END
#endif
|
