From 5fe1ab766be42466bea1856e3e13981a670a9b12 Mon Sep 17 00:00:00 2001 From: ncabatoff Date: Tue, 10 Mar 2020 16:01:20 -0400 Subject: [PATCH] Add option to detect deadlocks in Core.stateLock using build tag `deadlock` (#8524) --- go.mod | 2 + go.sum | 4 + vault/core.go | 2 +- vault/deadlock.go | 21 ++ vault/expiration.go | 2 +- vault/lock.go | 19 + vendor/github.com/petermattis/goid/.gitignore | 4 + .../github.com/petermattis/goid/.travis.yml | 11 + vendor/github.com/petermattis/goid/LICENSE | 202 +++++++++++ vendor/github.com/petermattis/goid/README.md | 5 + vendor/github.com/petermattis/goid/goid.go | 35 ++ .../github.com/petermattis/goid/goid_gccgo.go | 25 ++ .../github.com/petermattis/goid/goid_go1.3.c | 23 ++ .../github.com/petermattis/goid/goid_go1.3.go | 21 ++ .../github.com/petermattis/goid/goid_go1.4.go | 34 ++ .../github.com/petermattis/goid/goid_go1.4.s | 18 + .../petermattis/goid/goid_go1.5_amd64.go | 21 ++ .../petermattis/goid/goid_go1.5_amd64.s | 29 ++ .../petermattis/goid/goid_go1.5_arm.go | 26 ++ .../petermattis/goid/goid_go1.5_arm.s | 27 ++ .../github.com/petermattis/goid/goid_slow.go | 23 ++ .../petermattis/goid/runtime_gccgo_go1.8.go | 16 + .../petermattis/goid/runtime_go1.5.go | 56 +++ .../petermattis/goid/runtime_go1.6.go | 42 +++ .../petermattis/goid/runtime_go1.9.go | 36 ++ .../sasha-s/go-deadlock/.travis.yml | 10 + vendor/github.com/sasha-s/go-deadlock/LICENSE | 201 +++++++++++ .../github.com/sasha-s/go-deadlock/Readme.md | 117 +++++++ .../sasha-s/go-deadlock/deadlock.go | 325 ++++++++++++++++++ .../sasha-s/go-deadlock/stacktraces.go | 107 ++++++ vendor/modules.txt | 4 + 31 files changed, 1466 insertions(+), 2 deletions(-) create mode 100644 vault/deadlock.go create mode 100644 vault/lock.go create mode 100644 vendor/github.com/petermattis/goid/.gitignore create mode 100644 vendor/github.com/petermattis/goid/.travis.yml create mode 100644 vendor/github.com/petermattis/goid/LICENSE create mode 100644 vendor/github.com/petermattis/goid/README.md create mode 100644 vendor/github.com/petermattis/goid/goid.go create mode 100644 vendor/github.com/petermattis/goid/goid_gccgo.go create mode 100644 vendor/github.com/petermattis/goid/goid_go1.3.c create mode 100644 vendor/github.com/petermattis/goid/goid_go1.3.go create mode 100644 vendor/github.com/petermattis/goid/goid_go1.4.go create mode 100644 vendor/github.com/petermattis/goid/goid_go1.4.s create mode 100644 vendor/github.com/petermattis/goid/goid_go1.5_amd64.go create mode 100644 vendor/github.com/petermattis/goid/goid_go1.5_amd64.s create mode 100644 vendor/github.com/petermattis/goid/goid_go1.5_arm.go create mode 100644 vendor/github.com/petermattis/goid/goid_go1.5_arm.s create mode 100644 vendor/github.com/petermattis/goid/goid_slow.go create mode 100644 vendor/github.com/petermattis/goid/runtime_gccgo_go1.8.go create mode 100644 vendor/github.com/petermattis/goid/runtime_go1.5.go create mode 100644 vendor/github.com/petermattis/goid/runtime_go1.6.go create mode 100644 vendor/github.com/petermattis/goid/runtime_go1.9.go create mode 100644 vendor/github.com/sasha-s/go-deadlock/.travis.yml create mode 100644 vendor/github.com/sasha-s/go-deadlock/LICENSE create mode 100644 vendor/github.com/sasha-s/go-deadlock/Readme.md create mode 100644 vendor/github.com/sasha-s/go-deadlock/deadlock.go create mode 100644 vendor/github.com/sasha-s/go-deadlock/stacktraces.go diff --git a/go.mod b/go.mod index 8782b5afb..25bdad1a1 100644 --- a/go.mod +++ b/go.mod @@ -117,6 +117,7 @@ require ( github.com/oracle/oci-go-sdk v12.5.0+incompatible github.com/ory/dockertest v3.3.5+incompatible github.com/patrickmn/go-cache v2.1.0+incompatible + github.com/petermattis/goid v0.0.0-20180202154549-b0b1615b78e5 // indirect github.com/pkg/errors v0.8.1 github.com/posener/complete v1.2.1 github.com/pquerna/otp v1.2.1-0.20191009055518-468c2dd2b58d @@ -125,6 +126,7 @@ require ( github.com/ryanuber/columnize v2.1.0+incompatible github.com/ryanuber/go-glob v1.0.0 github.com/samuel/go-zookeeper v0.0.0-20180130194729-c4fab1ac1bec + github.com/sasha-s/go-deadlock v0.2.0 github.com/shirou/gopsutil v2.19.9+incompatible github.com/shirou/w32 v0.0.0-20160930032740-bb4de0191aa4 // indirect github.com/shopspring/decimal v0.0.0-20180709203117-cd690d0c9e24 // indirect diff --git a/go.sum b/go.sum index 54c2e72b4..9f4bb9d69 100644 --- a/go.sum +++ b/go.sum @@ -611,6 +611,8 @@ github.com/pascaldekloe/goe v0.1.0/go.mod h1:lzWF7FIEvWOWxwDKqyGYQf6ZUaNfKdP144T github.com/patrickmn/go-cache v0.0.0-20180815053127-5633e0862627/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ= github.com/patrickmn/go-cache v2.1.0+incompatible h1:HRMgzkcYKYpi3C8ajMPV8OFXaaRUnok+kx1WdO15EQc= github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ= +github.com/petermattis/goid v0.0.0-20180202154549-b0b1615b78e5 h1:q2e307iGHPdTGp0hoxKjt1H5pDo6utceo3dQVK3I5XQ= +github.com/petermattis/goid v0.0.0-20180202154549-b0b1615b78e5/go.mod h1:jvVRKCrJTQWu0XVbaOlby/2lO20uSCHEMzzplHXte1o= github.com/pierrec/lz4 v2.0.5+incompatible/go.mod h1:pdkljMzZIN41W+lC3N2tnIh5sFi+IEE17M5jbnwPHcY= github.com/pierrec/lz4 v2.2.5+incompatible/go.mod h1:pdkljMzZIN41W+lC3N2tnIh5sFi+IEE17M5jbnwPHcY= github.com/pierrec/lz4 v2.2.6+incompatible h1:6aCX4/YZ9v8q69hTyiR7dNLnTA3fgtKHVVW5BCd5Znw= @@ -669,6 +671,8 @@ github.com/ryanuber/go-glob v1.0.0 h1:iQh3xXAumdQ+4Ufa5b25cRpC5TYKlno6hsv6Cb3pkB github.com/ryanuber/go-glob v1.0.0/go.mod h1:807d1WSdnB0XRJzKNil9Om6lcp/3a0v4qIHxIXzX/Yc= github.com/samuel/go-zookeeper v0.0.0-20180130194729-c4fab1ac1bec h1:6ncX5ko6B9LntYM0YBRXkiSaZMmLYeZ/NWcmeB43mMY= github.com/samuel/go-zookeeper v0.0.0-20180130194729-c4fab1ac1bec/go.mod h1:gi+0XIa01GRL2eRQVjQkKGqKF3SF9vZR/HnPullcV2E= +github.com/sasha-s/go-deadlock v0.2.0 h1:lMqc+fUb7RrFS3gQLtoQsJ7/6TV/pAIFvBsqX73DK8Y= +github.com/sasha-s/go-deadlock v0.2.0/go.mod h1:StQn567HiB1fF2yJ44N9au7wOhrPS3iZqiDbRupzT10= github.com/satori/go.uuid v1.2.0 h1:0uYX9dsZ2yD7q2RtLRtPSdGDWzjeM3TbMJP9utgA0ww= github.com/satori/go.uuid v1.2.0/go.mod h1:dA0hQrYB0VpLJoorglMZABFdXlWrHn1NEOzdhQKdks0= github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529 h1:nn5Wsu0esKSJiIVhscUtVbo7ada43DJhG55ua/hjS5I= diff --git a/vault/core.go b/vault/core.go index b7180bae2..711dd6968 100644 --- a/vault/core.go +++ b/vault/core.go @@ -256,7 +256,7 @@ type Core struct { auditBackends map[string]audit.Factory // stateLock protects mutable state - stateLock sync.RWMutex + stateLock DeadlockRWMutex sealed *uint32 standby bool diff --git a/vault/deadlock.go b/vault/deadlock.go new file mode 100644 index 000000000..81b5199b4 --- /dev/null +++ b/vault/deadlock.go @@ -0,0 +1,21 @@ +// +build deadlock + +package vault + +import ( + "github.com/sasha-s/go-deadlock" +) + +// DeadlockMutex, when the build tag `deadlock` is present, behaves like a +// sync.Mutex but does periodic checking to see if outstanding locks and requests +// look like a deadlock. If it finds a deadlock candidate it will output it +// prefixed with "POTENTIAL DEADLOCK", as described at +// https://github.com/sasha-s/go-deadlock +type DeadlockMutex struct { + deadlock.Mutex +} + +// DeadlockRWMutex is the RW version of DeadlockMutex. +type DeadlockRWMutex struct { + deadlock.RWMutex +} diff --git a/vault/expiration.go b/vault/expiration.go index 303b9058d..149bfc839 100644 --- a/vault/expiration.go +++ b/vault/expiration.go @@ -82,7 +82,7 @@ type ExpirationManager struct { restoreLoaded sync.Map quitCh chan struct{} - coreStateLock *sync.RWMutex + coreStateLock *DeadlockRWMutex quitContext context.Context leaseCheckCounter *uint32 diff --git a/vault/lock.go b/vault/lock.go new file mode 100644 index 000000000..20ca4d97f --- /dev/null +++ b/vault/lock.go @@ -0,0 +1,19 @@ +// +build !deadlock + +package vault + +import ( + "sync" +) + +// DeadlockMutex is just a sync.Mutex when the build tag `deadlock` is absent. +// See its other definition in the corresponding deadlock-build-tag-constrained +// file for more details. +type DeadlockMutex struct { + sync.Mutex +} + +// DeadlockRWMutex is the RW version of DeadlockMutex. +type DeadlockRWMutex struct { + sync.RWMutex +} diff --git a/vendor/github.com/petermattis/goid/.gitignore b/vendor/github.com/petermattis/goid/.gitignore new file mode 100644 index 000000000..2b9d6b552 --- /dev/null +++ b/vendor/github.com/petermattis/goid/.gitignore @@ -0,0 +1,4 @@ +*~ +*.test +.*.swp +.DS_Store diff --git a/vendor/github.com/petermattis/goid/.travis.yml b/vendor/github.com/petermattis/goid/.travis.yml new file mode 100644 index 000000000..c63ef9369 --- /dev/null +++ b/vendor/github.com/petermattis/goid/.travis.yml @@ -0,0 +1,11 @@ +language: go + +go: + - 1.3.x + - 1.4.x + - 1.5.x + - 1.6.x + - 1.7.x + - 1.8.x + - 1.9.x + - master diff --git a/vendor/github.com/petermattis/goid/LICENSE b/vendor/github.com/petermattis/goid/LICENSE new file mode 100644 index 000000000..e06d20818 --- /dev/null +++ b/vendor/github.com/petermattis/goid/LICENSE @@ -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. + diff --git a/vendor/github.com/petermattis/goid/README.md b/vendor/github.com/petermattis/goid/README.md new file mode 100644 index 000000000..828fe9528 --- /dev/null +++ b/vendor/github.com/petermattis/goid/README.md @@ -0,0 +1,5 @@ +# goid [![Build Status](https://travis-ci.org/petermattis/goid.svg?branch=master)](https://travis-ci.org/petermattis/goid) + +Programatically retrieve the current goroutine's ID. See [the CI +configuration](.travis.yml) for supported Go versions. In addition, +gccgo 7.2.1 (Go 1.8.3) is supported. diff --git a/vendor/github.com/petermattis/goid/goid.go b/vendor/github.com/petermattis/goid/goid.go new file mode 100644 index 000000000..408e61992 --- /dev/null +++ b/vendor/github.com/petermattis/goid/goid.go @@ -0,0 +1,35 @@ +// Copyright 2016 Peter Mattis. +// +// 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. See the AUTHORS file +// for names of contributors. + +package goid + +import ( + "bytes" + "runtime" + "strconv" +) + +func ExtractGID(s []byte) int64 { + s = s[len("goroutine "):] + s = s[:bytes.IndexByte(s, ' ')] + gid, _ := strconv.ParseInt(string(s), 10, 64) + return gid +} + +// Parse the goid from runtime.Stack() output. Slow, but it works. +func getSlow() int64 { + var buf [64]byte + return ExtractGID(buf[:runtime.Stack(buf[:], false)]) +} diff --git a/vendor/github.com/petermattis/goid/goid_gccgo.go b/vendor/github.com/petermattis/goid/goid_gccgo.go new file mode 100644 index 000000000..e655e0687 --- /dev/null +++ b/vendor/github.com/petermattis/goid/goid_gccgo.go @@ -0,0 +1,25 @@ +// Copyright 2018 Peter Mattis. +// +// 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. See the AUTHORS file +// for names of contributors. + +// +build gccgo + +package goid + +//extern runtime.getg +func getg() *g + +func Get() int64 { + return getg().goid +} diff --git a/vendor/github.com/petermattis/goid/goid_go1.3.c b/vendor/github.com/petermattis/goid/goid_go1.3.c new file mode 100644 index 000000000..2e3f7ab79 --- /dev/null +++ b/vendor/github.com/petermattis/goid/goid_go1.3.c @@ -0,0 +1,23 @@ +// Copyright 2015 Peter Mattis. +// +// 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. See the AUTHORS file +// for names of contributors. + +// +build !go1.4 + +#include + +void ·Get(int64 ret) { + ret = g->goid; + USED(&ret); +} diff --git a/vendor/github.com/petermattis/goid/goid_go1.3.go b/vendor/github.com/petermattis/goid/goid_go1.3.go new file mode 100644 index 000000000..9202099e8 --- /dev/null +++ b/vendor/github.com/petermattis/goid/goid_go1.3.go @@ -0,0 +1,21 @@ +// Copyright 2015 Peter Mattis. +// +// 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. See the AUTHORS file +// for names of contributors. + +// +build !go1.4 + +package goid + +// Get returns the id of the current goroutine. +func Get() int64 diff --git a/vendor/github.com/petermattis/goid/goid_go1.4.go b/vendor/github.com/petermattis/goid/goid_go1.4.go new file mode 100644 index 000000000..ec7fc52d4 --- /dev/null +++ b/vendor/github.com/petermattis/goid/goid_go1.4.go @@ -0,0 +1,34 @@ +// Copyright 2015 Peter Mattis. +// +// 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. See the AUTHORS file +// for names of contributors. + +// +build go1.4,!go1.5 + +package goid + +import "unsafe" + +var pointerSize = unsafe.Sizeof(uintptr(0)) + +// Backdoor access to runtime·getg(). +func getg() uintptr // in goid_go1.4.s + +// Get returns the id of the current goroutine. +func Get() int64 { + // The goid is the 16th field in the G struct where each field is a + // pointer, uintptr or padded to that size. See runtime.h from the + // Go sources. I'm not aware of a cleaner way to determine the + // offset. + return *(*int64)(unsafe.Pointer(getg() + 16*pointerSize)) +} diff --git a/vendor/github.com/petermattis/goid/goid_go1.4.s b/vendor/github.com/petermattis/goid/goid_go1.4.s new file mode 100644 index 000000000..21a07d662 --- /dev/null +++ b/vendor/github.com/petermattis/goid/goid_go1.4.s @@ -0,0 +1,18 @@ +// Copyright 2014 The Go Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +// Assembly to get into package runtime without using exported symbols. +// See https://github.com/golang/go/blob/release-branch.go1.4/misc/cgo/test/backdoor/thunk.s + +// +build amd64 amd64p32 arm 386 +// +build go1.4,!go1.5 + +#include "textflag.h" + +#ifdef GOARCH_arm +#define JMP B +#endif + +TEXT ·getg(SB),NOSPLIT,$0-0 + JMP runtime·getg(SB) diff --git a/vendor/github.com/petermattis/goid/goid_go1.5_amd64.go b/vendor/github.com/petermattis/goid/goid_go1.5_amd64.go new file mode 100644 index 000000000..269abb3f5 --- /dev/null +++ b/vendor/github.com/petermattis/goid/goid_go1.5_amd64.go @@ -0,0 +1,21 @@ +// Copyright 2016 Peter Mattis. +// +// 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. See the AUTHORS file +// for names of contributors. + +// +build amd64 amd64p32 +// +build gc,go1.5 + +package goid + +func Get() int64 diff --git a/vendor/github.com/petermattis/goid/goid_go1.5_amd64.s b/vendor/github.com/petermattis/goid/goid_go1.5_amd64.s new file mode 100644 index 000000000..416665dd9 --- /dev/null +++ b/vendor/github.com/petermattis/goid/goid_go1.5_amd64.s @@ -0,0 +1,29 @@ +// Copyright 2016 Peter Mattis. +// +// 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. See the AUTHORS file +// for names of contributors. + +// Assembly to mimic runtime.getg. + +// +build amd64 amd64p32 +// +build gc,go1.5 + +#include "go_asm.h" +#include "textflag.h" + +// func Get() int64 +TEXT ·Get(SB),NOSPLIT,$0-8 + MOVQ (TLS), R14 + MOVQ g_goid(R14), R13 + MOVQ R13, ret+0(FP) + RET diff --git a/vendor/github.com/petermattis/goid/goid_go1.5_arm.go b/vendor/github.com/petermattis/goid/goid_go1.5_arm.go new file mode 100644 index 000000000..97fb81659 --- /dev/null +++ b/vendor/github.com/petermattis/goid/goid_go1.5_arm.go @@ -0,0 +1,26 @@ +// Copyright 2016 Peter Mattis. +// +// 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. See the AUTHORS file +// for names of contributors. + +// +build arm +// +build gc,go1.5 + +package goid + +// Backdoor access to runtime·getg(). +func getg() *g // in goid_go1.5plus.s + +func Get() int64 { + return getg().goid +} diff --git a/vendor/github.com/petermattis/goid/goid_go1.5_arm.s b/vendor/github.com/petermattis/goid/goid_go1.5_arm.s new file mode 100644 index 000000000..edab4d80f --- /dev/null +++ b/vendor/github.com/petermattis/goid/goid_go1.5_arm.s @@ -0,0 +1,27 @@ +// Copyright 2016 Peter Mattis. +// +// 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. See the AUTHORS file +// for names of contributors. + +// Assembly to mimic runtime.getg. +// This should work on arm64 as well, but it hasn't been tested. + +// +build arm +// +build gc,go1.5 + +#include "textflag.h" + +// func getg() *g +TEXT ·getg(SB),NOSPLIT,$0-8 + MOVW g, ret+0(FP) + RET diff --git a/vendor/github.com/petermattis/goid/goid_slow.go b/vendor/github.com/petermattis/goid/goid_slow.go new file mode 100644 index 000000000..d2d37650a --- /dev/null +++ b/vendor/github.com/petermattis/goid/goid_slow.go @@ -0,0 +1,23 @@ +// Copyright 2016 Peter Mattis. +// +// 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. See the AUTHORS file +// for names of contributors. + +// +build go1.4,!go1.5,!amd64,!amd64p32,!arm,!386 go1.5,!go1.6,!amd64,!amd64p32,!arm go1.6,!amd64,!amd64p32,!arm go1.9,!amd64,!amd64p32,!arm + +package goid + +// Get returns the id of the current goroutine. +func Get() int64 { + return getSlow() +} diff --git a/vendor/github.com/petermattis/goid/runtime_gccgo_go1.8.go b/vendor/github.com/petermattis/goid/runtime_gccgo_go1.8.go new file mode 100644 index 000000000..42c12bcc2 --- /dev/null +++ b/vendor/github.com/petermattis/goid/runtime_gccgo_go1.8.go @@ -0,0 +1,16 @@ +// +build gccgo,go1.8 + +package goid + +// https://github.com/gcc-mirror/gcc/blob/gcc-7-branch/libgo/go/runtime/runtime2.go#L329-L422 + +type g struct { + _panic uintptr + _defer uintptr + m uintptr + syscallsp uintptr + syscallpc uintptr + param uintptr + atomicstatus uint32 + goid int64 // Here it is! +} diff --git a/vendor/github.com/petermattis/goid/runtime_go1.5.go b/vendor/github.com/petermattis/goid/runtime_go1.5.go new file mode 100644 index 000000000..e1279a017 --- /dev/null +++ b/vendor/github.com/petermattis/goid/runtime_go1.5.go @@ -0,0 +1,56 @@ +// Copyright 2016 Peter Mattis. +// +// 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. See the AUTHORS file +// for names of contributors. + +// +build go1.5,!go1.6 + +package goid + +// Just enough of the structs from runtime/runtime2.go to get the offset to goid. +// See https://github.com/golang/go/blob/release-branch.go1.5/src/runtime/runtime2.go + +type stack struct { + lo uintptr + hi uintptr +} + +type gobuf struct { + sp uintptr + pc uintptr + g uintptr + ctxt uintptr + ret uintptr + lr uintptr + bp uintptr +} + +type g struct { + stack stack + stackguard0 uintptr + stackguard1 uintptr + + _panic uintptr + _defer uintptr + m uintptr + stackAlloc uintptr + sched gobuf + syscallsp uintptr + syscallpc uintptr + stkbar []uintptr + stkbarPos uintptr + param uintptr + atomicstatus uint32 + stackLock uint32 + goid int64 // Here it is! +} diff --git a/vendor/github.com/petermattis/goid/runtime_go1.6.go b/vendor/github.com/petermattis/goid/runtime_go1.6.go new file mode 100644 index 000000000..6b0067b1f --- /dev/null +++ b/vendor/github.com/petermattis/goid/runtime_go1.6.go @@ -0,0 +1,42 @@ +// +build gc,go1.6,!go1.9 + +package goid + +// Just enough of the structs from runtime/runtime2.go to get the offset to goid. +// See https://github.com/golang/go/blob/release-branch.go1.6/src/runtime/runtime2.go + +type stack struct { + lo uintptr + hi uintptr +} + +type gobuf struct { + sp uintptr + pc uintptr + g uintptr + ctxt uintptr + ret uintptr + lr uintptr + bp uintptr +} + +type g struct { + stack stack + stackguard0 uintptr + stackguard1 uintptr + + _panic uintptr + _defer uintptr + m uintptr + stackAlloc uintptr + sched gobuf + syscallsp uintptr + syscallpc uintptr + stkbar []uintptr + stkbarPos uintptr + stktopsp uintptr + param uintptr + atomicstatus uint32 + stackLock uint32 + goid int64 // Here it is! +} diff --git a/vendor/github.com/petermattis/goid/runtime_go1.9.go b/vendor/github.com/petermattis/goid/runtime_go1.9.go new file mode 100644 index 000000000..bf2c69668 --- /dev/null +++ b/vendor/github.com/petermattis/goid/runtime_go1.9.go @@ -0,0 +1,36 @@ +// +build gc,go1.9 + +package goid + +type stack struct { + lo uintptr + hi uintptr +} + +type gobuf struct { + sp uintptr + pc uintptr + g uintptr + ctxt uintptr + ret uintptr + lr uintptr + bp uintptr +} + +type g struct { + stack stack + stackguard0 uintptr + stackguard1 uintptr + + _panic uintptr + _defer uintptr + m uintptr + sched gobuf + syscallsp uintptr + syscallpc uintptr + stktopsp uintptr + param uintptr + atomicstatus uint32 + stackLock uint32 + goid int64 // Here it is! +} diff --git a/vendor/github.com/sasha-s/go-deadlock/.travis.yml b/vendor/github.com/sasha-s/go-deadlock/.travis.yml new file mode 100644 index 000000000..aacc9a920 --- /dev/null +++ b/vendor/github.com/sasha-s/go-deadlock/.travis.yml @@ -0,0 +1,10 @@ +language: go + +go: + - 1.3.x + - 1.4.x + - 1.5.x + - 1.6.x + - 1.7.x + - 1.8.x + - master diff --git a/vendor/github.com/sasha-s/go-deadlock/LICENSE b/vendor/github.com/sasha-s/go-deadlock/LICENSE new file mode 100644 index 000000000..8dada3eda --- /dev/null +++ b/vendor/github.com/sasha-s/go-deadlock/LICENSE @@ -0,0 +1,201 @@ + 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. diff --git a/vendor/github.com/sasha-s/go-deadlock/Readme.md b/vendor/github.com/sasha-s/go-deadlock/Readme.md new file mode 100644 index 000000000..c8236a18a --- /dev/null +++ b/vendor/github.com/sasha-s/go-deadlock/Readme.md @@ -0,0 +1,117 @@ +# Online deadlock detection in go (golang). [Docs](https://godoc.org/github.com/sasha-s/go-deadlock). [![Build Status](https://travis-ci.org/sasha-s/go-deadlock.svg?branch=master)](https://travis-ci.org/sasha-s/go-deadlock) +## Why +Deadlocks happen and are painful to debug. + +## What +go-deadlock provides (RW)Mutex drop-in replacements for sync.(RW)Mutex. +It would not work if you create a spaghetti of channels. +Mutexes only. + +## Installation +```sh +go get github.com/sasha-s/go-deadlock/... +``` + +## Usage +```go +import "github.com/sasha-s/go-deadlock" +var mu deadlock.Mutex +// Use normally, it works exactly like sync.Mutex does. +mu.Lock() + +defer mu.Unlock() +// Or +var rw deadlock.RWMutex +rw.RLock() +defer rw.RUnlock() +``` + +### Deadlocks +One of the most common sources of deadlocks is inconsistent lock ordering: +say, you have two mutexes A and B, and in some goroutines you have +```go +A.Lock() // defer A.Unlock() or similar. +... +B.Lock() // defer B.Unlock() or similar. +``` +And in another goroutine the order of locks is reversed: +```go +B.Lock() // defer B.Unlock() or similar. +... +A.Lock() // defer A.Unlock() or similar. +``` + +Another common sources of deadlocs is duplicate take a lock in a goroutine: +``` +A.Rlock() or lock() + +A.lock() or A.RLock() +``` + +This does not guarantee a deadlock (maybe the goroutines above can never be running at the same time), but it usually a design flaw at least. + +go-deadlock can detect such cases (unless you cross goroutine boundary - say lock A, then spawn a goroutine, block until it is singals, and lock B inside of the goroutine), even if the deadlock itself happens very infrequently and is painful to reproduce! + +Each time go-deadlock sees a lock attempt for lock B, it records the order A before B, for each lock that is currently being held in the same goroutine, and it prints (and exits the program by default) when it sees the locking order being violated. + +In addition, if it sees that we are waiting on a lock for a long time (opts.DeadlockTimeout, 30 seconds by default), it reports a potential deadlock, also printing the stacktrace for a goroutine that is currently holding the lock we are desperately trying to grab. + + +## Sample output +####Inconsistent lock ordering: +``` +POTENTIAL DEADLOCK: Inconsistent locking. saw this ordering in one goroutine: +happened before +inmem.go:623 bttest.(*server).ReadModifyWriteRow { r.mu.Lock() } <<<<< +inmem_test.go:118 bttest.TestConcurrentMutationsReadModifyAndGC.func4 { _, _ = s.ReadModifyWriteRow(ctx, rmw()) } + +happened after +inmem.go:629 bttest.(*server).ReadModifyWriteRow { tbl.mu.RLock() } <<<<< +inmem_test.go:118 bttest.TestConcurrentMutationsReadModifyAndGC.func4 { _, _ = s.ReadModifyWriteRow(ctx, rmw()) } + +in another goroutine: happened before +inmem.go:799 bttest.(*table).gc { t.mu.RLock() } <<<<< +inmem_test.go:125 bttest.TestConcurrentMutationsReadModifyAndGC.func5 { tbl.gc() } + +happend after +inmem.go:814 bttest.(*table).gc { r.mu.Lock() } <<<<< +inmem_test.go:125 bttest.TestConcurrentMutationsReadModifyAndGC.func5 { tbl.gc() } +``` + +#### Waiting for a lock for a long time: + +``` +POTENTIAL DEADLOCK: +Previous place where the lock was grabbed +goroutine 240 lock 0xc820160440 +inmem.go:799 bttest.(*table).gc { t.mu.RLock() } <<<<< +inmem_test.go:125 bttest.TestConcurrentMutationsReadModifyAndGC.func5 { tbl.gc() } + +Have been trying to lock it again for more than 40ms +goroutine 68 lock 0xc820160440 +inmem.go:785 bttest.(*table).mutableRow { t.mu.Lock() } <<<<< +inmem.go:428 bttest.(*server).MutateRow { r := tbl.mutableRow(string(req.RowKey)) } +inmem_test.go:111 bttest.TestConcurrentMutationsReadModifyAndGC.func3 { s.MutateRow(ctx, req) } + + +Here is what goroutine 240 doing now +goroutine 240 [select]: +github.com/sasha-s/go-deadlock.lock(0xc82028ca10, 0x5189e0, 0xc82013a9b0) + /Users/sasha/go/src/github.com/sasha-s/go-deadlock/deadlock.go:163 +0x1640 +github.com/sasha-s/go-deadlock.(*Mutex).Lock(0xc82013a9b0) + /Users/sasha/go/src/github.com/sasha-s/go-deadlock/deadlock.go:54 +0x86 +google.golang.org/cloud/bigtable/bttest.(*table).gc(0xc820160440) + /Users/sasha/go/src/google.golang.org/cloud/bigtable/bttest/inmem.go:814 +0x28d +google.golang.org/cloud/bigtable/bttest.TestConcurrentMutationsReadModifyAndGC.func5(0xc82015c760, 0xc820160440) /Users/sasha/go/src/google.golang.org/cloud/bigtable/bttest/inmem_test.go:125 +0x48 +created by google.golang.org/cloud/bigtable/bttest.TestConcurrentMutationsReadModifyAndGC + /Users/sasha/go/src/google.golang.org/cloud/bigtable/bttest/inmem_test.go:126 +0xb6f +``` + +## Used in +[cockroachdb: Potential deadlock between Gossip.SetStorage and Node.gossipStores](https://github.com/cockroachdb/cockroach/issues/7972) + +[bigtable/bttest: A race between GC and row mutations](https://code-review.googlesource.com#/c/5301/) + +## Need a mutex that works with net.context? +I have [one](https://github.com/sasha-s/go-csync). + diff --git a/vendor/github.com/sasha-s/go-deadlock/deadlock.go b/vendor/github.com/sasha-s/go-deadlock/deadlock.go new file mode 100644 index 000000000..6f8f81eda --- /dev/null +++ b/vendor/github.com/sasha-s/go-deadlock/deadlock.go @@ -0,0 +1,325 @@ +package deadlock + +import ( + "bufio" + "bytes" + "fmt" + "io" + "os" + "sync" + "time" + + "github.com/petermattis/goid" +) + +// Opts control how deadlock detection behaves. +// Options are supposed to be set once at a startup (say, when parsing flags). +var Opts = struct { + // Mutex/RWMutex would work exactly as their sync counterparts + // -- almost no runtime penalty, no deadlock detection if Disable == true. + Disable bool + // Would disable lock order based deadlock detection if DisableLockOrderDetection == true. + DisableLockOrderDetection bool + // Waiting for a lock for longer than DeadlockTimeout is considered a deadlock. + // Ignored is DeadlockTimeout <= 0. + DeadlockTimeout time.Duration + // OnPotentialDeadlock is called each time a potential deadlock is detected -- either based on + // lock order or on lock wait time. + OnPotentialDeadlock func() + // Will keep MaxMapSize lock pairs (happens before // happens after) in the map. + // The map resets once the threshold is reached. + MaxMapSize int + // Will print to deadlock info to log buffer. + mu sync.Mutex // Protects the LogBuf. + LogBuf io.Writer +}{ + DeadlockTimeout: time.Second * 30, + OnPotentialDeadlock: func() { + os.Exit(2) + }, + MaxMapSize: 1024 * 64, + LogBuf: os.Stderr, +} + +// A Mutex is a drop-in replacement for sync.Mutex. +// Performs deadlock detection unless disabled in Opts. +type Mutex struct { + mu sync.Mutex +} + +// Lock locks the mutex. +// If the lock is already in use, the calling goroutine +// blocks until the mutex is available. +// +// Unless deadlock detection is disabled, logs potential deadlocks to Opts.LogBuf, +// calling Opts.OnPotentialDeadlock on each occasion. +func (m *Mutex) Lock() { + lock(m.mu.Lock, m) +} + +// Unlock unlocks the mutex. +// It is a run-time error if m is not locked on entry to Unlock. +// +// A locked Mutex is not associated with a particular goroutine. +// It is allowed for one goroutine to lock a Mutex and then +// arrange for another goroutine to unlock it. +func (m *Mutex) Unlock() { + m.mu.Unlock() + if !Opts.Disable { + PostUnlock(m) + } +} + +// An RWMutex is a drop-in replacement for sync.RWMutex. +// Performs deadlock detection unless disabled in Opts. +type RWMutex struct { + mu sync.RWMutex +} + +// 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. +// +// Unless deadlock detection is disabled, logs potential deadlocks to Opts.LogBuf, +// calling Opts.OnPotentialDeadlock on each occasion. +func (m *RWMutex) Lock() { + lock(m.mu.Lock, m) +} + +// Unlock unlocks the mutex 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 (m *RWMutex) Unlock() { + m.mu.Unlock() + if !Opts.Disable { + PostUnlock(m) + } +} + +// RLock locks the mutex for reading. +// +// Unless deadlock detection is disabled, logs potential deadlocks to Opts.LogBuf, +// calling Opts.OnPotentialDeadlock on each occasion. +func (m *RWMutex) RLock() { + lock(m.mu.RLock, m) +} + +// 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 (m *RWMutex) RUnlock() { + if !Opts.Disable { + PostUnlock(m) + } + m.mu.RUnlock() +} + +// RLocker returns a Locker interface that implements +// the Lock and Unlock methods by calling RLock and RUnlock. +func (m *RWMutex) RLocker() sync.Locker { + return (*rlocker)(m) +} + +func PreLock(skip int, p interface{}) { + lo.PreLock(skip, p) +} + +func PostLock(skip int, p interface{}) { + lo.PostLock(skip, p) +} + +func PostUnlock(p interface{}) { + lo.PostUnlock(p) +} + +func lock(lockFn func(), ptr interface{}) { + if Opts.Disable { + lockFn() + return + } + PreLock(4, ptr) + if Opts.DeadlockTimeout <= 0 { + lockFn() + } else { + ch := make(chan struct{}) + go func() { + lockFn() + close(ch) + }() + for { + t := time.NewTimer(Opts.DeadlockTimeout) + defer t.Stop() + select { + case <-t.C: + lo.mu.Lock() + prev, ok := lo.cur[ptr] + if !ok { + lo.mu.Unlock() + break // Nobody seems to be holding the lock, try again. + } + Opts.mu.Lock() + fmt.Fprintln(Opts.LogBuf, header) + fmt.Fprintln(Opts.LogBuf, "Previous place where the lock was grabbed") + fmt.Fprintf(Opts.LogBuf, "goroutine %v lock %p\n", prev.gid, ptr) + printStack(Opts.LogBuf, prev.stack) + fmt.Fprintln(Opts.LogBuf, "Have been trying to lock it again for more than", Opts.DeadlockTimeout) + fmt.Fprintf(Opts.LogBuf, "goroutine %v lock %p\n", goid.Get(), ptr) + printStack(Opts.LogBuf, callers(2)) + fmt.Fprintln(Opts.LogBuf) + stacks := stacks() + grs := bytes.Split(stacks, []byte("\n\n")) + for _, g := range grs { + if goid.ExtractGID(g) == prev.gid { + fmt.Fprintln(Opts.LogBuf, "Here is what goroutine", prev.gid, "doing now") + Opts.LogBuf.Write(g) + fmt.Fprintln(Opts.LogBuf) + } + } + lo.other(ptr) + fmt.Fprintln(Opts.LogBuf, "All current goroutines:") + Opts.LogBuf.Write(stacks) + fmt.Fprintln(Opts.LogBuf) + if buf, ok := Opts.LogBuf.(*bufio.Writer); ok { + buf.Flush() + } + lo.mu.Unlock() + Opts.mu.Unlock() + Opts.OnPotentialDeadlock() + <-ch + PostLock(4, ptr) + return + case <-ch: + PostLock(4, ptr) + return + } + } + } + PostLock(4, ptr) +} + +type lockOrder struct { + mu sync.Mutex + cur map[interface{}]stackGID // stacktraces + gids for the locks currently taken. + order map[beforeAfter]ss // expected order of locks. +} + +type stackGID struct { + stack []uintptr + gid int64 +} + +type beforeAfter struct { + before interface{} + after interface{} +} + +type ss struct { + before []uintptr + after []uintptr +} + +var lo = newLockOrder() + +func newLockOrder() *lockOrder { + return &lockOrder{ + cur: map[interface{}]stackGID{}, + order: map[beforeAfter]ss{}, + } +} + +func (l *lockOrder) PostLock(skip int, p interface{}) { + stack := callers(skip) + gid := goid.Get() + l.mu.Lock() + l.cur[p] = stackGID{stack, gid} + l.mu.Unlock() +} + +func (l *lockOrder) PreLock(skip int, p interface{}) { + if Opts.DisableLockOrderDetection { + return + } + stack := callers(skip) + gid := goid.Get() + l.mu.Lock() + for b, bs := range l.cur { + if b == p { + if bs.gid == gid { + Opts.mu.Lock() + fmt.Fprintln(Opts.LogBuf, header, "Duplicate locking, saw callers this locks in one goroutine:") + fmt.Fprintf(Opts.LogBuf, "current goroutine %d lock %v \n", gid, b) + fmt.Fprintln(Opts.LogBuf, "all callers to this lock in the goroutine") + printStack(Opts.LogBuf, bs.stack) + printStack(Opts.LogBuf, stack) + l.other(p) + fmt.Fprintln(Opts.LogBuf) + if buf, ok := Opts.LogBuf.(*bufio.Writer); ok { + buf.Flush() + } + Opts.mu.Unlock() + Opts.OnPotentialDeadlock() + } + continue + } + if bs.gid != gid { // We want locks taken in the same goroutine only. + continue + } + if s, ok := l.order[beforeAfter{p, b}]; ok { + Opts.mu.Lock() + fmt.Fprintln(Opts.LogBuf, header, "Inconsistent locking. saw this ordering in one goroutine:") + fmt.Fprintln(Opts.LogBuf, "happened before") + printStack(Opts.LogBuf, s.before) + fmt.Fprintln(Opts.LogBuf, "happened after") + printStack(Opts.LogBuf, s.after) + fmt.Fprintln(Opts.LogBuf, "in another goroutine: happened before") + printStack(Opts.LogBuf, bs.stack) + fmt.Fprintln(Opts.LogBuf, "happend after") + printStack(Opts.LogBuf, stack) + l.other(p) + fmt.Fprintln(Opts.LogBuf) + if buf, ok := Opts.LogBuf.(*bufio.Writer); ok { + buf.Flush() + } + Opts.mu.Unlock() + Opts.OnPotentialDeadlock() + } + l.order[beforeAfter{b, p}] = ss{bs.stack, stack} + if len(l.order) == Opts.MaxMapSize { // Reset the map to keep memory footprint bounded. + l.order = map[beforeAfter]ss{} + } + } + l.mu.Unlock() +} + +func (l *lockOrder) PostUnlock(p interface{}) { + l.mu.Lock() + delete(l.cur, p) + l.mu.Unlock() +} + +type rlocker RWMutex + +func (r *rlocker) Lock() { (*RWMutex)(r).RLock() } +func (r *rlocker) Unlock() { (*RWMutex)(r).RUnlock() } + +// Under lo.mu Locked. +func (l *lockOrder) other(ptr interface{}) { + fmt.Fprintln(Opts.LogBuf, "\nOther goroutines holding locks:") + for k, pp := range l.cur { + if k == ptr { + continue + } + fmt.Fprintf(Opts.LogBuf, "goroutine %v lock %p\n", pp.gid, k) + printStack(Opts.LogBuf, pp.stack) + } + fmt.Fprintln(Opts.LogBuf) +} + +const header = "POTENTIAL DEADLOCK:" diff --git a/vendor/github.com/sasha-s/go-deadlock/stacktraces.go b/vendor/github.com/sasha-s/go-deadlock/stacktraces.go new file mode 100644 index 000000000..8369754b6 --- /dev/null +++ b/vendor/github.com/sasha-s/go-deadlock/stacktraces.go @@ -0,0 +1,107 @@ +package deadlock + +import ( + "bytes" + "fmt" + "io" + "io/ioutil" + "os" + "os/user" + "path/filepath" + "runtime" + "strings" + "sync" +) + +func callers(skip int) []uintptr { + s := make([]uintptr, 50) // Most relevant context seem to appear near the top of the stack. + return s[:runtime.Callers(2+skip, s)] +} + +func printStack(w io.Writer, stack []uintptr) { + home := os.Getenv("HOME") + usr, err := user.Current() + if err == nil { + home = usr.HomeDir + } + cwd, _ := os.Getwd() + + for i, pc := range stack { + f := runtime.FuncForPC(pc) + name := f.Name() + pkg := "" + if pos := strings.LastIndex(name, "/"); pos >= 0 { + name = name[pos+1:] + } + if pos := strings.Index(name, "."); pos >= 0 { + pkg = name[:pos] + name = name[pos+1:] + } + file, line := f.FileLine(pc - 1) + if (pkg == "runtime" && name == "goexit") || (pkg == "testing" && name == "tRunner") { + fmt.Fprintln(w) + return + } + tail := "" + if i == 0 { + tail = " <<<<<" // Make the line performing a lock prominent. + } + // Shorten the file name. + clean := file + if cwd != "" { + cl, err := filepath.Rel(cwd, file) + if err == nil { + clean = cl + } + } + if home != "" { + s2 := strings.Replace(file, home, "~", 1) + if len(clean) > len(s2) { + clean = s2 + } + } + fmt.Fprintf(w, "%s:%d %s.%s %s%s\n", clean, line, pkg, name, code(file, line), tail) + } + fmt.Fprintln(w) +} + +var fileSources struct { + sync.Mutex + lines map[string][][]byte +} + +// Reads souce file lines from disk if not cached already. +func getSourceLines(file string) [][]byte { + fileSources.Lock() + defer fileSources.Unlock() + if fileSources.lines == nil { + fileSources.lines = map[string][][]byte{} + } + if lines, ok := fileSources.lines[file]; ok { + return lines + } + text, _ := ioutil.ReadFile(file) + fileSources.lines[file] = bytes.Split(text, []byte{'\n'}) + return fileSources.lines[file] +} + +func code(file string, line int) string { + lines := getSourceLines(file) + // lines are 1 based. + if line >= len(lines) || line <= 0 { + return "???" + } + return "{ " + string(bytes.TrimSpace(lines[line-1])) + " }" +} + +// Stacktraces for all goroutines. +func stacks() []byte { + buf := make([]byte, 1024*16) + for { + n := runtime.Stack(buf, true) + if n < len(buf) { + return buf[:n] + } + buf = make([]byte, 2*len(buf)) + } +} diff --git a/vendor/modules.txt b/vendor/modules.txt index e748f889d..861581929 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -662,6 +662,8 @@ github.com/ory/dockertest/docker/types/strslice github.com/ory/dockertest/docker/types/versions # github.com/patrickmn/go-cache v2.1.0+incompatible github.com/patrickmn/go-cache +# github.com/petermattis/goid v0.0.0-20180202154549-b0b1615b78e5 +github.com/petermattis/goid # github.com/pierrec/lz4 v2.2.6+incompatible github.com/pierrec/lz4 github.com/pierrec/lz4/internal/xxh32 @@ -701,6 +703,8 @@ github.com/ryanuber/columnize github.com/ryanuber/go-glob # github.com/samuel/go-zookeeper v0.0.0-20180130194729-c4fab1ac1bec github.com/samuel/go-zookeeper/zk +# github.com/sasha-s/go-deadlock v0.2.0 +github.com/sasha-s/go-deadlock # github.com/satori/go.uuid v1.2.0 github.com/satori/go.uuid # github.com/shirou/gopsutil v2.19.9+incompatible