branches: 1.2.2;
Canonical prolog order

Add CTASSERT(9). From FreeBSD.

ok @wiz

Document new *ASSERTMSG() prototype, and update KASSERT(9).

See also
http://mail-index.netbsd.org/tech-kern/2011/09/07/msg011427.html

Note also KASSERTMSG(). Small markup changes.

Fix typo.

- add some random notes

Basically, KASSERT() should be used for light-weight checks and
KDASSERT() should be used for heavier ones.

Callers should not rely on the side effects of expression because,
depending on the kernel compile options mentioned above, expression might
not be evaluated at all.

- Xr options(4)
- bump date

branches: 1.9.2;
Sort SEE ALSO.

Xref CTASSERT(9).

branches: 1.7.10;
Changemanpages written by Igor Sobrado to 2-clause license, per
private email from Igor. Drop attribution to Matt Thomas in those man
pages, per private email from Matt. In coredump_write.9, fix
capitalization of THomas. Requested by martin@.

Simplify some unclear grammar (sync KASSERT and KDASSERT wording)

Backout previous: the license sweep touched these files in error, so
restore the old license.

branches: 1.4.2;
Convert TNF licenses to new 2 clause variant

branches: 1.3.10; 1.3.12;
fix description to match the code

branches: 1.2.4;
Fix xref. New sentence, new line. Remove superfluous quotes.

man pages contributed by Igor Sobrado.

Fix typo, use Nm instead of Xr to itself.

KERNEL_LOCK(9): New man page for old not-dead-yet hack.

I'm not documenting this to encourage anyone to use it. I'm only
documenting this to remind myself what the semantics is, because it's
kind of confusing and not at all like mutex(9).

fix various typos in comments, documentation and messages.

branches: 1.2.4;
should -> can

document LWP_CACHE_CREDS.

paravirt_membar_sync(9): New memory barrier.

For use in paravirtualized drivers which require store-before-load
ordering -- irrespective of whether the kernel is built for a single
processor, or whether the (virtual) machine is booted with a single
processor.

This is even required on architectures that don't even have a
store-before-load ordering barrier, like m68k; adding, e.g., a virtio
bus is _as if_ the architecture has been extended with relaxed memory
ordering when talking with that new bus. Such architectures need
some way to request the hypervisor enforce that ordering -- on m68k,
that's done by issuing a CASL instruction, which qemu maps to an
atomic r/m/w with sequential consistency ordering in the host.

PR kern/59618: occasional virtio block device lock ups/hangs

branches: 1.474.2;
Add heartbeat(9) to installed man pages

Add a man page for acct_process to be referenced from acct.5

crashme(9): Install man page

Suggested by ozaki-r@

man9: Provide all combinations of {,u}{i,l}{max,min}(9)

branches: 1.470.2;
uvm_obj_wirepages(9): New man page.

Install securelevel.9 as an alias of secmodel_securelevel.9

According to submitter, this should be sufficient to address misc/57824.

Add a vmem_xalloc_addr() function, which allocates a specific address
from an arena. This is just a convenience wrapper around vmem_xalloc(),
that's just a bit more obvious how to use and performs some additional
sanity checks.

Document how system call versioning is done. From this summer's compat-linux
GSoC, by Theodore Preduta.

portfeatures(9): the man page for the __HAVE macros

The man page itself is a skeleton/template for now. Please add short
descriptions and xrefs. If the target man page doesn't yet document
relevant __HAVE macros (hi, mutex(9)), please add something there,
possibly in a .Sh IMPLEMENTATION NOTES section.

branches: 1.465.2;
Document the pktqueue interface.

KERNEL_LOCK(9): New man page for old not-dead-yet hack.

I'm not documenting this to encourage anyone to use it. I'm only
documenting this to remind myself what the semantics is, because it's
kind of confusing and not at all like mutex(9).

__cpu_simple_lock(9): New man page.

This doesn't mean you should use it! Mostly it's to document the
semantics to help understand existing uses, which should not
proliferate, and audit definitions.

Add new acl vnode op pages

Add acl related changes; there is no more vaccess; document the genfs functions
instead.

Document PR_PSERIALIZE. Remove documentation for pool_cache_setpredestruct().

Add pool_cache_setpredestruct(), which allows a pool cache to specify
a function to be called before the destructor for a batch of one or more
objects is called. This can be used as a synchronization point by
subsystems that rely on the type-stable nature of pool cache objects or
subsystems that use other forms of passive serialization.

Update autoconf(9) for recent autoconfiguration changes.

- Remove obsolete cltom(9) and mtocl(9).
- Add missing manual page's link of m_adj.

Add printf_nostamp(9), kernel printf() without prepending a timestamp.

Add kmem_tmpbuf_alloc(), a utility function for allocating memory for
temporary use where allocation on the stack is desirable, but only up to
a certain size. If the requested size fits within the specified stack
buffer, the stack buffer is returned. Otherwise, memory is allocated with
kmem_alloc(). Add a corresponding kmem_tmpbuf_free() function that frees
the memory using kmem_free() if it is not the tempory stack buffer location.

Add a manual page for strlist(9).

Install ddb(9). Xref it from ddb(4).

Update pci_configure_bus(9) to reflect the new reality -- no more manual
fiddling with extent maps, use pciconf_resource_{init,add,fini}() instead.

Add vmem_xfreeall(), which frees all allocated regions in the specified arena.
All outstanding allocations MUST have been performed with vmem_xalloc() or
else the behavior is undefined. (This also implies that the arena must also
not have a quantum cache; note this in the documentation.)

link also m_apply(9) to mbuf(9)

Rewrite entropy subsystem.

Primary goals:

1. Use cryptography primitives designed and vetted by cryptographers.
2. Be honest about entropy estimation.
3. Propagate full entropy as soon as possible.
4. Simplify the APIs.
5. Reduce overhead of rnd_add_data and cprng_strong.
6. Reduce side channels of HWRNG data and human input sources.
7. Improve visibility of operation with sysctl and event counters.

Caveat: rngtest is no longer used generically for RND_TYPE_RNG
rndsources. Hardware RNG devices should have hardware-specific
health tests. For example, checking for two repeated 256-bit outputs
works to detect AMD's 2019 RDRAND bug. Not all hardware RNGs are
necessarily designed to produce exactly uniform output.

ENTROPY POOL

- A Keccak sponge, with test vectors, replaces the old LFSR/SHA-1
kludge as the cryptographic primitive.

- `Entropy depletion' is available for testing purposes with a sysctl
knob kern.entropy.depletion; otherwise it is disabled, and once the
system reaches full entropy it is assumed to stay there as far as
modern cryptography is concerned.

- No `entropy estimation' based on sample values. Such `entropy
estimation' is a contradiction in terms, dishonest to users, and a
potential source of side channels. It is the responsibility of the
driver author to study the entropy of the process that generates
the samples.

- Per-CPU gathering pools avoid contention on a global queue.

- Entropy is occasionally consolidated into global pool -- as soon as
it's ready, if we've never reached full entropy, and with a rate
limit afterward. Operators can force consolidation now by running
sysctl -w kern.entropy.consolidate=1.

- rndsink(9) API has been replaced by an epoch counter which changes
whenever entropy is consolidated into the global pool.
. Usage: Cache entropy_epoch() when you seed. If entropy_epoch()
has changed when you're about to use whatever you seeded, reseed.
. Epoch is never zero, so initialize cache to 0 if you want to reseed
on first use.
. Epoch is -1 iff we have never reached full entropy -- in other
words, the old rnd_initial_entropy is (entropy_epoch() != -1) --
but it is better if you check for changes rather than for -1, so
that if the system estimated its own entropy incorrectly, entropy
consolidation has the opportunity to prevent future compromise.

- Sysctls and event counters provide operator visibility into what's
happening:
. kern.entropy.needed - bits of entropy short of full entropy
. kern.entropy.pending - bits known to be pending in per-CPU pools,
can be consolidated with sysctl -w kern.entropy.consolidate=1
. kern.entropy.epoch - number of times consolidation has happened,
never 0, and -1 iff we have never reached full entropy

CPRNG_STRONG

- A cprng_strong instance is now a collection of per-CPU NIST
Hash_DRBGs. There are only two in the system: user_cprng for
/dev/urandom and sysctl kern.?random, and kern_cprng for kernel
users which may need to operate in interrupt context up to IPL_VM.

(Calling cprng_strong in interrupt context does not strike me as a
particularly good idea, so I added an event counter to see whether
anything actually does.)

- Event counters provide operator visibility into when reseeding
happens.

INTEL RDRAND/RDSEED, VIA C3 RNG (CPU_RNG)

- Unwired for now; will be rewired in a subsequent commit.

install rw_lock_op link too.

Document percpu_foreach_xcall().

New function percpu_create.

Associates a constructor and destructor with the percpu. Currently
the constructor runs immediately, but in principle we could use the
same API for future CPU hotplug support.

This lets you sleep for allocation or draining users before
deallocation when setting up or tearing down a percpu -- currently we
have many abuses of percpu_foreach in tree for that purpose.

Proposed on tech-kern:
https://mail-index.NetBSD.org/tech-kern/2020/01/30/msg026036.html

