diff options
| -rw-r--r-- | share/man/man9/Makefile | 10 | ||||
| -rw-r--r-- | share/man/man9/ppsratecheck.9 | 96 |
2 files changed, 101 insertions, 5 deletions
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index f78024ec95a..87f1250c0e4 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -1,4 +1,4 @@ -# $OpenBSD: Makefile,v 1.23 2000/07/01 14:45:44 aaron Exp $ +# $OpenBSD: Makefile,v 1.24 2000/10/10 13:40:45 itojun Exp $ # $NetBSD: Makefile,v 1.4 1996/01/09 03:23:01 thorpej Exp $ # Makefile for section 9 (kernel function and variable) manual pages. @@ -7,10 +7,10 @@ MAN= audio.9 boot.9 copy.9 crypto.9 ctxsw.9 disk.9 disklabel.9 \ dopowerhooks.9 doshutdownhooks.9 fetch.9 fork1.9 \ extent.9 hz.9 hzto.9 intro.9 inittodr.9 log.9 kthread.9 \ malloc.9 md5.9 microtime.9 panic.9 pfind.9 pool.9 \ - powerhook_establish.9 printf.9 psignal.9 ratecheck.9 resettodr.9 \ - random.9 shutdownhook_establish.9 sleep.9 spl.9 store.9 style.9 \ - time.9 timeout.9 vm_allocate.9 vm_map_copy.9 vm_deallocate.9 \ - vm_map_inherit.9 vm_map_protect.9 + powerhook_establish.9 ppsratecheck.9 printf.9 psignal.9 \ + ratecheck.9 resettodr.9 random.9 shutdownhook_establish.9 \ + sleep.9 spl.9 store.9 style.9 time.9 timeout.9 vm_allocate.9 \ + vm_map_copy.9 vm_deallocate.9 vm_map_inherit.9 vm_map_protect.9 MLINKS+=copy.9 copyin.9 copy.9 copyout.9 copy.9 copystr.9 \ copy.9 copyinstr.9 copy.9 copyoutstr.9 diff --git a/share/man/man9/ppsratecheck.9 b/share/man/man9/ppsratecheck.9 new file mode 100644 index 00000000000..0c9dbdb8464 --- /dev/null +++ b/share/man/man9/ppsratecheck.9 @@ -0,0 +1,96 @@ +.\" $OpenBSD: ppsratecheck.9,v 1.1 2000/10/10 13:40:46 itojun Exp $ +.\" $NetBSD: ppsratecheck.9,v 1.1 2000/08/03 00:09:39 itojun Exp $ +.\" +.\" Copyright (c) 2000 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Jun-ichiro itojun Hagino. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the NetBSD +.\" Foundation, Inc. and its contributors. +.\" 4. Neither the name of The NetBSD Foundation nor the names of its +.\" contributors may be used to endorse or promote products derived +.\" from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd August 3, 2000 +.Dt PPSRATECHECK 9 +.Os +.Sh NAME +.Nm ppsratecheck +.Nd function to help implement rate-limited actions +.Sh SYNOPSIS +.Fd #include <sys/time.h> +.Ft int +.Fn ppsratecheck "struct timeval *lasttime" "int *curpps" "int maxpps" +.Sh DESCRIPTION +The +.Fn ppsratecheck +function provides easy way to perform packet-per-sec, +or event-per-sec, rate limitation. +The motivation for implementing +.Fn ppsratecheck +was to provide a mechanism that could be used to add rate limitation to +network packet output. +For certain network packets, we may want to impose rate limitation, +to avoid denial-of-service attack possibilities. +.Pp +.Fa maxpps +specifies maximum permitted packets, or events, per second. +If +.Fn ppsratecheck +is called more than +.Fa maxpps +times in a given one second period, +the function will return 0, indicating that we exceeded the limit. +If we are below the limit, the function will return 1. +If +.Fa maxpps +is set to 0, the function will always return 0 +.Pq no packets/events are permitted . +Negative +.Fa maxpps +indicates that rate limitation is disabled, and +.Fa ppsratecheck +will always return 1. +.Pp +.Fa curpps +and +.Fa lasttime +are used to maintain the number of recent calls. +.Fa curpps +will be incremented every time +.Fn ppsratecheck +is called, and will be reset whenever necessary. +.Sh SEE ALSO +.Xr log 9 , +.Xr printf 9 , +.Xr ratecheck 9 , +.Xr time 9 +.Sh HISTORY +The +.Fn ppsratecheck +function appeared in +.Nx 1.5 . |