FreeBSD src
Go to file
Alan Somers 8907f744ff Improve performance and functionality of the bitstring(3) api
Two new functions are provided, bit_ffs_at() and bit_ffc_at(), which allow
for efficient searching of set or cleared bits starting from any bit offset
within the bit string.

Performance is improved by operating on longs instead of bytes and using
ffsl() for searches within a long. ffsl() is a compiler builtin in both
clang and gcc for most architectures, converting what was a brute force
while loop search into a couple of instructions.

All of the bitstring(3) API continues to be contained in the header file.
Some of the functions are large enough that perhaps they should be uninlined
and moved to a library, but that is beyond the scope of this commit.

sys/sys/bitstring.h:
        Convert the majority of the existing bit string implementation from
        macros to inline functions.

        Properly protect the implementation from inadvertant macro expansion
        when included in a user's program by prefixing all private
        macros/functions and local variables with '_'.

        Add bit_ffs_at() and bit_ffc_at(). Implement bit_ffs() and
        bit_ffc() in terms of their "at" counterparts.

        Provide a kernel implementation of bit_alloc(), making the full API
        usable in the kernel.

        Improve code documenation.

share/man/man3/bitstring.3:
        Add pre-exisiting API bit_ffc() to the synopsis.

        Document new APIs.

        Document the initialization state of the bit strings
        allocated/declared by bit_alloc() and bit_decl().

        Correct documentation for bitstr_size(). The original code comments
        indicate the size is in bytes, not "elements of bitstr_t". The new
        implementation follows this lead. Only hastd assumed "elements"
        rather than bytes and it has been corrected.

etc/mtree/BSD.tests.dist:
tests/sys/Makefile:
tests/sys/sys/Makefile:
tests/sys/sys/bitstring.c:
        Add tests for all existing and new functionality.

include/bitstring.h
	Include all headers needed by sys/bitstring.h

lib/libbluetooth/bluetooth.h:
usr.sbin/bluetooth/hccontrol/le.c:
        Include bitstring.h instead of sys/bitstring.h.

sbin/hastd/activemap.c:
        Correct usage of bitstr_size().

sys/dev/xen/blkback/blkback.c
        Use new bit_alloc.

sys/kern/subr_unit.c:
        Remove hard-coded assumption that sizeof(bitstr_t) is 1.  Get rid of
        unrb.busy, which caches the number of bits set in unrb.map.  When
        INVARIANTS are disabled, nothing needs to know that information.
        callapse_unr can be adapted to use bit_ffs and bit_ffc instead.
        Eliminating unrb.busy saves memory, simplifies the code, and
        provides a slight speedup when INVARIANTS are disabled.

sys/net/flowtable.c:
        Use the new kernel implementation of bit-alloc, instead of hacking
        the old libc-dependent macro.

sys/sys/param.h
        Update __FreeBSD_version to indicate availability of new API

