This change initializes rpc servers associated with disks that are local. It makes object layer initialization on demand, namely on the first request to the object layer. Also adds lock RPC service vendorized minio/dsyncmaster
Krishnan Parthasarathi
8 years ago
committed by
Harshavardhana
parent
f82f535509
commit
e55926e8cf
@ -0,0 +1,107 @@ |
|||||||
|
/* |
||||||
|
* Minio Cloud Storage, (C) 2016 Minio, Inc. |
||||||
|
* |
||||||
|
* 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 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. |
||||||
|
*/ |
||||||
|
|
||||||
|
package main |
||||||
|
|
||||||
|
import ( |
||||||
|
"fmt" |
||||||
|
"net/rpc" |
||||||
|
"path" |
||||||
|
"strings" |
||||||
|
"sync" |
||||||
|
|
||||||
|
router "github.com/gorilla/mux" |
||||||
|
) |
||||||
|
|
||||||
|
const lockRPCPath = "/lock" |
||||||
|
|
||||||
|
type lockServer struct { |
||||||
|
rpcPath string |
||||||
|
mutex sync.Mutex |
||||||
|
lockMap map[string]struct{} |
||||||
|
} |
||||||
|
|
||||||
|
/// Distributed lock handlers
|
||||||
|
|
||||||
|
// LockHandler - rpc handler for lock operation.
|
||||||
|
func (l *lockServer) LockHandler(name *string, reply *bool) error { |
||||||
|
l.mutex.Lock() |
||||||
|
defer l.mutex.Unlock() |
||||||
|
_, ok := l.lockMap[*name] |
||||||
|
if !ok { |
||||||
|
*reply = true |
||||||
|
l.lockMap[*name] = struct{}{} |
||||||
|
return nil |
||||||
|
} |
||||||
|
*reply = false |
||||||
|
return nil |
||||||
|
} |
||||||
|
|
||||||
|
// UnlockHandler - rpc handler for unlock operation.
|
||||||
|
func (l *lockServer) UnlockHandler(name *string, reply *bool) error { |
||||||
|
l.mutex.Lock() |
||||||
|
defer l.mutex.Unlock() |
||||||
|
_, ok := l.lockMap[*name] |
||||||
|
if !ok { |
||||||
|
return fmt.Errorf("Unlock attempted on an un-locked entity: %s", *name) |
||||||
|
} |
||||||
|
*reply = true |
||||||
|
delete(l.lockMap, *name) |
||||||
|
return nil |
||||||
|
} |
||||||
|
|
||||||
|
// Initialize distributed lock.
|
||||||
|
func initDistributedNSLock(mux *router.Router, serverConfig serverCmdConfig) { |
||||||
|
lockServers := newLockServers(serverConfig) |
||||||
|
registerStorageLockers(mux, lockServers) |
||||||
|
} |
||||||
|
|
||||||
|
// Create one lock server for every local storage rpc server.
|
||||||
|
func newLockServers(serverConfig serverCmdConfig) (lockServers []*lockServer) { |
||||||
|
// Initialize posix storage API.
|
||||||
|
exports := serverConfig.disks |
||||||
|
ignoredExports := serverConfig.ignoredDisks |
||||||
|
|
||||||
|
// Save ignored disks in a map
|
||||||
|
skipDisks := make(map[string]bool) |
||||||
|
for _, ignoredExport := range ignoredExports { |
||||||
|
skipDisks[ignoredExport] = true |
||||||
|
} |
||||||
|
for _, export := range exports { |
||||||
|
if skipDisks[export] { |
||||||
|
continue |
||||||
|
} |
||||||
|
if idx := strings.LastIndex(export, ":"); idx != -1 { |
||||||
|
export = export[idx+1:] |
||||||
|
} |
||||||
|
lockServers = append(lockServers, &lockServer{ |
||||||
|
rpcPath: export, |
||||||
|
mutex: sync.Mutex{}, |
||||||
|
lockMap: make(map[string]struct{}), |
||||||
|
}) |
||||||
|
} |
||||||
|
return lockServers |
||||||
|
} |
||||||
|
|
||||||
|
// registerStorageLockers - register locker rpc handlers for valyala/gorpc library clients
|
||||||
|
func registerStorageLockers(mux *router.Router, lockServers []*lockServer) { |
||||||
|
lockRPCServer := rpc.NewServer() |
||||||
|
for _, lockServer := range lockServers { |
||||||
|
lockRPCServer.RegisterName("Dsync", lockServer) |
||||||
|
lockRouter := mux.PathPrefix(reservedBucket).Subrouter() |
||||||
|
lockRouter.Path(path.Join("/lock", lockServer.rpcPath)).Handler(lockRPCServer) |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,202 @@ |
|||||||
|
|
||||||
|
Apache License |
||||||
|
Version 2.0, January 2004 |
||||||
|
http://www.apache.org/licenses/ |
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION |
||||||
|
|
||||||
|
1. Definitions. |
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction, |
||||||
|
and distribution as defined by Sections 1 through 9 of this document. |
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by |
||||||
|
the copyright owner that is granting the License. |
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all |
||||||
|
other entities that control, are controlled by, or are under common |
||||||
|
control with that entity. For the purposes of this definition, |
||||||
|
"control" means (i) the power, direct or indirect, to cause the |
||||||
|
direction or management of such entity, whether by contract or |
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the |
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity. |
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity |
||||||
|
exercising permissions granted by this License. |
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications, |
||||||
|
including but not limited to software source code, documentation |
||||||
|
source, and configuration files. |
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical |
||||||
|
transformation or translation of a Source form, including but |
||||||
|
not limited to compiled object code, generated documentation, |
||||||
|
and conversions to other media types. |
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or |
||||||
|
Object form, made available under the License, as indicated by a |
||||||
|
copyright notice that is included in or attached to the work |
||||||
|
(an example is provided in the Appendix below). |
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object |
||||||
|
form, that is based on (or derived from) the Work and for which the |
||||||
|
editorial revisions, annotations, elaborations, or other modifications |
||||||
|
represent, as a whole, an original work of authorship. For the purposes |
||||||
|
of this License, Derivative Works shall not include works that remain |
||||||
|
separable from, or merely link (or bind by name) to the interfaces of, |
||||||
|
the Work and Derivative Works thereof. |
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including |
||||||
|
the original version of the Work and any modifications or additions |
||||||
|
to that Work or Derivative Works thereof, that is intentionally |
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner |
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of |
||||||
|
the copyright owner. For the purposes of this definition, "submitted" |
||||||
|
means any form of electronic, verbal, or written communication sent |
||||||
|
to the Licensor or its representatives, including but not limited to |
||||||
|
communication on electronic mailing lists, source code control systems, |
||||||
|
and issue tracking systems that are managed by, or on behalf of, the |
||||||
|
Licensor for the purpose of discussing and improving the Work, but |
||||||
|
excluding communication that is conspicuously marked or otherwise |
||||||
|
designated in writing by the copyright owner as "Not a Contribution." |
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity |
||||||
|
on behalf of whom a Contribution has been received by Licensor and |
||||||
|
subsequently incorporated within the Work. |
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of |
||||||
|
this License, each Contributor hereby grants to You a perpetual, |
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
||||||
|
copyright license to reproduce, prepare Derivative Works of, |
||||||
|
publicly display, publicly perform, sublicense, and distribute the |
||||||
|
Work and such Derivative Works in Source or Object form. |
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of |
||||||
|
this License, each Contributor hereby grants to You a perpetual, |
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable |
||||||
|
(except as stated in this section) patent license to make, have made, |
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work, |
||||||
|
where such license applies only to those patent claims licensable |
||||||
|
by such Contributor that are necessarily infringed by their |
||||||
|
Contribution(s) alone or by combination of their Contribution(s) |
||||||
|
with the Work to which such Contribution(s) was submitted. If You |
||||||
|
institute patent litigation against any entity (including a |
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work |
||||||
|
or a Contribution incorporated within the Work constitutes direct |
||||||
|
or contributory patent infringement, then any patent licenses |
||||||
|
granted to You under this License for that Work shall terminate |
||||||
|
as of the date such litigation is filed. |
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the |
||||||
|
Work or Derivative Works thereof in any medium, with or without |
||||||
|
modifications, and in Source or Object form, provided that You |
||||||
|
meet the following conditions: |
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or |
||||||
|
Derivative Works a copy of this License; and |
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices |
||||||
|
stating that You changed the files; and |
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works |
||||||
|
that You distribute, all copyright, patent, trademark, and |
||||||
|
attribution notices from the Source form of the Work, |
||||||
|
excluding those notices that do not pertain to any part of |
||||||
|
the Derivative Works; and |
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its |
||||||
|
distribution, then any Derivative Works that You distribute must |
||||||
|
include a readable copy of the attribution notices contained |
||||||
|
within such NOTICE file, excluding those notices that do not |
||||||
|
pertain to any part of the Derivative Works, in at least one |
||||||
|
of the following places: within a NOTICE text file distributed |
||||||
|
as part of the Derivative Works; within the Source form or |
||||||
|
documentation, if provided along with the Derivative Works; or, |
||||||
|
within a display generated by the Derivative Works, if and |
||||||
|
wherever such third-party notices normally appear. The contents |
||||||
|
of the NOTICE file are for informational purposes only and |
||||||
|
do not modify the License. You may add Your own attribution |
||||||
|
notices within Derivative Works that You distribute, alongside |
||||||
|
or as an addendum to the NOTICE text from the Work, provided |
||||||
|
that such additional attribution notices cannot be construed |
||||||
|
as modifying the License. |
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and |
||||||
|
may provide additional or different license terms and conditions |
||||||
|
for use, reproduction, or distribution of Your modifications, or |
||||||
|
for any such Derivative Works as a whole, provided Your use, |
||||||
|
reproduction, and distribution of the Work otherwise complies with |
||||||
|
the conditions stated in this License. |
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise, |
||||||
|
any Contribution intentionally submitted for inclusion in the Work |
||||||
|
by You to the Licensor shall be under the terms and conditions of |
||||||
|
this License, without any additional terms or conditions. |
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify |
||||||
|
the terms of any separate license agreement you may have executed |
||||||
|
with Licensor regarding such Contributions. |
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade |
||||||
|
names, trademarks, service marks, or product names of the Licensor, |
||||||
|
except as required for reasonable and customary use in describing the |
||||||
|
origin of the Work and reproducing the content of the NOTICE file. |
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or |
||||||
|
agreed to in writing, Licensor provides the Work (and each |
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS, |
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
||||||
|
implied, including, without limitation, any warranties or conditions |
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A |
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the |
||||||
|
appropriateness of using or redistributing the Work and assume any |
||||||
|
risks associated with Your exercise of permissions under this License. |
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory, |
||||||
|
whether in tort (including negligence), contract, or otherwise, |
||||||
|
unless required by applicable law (such as deliberate and grossly |
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be |
||||||
|
liable to You for damages, including any direct, indirect, special, |
||||||
|
incidental, or consequential damages of any character arising as a |
||||||
|
result of this License or out of the use or inability to use the |
||||||
|
Work (including but not limited to damages for loss of goodwill, |
||||||
|
work stoppage, computer failure or malfunction, or any and all |
||||||
|
other commercial damages or losses), even if such Contributor |
||||||
|
has been advised of the possibility of such damages. |
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing |
||||||
|
the Work or Derivative Works thereof, You may choose to offer, |
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity, |
||||||
|
or other liability obligations and/or rights consistent with this |
||||||
|
License. However, in accepting such obligations, You may act only |
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf |
||||||
|
of any other Contributor, and only if You agree to indemnify, |
||||||
|
defend, and hold each Contributor harmless for any liability |
||||||
|
incurred by, or claims asserted against, such Contributor by reason |
||||||
|
of your accepting any such warranty or additional liability. |
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS |
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work. |
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following |
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]" |
||||||
|
replaced with your own identifying information. (Don't include |
||||||
|
the brackets!) The text should be enclosed in the appropriate |
||||||
|
comment syntax for the file format. We also recommend that a |
||||||
|
file or class name and description of purpose be included on the |
||||||
|
same "printed page" as the copyright notice for easier |
||||||
|
identification within third-party archives. |
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner] |
||||||
|
|
||||||
|
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 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. |
||||||
@ -0,0 +1,81 @@ |
|||||||
|
dsync |
||||||
|
===== |
||||||
|
|
||||||
|
A distributed sync package. |
||||||
|
|
||||||
|
Introduction |
||||||
|
------------ |
||||||
|
|
||||||
|
`dsync` is a package for doing distributed locks over a network of `n` nodes. It is designed with simplicity in mind and hence offers limited scalability (`n <= 16`). Each node will be connected to all other nodes and lock requests from any node will be broadcast to all connected nodes. A node will succeed in getting the lock if `n/2 + 1` nodes (including itself) respond positively. If the lock is acquired it can be held for some time and needs to be released afterwards. This will cause the release to be broadcast to all nodes after which the lock becomes available again. |
||||||
|
|
||||||
|
Design goals |
||||||
|
------------ |
||||||
|
|
||||||
|
* Simple design: by keeping the design simple, many tricky edge cases can be avoided. |
||||||
|
* No master node: there is no concept of a master node which, if this would be used and the master would be down, causes locking to come to a complete stop. (Unless you have a design with a slave node but this adds yet more complexity.) |
||||||
|
* Resilient: if one or more nodes go down, the other nodes should not be affected and can continue to acquire locks (provided not more than `n/2 - 1` nodes are down). |
||||||
|
* Automatically reconnect to (restarted) nodes. |
||||||
|
* Compatible with `sync/mutex` API. |
||||||
|
|
||||||
|
|
||||||
|
Restrictions |
||||||
|
------------ |
||||||
|
|
||||||
|
* Limited scalability: up to 16 nodes. |
||||||
|
* Fixed configuration: changes in the number and/or network names/IP addresses need a restart of all nodes in order to take effect. |
||||||
|
* If a down node comes up, it will not in any way (re)acquire any locks that it may have held. |
||||||
|
* Not designed for high performance applications such as key/value stores |
||||||
|
|
||||||
|
Performance |
||||||
|
----------- |
||||||
|
|
||||||
|
* Lock requests (successful) should not take longer than 1ms (provided decent network connection of 1 Gbit or more between the nodes) |
||||||
|
* Support up to 4000 locks per node per second. |
||||||
|
* Scale linearly with the number of locks. For the maximum size case of 16 nodes this means a maximum of 64K locks/sec (and 2048K lock request & release messages/sec) |
||||||
|
* Do not take more than (overall) 10% CPU usage |
||||||
|
|
||||||
|
Issues |
||||||
|
------ |
||||||
|
|
||||||
|
* In case the node that has the lock goes down, the lock release will not be broadcast: what do we do? (periodically ping 'back' to requesting node from all nodes that have the lock?) Or detect that the network connection has gone down. |
||||||
|
* If one of the nodes that participated in the lock goes down, this is not a problem since (when it comes back online) the node that originally acquired the lock will still have it, and a request for a new lock will fail due to only `n/2` being available. |
||||||
|
* If two nodes go down and both participated in the lock then there is a chance that a new lock will acquire locks from `n/2 + 1` nodes and will success, so we would have two concurrent locks. One way to counter this would be to monitor the network connections from the nodes that originated the lock, and, upon losing a connection to a node that granted a lock, get a new lock from a free node. |
||||||
|
* When two nodes want to acquire the same lock, it is possible for both to just acquire `n` locks and there is no majority winner so both would fail (and presumably fail back to their clients?). This then requires a retry in order to acquire the lock at a later time. |
||||||
|
* What if late acquire response still comes in after lock has been obtained (quorum is in) and has already been released again. |
||||||
|
|
||||||
|
Comparison to other techniques |
||||||
|
------------------------------ |
||||||
|
|
||||||
|
We are well aware that there are more sophisticated systems such as zookeeper, raft, etc but we found that for our limited use case this was adding too much complexity. So if `dsync` does not meet your requirements than you are probably better off using one of those systems. |
||||||
|
|
||||||
|
Performance |
||||||
|
----------- |
||||||
|
|
||||||
|
``` |
||||||
|
benchmark old ns/op new ns/op delta |
||||||
|
BenchmarkMutexUncontended-8 4.22 1164018 +27583264.93% |
||||||
|
BenchmarkMutex-8 96.5 1223266 +1267533.16% |
||||||
|
BenchmarkMutexSlack-8 120 1192900 +993983.33% |
||||||
|
BenchmarkMutexWork-8 108 1239893 +1147949.07% |
||||||
|
BenchmarkMutexWorkSlack-8 142 1210129 +852103.52% |
||||||
|
BenchmarkMutexNoSpin-8 292 319479 +109310.62% |
||||||
|
BenchmarkMutexSpin-8 1163 1270066 +109106.02% |
||||||
|
``` |
||||||
|
|
||||||
|
Usage |
||||||
|
----- |
||||||
|
|
||||||
|
Explain usage |
||||||
|
``` |
||||||
|
``` |
||||||
|
|
||||||
|
|
||||||
|
License |
||||||
|
------- |
||||||
|
|
||||||
|
Released under the Apache License v2.0. You can find the complete text in the file LICENSE. |
||||||
|
|
||||||
|
Contributing |
||||||
|
------------ |
||||||
|
|
||||||
|
Contributions are welcome, please send PRs for any enhancements. |
||||||
@ -0,0 +1,311 @@ |
|||||||
|
/* |
||||||
|
* Minio Cloud Storage, (C) 2016 Minio, Inc. |
||||||
|
* |
||||||
|
* 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 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. |
||||||
|
*/ |
||||||
|
|
||||||
|
package dsync |
||||||
|
|
||||||
|
import ( |
||||||
|
"log" |
||||||
|
"math" |
||||||
|
"math/rand" |
||||||
|
"net/rpc" |
||||||
|
"strings" |
||||||
|
"sync" |
||||||
|
"time" |
||||||
|
) |
||||||
|
|
||||||
|
const DMutexAcquireTimeout = 25 * time.Millisecond |
||||||
|
|
||||||
|
// A DMutex is a distributed mutual exclusion lock.
|
||||||
|
type DMutex struct { |
||||||
|
Name string |
||||||
|
locks []bool // Array of nodes that granted a lock
|
||||||
|
uids []string // Array of uids for verification of sending correct release messages
|
||||||
|
m sync.Mutex // Mutex to prevent multiple simultaneous locks from this node
|
||||||
|
|
||||||
|
// TODO: Decide: create per object or create once for whole class
|
||||||
|
clnts []*rpc.Client |
||||||
|
} |
||||||
|
|
||||||
|
type Granted struct { |
||||||
|
index int |
||||||
|
locked bool |
||||||
|
uid string |
||||||
|
} |
||||||
|
|
||||||
|
func connectLazy(dm *DMutex) { |
||||||
|
if dm.clnts == nil { |
||||||
|
dm.clnts = make([]*rpc.Client, n) |
||||||
|
} |
||||||
|
for i := range dm.clnts { |
||||||
|
if dm.clnts[i] == nil { |
||||||
|
// pass in unique path (as required by server.HandleHTTP()
|
||||||
|
dm.clnts[i], _ = rpc.DialHTTPPath("tcp", nodes[i], rpcPath+"-"+strings.Split(nodes[i], ":")[1]) |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// Lock locks dm.
|
||||||
|
//
|
||||||
|
// If the lock is already in use, the calling goroutine
|
||||||
|
// blocks until the mutex is available.
|
||||||
|
func (dm *DMutex) Lock() { |
||||||
|
|
||||||
|
// Shield Lock() with local mutex in order to prevent more than
|
||||||
|
// one broadcast going out at the same time from this node
|
||||||
|
dm.m.Lock() |
||||||
|
defer dm.m.Unlock() |
||||||
|
|
||||||
|
runs, backOff := 1, 1 |
||||||
|
|
||||||
|
for { |
||||||
|
// TODO: Implement reconnect
|
||||||
|
connectLazy(dm) |
||||||
|
|
||||||
|
// create temp arrays on stack
|
||||||
|
locks := make([]bool, n) |
||||||
|
ids := make([]string, n) |
||||||
|
|
||||||
|
// try to acquire the lock
|
||||||
|
success := lock(dm.clnts, &locks, &ids, dm.Name) |
||||||
|
if success { |
||||||
|
// if success, copy array to object
|
||||||
|
dm.locks = make([]bool, n) |
||||||
|
copy(dm.locks, locks[:]) |
||||||
|
dm.uids = make([]string, n) |
||||||
|
copy(dm.uids, ids[:]) |
||||||
|
return |
||||||
|
} |
||||||
|
|
||||||
|
// We timed out on the previous lock, incrementally wait for a longer back-off time,
|
||||||
|
// and try again afterwards
|
||||||
|
time.Sleep(time.Duration(backOff) * time.Millisecond) |
||||||
|
|
||||||
|
backOff += int(rand.Float64() * math.Pow(2, float64(runs))) |
||||||
|
if backOff > 1024 { |
||||||
|
backOff = backOff % 64 |
||||||
|
|
||||||
|
runs = 1 // reset runs
|
||||||
|
} else if runs < 10 { |
||||||
|
runs++ |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
func (dm *DMutex) tryLockTimeout() bool { |
||||||
|
|
||||||
|
// Shield Lock() with local mutex in order to prevent more than
|
||||||
|
// one broadcast going out at the same time from this node
|
||||||
|
dm.m.Lock() |
||||||
|
defer dm.m.Unlock() |
||||||
|
|
||||||
|
// TODO: Implement reconnect
|
||||||
|
connectLazy(dm) |
||||||
|
|
||||||
|
// create temp arrays on stack
|
||||||
|
locks := make([]bool, n) |
||||||
|
ids := make([]string, n) |
||||||
|
|
||||||
|
// try to acquire the lock
|
||||||
|
success := lock(dm.clnts, &locks, &ids, dm.Name) |
||||||
|
if success { |
||||||
|
// if success, copy array to object
|
||||||
|
dm.locks = make([]bool, n) |
||||||
|
copy(dm.locks, locks[:]) |
||||||
|
dm.uids = make([]string, n) |
||||||
|
copy(dm.uids, ids[:]) |
||||||
|
} |
||||||
|
return success |
||||||
|
} |
||||||
|
|
||||||
|
// lock tries to acquire the distributed lock, returning true or false
|
||||||
|
//
|
||||||
|
func lock(clnts []*rpc.Client, locks *[]bool, uids *[]string, lockName string) bool { |
||||||
|
|
||||||
|
// Create buffered channel of quorum size
|
||||||
|
ch := make(chan Granted, n/2+1) |
||||||
|
|
||||||
|
for index, c := range clnts { |
||||||
|
|
||||||
|
if c == nil { |
||||||
|
continue |
||||||
|
} |
||||||
|
// broadcast lock request to all nodes
|
||||||
|
go func(index int, c *rpc.Client) { |
||||||
|
// All client methods issuing RPCs are thread-safe and goroutine-safe,
|
||||||
|
// i.e. it is safe to call them from multiple concurrently running go routines.
|
||||||
|
var status bool |
||||||
|
err := c.Call("Dsync.Lock", lockName, &status) |
||||||
|
|
||||||
|
locked, uid := false, "" |
||||||
|
if err == nil { |
||||||
|
locked = status |
||||||
|
// TODO: Get UIOD again
|
||||||
|
uid = "" |
||||||
|
} else { |
||||||
|
// silently ignore error, retry later
|
||||||
|
} |
||||||
|
|
||||||
|
ch <- Granted{index: index, locked: locked, uid: uid} |
||||||
|
|
||||||
|
}(index, c) |
||||||
|
} |
||||||
|
|
||||||
|
var wg sync.WaitGroup |
||||||
|
wg.Add(1) |
||||||
|
|
||||||
|
quorum := false |
||||||
|
|
||||||
|
go func() { |
||||||
|
|
||||||
|
// Wait until we have received (minimally) quorum number of responses or timeout
|
||||||
|
i := 0 |
||||||
|
done := false |
||||||
|
timeout := time.After(DMutexAcquireTimeout) |
||||||
|
|
||||||
|
for ; i < n; i++ { |
||||||
|
|
||||||
|
select { |
||||||
|
case grant := <-ch: |
||||||
|
if grant.locked { |
||||||
|
// Mark that this node has acquired the lock
|
||||||
|
(*locks)[grant.index] = true |
||||||
|
(*uids)[grant.index] = grant.uid |
||||||
|
} else { |
||||||
|
done = true |
||||||
|
//fmt.Println("one lock failed before quorum -- release locks acquired")
|
||||||
|
releaseAll(clnts, locks, uids, lockName) |
||||||
|
} |
||||||
|
|
||||||
|
case <-timeout: |
||||||
|
done = true |
||||||
|
// timeout happened, maybe one of the nodes is slow, count
|
||||||
|
// number of locks to check whether we have quorum or not
|
||||||
|
if !quorumMet(locks) { |
||||||
|
//fmt.Println("timed out -- release locks acquired")
|
||||||
|
releaseAll(clnts, locks, uids, lockName) |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
if done { |
||||||
|
break |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// Count locks in order to determine whterh we have quorum or not
|
||||||
|
quorum = quorumMet(locks) |
||||||
|
|
||||||
|
// Signal that we have the quorum
|
||||||
|
wg.Done() |
||||||
|
|
||||||
|
// Wait for the other responses and immediately release the locks
|
||||||
|
// (do not add them to the locks array because the DMutex could
|
||||||
|
// already has been unlocked again by the original calling thread)
|
||||||
|
for ; i < n; i++ { |
||||||
|
grantToBeReleased := <-ch |
||||||
|
if grantToBeReleased.locked { |
||||||
|
// release lock
|
||||||
|
go sendRelease(clnts[grantToBeReleased.index], lockName, grantToBeReleased.uid) |
||||||
|
} |
||||||
|
} |
||||||
|
}() |
||||||
|
|
||||||
|
wg.Wait() |
||||||
|
|
||||||
|
return quorum |
||||||
|
} |
||||||
|
|
||||||
|
// quorumMet determines whether we have acquired n/2+1 underlying locks or not
|
||||||
|
func quorumMet(locks *[]bool) bool { |
||||||
|
|
||||||
|
count := 0 |
||||||
|
for _, locked := range *locks { |
||||||
|
if locked { |
||||||
|
count++ |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
return count >= n/2+1 |
||||||
|
} |
||||||
|
|
||||||
|
// releaseAll releases all locks that are marked as locked
|
||||||
|
func releaseAll(clnts []*rpc.Client, locks *[]bool, ids *[]string, lockName string) { |
||||||
|
|
||||||
|
for lock := 0; lock < n; lock++ { |
||||||
|
if (*locks)[lock] { |
||||||
|
go sendRelease(clnts[lock], lockName, (*ids)[lock]) |
||||||
|
(*locks)[lock] = false |
||||||
|
(*ids)[lock] = "" |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
} |
||||||
|
|
||||||
|
// hasLock returns whether or not a node participated in granting the lock
|
||||||
|
func (dm *DMutex) hasLock(node string) bool { |
||||||
|
|
||||||
|
for index, n := range nodes { |
||||||
|
if n == node { |
||||||
|
return dm.locks[index] |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
return false |
||||||
|
} |
||||||
|
|
||||||
|
// locked returns whether or not we have met the quorum
|
||||||
|
func (dm *DMutex) locked() bool { |
||||||
|
|
||||||
|
locks := make([]bool, n) |
||||||
|
copy(locks[:], dm.locks[:]) |
||||||
|
|
||||||
|
return quorumMet(&locks) |
||||||
|
} |
||||||
|
|
||||||
|
// Unlock unlocks dm.
|
||||||
|
//
|
||||||
|
// It is a run-time error if dm is not locked on entry to Unlock.
|
||||||
|
func (dm *DMutex) Unlock() { |
||||||
|
|
||||||
|
// Verify that we have the lock or panic otherwise (similar to sync.mutex)
|
||||||
|
if !dm.locked() { |
||||||
|
panic("dsync: unlock of unlocked distributed mutex") |
||||||
|
} |
||||||
|
|
||||||
|
// We don't need to wait until we have released all the locks (or the quorum)
|
||||||
|
// (a subsequent lock will retry automatically in case it would fail to get
|
||||||
|
// quorum)
|
||||||
|
for index, c := range dm.clnts { |
||||||
|
|
||||||
|
if dm.locks[index] { |
||||||
|
// broadcast lock release to all nodes the granted the lock
|
||||||
|
go sendRelease(c, dm.Name, dm.uids[index]) |
||||||
|
|
||||||
|
dm.locks[index] = false |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// sendRelease sends a release message to a node that previously granted a lock
|
||||||
|
func sendRelease(c *rpc.Client, name, uid string) { |
||||||
|
|
||||||
|
// All client methods issuing RPCs are thread-safe and goroutine-safe,
|
||||||
|
// i.e. it is safe to call them from multiple concurrently running goroutines.
|
||||||
|
var status bool |
||||||
|
// TODO: Send UID to server
|
||||||
|
if err := c.Call("Dsync.Unlock", name, &status); err != nil { |
||||||
|
log.Fatal("Unlock on %s failed on client %v", name, c) |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,143 @@ |
|||||||
|
/* |
||||||
|
* Minio Cloud Storage, (C) 2016 Minio, Inc. |
||||||
|
* |
||||||
|
* 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 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. |
||||||
|
*/ |
||||||
|
|
||||||
|
package dsync |
||||||
|
|
||||||
|
import ( |
||||||
|
"fmt" |
||||||
|
"sync" |
||||||
|
) |
||||||
|
|
||||||
|
const maxReaders = 8 |
||||||
|
|
||||||
|
type DRWMutex struct { |
||||||
|
rArray []*DMutex |
||||||
|
rLockedArray []bool |
||||||
|
w DMutex // held if there are pending writers
|
||||||
|
m sync.Mutex // Mutex to prevent multiple simultaneous locks from this node
|
||||||
|
m2 sync.Mutex // Mutex to prevent multiple simultaneous locks from this node
|
||||||
|
} |
||||||
|
|
||||||
|
func NewDRWMutex(name string) (drw *DRWMutex) { |
||||||
|
|
||||||
|
rArray := make([]*DMutex, maxReaders) |
||||||
|
rLockedArray := make([]bool, maxReaders) |
||||||
|
|
||||||
|
for r := 0; r < maxReaders; r++ { |
||||||
|
rArray[r] = &DMutex{Name: fmt.Sprintf("%s-r%d", name, r)} |
||||||
|
} |
||||||
|
|
||||||
|
return &DRWMutex{ |
||||||
|
rArray: rArray, |
||||||
|
rLockedArray: rLockedArray, |
||||||
|
w: DMutex{Name: name + "-w"}} |
||||||
|
} |
||||||
|
|
||||||
|
// RLock locks drw for reading.
|
||||||
|
func (drw *DRWMutex) RLock() { |
||||||
|
|
||||||
|
drw.m.Lock() |
||||||
|
defer drw.m.Unlock() |
||||||
|
|
||||||
|
// Check if no write is active, block otherwise
|
||||||
|
// Can skip this?
|
||||||
|
drw.w.Lock() |
||||||
|
drw.w.Unlock() |
||||||
|
|
||||||
|
// Lock either one of the reader locks
|
||||||
|
for i := 0; ; i++ { |
||||||
|
drw.rLockedArray[i%maxReaders] = drw.rArray[i%maxReaders].tryLockTimeout() |
||||||
|
if drw.rLockedArray[i%maxReaders] { |
||||||
|
return |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// RUnlock undoes a single RLock call;
|
||||||
|
// it does not affect other simultaneous readers.
|
||||||
|
// It is a run-time error if rw is not locked for reading
|
||||||
|
// on entry to RUnlock.
|
||||||
|
func (drw *DRWMutex) RUnlock() { |
||||||
|
|
||||||
|
drw.m.Lock() |
||||||
|
defer drw.m.Unlock() |
||||||
|
|
||||||
|
// Unlock whichever readlock that was acquired)
|
||||||
|
for r := 0; r < maxReaders; r++ { |
||||||
|
if drw.rLockedArray[r] { |
||||||
|
drw.rArray[r].Unlock() |
||||||
|
drw.rLockedArray[r] = false |
||||||
|
// we only want to release a single read lock at a time
|
||||||
|
break |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// Lock locks rw for writing.
|
||||||
|
// If the lock is already locked for reading or writing,
|
||||||
|
// Lock blocks until the lock is available.
|
||||||
|
// To ensure that the lock eventually becomes available,
|
||||||
|
// a blocked Lock call excludes new readers from acquiring
|
||||||
|
// the lock.
|
||||||
|
func (drw *DRWMutex) Lock() { |
||||||
|
|
||||||
|
drw.m.Lock() |
||||||
|
defer drw.m.Unlock() |
||||||
|
|
||||||
|
// First, resolve competition with other writers.
|
||||||
|
drw.w.Lock() |
||||||
|
|
||||||
|
// Acquire all read locks.
|
||||||
|
var wg sync.WaitGroup |
||||||
|
wg.Add(maxReaders) |
||||||
|
|
||||||
|
for r := 0; r < maxReaders; r++ { |
||||||
|
go func(r int) { |
||||||
|
defer wg.Done() |
||||||
|
drw.rArray[r].Lock() |
||||||
|
drw.rLockedArray[r] = true |
||||||
|
}(r) |
||||||
|
} |
||||||
|
|
||||||
|
wg.Wait() |
||||||
|
} |
||||||
|
|
||||||
|
// Unlock unlocks rw for writing. It is a run-time error if rw is
|
||||||
|
// not locked for writing on entry to Unlock.
|
||||||
|
//
|
||||||
|
// As with Mutexes, a locked RWMutex is not associated with a particular
|
||||||
|
// goroutine. One goroutine may RLock (Lock) an RWMutex and then
|
||||||
|
// arrange for another goroutine to RUnlock (Unlock) it.
|
||||||
|
func (drw *DRWMutex) Unlock() { |
||||||
|
|
||||||
|
drw.m.Lock() |
||||||
|
defer drw.m.Unlock() |
||||||
|
|
||||||
|
for r := 0; r < maxReaders; r++ { |
||||||
|
if !drw.rLockedArray[r] { |
||||||
|
panic("dsync: unlock of unlocked distributed rwmutex") |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// Unlock all read locks
|
||||||
|
for r := 0; r < maxReaders; r++ { |
||||||
|
drw.rArray[r].Unlock() |
||||||
|
drw.rLockedArray[r] = false |
||||||
|
} |
||||||
|
|
||||||
|
// Allow other writers to proceed.
|
||||||
|
drw.w.Unlock() |
||||||
|
} |
||||||
@ -0,0 +1,56 @@ |
|||||||
|
/* |
||||||
|
* Minio Cloud Storage, (C) 2016 Minio, Inc. |
||||||
|
* |
||||||
|
* 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 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. |
||||||
|
*/ |
||||||
|
|
||||||
|
package dsync |
||||||
|
|
||||||
|
import ( |
||||||
|
"errors" |
||||||
|
"net/rpc" |
||||||
|
) |
||||||
|
|
||||||
|
const RpcPath = "/dsync" |
||||||
|
const DebugPath = "/debug" |
||||||
|
|
||||||
|
const DefaultPath = "/rpc/dsync" |
||||||
|
|
||||||
|
var n int |
||||||
|
var nodes []string |
||||||
|
var rpcPath string |
||||||
|
|
||||||
|
func closeClients(clients []*rpc.Client) { |
||||||
|
for _, clnt := range clients { |
||||||
|
clnt.Close() |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// Same as SetNodes, but takes a path argument different from the package-level default.
|
||||||
|
func SetNodesWithPath(nodeList []string, path string) (err error) { |
||||||
|
|
||||||
|
// Validate if number of nodes is within allowable range.
|
||||||
|
if n != 0 { |
||||||
|
return errors.New("Cannot reinitialize dsync package") |
||||||
|
} else if len(nodeList) < 4 { |
||||||
|
return errors.New("Dsync not designed for less than 4 nodes") |
||||||
|
} else if len(nodeList) > 16 { |
||||||
|
return errors.New("Dsync not designed for more than 16 nodes") |
||||||
|
} |
||||||
|
|
||||||
|
nodes = make([]string, len(nodeList)) |
||||||
|
copy(nodes, nodeList[:]) |
||||||
|
rpcPath = path |
||||||
|
n = len(nodes) |
||||||
|
return nil |
||||||
|
} |
||||||
Loading…
Reference in new issue