mirror of
https://gitlab.freedesktop.org/libinput/libinput.git
synced 2025-12-20 04:30:06 +01:00
a202ed6115
This avoids mixing up milliseconds and usec, both by failing if we're providing just a number somewhere we expect usecs and also by making the API blindingly obvious that we're in usecs now. Part-of: <https://gitlab.freedesktop.org/libinput/libinput/-/merge_requests/1373>
80 lines
2.6 KiB
C
80 lines
2.6 KiB
C
/*
|
|
* Copyright © 2008-2011 Kristian Høgsberg
|
|
* Copyright © 2011 Intel Corporation
|
|
* Copyright © 2013-2015 Red Hat, Inc.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a
|
|
* copy of this software and associated documentation files (the "Software"),
|
|
* to deal in the Software without restriction, including without limitation
|
|
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
* and/or sell copies of the Software, and to permit persons to whom the
|
|
* Software is furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice (including the next
|
|
* paragraph) shall be included in all copies or substantial portions of the
|
|
* Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
|
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
* DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include <time.h>
|
|
|
|
#include "util-ratelimit.h"
|
|
#include "util-time.h"
|
|
|
|
void
|
|
ratelimit_init(struct ratelimit *r, usec_t ival_us, unsigned int burst)
|
|
{
|
|
r->interval = ival_us;
|
|
r->begin = usec_from_millis(0);
|
|
r->burst = burst;
|
|
r->num = 0;
|
|
}
|
|
|
|
/*
|
|
* Perform rate-limit test. Returns RATELIMIT_PASS if the rate-limited action
|
|
* is still allowed, RATELIMIT_THRESHOLD if the limit has been reached with
|
|
* this call, and RATELIMIT_EXCEEDED if you're beyond the threshold.
|
|
* It's safe to treat the return-value as boolean, if you're not interested in
|
|
* the exact state. It evaluates to "true" if the threshold hasn't been
|
|
* exceeded, yet.
|
|
*
|
|
* The ratelimit object must be initialized via ratelimit_init().
|
|
*
|
|
* Modelled after Linux' lib/ratelimit.c by Dave Young
|
|
* <hidave.darkstar@gmail.com>, which is licensed GPLv2.
|
|
*/
|
|
enum ratelimit_state
|
|
ratelimit_test(struct ratelimit *r)
|
|
{
|
|
struct timespec ts;
|
|
|
|
if (usec_is_zero(r->interval) || r->burst <= 0)
|
|
return RATELIMIT_PASS;
|
|
|
|
clock_gettime(CLOCK_MONOTONIC, &ts);
|
|
usec_t utime = usec_from_timespec(&ts);
|
|
|
|
if (usec_is_zero(r->begin) ||
|
|
usec_cmp(usec_add(r->begin, r->interval), utime) < 0) {
|
|
/* reset counter */
|
|
r->begin = utime;
|
|
r->num = 1;
|
|
return RATELIMIT_PASS;
|
|
}
|
|
|
|
if (r->num < r->burst) {
|
|
/* continue burst */
|
|
return (++r->num == r->burst) ? RATELIMIT_THRESHOLD : RATELIMIT_PASS;
|
|
}
|
|
|
|
return RATELIMIT_EXCEEDED;
|
|
}
|