xref: /netbsd-src/share/man/man3/bitops.3 (revision 15b02c1c945edbcf00896e07004a5815dcfaa2cb)
1.\" $NetBSD: bitops.3,v 1.6 2020/01/13 16:11:53 uwe Exp $
2.\"
3.\" Copyright (c) 2011 Jukka Ruohonen <jruohonen@iki.fi>
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 NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25.\" POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd December 4, 2012
28.Dt BITOPS 3
29.Os
30.Sh NAME
31.Nm bitops
32.Nd functions related to bits and integers
33.Sh SYNOPSIS
34.In sys/bitops.h
35.Sh DESCRIPTION
36The
37.In sys/bitops.h
38header provides macros and
39.Vt static inline
40functions related to bits and integers.
41Among these are:
42.Bl -tag -width ".Xr fast_divide32 3" -offset indent
43.It Xr bitmap 3
44bitmap manipulation macros
45.It Xr fast_divide32 3
46a function for fast 32-bit division
47.It Xr ffs32 3
48functions to find the first and last set bit in integers of type
49.Vt uint32_t
50and
51.Vt uint64_t
52.It Xr ilog2 3
53a macro for binary logarithm
54.El
55.Sh SEE ALSO
56.Xr bits 3 ,
57.Xr bitstring 3 ,
58.Xr cdefs 3 ,
59.Xr param 3
60.Sh HISTORY
61The
62.In sys/bitops.h
63header first appeared in
64.Nx 4.0 .
65