Remove FDDI support.

Missed a spot: delete mb.9 from MLINKS too.

New atomic load/store operations for the kernel.

Guarantee no fusing and no tearing, and can optionally impose
ordering relative to other memory operations.

Unordered:
- atomic_load_relaxed
- atomic_store_relaxed

Ordered:
- atomic_load_acquire
- atomic_load_consume
- atomic_store_release

These are intended to match C11 semantics, and can be defined in
terms of the C11 atomic API when ready.

Nix obsolete mb(9) man page.

Describe roundup2(9) in roundup(9).
Bump date.

Install it also as roundup2(9).

Install thmap(9) man page.

oops. i must have deleted the 'u' in 'ustore.9' when partially
fixing the alphabeta ordering here. fixes build.

usbnet may be stable now. document it.

branches: 1.437.2;
Update manpages respond to isaki-audio2 branch.

Overhaul the API used to fetch and store individual memory cells in
userspace. The old fetch(9) and store(9) APIs (fubyte(), fuword(),
subyte(), suword(), etc.) are retired and replaced with new ufetch(9)
and ustore(9) APIs that can return proper error codes, etc. and are
implemented consistently across all platforms. The interrupt-safe
variants are no longer supported (and several of the existing attempts
at fuswintr(), etc. were buggy and not actually interrupt-safe).

Also augmement the ucas(9) API, making it consistently available on
all plaforms, supporting uniprocessor and multiprocessor systems, even
those that do not have CAS or LL/SC primitives.

Welcome to NetBSD 8.99.37.

Install spi.9 and friends.

Add threadpool(9), an abstraction that provides shared pools of kernel
threads running at specific priorities, with support for unbound pools
and per-cpu pools.

Written by riastradh@, and based on the May 2014 draft, with a few changes
by me:
- Working on the assumption that a relative few priorities will actually
be used, reduce the memory footprint by using linked lists, rather than
2 large (and mostly empty) tables. The performance impact is essentially
nil, since these lists are consulted only when pools are created (and
destroyed, for DIAGNOSTIC checks), and the lists will have at most 225
entries.
- Make threadpool job object, which the caller must allocate storage for,
really opaque.
- Use typedefs for the threadpool types, to reduce the verbosity of the
API somewhat.
- Fix a bunch of pool / worker thread / job object lifecycle bugs.

Also include an ATF unit test, written by me, that exercises the basics
of the API by loading a kernel module that exposes several sysctls that
allow the ATF test script to create and destroy threadpools, schedule a
basic job, and verify that it ran.

And thus NetBSD 8.99.29 has arrived.

Update the man page, we don't want M_COPY_PKTHDR, M_MOVE_PKTHDR, MH_ALIGN
and M_ALIGN.

Simplify the mtag API:

- Remove m_tag_init(), m_tag_first(), m_tag_next() and
m_tag_delete_nonpersistent().

- Remove the 't' argument from m_tag_delete_chain().

Bring back three state file system suspension:

NORMAL -> SUSPENDING -> SUSPENDED

and add operation fstrans_start_lazy() that only blocks while SUSPENDED.

Change vndthread() support operation handle_with_rdwr() to bracket
its file system operations by fstrans_start_lazy() and fstrans_done().

PR kern/53624 (dom0 freeze on domU exit)

Link pci_intr_*(9) to pci_intr(9), except for those described in pci_msi(9).

Retire ipkdb entirely. The option was removed from the config files
yesterday.

ok kamil christos

Remove the kernel PMC code. Sent yesterday on tech-kern@.

This change:

* Removes "options PERFCTRS", the associated includes, and the associated
ifdefs. In doing so, it removes several XXXSMPs in the MI code, which is
good.

* Removes the PMC code of ARM XSCALE.

* Removes all the pmc.h files. They were all empty, except for ARM XSCALE.

* Reorders the x86 PMC code not to rely on the legacy pmc.h file. The
definitions are put in sysarch.h.

* Removes the kern/sys_pmc.c file, and along with it, the sys_pmc_control
and sys_pmc_get_info syscalls. They are marked as OBSOL in kern,
netbsd32 and rump.

* Removes the pmc_evid_t and pmc_ctr_t types.

* Removes all the associated man pages. The sets are marked as obsolete.

branches: 1.427.2;
Remove stray space to unbreak build

Finish documenting the new modules(9) interfaces by adding the module
specificdata routines.

Make a first pass at documenting the specificdata functionality.

XXX This is just a first pass, and I've probably made a ton of mistakes
XXX while reading the code! Updates and corrections greatly appreciated.

Also add new entries in the .Nm list, and update Makefile to actually
build the MLINKS

Add man-page links for new module_* accessor functions

Move the audio specification to section 9 under audio_system.

Ok wiz@

Don't mention sprintf and vsprintf, they don't exist in the kernel.
Drop MLINKS, too.

remove ubc_alloc(9) and ubc_release(9) from ubc(9) from the documentation, they
are internal (static) functions

pointed out by Matthew Green in private email

