diff options
| author | Rutger Broekhoff | 2023-12-29 21:31:53 +0100 |
|---|---|---|
| committer | Rutger Broekhoff | 2023-12-29 21:31:53 +0100 |
| commit | 404aeae4545d2426c089a5f8d5e82dae56f5212b (patch) | |
| tree | 2d84e00af272b39fc04f3795ae06bc48970e57b5 /vendor/github.com/modern-go/concurrent | |
| parent | 209d8b0187ed025dec9ac149ebcced3462877bff (diff) | |
| download | gitolfs3-404aeae4545d2426c089a5f8d5e82dae56f5212b.tar.gz gitolfs3-404aeae4545d2426c089a5f8d5e82dae56f5212b.zip | |
Make Nix builds work
Diffstat (limited to 'vendor/github.com/modern-go/concurrent')
| -rw-r--r-- | vendor/github.com/modern-go/concurrent/.gitignore | 1 | ||||
| -rw-r--r-- | vendor/github.com/modern-go/concurrent/.travis.yml | 14 | ||||
| -rw-r--r-- | vendor/github.com/modern-go/concurrent/LICENSE | 201 | ||||
| -rw-r--r-- | vendor/github.com/modern-go/concurrent/README.md | 49 | ||||
| -rw-r--r-- | vendor/github.com/modern-go/concurrent/executor.go | 14 | ||||
| -rw-r--r-- | vendor/github.com/modern-go/concurrent/go_above_19.go | 15 | ||||
| -rw-r--r-- | vendor/github.com/modern-go/concurrent/go_below_19.go | 33 | ||||
| -rw-r--r-- | vendor/github.com/modern-go/concurrent/log.go | 13 | ||||
| -rw-r--r-- | vendor/github.com/modern-go/concurrent/test.sh | 12 | ||||
| -rw-r--r-- | vendor/github.com/modern-go/concurrent/unbounded_executor.go | 119 |
10 files changed, 471 insertions, 0 deletions
diff --git a/vendor/github.com/modern-go/concurrent/.gitignore b/vendor/github.com/modern-go/concurrent/.gitignore new file mode 100644 index 0000000..3f2bc47 --- /dev/null +++ b/vendor/github.com/modern-go/concurrent/.gitignore | |||
| @@ -0,0 +1 @@ | |||
| /coverage.txt | |||
diff --git a/vendor/github.com/modern-go/concurrent/.travis.yml b/vendor/github.com/modern-go/concurrent/.travis.yml new file mode 100644 index 0000000..449e67c --- /dev/null +++ b/vendor/github.com/modern-go/concurrent/.travis.yml | |||
| @@ -0,0 +1,14 @@ | |||
| 1 | language: go | ||
| 2 | |||
| 3 | go: | ||
| 4 | - 1.8.x | ||
| 5 | - 1.x | ||
| 6 | |||
| 7 | before_install: | ||
| 8 | - go get -t -v ./... | ||
| 9 | |||
| 10 | script: | ||
| 11 | - ./test.sh | ||
| 12 | |||
| 13 | after_success: | ||
| 14 | - bash <(curl -s https://codecov.io/bash) | ||
diff --git a/vendor/github.com/modern-go/concurrent/LICENSE b/vendor/github.com/modern-go/concurrent/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/vendor/github.com/modern-go/concurrent/LICENSE | |||
| @@ -0,0 +1,201 @@ | |||
| 1 | Apache License | ||
| 2 | Version 2.0, January 2004 | ||
| 3 | http://www.apache.org/licenses/ | ||
| 4 | |||
| 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
| 6 | |||
| 7 | 1. Definitions. | ||
| 8 | |||
| 9 | "License" shall mean the terms and conditions for use, reproduction, | ||
| 10 | and distribution as defined by Sections 1 through 9 of this document. | ||
| 11 | |||
| 12 | "Licensor" shall mean the copyright owner or entity authorized by | ||
| 13 | the copyright owner that is granting the License. | ||
| 14 | |||
| 15 | "Legal Entity" shall mean the union of the acting entity and all | ||
| 16 | other entities that control, are controlled by, or are under common | ||
| 17 | control with that entity. For the purposes of this definition, | ||
| 18 | "control" means (i) the power, direct or indirect, to cause the | ||
| 19 | direction or management of such entity, whether by contract or | ||
| 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
| 21 | outstanding shares, or (iii) beneficial ownership of such entity. | ||
| 22 | |||
| 23 | "You" (or "Your") shall mean an individual or Legal Entity | ||
| 24 | exercising permissions granted by this License. | ||
| 25 | |||
| 26 | "Source" form shall mean the preferred form for making modifications, | ||
| 27 | including but not limited to software source code, documentation | ||
| 28 | source, and configuration files. | ||
| 29 | |||
| 30 | "Object" form shall mean any form resulting from mechanical | ||
| 31 | transformation or translation of a Source form, including but | ||
| 32 | not limited to compiled object code, generated documentation, | ||
| 33 | and conversions to other media types. | ||
| 34 | |||
| 35 | "Work" shall mean the work of authorship, whether in Source or | ||
| 36 | Object form, made available under the License, as indicated by a | ||
| 37 | copyright notice that is included in or attached to the work | ||
| 38 | (an example is provided in the Appendix below). | ||
| 39 | |||
| 40 | "Derivative Works" shall mean any work, whether in Source or Object | ||
| 41 | form, that is based on (or derived from) the Work and for which the | ||
| 42 | editorial revisions, annotations, elaborations, or other modifications | ||
| 43 | represent, as a whole, an original work of authorship. For the purposes | ||
| 44 | of this License, Derivative Works shall not include works that remain | ||
| 45 | separable from, or merely link (or bind by name) to the interfaces of, | ||
| 46 | the Work and Derivative Works thereof. | ||
| 47 | |||
| 48 | "Contribution" shall mean any work of authorship, including | ||
| 49 | the original version of the Work and any modifications or additions | ||
| 50 | to that Work or Derivative Works thereof, that is intentionally | ||
| 51 | submitted to Licensor for inclusion in the Work by the copyright owner | ||
| 52 | or by an individual or Legal Entity authorized to submit on behalf of | ||
| 53 | the copyright owner. For the purposes of this definition, "submitted" | ||
| 54 | means any form of electronic, verbal, or written communication sent | ||
| 55 | to the Licensor or its representatives, including but not limited to | ||
| 56 | communication on electronic mailing lists, source code control systems, | ||
| 57 | and issue tracking systems that are managed by, or on behalf of, the | ||
| 58 | Licensor for the purpose of discussing and improving the Work, but | ||
| 59 | excluding communication that is conspicuously marked or otherwise | ||
| 60 | designated in writing by the copyright owner as "Not a Contribution." | ||
| 61 | |||
| 62 | "Contributor" shall mean Licensor and any individual or Legal Entity | ||
| 63 | on behalf of whom a Contribution has been received by Licensor and | ||
| 64 | subsequently incorporated within the Work. | ||
| 65 | |||
| 66 | 2. Grant of Copyright License. Subject to the terms and conditions of | ||
| 67 | this License, each Contributor hereby grants to You a perpetual, | ||
| 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| 69 | copyright license to reproduce, prepare Derivative Works of, | ||
| 70 | publicly display, publicly perform, sublicense, and distribute the | ||
| 71 | Work and such Derivative Works in Source or Object form. | ||
| 72 | |||
| 73 | 3. Grant of Patent License. Subject to the terms and conditions of | ||
| 74 | this License, each Contributor hereby grants to You a perpetual, | ||
| 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| 76 | (except as stated in this section) patent license to make, have made, | ||
| 77 | use, offer to sell, sell, import, and otherwise transfer the Work, | ||
| 78 | where such license applies only to those patent claims licensable | ||
| 79 | by such Contributor that are necessarily infringed by their | ||
| 80 | Contribution(s) alone or by combination of their Contribution(s) | ||
| 81 | with the Work to which such Contribution(s) was submitted. If You | ||
| 82 | institute patent litigation against any entity (including a | ||
| 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
| 84 | or a Contribution incorporated within the Work constitutes direct | ||
| 85 | or contributory patent infringement, then any patent licenses | ||
| 86 | granted to You under this License for that Work shall terminate | ||
| 87 | as of the date such litigation is filed. | ||
| 88 | |||
| 89 | 4. Redistribution. You may reproduce and distribute copies of the | ||
| 90 | Work or Derivative Works thereof in any medium, with or without | ||
| 91 | modifications, and in Source or Object form, provided that You | ||
| 92 | meet the following conditions: | ||
| 93 | |||
| 94 | (a) You must give any other recipients of the Work or | ||
| 95 | Derivative Works a copy of this License; and | ||
| 96 | |||
| 97 | (b) You must cause any modified files to carry prominent notices | ||
| 98 | stating that You changed the files; and | ||
| 99 | |||
| 100 | (c) You must retain, in the Source form of any Derivative Works | ||
| 101 | that You distribute, all copyright, patent, trademark, and | ||
| 102 | attribution notices from the Source form of the Work, | ||
| 103 | excluding those notices that do not pertain to any part of | ||
| 104 | the Derivative Works; and | ||
| 105 | |||
| 106 | (d) If the Work includes a "NOTICE" text file as part of its | ||
| 107 | distribution, then any Derivative Works that You distribute must | ||
| 108 | include a readable copy of the attribution notices contained | ||
| 109 | within such NOTICE file, excluding those notices that do not | ||
| 110 | pertain to any part of the Derivative Works, in at least one | ||
| 111 | of the following places: within a NOTICE text file distributed | ||
| 112 | as part of the Derivative Works; within the Source form or | ||
| 113 | documentation, if provided along with the Derivative Works; or, | ||
| 114 | within a display generated by the Derivative Works, if and | ||
| 115 | wherever such third-party notices normally appear. The contents | ||
| 116 | of the NOTICE file are for informational purposes only and | ||
| 117 | do not modify the License. You may add Your own attribution | ||
| 118 | notices within Derivative Works that You distribute, alongside | ||
| 119 | or as an addendum to the NOTICE text from the Work, provided | ||
| 120 | that such additional attribution notices cannot be construed | ||
| 121 | as modifying the License. | ||
| 122 | |||
| 123 | You may add Your own copyright statement to Your modifications and | ||
| 124 | may provide additional or different license terms and conditions | ||
| 125 | for use, reproduction, or distribution of Your modifications, or | ||
| 126 | for any such Derivative Works as a whole, provided Your use, | ||
| 127 | reproduction, and distribution of the Work otherwise complies with | ||
| 128 | the conditions stated in this License. | ||
| 129 | |||
| 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, | ||
| 131 | any Contribution intentionally submitted for inclusion in the Work | ||
| 132 | by You to the Licensor shall be under the terms and conditions of | ||
| 133 | this License, without any additional terms or conditions. | ||
| 134 | Notwithstanding the above, nothing herein shall supersede or modify | ||
| 135 | the terms of any separate license agreement you may have executed | ||
| 136 | with Licensor regarding such Contributions. | ||
| 137 | |||
| 138 | 6. Trademarks. This License does not grant permission to use the trade | ||
| 139 | names, trademarks, service marks, or product names of the Licensor, | ||
| 140 | except as required for reasonable and customary use in describing the | ||
| 141 | origin of the Work and reproducing the content of the NOTICE file. | ||
| 142 | |||
| 143 | 7. Disclaimer of Warranty. Unless required by applicable law or | ||
| 144 | agreed to in writing, Licensor provides the Work (and each | ||
| 145 | Contributor provides its Contributions) on an "AS IS" BASIS, | ||
| 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
| 147 | implied, including, without limitation, any warranties or conditions | ||
| 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
| 149 | PARTICULAR PURPOSE. You are solely responsible for determining the | ||
| 150 | appropriateness of using or redistributing the Work and assume any | ||
| 151 | risks associated with Your exercise of permissions under this License. | ||
| 152 | |||
| 153 | 8. Limitation of Liability. In no event and under no legal theory, | ||
| 154 | whether in tort (including negligence), contract, or otherwise, | ||
| 155 | unless required by applicable law (such as deliberate and grossly | ||
| 156 | negligent acts) or agreed to in writing, shall any Contributor be | ||
| 157 | liable to You for damages, including any direct, indirect, special, | ||
| 158 | incidental, or consequential damages of any character arising as a | ||
| 159 | result of this License or out of the use or inability to use the | ||
| 160 | Work (including but not limited to damages for loss of goodwill, | ||
| 161 | work stoppage, computer failure or malfunction, or any and all | ||
| 162 | other commercial damages or losses), even if such Contributor | ||
| 163 | has been advised of the possibility of such damages. | ||
| 164 | |||
| 165 | 9. Accepting Warranty or Additional Liability. While redistributing | ||
| 166 | the Work or Derivative Works thereof, You may choose to offer, | ||
| 167 | and charge a fee for, acceptance of support, warranty, indemnity, | ||
| 168 | or other liability obligations and/or rights consistent with this | ||
| 169 | License. However, in accepting such obligations, You may act only | ||
| 170 | on Your own behalf and on Your sole responsibility, not on behalf | ||
| 171 | of any other Contributor, and only if You agree to indemnify, | ||
| 172 | defend, and hold each Contributor harmless for any liability | ||
| 173 | incurred by, or claims asserted against, such Contributor by reason | ||
| 174 | of your accepting any such warranty or additional liability. | ||
| 175 | |||
| 176 | END OF TERMS AND CONDITIONS | ||
| 177 | |||
| 178 | APPENDIX: How to apply the Apache License to your work. | ||
| 179 | |||
| 180 | To apply the Apache License to your work, attach the following | ||
| 181 | boilerplate notice, with the fields enclosed by brackets "[]" | ||
| 182 | replaced with your own identifying information. (Don't include | ||
| 183 | the brackets!) The text should be enclosed in the appropriate | ||
| 184 | comment syntax for the file format. We also recommend that a | ||
| 185 | file or class name and description of purpose be included on the | ||
| 186 | same "printed page" as the copyright notice for easier | ||
| 187 | identification within third-party archives. | ||
| 188 | |||
| 189 | Copyright [yyyy] [name of copyright owner] | ||
| 190 | |||
| 191 | Licensed under the Apache License, Version 2.0 (the "License"); | ||
| 192 | you may not use this file except in compliance with the License. | ||
| 193 | You may obtain a copy of the License at | ||
| 194 | |||
| 195 | http://www.apache.org/licenses/LICENSE-2.0 | ||
| 196 | |||
| 197 | Unless required by applicable law or agreed to in writing, software | ||
| 198 | distributed under the License is distributed on an "AS IS" BASIS, | ||
| 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| 200 | See the License for the specific language governing permissions and | ||
| 201 | limitations under the License. | ||
diff --git a/vendor/github.com/modern-go/concurrent/README.md b/vendor/github.com/modern-go/concurrent/README.md new file mode 100644 index 0000000..acab320 --- /dev/null +++ b/vendor/github.com/modern-go/concurrent/README.md | |||
| @@ -0,0 +1,49 @@ | |||
| 1 | # concurrent | ||
| 2 | |||
| 3 | [](https://sourcegraph.com/github.com/modern-go/concurrent?badge) | ||
| 4 | [](http://godoc.org/github.com/modern-go/concurrent) | ||
| 5 | [](https://travis-ci.org/modern-go/concurrent) | ||
| 6 | [](https://codecov.io/gh/modern-go/concurrent) | ||
| 7 | [](https://goreportcard.com/report/github.com/modern-go/concurrent) | ||
| 8 | [](https://raw.githubusercontent.com/modern-go/concurrent/master/LICENSE) | ||
| 9 | |||
| 10 | * concurrent.Map: backport sync.Map for go below 1.9 | ||
| 11 | * concurrent.Executor: goroutine with explicit ownership and cancellable | ||
| 12 | |||
| 13 | # concurrent.Map | ||
| 14 | |||
| 15 | because sync.Map is only available in go 1.9, we can use concurrent.Map to make code portable | ||
| 16 | |||
| 17 | ```go | ||
| 18 | m := concurrent.NewMap() | ||
| 19 | m.Store("hello", "world") | ||
| 20 | elem, found := m.Load("hello") | ||
| 21 | // elem will be "world" | ||
| 22 | // found will be true | ||
| 23 | ``` | ||
| 24 | |||
| 25 | # concurrent.Executor | ||
| 26 | |||
| 27 | ```go | ||
| 28 | executor := concurrent.NewUnboundedExecutor() | ||
| 29 | executor.Go(func(ctx context.Context) { | ||
| 30 | everyMillisecond := time.NewTicker(time.Millisecond) | ||
| 31 | for { | ||
| 32 | select { | ||
| 33 | case <-ctx.Done(): | ||
| 34 | fmt.Println("goroutine exited") | ||
| 35 | return | ||
| 36 | case <-everyMillisecond.C: | ||
| 37 | // do something | ||
| 38 | } | ||
| 39 | } | ||
| 40 | }) | ||
| 41 | time.Sleep(time.Second) | ||
| 42 | executor.StopAndWaitForever() | ||
| 43 | fmt.Println("executor stopped") | ||
| 44 | ``` | ||
| 45 | |||
| 46 | attach goroutine to executor instance, so that we can | ||
| 47 | |||
| 48 | * cancel it by stop the executor with Stop/StopAndWait/StopAndWaitForever | ||
| 49 | * handle panic by callback: the default behavior will no longer crash your application \ No newline at end of file | ||
diff --git a/vendor/github.com/modern-go/concurrent/executor.go b/vendor/github.com/modern-go/concurrent/executor.go new file mode 100644 index 0000000..623dba1 --- /dev/null +++ b/vendor/github.com/modern-go/concurrent/executor.go | |||
| @@ -0,0 +1,14 @@ | |||
| 1 | package concurrent | ||
| 2 | |||
| 3 | import "context" | ||
| 4 | |||
| 5 | // Executor replace go keyword to start a new goroutine | ||
| 6 | // the goroutine should cancel itself if the context passed in has been cancelled | ||
| 7 | // the goroutine started by the executor, is owned by the executor | ||
| 8 | // we can cancel all executors owned by the executor just by stop the executor itself | ||
| 9 | // however Executor interface does not Stop method, the one starting and owning executor | ||
| 10 | // should use the concrete type of executor, instead of this interface. | ||
| 11 | type Executor interface { | ||
| 12 | // Go starts a new goroutine controlled by the context | ||
| 13 | Go(handler func(ctx context.Context)) | ||
| 14 | } | ||
diff --git a/vendor/github.com/modern-go/concurrent/go_above_19.go b/vendor/github.com/modern-go/concurrent/go_above_19.go new file mode 100644 index 0000000..aeabf8c --- /dev/null +++ b/vendor/github.com/modern-go/concurrent/go_above_19.go | |||
| @@ -0,0 +1,15 @@ | |||
| 1 | //+build go1.9 | ||
| 2 | |||
| 3 | package concurrent | ||
| 4 | |||
| 5 | import "sync" | ||
| 6 | |||
| 7 | // Map is a wrapper for sync.Map introduced in go1.9 | ||
| 8 | type Map struct { | ||
| 9 | sync.Map | ||
| 10 | } | ||
| 11 | |||
| 12 | // NewMap creates a thread safe Map | ||
| 13 | func NewMap() *Map { | ||
| 14 | return &Map{} | ||
| 15 | } | ||
diff --git a/vendor/github.com/modern-go/concurrent/go_below_19.go b/vendor/github.com/modern-go/concurrent/go_below_19.go new file mode 100644 index 0000000..b9c8df7 --- /dev/null +++ b/vendor/github.com/modern-go/concurrent/go_below_19.go | |||
| @@ -0,0 +1,33 @@ | |||
| 1 | //+build !go1.9 | ||
| 2 | |||
| 3 | package concurrent | ||
| 4 | |||
| 5 | import "sync" | ||
| 6 | |||
| 7 | // Map implements a thread safe map for go version below 1.9 using mutex | ||
| 8 | type Map struct { | ||
| 9 | lock sync.RWMutex | ||
| 10 | data map[interface{}]interface{} | ||
| 11 | } | ||
| 12 | |||
| 13 | // NewMap creates a thread safe map | ||
| 14 | func NewMap() *Map { | ||
| 15 | return &Map{ | ||
| 16 | data: make(map[interface{}]interface{}, 32), | ||
| 17 | } | ||
| 18 | } | ||
| 19 | |||
| 20 | // Load is same as sync.Map Load | ||
| 21 | func (m *Map) Load(key interface{}) (elem interface{}, found bool) { | ||
| 22 | m.lock.RLock() | ||
| 23 | elem, found = m.data[key] | ||
| 24 | m.lock.RUnlock() | ||
| 25 | return | ||
| 26 | } | ||
| 27 | |||
| 28 | // Load is same as sync.Map Store | ||
| 29 | func (m *Map) Store(key interface{}, elem interface{}) { | ||
| 30 | m.lock.Lock() | ||
| 31 | m.data[key] = elem | ||
| 32 | m.lock.Unlock() | ||
| 33 | } | ||
diff --git a/vendor/github.com/modern-go/concurrent/log.go b/vendor/github.com/modern-go/concurrent/log.go new file mode 100644 index 0000000..9756fcc --- /dev/null +++ b/vendor/github.com/modern-go/concurrent/log.go | |||
| @@ -0,0 +1,13 @@ | |||
| 1 | package concurrent | ||
| 2 | |||
| 3 | import ( | ||
| 4 | "os" | ||
| 5 | "log" | ||
| 6 | "io/ioutil" | ||
| 7 | ) | ||
| 8 | |||
| 9 | // ErrorLogger is used to print out error, can be set to writer other than stderr | ||
| 10 | var ErrorLogger = log.New(os.Stderr, "", 0) | ||
| 11 | |||
| 12 | // InfoLogger is used to print informational message, default to off | ||
| 13 | var InfoLogger = log.New(ioutil.Discard, "", 0) \ No newline at end of file | ||
diff --git a/vendor/github.com/modern-go/concurrent/test.sh b/vendor/github.com/modern-go/concurrent/test.sh new file mode 100644 index 0000000..d1e6b2e --- /dev/null +++ b/vendor/github.com/modern-go/concurrent/test.sh | |||
| @@ -0,0 +1,12 @@ | |||
| 1 | #!/usr/bin/env bash | ||
| 2 | |||
| 3 | set -e | ||
| 4 | echo "" > coverage.txt | ||
| 5 | |||
| 6 | for d in $(go list ./... | grep -v vendor); do | ||
| 7 | go test -coverprofile=profile.out -coverpkg=github.com/modern-go/concurrent $d | ||
| 8 | if [ -f profile.out ]; then | ||
| 9 | cat profile.out >> coverage.txt | ||
| 10 | rm profile.out | ||
| 11 | fi | ||
| 12 | done | ||
diff --git a/vendor/github.com/modern-go/concurrent/unbounded_executor.go b/vendor/github.com/modern-go/concurrent/unbounded_executor.go new file mode 100644 index 0000000..05a77dc --- /dev/null +++ b/vendor/github.com/modern-go/concurrent/unbounded_executor.go | |||
| @@ -0,0 +1,119 @@ | |||
| 1 | package concurrent | ||
| 2 | |||
| 3 | import ( | ||
| 4 | "context" | ||
| 5 | "fmt" | ||
| 6 | "runtime" | ||
| 7 | "runtime/debug" | ||
| 8 | "sync" | ||
| 9 | "time" | ||
| 10 | "reflect" | ||
| 11 | ) | ||
| 12 | |||
| 13 | // HandlePanic logs goroutine panic by default | ||
| 14 | var HandlePanic = func(recovered interface{}, funcName string) { | ||
| 15 | ErrorLogger.Println(fmt.Sprintf("%s panic: %v", funcName, recovered)) | ||
| 16 | ErrorLogger.Println(string(debug.Stack())) | ||
| 17 | } | ||
| 18 | |||
| 19 | // UnboundedExecutor is a executor without limits on counts of alive goroutines | ||
| 20 | // it tracks the goroutine started by it, and can cancel them when shutdown | ||
| 21 | type UnboundedExecutor struct { | ||
| 22 | ctx context.Context | ||
| 23 | cancel context.CancelFunc | ||
| 24 | activeGoroutinesMutex *sync.Mutex | ||
| 25 | activeGoroutines map[string]int | ||
| 26 | HandlePanic func(recovered interface{}, funcName string) | ||
| 27 | } | ||
| 28 | |||
| 29 | // GlobalUnboundedExecutor has the life cycle of the program itself | ||
| 30 | // any goroutine want to be shutdown before main exit can be started from this executor | ||
| 31 | // GlobalUnboundedExecutor expects the main function to call stop | ||
| 32 | // it does not magically knows the main function exits | ||
| 33 | var GlobalUnboundedExecutor = NewUnboundedExecutor() | ||
| 34 | |||
| 35 | // NewUnboundedExecutor creates a new UnboundedExecutor, | ||
| 36 | // UnboundedExecutor can not be created by &UnboundedExecutor{} | ||
| 37 | // HandlePanic can be set with a callback to override global HandlePanic | ||
| 38 | func NewUnboundedExecutor() *UnboundedExecutor { | ||
| 39 | ctx, cancel := context.WithCancel(context.TODO()) | ||
| 40 | return &UnboundedExecutor{ | ||
| 41 | ctx: ctx, | ||
| 42 | cancel: cancel, | ||
| 43 | activeGoroutinesMutex: &sync.Mutex{}, | ||
| 44 | activeGoroutines: map[string]int{}, | ||
| 45 | } | ||
| 46 | } | ||
| 47 | |||
| 48 | // Go starts a new goroutine and tracks its lifecycle. | ||
| 49 | // Panic will be recovered and logged automatically, except for StopSignal | ||
| 50 | func (executor *UnboundedExecutor) Go(handler func(ctx context.Context)) { | ||
| 51 | pc := reflect.ValueOf(handler).Pointer() | ||
| 52 | f := runtime.FuncForPC(pc) | ||
| 53 | funcName := f.Name() | ||
| 54 | file, line := f.FileLine(pc) | ||
| 55 | executor.activeGoroutinesMutex.Lock() | ||
| 56 | defer executor.activeGoroutinesMutex.Unlock() | ||
| 57 | startFrom := fmt.Sprintf("%s:%d", file, line) | ||
| 58 | executor.activeGoroutines[startFrom] += 1 | ||
| 59 | go func() { | ||
| 60 | defer func() { | ||
| 61 | recovered := recover() | ||
| 62 | // if you want to quit a goroutine without trigger HandlePanic | ||
| 63 | // use runtime.Goexit() to quit | ||
| 64 | if recovered != nil { | ||
| 65 | if executor.HandlePanic == nil { | ||
| 66 | HandlePanic(recovered, funcName) | ||
| 67 | } else { | ||
| 68 | executor.HandlePanic(recovered, funcName) | ||
| 69 | } | ||
| 70 | } | ||
| 71 | executor.activeGoroutinesMutex.Lock() | ||
| 72 | executor.activeGoroutines[startFrom] -= 1 | ||
| 73 | executor.activeGoroutinesMutex.Unlock() | ||
| 74 | }() | ||
| 75 | handler(executor.ctx) | ||
| 76 | }() | ||
| 77 | } | ||
| 78 | |||
| 79 | // Stop cancel all goroutines started by this executor without wait | ||
| 80 | func (executor *UnboundedExecutor) Stop() { | ||
| 81 | executor.cancel() | ||
| 82 | } | ||
| 83 | |||
| 84 | // StopAndWaitForever cancel all goroutines started by this executor and | ||
| 85 | // wait until all goroutines exited | ||
| 86 | func (executor *UnboundedExecutor) StopAndWaitForever() { | ||
| 87 | executor.StopAndWait(context.Background()) | ||
| 88 | } | ||
| 89 | |||
| 90 | // StopAndWait cancel all goroutines started by this executor and wait. | ||
| 91 | // Wait can be cancelled by the context passed in. | ||
| 92 | func (executor *UnboundedExecutor) StopAndWait(ctx context.Context) { | ||
| 93 | executor.cancel() | ||
| 94 | for { | ||
| 95 | oneHundredMilliseconds := time.NewTimer(time.Millisecond * 100) | ||
| 96 | select { | ||
| 97 | case <-oneHundredMilliseconds.C: | ||
| 98 | if executor.checkNoActiveGoroutines() { | ||
| 99 | return | ||
| 100 | } | ||
| 101 | case <-ctx.Done(): | ||
| 102 | return | ||
| 103 | } | ||
| 104 | } | ||
| 105 | } | ||
| 106 | |||
| 107 | func (executor *UnboundedExecutor) checkNoActiveGoroutines() bool { | ||
| 108 | executor.activeGoroutinesMutex.Lock() | ||
| 109 | defer executor.activeGoroutinesMutex.Unlock() | ||
| 110 | for startFrom, count := range executor.activeGoroutines { | ||
| 111 | if count > 0 { | ||
| 112 | InfoLogger.Println("UnboundedExecutor is still waiting goroutines to quit", | ||
| 113 | "startFrom", startFrom, | ||
| 114 | "count", count) | ||
| 115 | return false | ||
| 116 | } | ||
| 117 | } | ||
| 118 | return true | ||
| 119 | } | ||