1.\" $OpenBSD: tvtohz.9,v 1.11 2019/01/18 03:34:58 schwarze Exp $ 2.\" 3.\" Copyright (c) 1999 Marc Espie 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25.\" 26.Dd $Mdocdate: January 18 2019 $ 27.Dt TVTOHZ 9 28.Os 29.Sh NAME 30.Nm tvtohz , 31.Nm tstohz 32.Nd translate time period to timeout delay 33.Sh SYNOPSIS 34.In sys/types.h 35.In sys/time.h 36.In sys/systm.h 37.Ft int 38.Fn tvtohz "const struct timeval *tv" 39.Ft int 40.Fn tstohz "const struct timespec *ts" 41.Sh DESCRIPTION 42The 43.Fn tvtohz 44and 45.Fn tstohz 46functions return the number of ticks in the specified amount of time. 47If the return value would exceed the maximum value representable by an 48.Vt int , 49it is capped at 50.Dv INT_MAX . 51They are mainly used to translate a 52.Vt timeval 53or 54.Vt timespec , 55respectively, 56into a suitable argument for 57.Xr tsleep 9 . 58.Sh CODE REFERENCES 59These functions are implemented in the file 60.Pa sys/kern/kern_clock.c . 61.Sh SEE ALSO 62.Xr hz 9 , 63.Xr timeout 9 64