Remove m_getclr. It is unused, confusing (vs m_clget), and is a weak
implementation (eg you can't request a zeroed pkthdr mbuf).

branches: 1.418.2;
document pfil_{add,remove}_ihook, pfil_run_{addr,if}hooks

from ryo shimizu in PR bin/51941

changes by myself: fix mdoc -Tlint, add missing set lists, adjust date
to today, reword history addition.

document kmem_strdupsize/kmem_strdupfree

remove ppi(9) manpage, the actual subsystem got never implemented

PR kern/52665 by Kamil Rytarowski

Add wsbell.

Found by wiz@.

branches: 1.414.2;
Add MLINKS for the functions described in bufq(9)

Missed this during the localcount(9) import:

Add localcount(9) man-page - fix the build

Ooops, localcount.9 was not supposed to be included here!

Update mutex(9) for mutex_ownable()

Make the primary name for this man-page devsw

branches: 1.409.2;
Add new documentation locking(9)

It's a document from June 2015.

DESCRIPTION
The NetBSD kernel provides several synchronization and interrupt control
primitives. This manpage aims at giving an overview of these interfaces
and their proper application. This document includes also basic kernel
thread control primitives and rough overview of the NetBSD kernel design.

Part of interfaces are missing, like new mechanisms for networking SMP,
as this documentation page predates them.

Initial review back in 2015 by Thomas Klausner <wiz>

Add new documentation for klua_mod_register(9) and klua_lock(9)

Lua kernel bindings.

Add MLINKS for extent_alloc1(9) and extent_alloc_subregion1(9).

Oooppsss - the MLINK for splbio.9 was already present!

Document splbio() as a deprecated synonym for splvm().

Document ubc_zerorange(9). Add it (and ubc_purge(9)) to the MLINKS

PR misc/52058: replace all proc_trampoline with lwp_trampoline belatedly.

Add links for kmem_intr_alloc.9, kmem_intr_free.9 and kmem_intr_zalloc.9.

branches: 1.401.2;
Add entries of pmap(9) functions

Rename vget() to vcache_vget() and vcache_tryvget() respectively and
move the definitions to sys/vnode_impl.h.

No functional change intended.

Welcome to 7.99.54

Add the uvm_hotplug.9 manpage to the build tree.

Provide a man page for the disk driver subroutines (dksubr).

Remove now obsolete operation vcache_remove().

Welcome to 7.99.36

branches: 1.396.2;
fix missing mans about pci.9 and pci_intr.9

- add links from pci.9 and pci_intr.9 to pci_msi.9
- add pci_intr_establish_xname entries
- add pci_intr_setattr entries
- add pci_intr_type descriptions
- fix pci_*_alloc functions' argument type

pointed out by nonaka@n.o.

Add passive references, intermediate between pserialize and refcount.

Discussed on tech-kern:

https://mail-index.netbsd.org/tech-kern/2016/01/24/msg020069.html

API is still experimental and likely to change. (Obvious changes:
either remove extra arguments everywhere, or shrink psref_target to a
single bit, at the expense of possibly valuable diagnostic checks.)
Should do some real testing before we use this in anger!

Introduce pserialize-safe linked lists.

These are like LIST_* from queue(3), but issue the appropriate memory
barriers for pserialize readers and writers.

Discussed on tech-kern:

https://mail-index.netbsd.org/tech-kern/2016/04/03/msg020365.html

add documentation on "options KERNHIST".

PCI Extended Configuration stuff written by nonaka@:
- Add PCI Extended Configuration Space support into x86.
- Check register offset of pci_conf_read() in MD part. It returns (pcireg_t)-1
if it isn't accessible.
- Decode Extended Capability in PCI Extended Configuration Space.
Currently the following extended capabilities are decoded:
- Advanced Error Reporting
- Virtual Channel
- Device Serial Number
- Power Budgeting
- Root Complex Link Declaration
- Root Complex Event Collector Association
- Access Control Services
- Alternative Routing-ID Interpretation
- Address Translation Services
- Single Root IO Virtualization
- Page Request
- TPH Requester
- Latency Tolerance Reporting
- Secondary PCI Express
- Process Address Space ID
- LN Requester
- L1 PM Substates
The following extended capabilities are not decoded yet:
- Root Complex Internal Link Control
- Multi-Function Virtual Channel
- RCRB Header
- Vendor Unique
- Configuration Access Correction
- Multiple Root IO Virtualization
- Multicast
- Resizable BAR
- Dynamic Power Allocation
- Protocol Multiplexing
- Downstream Port Containment
- Precision Time Management
- M-PCIe
- Function Reading Status Queueing
- Readiness Time Reporting
- Designated Vendor-Specific

Add man about kernel APIs to support intrctl(8).

Add pci_get_ht_capability(9) man.

add pci_intr_alloc() man

Operations getnewvnode() and ungetnewvnode() have been replaced with vcache.
- Remove now obsolete functions getnewvnode() and ungetnewvnode().
- Document vcache operations.

Welcome to 7.99.20

Add new man page for devsw_attach() and friends.

From Kamil Ritarowski with some editting by myself.

add x86 MD MSI/MSI-X support code.

add pci_intr_distribute(9) for x86.

Remove the unused and all-but-unusable kthread_destroy(). Also makes
it more obvious that the opposite of kthread_create() is kthread_exit().

Remove obsolete cprng_strong_getflags/setflags(9) man page links.

XXX pullup-7

Hook bufferio(9) man page into the build.

Remove separate getiobuf(9) man page, subsumed by bufferio(9).

Hook up the new wapbl(9) man page.

Cleanup:
- remove struct kmembuckets (dead)
- correctly deadify MALLOC_XX
- remove MALLOC_DEFINE_LIMIT and MALLOC_JUSTDEFINE_LIMIT (dead)
- remove malloc_roundup(), malloc_type_setlimit(), MALLOC_DEFINE_LIMIT()
and MALLOC_JUSTDEFINE_LIMIT() from man 9 malloc

Add clock(9) from Kamil Rytarowski.

branches: 1.378.2;
MI IPI interface:
- Implement support for the asynchronous IPI calls.
- Rework synchronous IPI code to reuse the asynchronous mechanism.
- Add ipi(9) manual page; needs wizd(8).

Note: MD code can now provide a low level primitive for the ipi(9) and
reuse this interface instead of open-coding. Portmasters are encouraged
to convert. Ride 6.99.43!

branches: 1.377.2;
- Make VI_XLOCK, VI_CLEAN and VI_LOCKSHARE private to kern/vfs_*.c.
- Make vwait() static.
- Add vdead_check() to check a vnode for being or becoming dead.

Discussed on tech-kern.

Welcome to 6.99.38

Add mtsleep(9) and a description of how it, tsleep(9), and wakeup(9)
should all be replaced with condvar(9).

While here clear out the lock(9) reference(s) and the obsoleted example.

Based on misc/48671

Operations vmark(), vunmark() and vismarker() have been replaced by
vfs_vnode_iterator_*(), remove them.

Document vfs_vnode_iterator_*().

Make VI_MARKER private to vfs_vnode.c, vfs_mount.c and unfortunately
to ufs/lfs/lfs_segment.c.

Welcome to 6.99.37

G/C npf_ncode(9)

Build orphaned man pages.

add m_copyup(9) obtained from FreeBSD (manual only)

add a man page for ts2timo.

Add more links for kcpuset(9).

Also add links to pcu(9).

Add pcu(9).

branches: 1.367.2;
add rootconf(9) as a link to cpu_rootconf(9)

Document atop(9), ptoa(9), round_page(9) and trunc_page(9).

document a large chunk of the USB interface. some of this is kind of
generic and depends upon understanding USB itself (and since i don't
really that well, i might have gotten some wrong.)

Replace the remaining KAUTH_GENERIC_ISSUSER authorization calls with
something meaningful. All relevant documentation has been updated or
written.

Most of these changes were brought up in the following messages:

http://mail-index.netbsd.org/tech-kern/2012/01/18/msg012490.html
http://mail-index.netbsd.org/tech-kern/2012/01/19/msg012502.html
http://mail-index.netbsd.org/tech-kern/2012/02/17/msg012728.html

Thanks to christos, manu, njoly, and jmmv for input.

Huge thanks to pgoyette for spinning these changes through some build
cycles and ATF.

document config_detach_children(9)

branches: 1.362.2;
Improvements in secmodel(9). Document secmodel_register(9), _deregister(9)
and _eval(9).

Add secmodel_extensions(9), and indicate the new sysctl(7) to let
ordinary users control the CPU affinity (user_set_cpu_affinity).

Add (links for) missing "cross-references" from cprng(9). Some of the
functions replaced by cprng were never documented at all.

Add cprng(9) manual page, remove arc4random(9) manual page

pool_cache_sethiwat(9), pool_cache_setlowat(9), pool_cache_sethardlimit(9)

pool_sethardlimit.9 => pool.9

branches: 1.357.2;
document skpc

document scanc

document ucas

Add kcpuset(9). Ok rmind@.

There's no stand alone vpanic.9 man page.

add vpanic

Add a simple cpufreq(9).

This is slightly improved version presented on tech-kern@ with proper
locking and few additional functions, mainly required for ioctl(9)/cpuctl(8).

Document new *ASSERTMSG() prototype, and update KASSERT(9).

See also
http://mail-index.netbsd.org/tech-kern/2011/09/07/msg011427.html

Add pserialize(9) manual page.

Sync (mostly, not fully) uvm_km(9) and uvm_map(9) man pages with reality.

branches: 1.347.2;
Split parts of uvm(9) into uvm_km(9) and uvm_map(9) man pages.

OK mrg@

Note also KASSERTMSG(). Small markup changes.

Import the Flash and NAND subsytem code contributed by the University
of Szeged, Hungary.

The commit includes:
- Flash layer, which gives a common API to access flash devices
- NAND controller subsystem for the flash layer
- An example OMAP driver which is used on BeagleBoard or alike ARM boards

Link kprintf(9) to device_printf(9). For David.

branches: 1.343.2;
Introduce struct pathbuf. This is an abstraction to hold a pathname
and the metadata required to interpret it. Callers of namei must now
create a pathbuf and pass it to NDINIT (instead of a string and a
uio_seg), then destroy the pathbuf after the namei session is
complete.

Update all namei call sites accordingly. Add a pathbuf(9) man page and
update namei(9).

The pathbuf interface also now appears in a couple of related
additional places that were passing string/uio_seg pairs that were
later fed into NDINIT. Update other call sites accordingly.

Import NPF - a packet filter. Some features:

- Designed to be fully MP-safe and highly efficient.

- Tables/IP sets (hash or red-black tree) for high performance lookups.

- Stateful filtering and Network Address Port Translation (NAPT).
Framework for application level gateways (ALGs).

- Packet inspection engine called n-code processor - inspired by BPF -
supporting generic RISC-like and specific CISC-like instructions for
common patterns (e.g. IPv4 address matching). See npf_ncode(9) manual.

- Convenient userland utility npfctl(8) with npf.conf(8).

NOTE: This is not yet a fully capable alternative to PF or IPFilter.
Further work (support for binat/rdr, return-rst/return-icmp, common ALGs,
state saving/restoring, logging, etc) is in progress.

Thanks a lot to Matt Thomas for various useful comments and code review.
Aye by: board@

Add x86_msr_xcall(9).

Add documentation for the various module system initialization routines.

Add documentation for module_find_section()

Make a first pass at documenting the module(9) subsystem.

XXX This is by no means complete, but it is a beginning.

Document the stack macros from <sys/param.h>.

Document the fine nullop() family of dummy functions.

Briefly document proc_find() and pgrp_find().

Add config_mountroot(9) in autoconf(9) man page and LINKS for it.

Remove the concept of recursive vnode locks by eliminating
vn_setrecurse(), vn_restorerecurse() and LK_CANRECURSE.
Welcome to 5.99.31

Discussed on tech-kern.

Briefly document the bintime_add() family of static inline functions.

Hook kthread_join(9) to the build.

Remove gsignal(9) and kgsignal(). Add links for kpgsignal(9) and kpsignal(9).

branches: 1.329.2;
Remove sched_psignal(9) and sigmasked(9). From Tetsuya Isaki in PR #40125.

Add a link, bus_space_is_equal.9 -> bus_space.9.

cpu_swapout(9) is no more.

Document the ctod-family of macros from <sys/param.h>.

XXX: Someone may want to check if there is anything to add or correct.

As the cited setroot(9) was nonexistent, briefly document it here.

Briefly note also curlwp.

In addition to 'hz', document also 'tick', 'tickadj', 'stathz', and 'profhz'.

The idea comes from OpenBSD, but this was written largely based on the
comments in kern_clock.c. XXX: schedhz?

Document p_find(), pfind(), pg_find(), and pgfind().

XXX: Needs a quick proofread.

Document the questionable ISSET/SET/CLR macros.

Since someone (hi ahoka) added a reference to non-existant sched_m2(9),
add at least a stub now.

Document the counting and rounding macros from <sys/param.h>.

Document the bitmap related macros in <sys/param.h>.

In addition to mstohz(9), document also hztoms.

Fix a typo in the MLINKS line for kmem.9.

Hook kmem_asprintf and vrele_async manpages to the build.

Move MD spllower(9) and splraise(9) doco from the MI spl(9) to an i386
manual page.

Document also the sysmon power switches; sysmon_pswitch(9).

Build links for rest of the sysmon_taskq(9) functions.

Add a simple manual page for the simple sysmon task queue.

ok wiz@

Add CTASSERT(9). From FreeBSD.

ok @wiz

Remove xc_init_cpu(), percpu_init(), percpu_init_cpu() - they are part
of implementation, not public API. OK dyoung@.

Rename xc(9) to xcall(9). OK dyoung@.

Install manual pages for cross-calls and per-CPU storage.

add short description for bpf.9

Update PMF documentation: rename pmf_device_resume_subtree to
pmf_device_subtree_resume. Briefly describe pmf_qual_t and add it to
the PMF function signatures.

There's still a lot left to document.

Remove MKLINKS for VATTR_NULL, so that the obsolete lists don't
have to do the work every build.

Undocument checkalias() -- it was removed two years ago.

vcount() was removed

Remove documentation for removed macros.

Install pcq.9 and links. Update set list accordingly.

remove cv_wakeup.9 (it wasn't documented, just linked)

Describe spllower(9) and splraise(9).

Document the device iteration routines.

I derived this manual page from pmf(9), hence my retention of Jared's
copyright notice.

Remove pool_cache_invalidate_local(9) from the sets, and mark the
entries as obsolete.

Noted by haad@. Thanks!

Add pool_cache_invalidate_local() to the pool_cache(9) API, to permit
per-CPU objects invalidation when cached in the pool cache.

See http://mail-index.netbsd.org/tech-kern/2009/10/05/msg006206.html .

Reviewed by bouyer@. Thanks!

Add callback(9) man page. Reviewed and improved by <wiz>, thanks!

First part of secmodel cleanup and other misc. changes:

- Separate the suser part of the bsd44 secmodel into its own secmodel
and directory, pending even more cleanups. For revision history
purposes, the original location of the files was

src/sys/secmodel/bsd44/secmodel_bsd44_suser.c
src/sys/secmodel/bsd44/suser.h

- Add a man-page for secmodel_suser(9) and update the one for
secmodel_bsd44(9).

- Add a "secmodel" module class and use it. Userland program and
documentation updated.

- Manage secmodel count (nsecmodels) through the module framework.
This eliminates the need for secmodel_{,de}register() calls in
secmodel code.

- Prepare for secmodel modularization by adding relevant module bits.
The secmodels don't allow auto unload. The bsd44 secmodel depends
on the suser and securelevel secmodels. The overlay secmodel depends
on the bsd44 secmodel. As the module class is only cosmetic, and to
prevent ambiguity, the bsd44 and overlay secmodels are prefixed with
"secmodel_".

- Adapt the overlay secmodel to recent changes (mainly vnode scope).

- Stop using link-sets for the sysctl node(s) creation.

- Keep sysctl variables under nodes of their relevant secmodels. In
other words, don't create duplicates for the suser/securelevel
secmodels under the bsd44 secmodel, as the latter is merely used
for "grouping".

- For the suser and securelevel secmodels, "advertise presence" in
relevant sysctl nodes (sysctl.security.models.{suser,securelevel}).

- Get rid of the LKM preprocessor stuff.

- As secmodels are now modules, there's no need for an explicit call
to secmodel_start(); it's handled by the module framework. That
said, the module framework was adjusted to properly load secmodels
early during system startup.

- Adapt rump to changes: Instead of using empty stubs for securelevel,
simply use the suser secmodel. Also replace secmodel_start() with a
call to secmodel_suser_start().

- 5.99.20.

Testing was done on i386 ("release" build). Spearated module_init()
changes were tested on sparc and sparc64 as well by martin@ (thanks!).

Mailing list reference:

http://mail-index.netbsd.org/tech-kern/2009/09/25/msg006135.html

Don't install config_activate links such as config_activate.9 ->
autoconf.9. In the set list, mark the config_activate links
obsolete.

Sort bzero to the correct position

The man page should be BOOT_FLAG.9, not BOOT_FLAGS.9.
I am not marking the incorrect name as "obsolete" in the set lists
because it's been less than 12 hours. If you have already installed the
incorrectly named file, you will have to delete it manually.

Add a boothowto(9) man page, and link it to BOOT_FLAGS(9).

Merge vmem_alloc(9) & friends (it's a whole company) into a single vmem(9).

Merge workqueue_create(9), workqueue_destroy(9) and workqueue_enqueue(9)
into a single workqueue(9) man page.

I guess ubc(9) should be used for all ubc_*(9) man pages, not only for
some. Make it so.

Unify kmem_alloc/zalloc/free under kmem(9). Links preserved.

Split descriptions of UBC functions from uvm(9) into separate ubc(9) man page.

add mlinks for iic manpages

Install disk_begindetach.9 links.

Add MLINKS for pmf(9) functions.

Install a link from vfs_mountalloc.9 to vfssubr.9.

+ callout_halt

Add byteorder(9) man page which describes htole32() etc. From FreeBSD
via PR misc/40770, with some tweaks by me.

branches: 1.277.2;
config_found_sm(9) -> config_found_sm_loc(9)

Add missing callout_* links and order the callout_* links as per the
manual page.

kill bitmask_snprintf

Replace timecounter(9) man page with OpenBSD's tc_init(9)
since the previous one was derived from FreeBSD's time(9)
which was based on NetBSD's time_second(9), and
it didn't mention the timecounter framework itself.

Add tvtohz(9) man page, which is Xref'ed from microtime(9) and microuptime(9),
from FreeBSD.

Merge description about bintime(9), getbintime(9), getmicrotime(9),
nanotime(9), and getnanotime(9) from FreeBSD's microtime(9) man page,
and add appropriate MLINKS.

Add MLINKS to binuptime(9), getbinuptime(9), getmicrouptime(9), nanouptime(9),
and getnanouptime(9) from microuptime(9).

branches: 1.270.2;
Add MLINKS for all the routines that cnmagic.9 documents. Without this,
"apropos magic" indicates that cn_trap(9) and friends have man pages, but
"man cn_trap" thinks otherwise.

Add video(4) and video(9) man pages.

Add man page links from ttyldisc_{add,lookup,remove} to linedisc

Manual pages for accept_filters(9), from FreeBSD. Also, document syntax we
added in NetBSD for specifying accept filters in inetd.conf.

there was a backslash too much

add man page for sockopt(9)

branches: 1.264.2;
update to match with the recent reality.

document kpreempt_disable, kpreempt_enable, and kpreempt_disabled.

update disk.9 manpage to current reality
- add disk_init() (from vmlocking merge)
- add disk_destroy() (from vmlocking merge)
- remove disk_resetstat() (was removed)
- update structure defs
- update examples (ANSI, const, device_t etc)

branches: 1.261.2; 1.261.4;
Add MLINKS for the sysmon_envsys_* functions.

update after yamt-lazymbuf merge.

Rename selrecord(9) man page to select(9). Sync selnotify() with reality,
remove selwakeup(), add and explain the usage of selinit() and seldestroy().

Reviewed by <ad>.

branches: 1.258.4;
Add power management framework man page.

document LWP_CACHE_CREDS.

Add links for softint_*

+ mutex_spin_enter, mutex_spin_exit

+splsoftbio(9)

Make securelevel a "secmodel" of its own.

While it's true that it's part of the traditional 4.4BSD security model,
there may come a time where a different "primary" security model used for
fine-grained privileges (ie., splitting root's responsibilities to various
privileges that can be assigned) may want to still have a securelevel
setting.

Idea from Daniel Carosone:

http://mail-index.netbsd.org/tech-security/2006/08/25/0001.html

The location of the removed files, for reference, was:

src/secmodel/bsd44/secmodel_bsd44_securelevel.c
src/secmodel/bsd44/securelevel.h

Short description of putter(9)

- uvn_attach.9
+ ubc_uiomove.9

Update the file system copy-on-write handler.

- Instead of hooking the handler on the specdev of a mounted file system
hook directly on the `struct mount'.

- Rename from `vn_cow_*' to `fscow_*' and move to `kern/vfs_trans.c'. Use
`mount_*specific' instead of clobbering `struct mount' or `struct specinfo'.

- Replace the hand-made reader/writer lock with a krwlock.

- Keep `vn_cow_*' functions and mark as obsolete.

- Welcome to NetBSD 4.99.32 - `struct specinfo' changed size.

Reviewed by: Jason Thorpe <thorpej@netbsd.org>

Document aprint*_dev and aprint*_ifnet. Requested by joerg@

branches: 1.248.4; 1.248.6;
Fix a glitch in previous commit:
s/mi_switch 9/mi_switch.9/

Reported by Paul Goyette.

Remove obsolete content about cpu_switchto() from ctxsw(9) and rename
it to mi_switch(9).

Suggested by yamt@

document kpause. largely copied from condvar.9.

setrunqueue is no more

Remove obsolete SCHED_LOCK(9), which is gone.

ok by <ad>

Move scheduler(9) to sched_4bsd(9) and sync its contents with reality. Also
add a reference to McKusick et. al., which still contains the best in-depth
description of the 4.4BSD scheduler.

Remove obsolete setrunqueue(9) manpage.

ok by <ad>.

Add initial manpage for the "new" scheduler API.

Note: More content will follow, to this manpage as well as the NetBSD
Internals book.

Ok by <ad>

Update mlinks for callout/kthread changes.

- kcont was removed.
- Replace some references to tsleep.

update and document yield().

Imported envsys 2, a brief description of the new features:
(Part 4: documentation and configuration files)

* Support for detachable sensors.
* Cleaned up the API for simplicity and efficiency.
* Ability to send capacity/critical/warning events to powerd(8).
* Adapted all the code to the new locking order.
* Compatibility with the old envsys API: the ENVSYS_GTREINFO
and ENVSYS_GTREDATA ioctl(2)s are supported.
* Added support for a 'dictionary based communication channel' between
sysmon_power(9) and powerd(8), that means there is no 32 bytes event
size restriction anymore.
* Binary compatibility with old envstat(8) and powerd(8) via COMPAT_40.
* All drivers with the n^2 gtredata bug were fixed, PR kern/36226.

Tested by:

blymn: smsc(4).
bouyer: ipmi(4), mfi(4).
kefren: ug(4).
njoly: viaenv(4), adt7463.c.
riz: owtemp(4).
xtraeme: acpiacad(4), acpibat(4), acpitz(4), aiboost(4), it(4), lm(4).

obsolete mi_switch.9 and cpu_switch.9 MLINKS. pointed by Blair Sadewitz.

add cpu_idle.9.

update after yamt-idlelwp merge.
- remove cpu_exit.9.
- remove ctxsw.9 from makefile because it's too stale.
XXX maybe it will revive as mi_switch.9 later.
- add cpu_switchto.9 to makefile.

document bus_dmatag_subregion(9) and bus_dmatag_destroy(9).

need_resched -> cpu_need_resched.

remove cpu_idle.9. it has not been available on trunk.

Make fstrans(9) the default helper for file system suspension.
Replaces the now obsolete vn_start_write()/vn_finished_write().

Remove entries for rw_owned(9) again. The set lists were incorrect,
not this "Makefile".

Create symbolic links for rw_owned(9).

Sort some entries.

Fix up MLINKS for previous. From nick@.

Add mb/rwlock/condvar/mutex section 9 manual pages.

Add and update documentation for fstrans(9) file system suspension helper.

wiz?

Add a memoryallocators(9) man-page to give a short summary of memory
allocators available in the kernel.

Tons of input from YAMAMOTO Takashi, thanks!

document splraiseipl and makeiplcookie.

Add a source-address selection policy mechanism to the kernel.

Also, add ioctls SIOCGIFADDRPREF/SIOCSIFADDRPREF to get/set preference
numbers for addresses. Make ifconfig(8) set/display preference
numbers.

To activate source-address selection policies in your kernel, add
'options IPSELSRC' to your kernel configuration.

Miscellaneous changes in support of source-address selection:

1 Factor out some common code, producing rt_replace_ifa().

2 Abbreviate a for-loop with TAILQ_FOREACH().

3 Add the predicates on IPv4 addresses IN_LINKLOCAL() and
IN_PRIVATE(), that are true for link-local unicast
(169.254/16) and RFC1918 private addresses, respectively.
Add the predicate IN_ANY_LOCAL() that is true for link-local
unicast and multicast.

4 Add IPv4-specific interface attach/detach routines,
in_domifattach and in_domifdetach, which build #ifdef
IPSELSRC.

See in_getifa(9) for a more thorough description of source-address
selection policy.

document vmem_xalloc/xfree.

document vmem.

Modular (I tried ;-) TCP congestion control API. Whenever certain conditions
happen in the TCP stack, this interface calls the specified callback to
handle the situation according to the currently selected congestion
control algorithm.
A new sysctl node was created: net.inet.tcp.congctl.{available,selected}
with obvious meanings.
The old net.inet.tcp.newreno MIB was removed.
The API is discussed in tcp_congctl(9).

In the near future, it will be possible to selected a congestion control
algorithm on a per-socket basis.

Discussed on tech-net and reviewed by <yamt>.

Synchronise documentation with code. E.g., config_search is no more, but
instead you have config_search_{loc,ia}. Add documentation for
config_finalize_regsiter, too. Mostly fixes PR#32106 by Gavan Fantom, as I
think the cfdriver_* and cfattach_* stuff should be documented too, but I'm
not entirely sure where yet.

fix slight ooops in previous

and lo, the uvm_coredump() peril was no more (since almost 5 years ago)

Make links from ieee80211(9) to pages for all included functions.

add workqueue_destroy.

Add a man-page for secmodel_overlay(9).

Add a man-page for secmodel_bsd44, describing a bit the concepts of
super-user and securelevel.

The securelevel part was compiled of text from both init(8) and OpenBSD's
securelevel(7), and brought in-sync with what we really do.

First take at security model abstraction.

- Add a few scopes to the kernel: system, network, and machdep.

- Add a few more actions/sub-actions (requests), and start using them as
opposed to the KAUTH_GENERIC_ISSUSER place-holders.

- Introduce a basic set of listeners that implement our "traditional"
security model, called "bsd44". This is the default (and only) model we
have at the moment.

- Update all relevant documentation.

- Add some code and docs to help folks who want to actually use this stuff:

* There's a sample overlay model, sitting on-top of "bsd44", for
fast experimenting with tweaking just a subset of an existing model.

This is pretty cool because it's *really* straightforward to do stuff
you had to use ugly hacks for until now...

* And of course, documentation describing how to do the above for quick
reference, including code samples.

All of these changes were tested for regressions using a Python-based
testsuite that will be (I hope) available soon via pkgsrc. Information
about the tests, and how to write new ones, can be found on:

http://kauth.linbsd.org/kauthwiki

NOTE FOR DEVELOPERS: *PLEASE* don't add any code that does any of the
following:

- Uses a KAUTH_GENERIC_ISSUSER kauth(9) request,
- Checks 'securelevel' directly,
- Checks a uid/gid directly.

(or if you feel you have to, contact me first)

This is still work in progress; It's far from being done, but now it'll
be a lot easier.

Relevant mailing list threads:

http://mail-index.netbsd.org/tech-security/2006/01/25/0011.html
http://mail-index.netbsd.org/tech-security/2006/03/24/0001.html
http://mail-index.netbsd.org/tech-security/2006/04/18/0000.html
http://mail-index.netbsd.org/tech-security/2006/05/15/0000.html
http://mail-index.netbsd.org/tech-security/2006/08/01/0000.html
http://mail-index.netbsd.org/tech-security/2006/08/25/0000.html

Many thanks to YAMAMOTO Takashi, Matt Thomas, and Christos Zoulas for help
stablizing kauth(9).

Full credit for the regression tests, making sure these changes didn't break
anything, goes to Matt Fleming and Jaime Fournier.

Happy birthday Randi! :)

Fix todr(9) MLINKS line.

time.9 renamed to time_second.9. various updates to reflect API changes.

man pages contributed by Igor Sobrado.

first take at veriexec(9) man page, finally documenting some more
internals.

okay, since there was no way to divide this to two commits, here it goes..

introduce fileassoc(9), a kernel interface for associating meta-data with
files using in-kernel memory. this is very similar to what we had in
veriexec till now, only abstracted so it can be used more easily by more
consumers.

this also prompted the redesign of the interface, making it work on vnodes
and mounts and not directly on devices and inodes. internally, we still
use file-id but that's gonna change soon... the interface will remain
consistent.

as a result, veriexec went under some heavy changes to conform to the new
interface. since we no longer use device numbers to identify file-systems,
the veriexec sysctl stuff changed too: kern.veriexec.count.dev_N is now
kern.veriexec.tableN.* where 'N' is NOT the device number but rather a
way to distinguish several mounts.

also worth noting is the plugging of unmount/delete operations
wrt/fileassoc and veriexec.

tons of input from yamt@, wrstuden@, martin@, and christos@.

Some section 9 man page edits:
- Update ctxsw(9) to reflect reality a little better
- chooselwp doesn't exist in the kernel so remove the man page.
- Remove the references to chooseproc which existed briefly.

document kmem_alloc, kmem_free, kmem_zalloc.

add microuptime.9 (from FreeBSD) for timecounters

include timecounter.9 description

Initial import of bluetooth stack on behalf of Iain Hibbert. (plunky@,
NetBSD Foundation Membership still pending.) This stack was written by
Iain under sponsorship from Itronix Inc.

The stack includes support for rfcomm networking (networking via your
bluetooth enabled cell phone), hid devices (keyboards/mice), and headsets.

Drivers for both PCMCIA and USB bluetooth controllers are included.

Document kernel function hashinit/hashdone.

"No[ objections] here." -christos@

branches: 1.198.2;
kill unused man-pages. prompted by Iain Hibbert.

add kauth man-page.

G/c properties(9) and links. They are marked as obsolete in the sets
already.

Add preliminary documentation for DDC and EDID subsystem.

branches: 1.194.2;
Document libkern's bcdtobin(9)/bintobcd(9).

fdavail is a goner

document fdclone

add vcons.9

Implement options string parsing of the form 'a=b c=d ...'. This will be
initially used by i386's Multiboot support but will be useful in other
situations too (think refactoring mount(2)'s API).

Add a firmload(9) manual page.

add getiobuf.9

Manpage that explains the i2c framework... from OpenBSD.

Update man pages for new coredump interface.

Fix links for cpu_lwp_fork.9. Pointed out by ghen@ and salo@.

Adapt man pages to ktrace-lwp.

document workqueue.

document RUN_ONCE.

sync with kernel. (yamt-vop)

Remove MLINKS leftover from previous.

we don't have the global runtime anymore.

Kill the tmpfs(9) manual page; it was just documenting internal details of
tmpfs' "API" and was already rotting.

Instead, merge all the relevant comments into the code. This includes
acknowledgements to Google's Summer of Code 2005 program (they were in the
AUTHORS section of tmpfs(9) before), so all the files need to be changed
to include this sentence alongside the title. (Note that this was not a
requirement of the program.)

Apply the NFS exports list rototill patch:

- Remove all NFS related stuff from file system specific code.
- Drop the vfs_checkexp hook and generalize it in the new nfs_check_export
function, thus removing redundancy from all file systems.
- Move all NFS export-related stuff from kern/vfs_subr.c to the new
file sys/nfs/nfs_export.c. The former was becoming large and its code
is always compiled, regardless of the build options. Using the latter,
the code is only compiled in when NFSSERVER is enabled. While doing this,
also make some functions in nfs_subs.c conditional to NFSSERVER.
- Add a new command in nfssvc(2), called NFSSVC_SETEXPORTSLIST, that takes a
path and a set of export entries. At the moment it can only clear the
exports list or append entries, one by one, but it is done in a way that
allows setting the whole set of entries atomically in the future (see the
comment in mountd_set_exports_list or in doc/TODO).
- Change mountd(8) to use the nfssvc(2) system call instead of mount(2) so
that it becomes file system agnostic. In fact, all this whole thing was
done to remove a 'XXX' block from this utility!
- Change the mount*, newfs and fsck* userland utilities to not deal with NFS
exports initialization; done internally by the kernel when initializing
the NFS support for each file system.
- Implement an interface for VFS (called VFS hooks) so that several kernel
subsystems can run arbitrary code upon receipt of specific VFS events.
At the moment, this only provides support for unmount and is used to
destroy NFS exports lists from the file systems being unmounted, though it
has room for extension.

Thanks go to yamt@, chs@, thorpej@, wrstuden@ and others for their comments
and advice in the development of this patch.

Initial addition of tmpfs, an efficient memory file-system. This project
was developed as part of Google's Summer of Code 2005 program. This
change adds the kernel code, the mount_tmpfs utility, a regression test
suite and does all other related changes to integrate these.

The file-system is still *experimental*. Therefore, it is disabled by
default in all kernels. However, as typically done, a commented-out
entry is added in them to ease its setup.

Note that I haven't commited the required mountd(8) changes to be able
to export tmpfs file-systems because NFS support is still very unstable
and because, before enabling it, I'd like to do some other changes.

OK'ed by my project mentor, William Studenmund (wrstuden@).

Create functions ioctl_copyin() and ioctl_copyout(). They are meant to be
used in ioctl routines to do the right thing when the FKIOCTL flag is
passed to the IOCTL routine indicating its a in-kernel VOP_IOCTL call and
indirect addresses provided in the arguments are to be seen as kernel
adresses rather than userland adresses.

A simple substitution and prepending of the `flags' passed on to the ioctl
handler is enough to DTRT.

document M_MOVE_PKTHDR.

remove disk_init.

statfs -> statvfs
(better late than never)

Add IEEE 802.11 manual pages from FreeBSD to both the Makefiles
and the set lists.

remove links to uvm.9 for removed functions.

branches: 1.169.2;
Document file system extended attribute functions.

document uvm_unmap.

Add a man page that describes the kernel-only errno values that never
get passed back up to userland.

add MLINKS for each mbuf tagging functions.

document mbuf tagging interfaces.

- document m_copyback_cow and m_makewritable.
- note limitations of m_copyback.
- bump date.

Complete removal of uvm_useracc(9), as described in

http://mail-index.netbsd.org/source-changes/2003/11/13/0011.html

Add ffs internal snapshots. Written by Marshall Kirk McKusick for FreeBSD.

- Not enabled by default. Needs kernel option FFS_SNAPSHOT.
- Change parameters of ffs_blkfree.
- Let the copy-on-write functions return an error so spec_strategy
may fail if the copy-on-write fails.
- Change genfs_*lock*() to use vp->v_vnlock instead of &vp->v_lock.
- Add flag B_METAONLY to VOP_BALLOC to return indirect block buffer.
- Add a function ffs_checkfreefile needed for snapshot creation.
- Add special handling of snapshot files:
Snapshots may not be opened for writing and the attributes are read-only.
Use the mtime as the time this snapshot was taken.
Deny mtime updates for snapshot files.
- Add function transferlockers to transfer any waiting processes from
one lock to another.
- Add vfsop VFS_SNAPSHOT to take a snapshot and make it accessible through
a vnode.
- Add snapshot support to ls, fsck_ffs and dump.

Welcome to 2.0F.

Approved by: Jason R. Thorpe <thorpej@netbsd.org>

Add a manual page to section 9 for rssadapt, the rate-adaptation
framework.

branches: 1.160.2;
Add man page for new sysctl_teardown() function.

Add kcont(9) to Makefile, comp set.

The man-page symlink should be pckbport_set_inputhandler, not
pckbport_set_inputhandle -- make it so.

Kernel-internal documentation for pckbport.

- document selnotify.
- add ref. to knote(9).

Add a generic copy-on-write hook to add/remove functions that will be
called with every buffer written through spec_strategy().

Used by fss(4). Future file-system-internal snapshots will need them too.

Welcome to 1.6ZK

Approved by: Jason R. Thorpe <thorpej@netbsd.org>

g/c obsolete cpu_wait(9)
reported in PR misc/24260 by Nicolas Joly

Man page for kernel's sysctl infrastructure. Thanks for being
patient.

Add opencrypto.9 manpage, manpage copied from OpenBSD (Angelos D. Keromytis)
Some text added me (and thus all errors in the manpage are mine)

Garbage collect some references to the old sysctl() infrastructure.

a manpage of selrecord and selwakeup. from FreeBSD.

Add section 9 man pages for:
vfs_write_suspend, vfs_write_resume, vn_start_write and vn_finished_write.

Add a man page for pmatch().

Add do_setres[u,g}id

add manpage for fsetown(9), fgetown(9), fownsignal(9)

Remove link from pool_cache.9 to itself.

Implicit approval by kleink@.

a pool_cache(9) manpage.
maybe incomplete, but better than none.

a man page for buffer cache interfaces.
(an incomplete page is better than no page)

vfs_setpublic.9 -> vfs_setpublicfs.9

Move vfs interface out of vfsops.9 into its own page. Document
it completely.

Minimally document vfs_shutdown(9). XXX: Right man page?

Document pci_vpd_read() and pci_vpd_write().

remove leftover pre-UVM manpages

Oops, forgot to remove links for callout_active and callout_deactivate.

Update for new callout(9) implemenatation.

Update for extensibe malloc types.

s/pfil_get_head/pfil_head_get/

fixes Joel Wilsson's <joelw@unix.se> misc/19796

Document aprint_error(), aprint_get_error_count(), and printf_nolog().

Document the "aprint" autoconfiguration message printing routines.

Add vgonel(), although it is used only once.

More kernel documentation.

link for vn_rdwr()

Move the vnode file descriptor operations into their own file.
Add vn_marktext() and vn_statfile() descriptions.

Document config_match().

bring knote(9) and kfilter_register(9) from kqueue branch to mainline
HISTORY section mentions the interface is only available on experimental
kqueue branch (for now)

Sort man page a bit after last.

Rename sleep.9 to ltsleep.9, since sleep(9) is not there any more.

Document the details of the scheduler.

Documentation for Restartable Atomic Sequences (RAS).

Fix incorret (and obiously untested) symlink targets.

Document new performance monitoring interface.

Document pci_set_powerstate()/pci_get_powerstate().

Manual page for hardware-assisted data mover interface.

* Add copyin_proc() and copyout_proc(), which are like copyin() and
copyout(), except they can operate on any process, not just curproc.
* Use this in uiomove() to allow UIO_USERSPACE to non-curproc.

Add manpage for new device buffer queue interface.
With help from Thomas Klausner <wiz@netbsd.org>.

add missing pfil_head_get in manpage
add missing MLINKS
add new files to sets lists

fixes my own pr kern/15060

simple_lock_unlock -> simple_unlock

Overhaul documentation of the kernel signal facilities. Some text
liberally borrowed from Paul's psignal(9) manpage.

More work can be done here, but there's more here than before, at least.

Document for driver authors.

Add missing bus_space_vaddr(9) link.

add arc4random(9).

Document some mandatory machine-dependent interfaces. Addresses PR16272.

branches: 1.108.2;
Add a man page for mstohz()

Add link for pci_conf_hook().

add MALLOC.9 and FREE.9

add VOP_GETPAGES to NAME and create link

Add radio(4) man pages.

Some basic documentation of uvm_loan() and uvm_unloan()

Link malloc_roundup.9 to the right thing; section 9 links were off by one.

Document malloc_roundup().

add hash(9)

Documentation for itimerfix(9), from Christos Zoulas.

Create a bus_space_mmap(9) link, too.

Document new VEXECMAP vnode flag and rename vn_marktext() to vn_markexec().

s/fnctl/fcntl/

fnctl -> fcntl

Update for new pages and sort.

Build the properties.9 manpage.

Document pci_find_device().

Add hardclock(9). Written by myself, improved via some comments from
Christos (thanks!).

Add hz(9) man page.

Remove trailing whitespace

update uvm.9 links.

add altq(9).

branches: 1.86.2;
add new b*() and mem*() man pages

Basic man page for setrunqueue() and remrunqueue(). Why not? They're easy.

Add some missing documentation.

add m_pulldown.9 to MLINKS.

disk_detach.9, not disk_detatch.9

Document cnbell(), cngetc(), cngetsn(), cnpollc(), cnputc().

Clarify specification of in4_cksum; add description of in_cksum and
in6_cksum as well as makefile goo to install links.

Add in4_cksum

Add pool_init.9

Manual page describing interface between scsipi middle-layer and host bus
adapters.

Install the cnmagic(9) manpage.

Document ltsleep(9). Feel free to improve if you wish.

Add a manual page that describes the pmap(9) API and the requirements
of a pmap module.

Many thanks to Bill Sommerfeld for reviewing the document for me.

Also create splvm(9) link to spl(9)

Make and install pci_configure_bus(9) with a link to pci_conf_interrupt(9)
(called from pci_configure_bus()).
Also make and install pci_intr(9), which seems to have been overlooked in
the Makefile

Add manpage for new line discipline stuff.

document m_dup(9). talk a little bit about issues with shared
external storage (M_EXT).

Add manpage for bitmask_snprintf(9), describe tprintf(9), and simplify
kprintf(9) by removing the now unsupported "extra" printf format strings.

add ppsratecheck(9).

Add man page for a new time-of-day clock driver interface. Also documents the
already existing clock_secs_to_ymdhms() & clock_ymdhms_to_secs().

Back out previous.

uvn_attach.9 -> uvm_attach.9

Fix the broken spinlockmgr.9 link to lock.9

lock(9) manpage. Not much, but it is a start.

branches: 1.62.2;
Implement the more flexiable `evcnt' interface as discussed (briefly) on
tech-kern and now documented in evcnt(9).

documentation of the NetBSD machine-independent software interrupt
framework, dredged out of the January, 1997 tech-kern e-mail archives.

branches: 1.60.2;
Add a man page describing the ucom interface for making tty like USB devices.

add a MLINKS for spllowersoftclock.9

Documentation for new callout interfaces.

add documentation for the ratecheck() function, a new kernel function
(not even committed... docs before changes?! CALL RIPLEY!!!)
which can help programmers implement rate-limited actions.

vslock() is gone in UVM; uvm_vslock() can be found in uvm(9).

Add a skeleton for the usbdi documentation.
This is still very incomplete.

Back out one change that's not ready yet.

Document powerhook functions.

branches: 1.52.4;
add humanize_number(9) / format_bytes(9)

add MLINKS for pool(9).
fix some bugs.

branches: 1.50.2;
Enable ioctl.9.

Document uiomove().

Man page describing the interface between the MI core wdc and its bus
front-ends.

add bioscall(9) for i386

Added microtime.9.

Keep the alphabetical order.

Fix kprintf related Makefile problems.
From John.P.Darrow@wheaton.edu, fixes PR 6091.

Added kprintf.9 and its aliases.

uvm_swapout is a static function, not exported. does not belong in uvm.9

Create a link for uvm_swapout(9).

add uvm.9

rt_timer documentation

remove man9.sun3x from SUBDIR list

add pool.9

Sigh, typo.

oops, forgot a \

Add fork1.9

Added sun3x subdirectory.

add missing .Nm calls and MLINKS. from spz@serpens.swb.de

Add rnd.9

branches: 1.30.2;
Use bsd.man.mk and bsd.subdir.mk as appropriate.

Add manual page containing documentation on mbuf management functions and
macros; contributed by S.P.Zeidler <spz@serpens.swb.de>.

Add audio(9).

Rename busdma -> bus_dma

bus_space_*() function manual page. Written by me (as plain text),
converted to use the doc macros by Christos, then severely cleaned,
hacked, and improved by me.

add busdma(9) and MLINKS for bus_dma* functions

My last commit included SUBDIRS that don't exist yet. Remove them.

Documentation of Ethernet and FDDI driver support functions and macros.

Add intro(9).

Added SUBDIRS= for architecture dependent directories.

Add kernel log() man page. Will add other logging/printing functions soon.

Renamed boot to cpu_reboot

add arpresolve and arpintr descriptions

Pull the ARP support function man page up to the main branch.

add incomplete spl(9); realphabetize Makefile.

branches: 1.15.2;
Fix typo in the last commit.

Document disklabel routines.

Have a shot at `mi_switch()' and `cpu_switch()'.

Install mrg's pfil man page, which he forgot to have installed.

Install extent.9 and symlinks for each of its functions.

add panic(9) man page

Add timeout(9)/untimeout(9)

Add tsleep(9)/sleep(9)/wakeup(9)

Add psignal()/pgsignal()/gsignal()

malloc.9/free.9

Additions: access.9, physio.9, vslock.9

Add fetch(9) and store(9), which describe the {fu,su}{,i}{byte,word}
functions. Cross-reference with each-other and copy(9).

copy(9) manual page: describes the copyin(), copyout(), copystr(),
copyinstr(), and copyoutstr() functions.

Build and install the disk(9) manual page.

Added first section 9 man pages -- initial pages and Makefile from cgd
Section 9 man pages document the internals of the kernel.

New sentence, new line. Fix Dd argument.

add INIT_ONCE(9), FINI_ONCE(9) with changing once_t.

Welcome to 8.99.36

branches: 1.9.6;
Remove workaround for ancient HTML generation code.

Use .Xr for Xrefs.

branches: 1.7.10;
fix example: ONCE_DECL(), not DECL_ONCE()

branches: 1.6.10;
- kcont was removed.
- Replace some references to tsleep.

Be a bit more explicit what happens when init_func fails.
After explanation from yamt@.

Improve English.

sync with kernel.

Grammar fix, HTML quoting, sort SEE ALSO.

document RUN_ONCE.

Remove obsolete SCHED_LOCK(9), which is gone.

ok by <ad>

Use
.In header.h
instead of
.Fd #include \*[Lt]header.h\*[Gt]
Much easier to read and write, and supported by groff for ages.
Okayed by ross.

Begin new sentences on new lines; drop trailing whitespace; some mdoc
and typo fixes.

Correct argument to SCHED_LOCK; drop a trailing whitespace, fix an xref.
Begin a sentence on a new line.

Document the details of the scheduler.

Add missing verb.

Clarify the meaning of this. These macros do not operate on bit numbers
as is implied.. the macros are defined as

#define SET(t, f) ((t) |= (f))
#define ISSET(t, f) ((t) & (f))
#define CLR(t, f) ((t) &= ~(f))

When the rationale is to provide clarity in the source code, then it
is good to have manual pages that are correct.

Fix a prototype.

branches: 1.2.2; 1.2.8; 1.2.14;
Add a BUGS section.

Document the questionable ISSET/SET/CLR macros.

Xref param(3).

branches: 1.1.2;
Document the stack macros from <sys/param.h>.

Sort ERRORS, mark up NULL.

Add new acl vnode op pages

Sort ERRORS, mark up NULL.

Add new acl vnode op pages

Sort ERRORS, mark up NULL.

Add new acl vnode op pages

__cpu_simple_lock(9): Document __SIMPLELOCK_UNLOCKED.

branches: 1.1.4;
__cpu_simple_lock(9): New man page.

This doesn't mean you should use it! Mostly it's to document the
semantics to help understand existing uses, which should not
proliferate, and audit definitions.

New sentence, new line. Add RCS Id. Punctuation.

Tweak markup.

Fix preamble to match order set out by mdoc(7). Discussed with wiz.

branches: 1.2.2;
Remove LKMs and switch to the module framework, pass 1.

Proposed on tech-kern@.

branches: 1.1.2; 1.1.4;
Manual pages for accept_filters(9), from FreeBSD. Also, document syntax we
added in NetBSD for specifying accept filters in inetd.conf.

remove leftover pre-UVM manpages

branches: 1.10.2;
Fix typo reported in misc/15524.

Drop some .Pps.

Fix typos, punctuation and whitespace.

More .Os cleanups. .Os is defined in the tmac.doc-common file,
so we shouldn't override it with versions in the manpages. Many more to
come.

Fix formatting errors (bad sentence breaks).

Use size_t to pass the length of the memory region to operate on to chgkprot(),
kernacc(), useracc(), vslock() and vsunlock(); (unsigned) ints are not
adequate on all platforms.

Add David Brownlee's new intro pages, with editing. (PR #534[23])
Also, while here, expand apparently incorrectly .Dd month abbreviations.
(I thought about doing this in tmac/doc-common...heh...that would have
allowed a possible reverse map back to abbreviations.)

add missing .Nm sections

branches: 1.2.2;
Fix tipo inherited from old version of TNF copyright form.
s/REGENTS/FOUNDATION/.

kernacc() & useracc() manual pages.

Remove workaround for ancient HTML generation code.

branches: 1.5.2;
Make ready for HTML output.
Add RCS Id.

Use .Nm.

Fix preamble to match order set out by mdoc(7). Discussed with wiz.

branches: 1.2.2;
mdoc warning fix.

branches: 1.1.2; 1.1.4;
Manual pages for accept_filters(9), from FreeBSD. Also, document syntax we
added in NetBSD for specifying accept filters in inetd.conf.

Remove workaround for ancient HTML generation code.

branches: 1.7.2;
Use .Nm.

New sentence, new line. Add RCS Id. Make HTML-ready.

Clarify accf_http manual page per wiz's request.

Fix preamble to match order set out by mdoc(7). Discussed with wiz.

branches: 1.3.2;
mdoc warning fix.

branches: 1.2.2; 1.2.4;
The pseudo-device is really "accf_http" instead of "accf_data"
Bump date

Sanity-checked by tls@

Manual pages for accept_filters(9), from FreeBSD. Also, document syntax we
added in NetBSD for specifying accept filters in inetd.conf.

branches: 1.2.4;
acct_process(9): fix markup glitches, g/c pasto

Add a man page for acct_process to be referenced from acct.5

put back more links now that we have them.

Sort SEE ALSO, fix punctuation.

Add acl related changes; there is no more vaccess; document the genfs functions
instead.

Add acl(9) from FreeBSD.

Needs work before it should be added to the build.

ifq_drops was changed to use uint64_t.

altq.9: remove CONSTCOND comment from example code

Since 2021-01-31, lint no longer needs CONSTCOND in a do-while loop.

Merge altq(4) HISTORY changes.

Extend HISTORY section to match altq(4)

branches: 1.15.4;
Remove workaround for ancient HTML generation code.

TRUE -> true, FALSE -> false.

Sort SEE ALSO.

Merge the peter-altq branch.

(sync with KAME & add support for using ALTQ with pf(4)).

Use 'pattr' consistently, bump date.

- Correct the IFQ_ENQUEUE macro.
- Fix some internal variable names for some macros.
- A few corrections from the OpenBSD manpage.

Use
.In header.h
instead of
.Fd #include \*[Lt]header.h\*[Gt]
Much easier to read and write, and supported by groff for ages.
Okayed by ross.

Drop trailing spaces.

nroff fixes, from openbsd via kame

Generate <>& symbolically. I'm avoiding .../dist/... directories for now.

fix typo in example code

Boring whitespace fixes.

Grammar, whitespace and typo fixes.

typo fixes, sync with openbsd tree

add altq(9).

Add cprng(9) manual page, remove arc4random(9) manual page

branches: 1.3.46;
u_intN_t -> uintN_t

Use
.In header.h
instead of
.Fd #include \*[Lt]header.h\*[Gt]
Much easier to read and write, and supported by groff for ages.
Okayed by ross.

add arc4random(9).

Update arpresolve arguments

branches: 1.26.18; 1.26.26; 1.26.28;
Sort sections: consistently put CODE REFERENCES directly before SEE ALSO.

branches: 1.25.6; 1.25.12;
Resort sections to canonical order

branches: 1.24.2;
Avoid .br, use .An for authors as suggested by wiz.

branches: 1.23.6;
Convert TNF licenses to new 2 clause variant

branches: 1.22.26; 1.22.28;
Removed accidental repetitious words.

Use
.In header.h
instead of
.Fd #include \*[Lt]header.h\*[Gt]
Much easier to read and write, and supported by groff for ages.
Okayed by ross.

ifattach(9) has been split into *_ifattach().

Generate <>& symbolically. I'm avoiding .../dist/... directories for now.

Fix typos, punctuation and whitespace.

Remove nonexistant references to ifattach(9) and *_ifattach(9),
per PR kern/4901.

More .Os cleanups. .Os is defined in the tmac.doc-common file,
so we shouldn't override it with versions in the manpages. Many more to
come.

Fix formatting errors (bad sentence breaks).

Fix Copyright dates

Assign my files to The NetBSD Foundation, Inc.

Eliminate extra comma in SEE ALSO section

Changed references to filesystem paths to use the mdoc filesystem path
macro (.Pa).

fix .Nx usage (use 1.0 instead of 0.9a, etc), and other minor cleanups

add missing .Nm calls and MLINKS. from spz@serpens.swb.de

branches: 1.8.2;
Add CODE REFERENCES sections. While here, move the fddi_{add,del}multi
description right below the ether_{add,del}multi description.

Make clear which of these functions need to be called by hardware drivers.

add arpresolve and arpintr descriptions

Fix yet another typo.

fix typo

Pull the ARP support function man page up to the main branch.

Pull this to the main branch.

branches: 1.1.2;
file arp.9 was initially added on branch is-newarp.

atomic_loadstore(9): Clarify relation to __HAVE_ATOMIC64_OPS.

PR kern/58340

branches: 1.7.2;
Introduce membar_acquire/release. Deprecate membar_enter/exit.

The names membar_enter/exit were unclear, and the documentation of
membar_enter has disagreed with the implementations on sparc,
powerpc, and even x86(!) for the entire time it has been in NetBSD.

The terms `acquire' and `release' are ubiquitous in the literature
today, and have been adopted in the C and C++ standards to mean
load-before-load/store and load/store-before-store, respectively,
which are exactly the orderings required by acquiring and releasing a
mutex, as well as other useful applications like decrementing a
reference count and then freeing the underlying object if it went to
zero.

Originally I proposed changing one word in the documentation for
membar_enter to make it load-before-load/store instead of
store-before-load/store, i.e., to make it an acquire barrier. I
proposed this on the grounds that

(a) all implementations guarantee load-before-load/store,
(b) some implementations fail to guarantee store-before-load/store,
and
(c) all uses in-tree assume load-before-load/store.

I verified parts (a) and (b) (except, for (a), powerpc didn't even
guarantee load-before-load/store -- isync isn't necessarily enough;
need lwsync in general -- but it _almost_ did, and it certainly didn't
guarantee store-before-load/store).

Part (c) might not be correct, however: under the mistaken assumption
that atomic-r/m/w then membar-w/rw is equivalent to atomic-r/m/w then
membar-r/rw, I only audited the cases of membar_enter that _aren't_
immediately after an atomic-r/m/w. All of those cases assume
load-before-load/store. But my assumption was wrong -- there are
cases of atomic-r/m/w then membar-w/rw that would be broken by
changing to atomic-r/m/w then membar-r/rw:

https://mail-index.netbsd.org/tech-kern/2022/03/29/msg028044.html

Furthermore, the name membar_enter has been adopted in other places
like OpenBSD where it actually does follow the documentation and
guarantee store-before-load/store, even if that order is not useful.
So the name membar_enter currently lives in a bad place where it
means either of two things -- r/rw or w/rw.

With this change, we deprecate membar_enter/exit, introduce
membar_acquire/release as better names for the useful pair (r/rw and
rw/w), and make sure the implementation of membar_enter guarantees
both what was documented _and_ what was implemented, making it an
alias for membar_sync.

While here, rework all of the membar_* definitions and aliases. The
new logic follows a rule to make it easier to audit:

membar_X is defined as an alias for membar_Y iff membar_X is
guaranteed by membar_Y.

The `no stronger than' relation is (the transitive closure of):

- membar_consumer (r/r) is guaranteed by membar_acquire (r/rw)
- membar_producer (w/w) is guaranteed by membar_release (rw/w)
- membar_acquire (r/rw) is guaranteed by membar_sync (rw/rw)
- membar_release (rw/w) is guaranteed by membar_sync (rw/rw)

And, for the deprecated membars:

- membar_enter (whether r/rw, w/rw, or rw/rw) is guaranteed by
membar_sync (rw/rw)
- membar_exit (rw/w) is guaranteed by membar_release (rw/w)

(membar_exit is identical to membar_release, but the name is
deprecated.)

Finally, while here, annotate some of the instructions with their
semantics. For powerpc, leave an essay with citations on the
unfortunate but -- as far as I can tell -- necessary decision to use
lwsync, not isync, for membar_acquire and membar_consumer.

Also add membar(3) and atomic(3) man page links.

atomic_load/store_* appeared in NetBSD 9, not 10.

Pullup preceded release of 9.0.

branches: 1.5.2; 1.5.6;
Simplify markup for inline code to plain .Li in most places.

Use backslashes to protetect embedded spaces in inline code to prevent
filling from stretching them.

Use .Fn and .Fa to refer only to things this manual page documents,
they are not to be used for "a function" or "a function argument" in
general.

In code examples drop the empty line at the beginning of a function
(mandated by the KNF when there are no variables) - it doesn't help
readability here.

Simplify macro usage.