Initial commit
This commit is contained in:
201
vendor/github.com/cockroachdb/tokenbucket/LICENSE
generated
vendored
Normal file
201
vendor/github.com/cockroachdb/tokenbucket/LICENSE
generated
vendored
Normal file
@@ -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.
|
||||
2
vendor/github.com/cockroachdb/tokenbucket/README.md
generated
vendored
Normal file
2
vendor/github.com/cockroachdb/tokenbucket/README.md
generated
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
# tokenbucket
|
||||
Token bucket implementation in Go
|
||||
202
vendor/github.com/cockroachdb/tokenbucket/token_bucket.go
generated
vendored
Normal file
202
vendor/github.com/cockroachdb/tokenbucket/token_bucket.go
generated
vendored
Normal file
@@ -0,0 +1,202 @@
|
||||
// Copyright 2023 The Cockroach Authors.
|
||||
//
|
||||
// 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 tokenbucket
|
||||
|
||||
import (
|
||||
"context"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Tokens are abstract units (usually units of work).
|
||||
type Tokens float64
|
||||
|
||||
// TokensPerSecond is the rate of token replenishment.
|
||||
type TokensPerSecond float64
|
||||
|
||||
// TokenBucket implements the basic accounting for a token bucket.
|
||||
//
|
||||
// A token bucket has a rate of replenishment and a burst limit. Tokens are
|
||||
// replenished over time, up to the burst limit.
|
||||
//
|
||||
// The token bucket keeps track of the current amount and updates it as time
|
||||
// passes. The bucket can go into debt (i.e. negative current amount).
|
||||
type TokenBucket struct {
|
||||
rate TokensPerSecond
|
||||
burst Tokens
|
||||
nowFn func() time.Time
|
||||
|
||||
current Tokens
|
||||
lastUpdated time.Time
|
||||
|
||||
exhaustedStart time.Time
|
||||
exhaustedMicros int64
|
||||
}
|
||||
|
||||
// Init the token bucket.
|
||||
func (tb *TokenBucket) Init(rate TokensPerSecond, burst Tokens) {
|
||||
tb.InitWithNowFn(rate, burst, func() time.Time {
|
||||
return time.Now()
|
||||
})
|
||||
}
|
||||
|
||||
// Init the token bucket with a custom "Now" function.
|
||||
// Note that Wait/WaitCtx cannot be used with a custom time function.
|
||||
func (tb *TokenBucket) InitWithNowFn(rate TokensPerSecond, burst Tokens, nowFn func() time.Time) {
|
||||
*tb = TokenBucket{
|
||||
rate: rate,
|
||||
burst: burst,
|
||||
nowFn: nowFn,
|
||||
current: burst,
|
||||
lastUpdated: nowFn(),
|
||||
}
|
||||
}
|
||||
|
||||
// Update moves the time forward, accounting for the replenishment since the
|
||||
// last update.
|
||||
func (tb *TokenBucket) Update() {
|
||||
now := tb.nowFn()
|
||||
if since := now.Sub(tb.lastUpdated); since > 0 {
|
||||
tb.current += Tokens(float64(tb.rate) * since.Seconds())
|
||||
|
||||
if tb.current > tb.burst {
|
||||
tb.current = tb.burst
|
||||
}
|
||||
tb.lastUpdated = now
|
||||
tb.updateExhaustedMicros()
|
||||
}
|
||||
}
|
||||
|
||||
// UpdateConfig updates the rate and burst limits. The change in burst will be
|
||||
// applied to the current token quantity. For example, if the RateLimiter
|
||||
// currently had 5 available tokens and the burst is updated from 10 to 20, the
|
||||
// amount will increase to 15. Similarly, if the burst is decreased by 10, the
|
||||
// current quota will decrease accordingly, potentially putting the limiter into
|
||||
// debt.
|
||||
func (tb *TokenBucket) UpdateConfig(rate TokensPerSecond, burst Tokens) {
|
||||
tb.Update()
|
||||
|
||||
burstDelta := burst - tb.burst
|
||||
tb.rate = rate
|
||||
tb.burst = burst
|
||||
|
||||
tb.current += burstDelta
|
||||
tb.updateExhaustedMicros()
|
||||
}
|
||||
|
||||
// Reset resets the current tokens to whatever the burst is.
|
||||
func (tb *TokenBucket) Reset() {
|
||||
tb.current = tb.burst
|
||||
tb.updateExhaustedMicros()
|
||||
}
|
||||
|
||||
// Adjust returns tokens to the bucket (positive delta) or accounts for a debt
|
||||
// of tokens (negative delta).
|
||||
func (tb *TokenBucket) Adjust(delta Tokens) {
|
||||
tb.Update()
|
||||
tb.current += delta
|
||||
if tb.current > tb.burst {
|
||||
tb.current = tb.burst
|
||||
}
|
||||
tb.updateExhaustedMicros()
|
||||
}
|
||||
|
||||
// TryToFulfill either removes the given amount if is available, or returns a
|
||||
// time after which the request should be retried.
|
||||
func (tb *TokenBucket) TryToFulfill(amount Tokens) (fulfilled bool, tryAgainAfter time.Duration) {
|
||||
tb.Update()
|
||||
|
||||
// Deal with the case where the request is larger than the burst size. In
|
||||
// this case we'll allow the acquisition to complete if and when the current
|
||||
// value is equal to the burst. If the acquisition succeeds, it will put the
|
||||
// limiter into debt.
|
||||
want := amount
|
||||
if want > tb.burst {
|
||||
want = tb.burst
|
||||
}
|
||||
if delta := want - tb.current; delta > 0 {
|
||||
// Compute the time it will take to get to the needed capacity.
|
||||
timeDelta := time.Duration((float64(delta) * float64(time.Second)) / float64(tb.rate))
|
||||
if timeDelta < time.Nanosecond {
|
||||
timeDelta = time.Nanosecond
|
||||
}
|
||||
return false, timeDelta
|
||||
}
|
||||
|
||||
tb.current -= amount
|
||||
tb.updateExhaustedMicros()
|
||||
return true, 0
|
||||
}
|
||||
|
||||
// Wait removes the given amount, waiting as long as necessary.
|
||||
func (tb *TokenBucket) Wait(amount Tokens) {
|
||||
_ = tb.WaitCtx(context.Background(), amount)
|
||||
}
|
||||
|
||||
// WaitCtx removes the given amount, waiting as long as necessary or until the
|
||||
// context is canceled.
|
||||
func (tb *TokenBucket) WaitCtx(ctx context.Context, amount Tokens) error {
|
||||
// We want to check for context cancelation even if we don't need to wait.
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return ctx.Err()
|
||||
default:
|
||||
}
|
||||
for {
|
||||
fulfilled, tryAgainAfter := tb.TryToFulfill(amount)
|
||||
if fulfilled {
|
||||
return nil
|
||||
}
|
||||
select {
|
||||
case <-time.After(tryAgainAfter):
|
||||
case <-ctx.Done():
|
||||
return ctx.Err()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Exhausted returns the cumulative duration over which this token bucket was
|
||||
// exhausted. Exported only for metrics.
|
||||
func (tb *TokenBucket) Exhausted() time.Duration {
|
||||
var ongoingExhaustionMicros int64
|
||||
if !tb.exhaustedStart.IsZero() {
|
||||
ongoingExhaustionMicros = tb.nowFn().Sub(tb.exhaustedStart).Microseconds()
|
||||
}
|
||||
return time.Duration(tb.exhaustedMicros+ongoingExhaustionMicros) * time.Microsecond
|
||||
}
|
||||
|
||||
// Available returns the currently available tokens (can be -ve). Exported only
|
||||
// for metrics.
|
||||
func (tb *TokenBucket) Available() Tokens {
|
||||
return tb.current
|
||||
}
|
||||
|
||||
func (tb *TokenBucket) updateExhaustedMicros() {
|
||||
now := tb.nowFn()
|
||||
if tb.current <= 0 && tb.exhaustedStart.IsZero() {
|
||||
tb.exhaustedStart = now
|
||||
}
|
||||
if tb.current > 0 && !tb.exhaustedStart.IsZero() {
|
||||
tb.exhaustedMicros += now.Sub(tb.exhaustedStart).Microseconds()
|
||||
tb.exhaustedStart = time.Time{}
|
||||
}
|
||||
}
|
||||
|
||||
// TestingInternalParameters returns the refill rate (configured), burst tokens
|
||||
// (configured), and number of available tokens where available <= burst. It's
|
||||
// used in tests.
|
||||
func (tb *TokenBucket) TestingInternalParameters() (rate TokensPerSecond, burst, available Tokens) {
|
||||
tb.Update()
|
||||
return tb.rate, tb.burst, tb.current
|
||||
}
|
||||
Reference in New Issue
Block a user