.\" $NetBSD: bitops.3,v 1.6 2020/01/13 16:11:53 uwe Exp $
.\"
.\" Copyright (c) 2011 Jukka Ruohonen <jruohonen@iki.fi>
.\" All rights reserved.
.\"
.\" 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.
.\"
.\" 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 December 4, 2012
.Dt BITOPS 3
.Os
.Sh NAME
.Nm bitops
.Nd functions related to bits and integers
.Sh SYNOPSIS
.In sys/bitops.h
.Sh DESCRIPTION
The
.In sys/bitops.h
header provides macros and
.Vt static inline
functions related to bits and integers.
Among these are:
.Bl -tag -width ".Xr fast_divide32 3" -offset indent
.It Xr bitmap 3
bitmap manipulation macros
.It Xr fast_divide32 3
a function for fast 32-bit division
.It Xr ffs32 3
functions to find the first and last set bit in integers of type
.Vt uint32_t
and
.Vt uint64_t
.It Xr ilog2 3
a macro for binary logarithm
.El
.Sh SEE ALSO
.Xr bits 3 ,
.Xr bitstring 3 ,
.Xr cdefs 3 ,
.Xr param 3
.Sh HISTORY
The
.In sys/bitops.h
header first appeared in
.Nx 4.0 .