Submitted by:   gibbs, asomers
Reviewed by:    gibbs, ngie
MFC after:      4 weeks
Sponsored by:   Spectra Logic Corp
Differential Revision:  https://reviews.freebsd.org/D6004
2016-05-04 22:34:11 +00:00
bin sh: Handle empty hostname and $PWD when building prompt 2016-05-04 02:06:46 +00:00
cddl Fix including Kyuafile in packaged base system. 2016-04-29 05:28:40 +00:00
contrib Re-sync the FreeBSD-specific Subversion template with the one from 2016-05-03 18:06:42 +00:00
crypto Merge OpenSSL 1.0.2h. 2016-05-03 18:50:10 +00:00
etc Improve performance and functionality of the bitstring(3) api 2016-05-04 22:34:11 +00:00
gnu import sdiff(1) from GSoC 2012 2016-04-29 23:27:15 +00:00
include Improve performance and functionality of the bitstring(3) api 2016-05-04 22:34:11 +00:00
kerberos5 Remove the old depend (mkdep) code and make FAST_DEPEND the one true way. 2016-03-30 23:50:23 +00:00
lib Improve performance and functionality of the bitstring(3) api 2016-05-04 22:34:11 +00:00
libexec libexec: minor spelling fixes in comments. 2016-05-01 19:39:23 +00:00
release picobsd: minor spelling fixes. 2016-05-01 16:16:11 +00:00
rescue Split /rescue into its own package. 2016-02-08 14:27:45 +00:00
sbin Improve performance and functionality of the bitstring(3) api 2016-05-04 22:34:11 +00:00
secure Merge OpenSSL 1.0.2h. 2016-05-03 18:50:10 +00:00
share Improve performance and functionality of the bitstring(3) api 2016-05-04 22:34:11 +00:00
sys Improve performance and functionality of the bitstring(3) api 2016-05-04 22:34:11 +00:00
targets Simplify building libpam and fix libpam.a not containing the modules since r284345. 2016-04-14 01:17:03 +00:00
tests Improve performance and functionality of the bitstring(3) api 2016-05-04 22:34:11 +00:00
tools tools: minor spelling fix in locales template. 2016-05-04 17:29:07 +00:00
usr.bin DIRDEPS_BUILD: Update dependencies. 2016-05-04 03:14:34 +00:00
usr.sbin Improve performance and functionality of the bitstring(3) api 2016-05-04 22:34:11 +00:00
.arcconfig Remove project.name which is a product of a bygone era. 2016-04-21 04:33:07 +00:00
.arclint phabricator related changes: 2015-04-20 20:33:22 +00:00
COPYRIGHT Bump copyright year. 2015-12-31 11:21:45 +00:00
LOCKS Explicitly require Security Officer's approval for kernel PRNG bits. 2013-09-17 14:19:05 +00:00
MAINTAINERS Add myself to MAINTAINERS. 2016-03-14 16:27:43 +00:00
Makefile Import OpenSSL 1.0.2h. 2016-05-03 18:00:27 +00:00
Makefile.inc1 Default NO_INSTALLEXTRAKERNELS to yes, not no 2016-05-04 21:15:28 +00:00
Makefile.libcompat Set CPP from XCPP for the libcompat build. 2016-04-15 18:32:05 +00:00
ObsoleteFiles.inc Misc. build: minor spelling fixes. 2016-05-03 22:01:48 +00:00
README Import OpenSSL 1.0.2h. 2016-05-03 18:00:27 +00:00
UPDATING Misc. build: minor spelling fixes. 2016-05-03 22:01:48 +00:00

This is the top level of the FreeBSD source directory.  This file
was last revised on:
$FreeBSD$

For copyright information, please see the file COPYRIGHT in this
directory (additional copyright information also exists for some
sources in this tree - please see the specific source directories for
more information).

The Makefile in this directory supports a number of targets for
building components (or all) of the FreeBSD source tree.  See build(7)
and http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
for more information, including setting make(1) variables.

The `buildkernel` and `installkernel` targets build and install
the kernel and the modules (see below).  Please see the top of
the Makefile in this directory for more information on the
standard build targets and compile-time flags.

Building a kernel is a somewhat more involved process.  See build(7), config(8),
and http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
for more information.

Note: If you want to build and install the kernel with the
`buildkernel` and `installkernel` targets, you might need to build
world before.  More information is available in the handbook.

The kernel configuration files reside in the sys/<arch>/conf
sub-directory.  GENERIC is the default configuration used in release builds.
NOTES contains entries and documentation for all possible
devices, not just those commonly used.


Source Roadmap:
---------------

bin		System/user commands.

cddl		Various commands and libraries under the Common Development
		and Distribution License.

contrib		Packages contributed by 3rd parties.

crypto		Cryptography stuff (see crypto/README).

etc		Template files for /etc.

games		Amusements.

gnu		Various commands and libraries under the GNU Public License.
		Please see gnu/COPYING* for more information.

include		System include files.

kerberos5	Kerberos5 (Heimdal) package.

lib		System libraries.

libexec		System daemons.

release		Release building Makefile & associated tools.

rescue		Build system for statically linked /rescue utilities.

sbin		System commands.

secure		Cryptographic libraries and commands.

share		Shared resources.

sys		Kernel sources.

tests		Regression tests which can be run by Kyua.  See tests/README
		for additional information.

tools		Utilities for regression testing and miscellaneous tasks.

usr.bin		User commands.

usr.sbin	System administration commands.


For information on synchronizing your source tree with one or more of
the FreeBSD Project's development branches, please see:

  http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/synching.html