History log of /freebsd-9.3-release/share/man/man9/Makefile
Revision Date Author Comments
(<<< Hide modified files)
(Show modified files >>>)
# 267654 19-Jun-2014 gjb

Copy stable/9 to releng/9.3 as part of the 9.3-RELEASE cycle.

Approved by: re (implicit)
Sponsored by: The FreeBSD Foundation

# 265930 12-May-2014 pluknet

MFC r265285,r265320:

Documented the pget(9) system kernel interface.


# 265300 03-May-2014 bryanv

MFC r260581:

- Add sglist_append_bio(9) to append a struct bio's data to a sglist


# 262064 17-Feb-2014 avg

MFC r258713,262062: add taskqueue_drain_all


# 262021 17-Feb-2014 avg

MFC r252895: Add a man page for the SDT_* macros


# 258146 14-Nov-2013 jhb

MFC 255498:
- Document the UQUAD sysctl variants.
- Clarify that exactly one of the "access" flags is required and
list the optional flags in a separate list. Prefer bundling
CTLFLAG_TUN into the access flag by not documenting it as an
optional flag to set.


# 256001 02-Oct-2013 jhb

MFC 236768,252209,253047:
Several improvements to rmlock(9). Many of these are based on patches
provided by Isilon.
- Add an rm_assert() supporting various lock assertions similar to other
locking primitives. Because rmlocks track readers the assertions are
always fully accurate unlike rw_assert() and sx_assert().
- Flesh out the lock class methods for rmlocks to support sleeping via
condvars and rm_sleep() (but only while holding write locks), rmlock
details in 'show lock' in DDB, and the lc_owner method used by
dtrace.
- Add an internal destroyed cookie so that API functions can assert
that an rmlock is not destroyed.
- Make use of rm_assert() to add various assertions to the API (e.g.
to assert locks are held when an unlock routine is called).
- Give RM_SLEEPABLE locks their own lock class and always use the
rmlock's own lock_object with WITNESS.
- Various updates to the manpage.


# 252487 01-Jul-2013 delphij

MFC r251825,252486:

Remove vfs_mount(9), it have been died since 2004.


# 247344 26-Feb-2013 jhb

MFC 239512:
Add a BUS_CHILD_DELETED() method that a bus can hook to allow it to cleanup
any bus-specific state (such as ivars) when a child device is deleted.


# 237296 20-Jun-2012 brueffer

MFC: r232051

Catch up with r195837 (2.5 years ago) which renamed net_add_domain() to domain_add().


# 237007 13-Jun-2012 pluknet

MFC r234188,r234463,r234465:

- Update the swi_add prototype after struct ithd was split up into
struct intr_event and struct intr_thread. [1]
- Update the rest of struct ithd references.
- net_ih and softclock_ih cookies have gone away.
- Document swi_remove(9).

PR: docs/166864 [1]


# 236683 06-Jun-2012 jhb

MFC 228509,228620,228533:
Add a helper API to allow in-kernel code to map portions of shared memory
objects created by shm_open(2) into the kernel's address space. This
provides a convenient way for creating shared memory buffers between
userland and the kernel without requiring custom character devices.


# 233395 23-Mar-2012 jhb

MFC 232362,232363,232463,232553,232569,232571:
- Sort function prototypes.
- Update the documentation on pci_get/set_powerstate(). These methods are
not ACPI-specific at all, but deal with PCI power states. Also,
pci_set_powerstate() fails with EOPNOTSUPP if a request is made that the
underlying device does not support rather than falling back to somehow
setting D0.
- Document the following routines: pci_alloc_msi(), pci_alloc_msix(),
pci_find_cap(), pci_get_max_read_req(), pci_get_vpd_ident(),
pci_get_vpd_readonly(), pci_msi_count(), pci_msix_count(),
pci_pending_msix(), pci_release_msi(), pci_remap_msix(), and
pci_set_max_read_req().
- Group the functions into five sub-sections: raw configuration access,
locating devices, device information, device configuration, and
message signaled interrupts.
- Discourage use of pci_disable_io() and pci_enable_io() in device drivers.
The PCI bus driver handles this automatically as resources are activated.


# 233379 23-Mar-2012 jhb

MFC 232360:
Add pci_save_state() and pci_restore_state() wrappers around
pci_cfg_save() and pci_cfg_restore() for device drivers to use when
saving and restoring state (e.g. to handle device-specific resets).


# 231292 09-Feb-2012 bapt

MFH r226119: Mention tdsignal(9)

Approved by: des (mentor)


# 231081 06-Feb-2012 brueffer

MFC: r230787

Manpages for the buf_ring and drbr interfaces.


# 230841 31-Jan-2012 glebius

Merge 228500:
More MLINKS for rtalloc.9


# 230012 12-Jan-2012 jhb

MFC 228715:
Add a TASK_INITIALIZER() macro that can be used to statically
initialize a task structure.


# 229314 02-Jan-2012 mav

MFC r228731:
Add eventtimers(9) man page, describing related KPIs.

Sponsored by: iXsystems, Inc.


# 227711 19-Nov-2011 marius

MFC: r227537

As it turns out, r186347 actually is insufficient to avoid the use of the
curthread-accessing part of mtx_{,un}lock(9) when using a r210623-style
curthread implementation on sparc64, crashing the kernel in its early
cycles as PCPU isn't set up, yet (and can't be set up as OFW is one of the
things we need for that, which leads to a chicken-and-egg problem). What
happens is that due to the fact that the idea of r210623 actually is to
allow the compiler to cache invocations of curthread, it factors out
obtaining curthread needed for both mtx_lock(9) and mtx_unlock(9) to
before the branch based on kobj_mutex_inited when compiling the kernel
without the debugging options. So change kobj_class_compile_static(9)
to just never acquire kobj_mtx, effectively restricting it to its
documented use, and add a kobj_init_static(9) for initializing objects
using a class compiled with the former and that also avoids using mutex(9)
(and malloc(9)). Also assert in both of these functions that they are
used in their intended way only.
While at it, inline kobj_register_method() and kobj_unregister_method()
as there wasn't much point for factoring them out in the first place
and so that a reader of the code has to figure out the locking for
fewer functions missing a KOBJ_ASSERT.
Tested on powerpc{,64} by andreast.

Reviewed by: nwhitehorn (earlier version), jhb
Approved by: re (kib)


# 225736 22-Sep-2011 kensmith

Copy head to stable/9 as part of 9.0-RELEASE release cycle.

Approved by: re (implicit)


# 225583 15-Sep-2011 lstewart

Rename the cc.4 and cc.9 modular congestion control related man pages to
mod_cc.4 and mod_cc.9 respectively to avoid any possible confusion with the cc.1
gcc man page. Update references to these man pages where required.

Requested by: Grenville Armitage
Approved by: re (kib)
MFC after: 3 days


# 225419 06-Sep-2011 kib

Document vm_page_aflag_set(9), vm_page_aflag_clear(9) and vm_page_reference(9).
Retire vm_page_flag_set() and vm_page_flag_clear() functions.

Reviewed by: alc
Approved by: re (bz)


# 225220 27-Aug-2011 brueffer

Remove information and MLINK for MULTI_DRIVER_MODULE().
The macro was removed in r121129 almost 8 years ago.

PR: 150244
Submitted by: Gireesh Nagabhushana <dngireesh@avrita.com>
Approved by: re (kib)


# 225181 25-Aug-2011 attilio

Fix an error in the generation of the manpage after r225177.

Sponsored by: Sandvine Incorporated
Submitted by: jkim
Approved by: re (bz)
MFC after: 3 weeks
X-MFC: r225177


# 225177 25-Aug-2011 attilio

Fix a deficiency in the selinfo interface:
If a selinfo object is recorded (via selrecord()) and then it is
quickly destroyed, with the waiters missing the opportunity to awake,
at the next iteration they will find the selinfo object destroyed,
causing a PF#.

That happens because the selinfo interface has no way to drain the
waiters before to destroy the registered selinfo object. Also this
race is quite rare to get in practice, because it would require a
selrecord(), a poll request by another thread and a quick destruction
of the selrecord()'ed selinfo object.

Fix this by adding the seldrain() routine which should be called
before to destroy the selinfo objects (in order to avoid such case),
and fix the present cases where it might have already been called.
Sometimes, the context is safe enough to prevent this type of race,
like it happens in device drivers which installs selinfo objects on
poll callbacks. There, the destruction of the selinfo object happens
at driver detach time, when all the filedescriptors should be already
closed, thus there cannot be a race.
For this case, mfi(4) device driver can be set as an example, as it
implements a full correct logic for preventing this from happening.

Sponsored by: Sandvine Incorporated
Reported by: rstone
Tested by: pluknet
Reviewed by: jhb, kib
Approved by: re (bz)
MFC after: 3 weeks


# 223894 09-Jul-2011 alc

vm_map_clean() was long ago renamed to vm_map_sync(). Also, it no longer
acquires Giant.

MFC after: 1 week


# 223891 09-Jul-2011 alc

Remove manual pages for functions that no longer exist.

MFC after: 1 week


# 223890 09-Jul-2011 kib

Document copyin_nofault, copyout_nofault, uiomove_nofault.

Submitted by: alc


# 223260 18-Jun-2011 bz

Install symlinks for m_tag_* mbuf tag functions to the mbuf_tags.9 man page.

MFC after: 1 week


# 221496 05-May-2011 ae

Add make_dev_alias_p to MLINKS.

Pointed out by: pjd
MFC after: 2 weeks


# 221231 29-Apr-2011 jhb

Add a new bus method, BUS_ADJUST_RESOURCE() that is intended to be a
wrapper around rman_adjust_resource(). Include a generic implementation,
bus_generic_adjust_resource() which passes the request up to the parent
bus. There is currently no default implementation. A
bus_adjust_resource() wrapper is provided for use in drivers.


# 221220 29-Apr-2011 jhb

Extend the rman(9) API to support altering an existing resource.
Specifically, these changes allow a resource to back a relocatable and
resizable resource such as the I/O window decoders in PCI-PCI bridges.
- rman_adjust_resource() can adjust the start and end address of an
existing resource. It only succeeds if the newly requested address
space is already free. It also supports shrinking a resource in
which case the freed space will be marked unallocated in the rman.
- rman_first_free_region() and rman_last_free_region() return the
start and end addresses for the first or last unallocated region in
an rman, respectively. This can be used to determine by how much
the resource backing an rman must be adjusted to accomodate an
allocation request that does not fit into the existing rman.

While here, document the rm_start and rm_end fields in struct rman,
rman_is_region_manager(), the bound argument to
rman_reserve_resource_bound(), and rman_init_from_resource().


# 221103 26-Apr-2011 des

Rename alloc_unr(9) to unr(9) and adjust the links accordingly.

MFC after: 3 weeks


# 218912 21-Feb-2011 lstewart

Final commit to round out the "Five New TCP Congestion Control Algorithms for
FreeBSD" FreeBSD Foundation funded project.

- Add new man pages for the modular congestion control, Khelp and Hhook
frameworks (cc.4, cc.9, khelp.9 and hhook.9).

- Add new man pages for each available congestion control algorithm (cc_chd.4,
cc_cubic.4, cc_hd.4, cc_htcp.4, cc_newreno.4 and cc_vegas.4).

- Add a new man page for the Enhanced Round Trip Time (ERTT) Khelp module
(h_ertt.4).

- Update the TCP (tcp.4) man page to mention the TCP_CONGESTION socket option,
cross reference to cc.4 and remove references to the retired
"net.inet.tcp.newreno" sysctl MIB variable.

In collaboration with: David Hayes <dahayes at swin edu au> and
Grenville Armitage <garmitage at swin edu au>
Sponsored by: FreeBSD Foundation
MFC after: 3 months


# 217830 25-Jan-2011 mdf

Document sbuf_new_for_sysctl(9).

Pointed out by: lstewart


# 217586 19-Jan-2011 mdf

sysctl(8) should use the CTLTYPE to determine the type of data when
reading. (This was already done for writing to a sysctl). This
requires all SYSCTL setups to specify a type. Most of them are now
checked at compile-time.

Remove SYSCTL_*X* sysctl additions as the print being in hex should be
controlled by the -x flag to sysctl(8).

Succested by: bde


# 216995 05-Jan-2011 lstewart

Add a man page for the Object Specific Data (OSD) KPI.

Although not directly related the FreeBSD Foundation funded "Five New TCP
Congestion Control Algorithms for FreeBSD" project, the understanding and
inspiration required to write this documentation was significantly bolstered
by the Foundation's support.

Reviewed by: pjd
MFC after: 1 week


# 216232 06-Dec-2010 jhb

Add a manpage for SYSINIT() and SYSUNINIT().

PR: docs/132884
Submitted by: pluknet, hmp


# 215176 12-Nov-2010 pluknet

Stop documenting vgonel() after its converting to the static function:
svn r147332 (by jeff): "Don't make vgonel() globally visible".
While here, specify the vnode locking scheme for vgone().

Discussed on: freebsd-hackers@
Approved by: kib (mentor)
MFC after: 10 days


# 215011 08-Nov-2010 mdf

Add a taskqueue_cancel(9) to cancel a pending task without waiting for
it to run as taskqueue_drain(9) does.

Requested by: hselasky
Original code: jeff
Reviewed by: jhb
MFC after: 2 weeks


# 214277 24-Oct-2010 jh

Document make_dev_p(9).

Reviewed by: brueffer, kib


# 214097 20-Oct-2010 avg

catch up manual pages with rename of vm_page_sleep_busy to vm_page_sleep_if_busy

Suggested by: alc
MFC after: 4 days


# 214019 18-Oct-2010 pjd

Update links for taskqueue(9) functions.


# 213983 17-Oct-2010 kib

Document vunref(9), add some important notes for vrele(9) and vput(9).
Merge all three manpages to one, removing separate file for vput(9).

MFC after: 1 week


# 212425 10-Sep-2010 mdf

Replace sbuf_overflowed() with sbuf_error(), which returns any error
code associated with overflow or with the drain function. While this
function is not expected to be used often, it produces more information
in the form of an errno that sbuf_overflowed() did.


# 212367 09-Sep-2010 mdf

Add drain functionality to sbufs. The drain is a function that is
called when the sbuf internal buffer is filled. For kernel sbufs with a
drain, the internal buffer will never be expanded. For userland sbufs
with a drain, the internal buffer may still be expanded by
sbuf_[v]printf(3).

Sbufs now have three basic uses:
1) static string manipulation. Overflow is marked.
2) dynamic string manipulation. Overflow triggers string growth.
3) drained string manipulation. Overflow triggers draining.

In all cases the manipulation is 'safe' in that overflow is detected and
managed.

Reviewed by: phk (the previous version)


# 212112 01-Sep-2010 mlaier

rmlock(9) two additions and one change/fix:
- add rm_try_rlock().
- add RM_SLEEPABLE to use sx(9) as the back-end lock in order to sleep while
holding the write lock.
- change rm_noreadtoken to a cpu bitmask to indicate which CPUs need to go
through the lock/unlock in order to synchronize. As a side effect, this
also avoids IPI to CPUs without any readers during rm_wlock.

Discussed with: ups@, rwatson@ on arch@
Sponsored by: Isilon Systems, Inc.


# 211633 22-Aug-2010 ed

Add missing mlink for insmntque1().

MFC after: 1 week


# 211353 15-Aug-2010 brueffer

Tie up some loose ends r88509 left behind:

- chooseproc() is long gone, MLINK choosethread instead
- Update NAME section for choosethread
- Mark chooseproc.9 for removal

PR: 149549
Submitted by: pluknet
MFC after: 1 week


# 210941 06-Aug-2010 stefanf

Add links for destroy_dev_drain, destroy_dev_sched, destroy_dev_sched_cb,
make_dev_cred and make_dev_credf.


# 209710 05-Jul-2010 jh

Extend the kernel unit number allocator for allocating specific unit
numbers. This change adds a new function alloc_unr_specific() which
returns the requested unit number if it is free. If the number is
already allocated or out of the range, -1 is returned.

Update alloc_unr(9) manual page accordingly and add a MLINK for
alloc_unr_specific(9).

Discussed on: freebsd-hackers


# 202650 19-Jan-2010 jhb

Sort NDHASGIANT.9 link properly.


# 202284 14-Jan-2010 jhb

- Update required headers for namei() to add <sys/fcntl.h> and remove
<sys/proc.h>.
- Add RETURN VALUES and ERROR sections for namei()'s error return values.
- Add a missing link to NDHASGIANT.9.

PR: docs/142815, docs/142816
Submitted by: Lachlan Kang (1, 2)
MFC after: 3 days


# 200849 22-Dec-2009 ru

Removed duplicate usbd_xfer_state(9) link.


# 200848 22-Dec-2009 ru

Sort mlinks.


# 198518 27-Oct-2009 emaste

Add link for callout_schedule(9).


# 198134 15-Oct-2009 jhb

Add a facility for associating optional descriptions with active interrupt
handlers. This is primarily intended as a way to allow devices that use
multiple interrupts (e.g. MSI) to meaningfully distinguish the various
interrupt handlers.
- Add a new BUS_DESCRIBE_INTR() method to the bus interface to associate
a description with an active interrupt handler setup by BUS_SETUP_INTR.
It has a default method (bus_generic_describe_intr()) which simply passes
the request up to the parent device.
- Add a bus_describe_intr() wrapper around BUS_DESCRIBE_INTR() that supports
printf(9) style formatting using var args.
- Reserve MAXCOMLEN bytes in the intr_handler structure to hold the name of
an interrupt handler and copy the name passed to intr_event_add_handler()
into that buffer instead of just saving the pointer to the name.
- Add a new intr_event_describe_handler() which appends a description string
to an interrupt handler's name.
- Implement support for interrupt descriptions on amd64 and i386 by having
the nexus(4) driver supply a custom bus_describe_intr method that invokes
a new intr_describe() MD routine which in turn looks up the associated
interrupt event and invokes intr_event_describe_handler().

Requested by: many
Reviewed by: scottl
MFC after: 2 weeks


# 198085 14-Oct-2009 jhb

Add a manual page for BUS_BIND_INTR() and bus_bind_intr().

MFC after: 1 week


# 197780 05-Oct-2009 trasz

Make fetch(9) and store(9) manual pages closer to reality.


# 197405 22-Sep-2009 trasz

Add pieces of infrastructure required for NFSv4 ACL support in UFS.

Reviewed by: rwatson


# 196450 23-Aug-2009 julian

Add claraifications to the kproc and kthread manpages and link
the kthread_create(9) man page to the kproc(9) page as it had migrated and
people looking for it may need a hand to find its new name.

MFC after: 1 week


# 196155 12-Aug-2009 sam

First (early) draft of net80211 documentation. Note this is
focused on driver writers (as opposed to folks adding to net80211).

Reviewed by: wkoszek
Approved by: re (rwatson)


# 195622 11-Jul-2009 cperciva

Fix typo: kproc_resume,.9 -> kproc_resume.9.

Approved by: re (kib)


# 194860 24-Jun-2009 thompsa

Move programming info from usb(4) to usbdi(9) and update for the usb stack
changeover. Needs much more content still.


# 193873 09-Jun-2009 imp

These are no longer public, so remove the man page.


# 193833 09-Jun-2009 jhb

Add support for multiple passes of the device tree during the boot-time
probe. The current device order is unchanged. This commit just adds the
infrastructure and ABI changes so that it is easier to merge later changes
into 8.x.
- Driver attachments now have an associated pass level. Attachments are
not allowed to probe or attach to drivers until the system-wide pass level
is >= the attachment's pass level. By default driver attachments use the
"last" pass level (BUS_PASS_DEFAULT). Driver's that wish to probe during
an earlier pass use EARLY_DRIVER_MODULE() instead of DRIVER_MODULE() which
accepts the pass level as an additional parameter.
- A new method BUS_NEW_PASS has been added to the bus interface. This
method is invoked when the system-wide pass level is changed to kick off
a rescan of the device tree so that drivers that have just been made
"eligible" can probe and attach.
- The bus_generic_new_pass() function provides a default implementation of
BUS_NEW_PASS(). It first allows drivers that were just made eligible for
this pass to identify new child devices. Then it propogates the rescan to
child devices that already have an attached driver by invoking their
BUS_NEW_PASS() method. It also reprobes devices without a driver.
- BUS_PROBE_NOMATCH() is only invoked for devices that do not have
an attached driver after being scanned during the final pass.
- The bus_set_pass() function is used during boot to raise the pass level.
Currently it is only called once during root_bus_configure() to raise
the pass level to BUS_PASS_DEFAULT. This has the effect of probing all
devices in a single pass identical to previous behavior.

Reviewed by: imp
Approved by: re (kib)


# 193652 07-Jun-2009 rwatson

Add beginnings of a netisr(9) man page.


# 193260 01-Jun-2009 jhb

Add a simple API to manage scatter/gather lists of phyiscal addresses.
Each list describes a logical memory object that is backed by one or more
physical address ranges. To minimize locking, the sglist objects
themselves are immutable once they are shared.

These objects may be used in the future to facilitate I/O requests using
physically-addressed buffers. For the immediate future I plan to use them
to implement a new type of VM object and pager.

Reviewed by: jeff, scottl
MFC after: 1 month


# 193092 30-May-2009 trasz

Add VOP_ACCESSX, which can be used to query for newly added V*
permissions, such as VWRITE_ACL. For a filsystems that don't
implement it, there is a default implementation, which works
as a wrapper around VOP_ACCESS.

Reviewed by: rwatson@


# 192908 27-May-2009 zml

fail(9) support:

Add support for kernel fault injection using KFAIL_POINT_* macros and
fail_point_* infrastructure. Add example fail point in vfs_bio.c to
simulate VM buf pressure.

Approved by: dfr (mentor)


# 190889 10-Apr-2009 rwatson

Remove VOP_LEASE(9) man page, as we no longer have a VOP_LEASE() in the
kernel.


# 190564 30-Mar-2009 jhb

Add a simple manage for the refcount(9) API.

Requested by: rwatson


# 189290 02-Mar-2009 jamie

Extend the "vfsopt" mount options for more general use. Make struct
vfsopt and the vfs_buildopts function public, and add some new fields
to struct vfsopt (pos and seen), and new functions vfs_getopt_pos and
vfs_opterror.

Further extend the interface to allow reading options from the kernel
in addition to sending them to the kernel, with vfs_setopt and related
functions.

While this allows the "name=value" option interface to be used for more
than just FS mounts (planned use is for jails), it retains the current
"vfsopt" name and <sys/mount.h> requirement.

Approved by: bz (mentor)


# 188917 22-Feb-2009 trasz

Mention disk_gone() in disk(9).

Approved by: rwatson (mentor)


# 185961 11-Dec-2008 marcus

Add a man page for VOP_VPTOCNP.

Reviewed by: arch
Approved by: kib


# 185226 23-Nov-2008 hrs

Remove vfs_mountedon(9) manual page. The vfs_mountedon(9) has been
removed since 2004.


# 184205 23-Oct-2008 des

Retire the MALLOC and FREE macros. They are an abomination unto style(9).

MFC after: 3 months


# 183442 28-Sep-2008 ed

Several documentation fixups related to device minor/major numbers:

- Document the minor(3), major(3) and makedev(3) macro's. They also
apply to umajor() and uminor() in the kernel, but hopefully we'll sort
that out one day.

- Briefly dev2unit() inside the make_dev(9) manual page, since this is
now the preferred macro to obtain character device unit numbers inside
the kernel.

- Remove the device_ids(9) manual page. It contains highly inaccurate
information, such as a description of the nonexistent major().


# 183113 17-Sep-2008 attilio

Remove the suser(9) interface from the kernel. It has been replaced from
years by the priv_check(9) interface and just very few places are left.
Note that compatibility stub with older FreeBSD version
(all above the 8 limit though) are left in order to reduce diffs against
old versions. It is responsibility of the maintainers for any module, if
they think it is the case, to axe out such cases.

This patch breaks KPI so __FreeBSD_version will be bumped into a later
commit.

This patch needs to be credited 50-50 with rwatson@ as he found time to
explain me how the priv_check() works in detail and to review patches.

Tested by: Giovanni Trematerra <giovanni dot trematerra at gmail dot com>
Reviewed by: rwatson


# 183056 15-Sep-2008 sam

decription of macros to add ddb commands

Submitted by: Guillaume Ballet <gballet@gmail.com>
MFC after: 1 month


# 183036 15-Sep-2008 kib

Connect dev_clone.9 and devfs_set_cdevpriv.9 to the build.


# 182378 28-Aug-2008 jkim

Add links to all bpf(9) functions.


# 180595 18-Jul-2008 dwmalone

Add a man page for the DNS accept filter.


# 179211 22-May-2008 alc

The function pmap_addr_hint no longer exists. Remove its man page.


# 177962 06-Apr-2008 attilio

Commit manpages for lockmgr_args_rw(9) and lockmgr_rw(9).


# 177846 01-Apr-2008 attilio

Add manpages for rw_try_rlock() and rw_try_wlock() functions.


# 177697 28-Mar-2008 brueffer

Document lockmgr_waiters(9).

Reviewed by: attilio


# 177168 14-Mar-2008 rwatson

Add stack_print_ddb() to the synposis of stack(9), add mlink for it; fix
stack_print(9) mlink.

Spotted by: attilio


# 176712 01-Mar-2008 attilio

Connect lockmgr_args(9) to the build.


# 176612 26-Feb-2008 davidc

Add vfs_mountedfrom.9 to the build.


# 176610 26-Feb-2008 davidc

Add insmntque.9 to the build.


# 176608 26-Feb-2008 davidc

Link vholdl.9 to vhold.9


# 176603 26-Feb-2008 davidc

Add vrefcnt.9 to the build.


# 176253 13-Feb-2008 attilio

Update manpage with lockmgr_assert() description.


# 176230 13-Feb-2008 brueffer

Remove dublicate MLINK.

Submitted by: David Naylor <blackdragon@highveldmail.co.za>


# 175578 22-Jan-2008 attilio

Add manpages for BUF_RECURSED(9) and BUF_ISLOCKED(9) and connect them to
the build.

Reviewed by: brueffer


# 175577 22-Jan-2008 attilio

Add the newly added function lockmgr_recursed() to the manpages.


# 175575 22-Jan-2008 attilio

BUF_REFCNT(9) function no more exists, so just axe out the manpage.


# 175574 22-Jan-2008 attilio

Fix lock.9 manpage in order to recall lockmgr_disown() with 'man' command.


# 174137 01-Dec-2007 rwatson

Modify stack(9) stack_print() and stack_sbuf_print() routines to use new
linker interfaces for looking up function names and offsets from
instruction pointers. Create two variants of each call: one that is
"DDB-safe" and avoids locking in the linker, and one that is safe for
use in live kernels, by virtue of observing locking, and in particular
safe when kernel modules are being loaded and unloaded simultaneous to
their use. This will allow them to be used outside of debugging
contexts.

Modify two of three current stack(9) consumers to use the DDB-safe
interfaces, as they run in low-level debugging contexts, such as inside
lockmgr(9) and the kernel memory allocator.

Update man page.


# 174078 29-Nov-2007 rwatson

Add description of stack_print() and MLINK.


# 173979 27-Nov-2007 rwatson

Add a man page for stack(9).

MFC after: 1 week


# 173779 20-Nov-2007 gabor

- Add callout_init_rw.9 to MLINKS of timeout.9

Forgotten by: gabor
Reminded by: ru


# 173591 13-Nov-2007 ru

Sort.


# 173523 10-Nov-2007 rwatson

Hook up rmlock(9) and its links to the build.


# 173030 26-Oct-2007 julian

Doc police fixes

thanks to: ru@


# 173016 26-Oct-2007 ru

Sort MLINKS.


# 172674 15-Oct-2007 netchild

Backout sensors framework.

Requested by: phk
Discussed on: cvs-all


# 172631 14-Oct-2007 netchild

Import OpenBSD's sysctl hardware sensors framework.

This commit includes the following core components:

* sample configuration file for sensorsd
* rc(8) script and glue code for sensorsd(8)
* sysctl(3) doc fixes for CTL_HW tree
* sysctl(3) documentation for hardware sensors
* sysctl(8) documentation for hardware sensors
* support for the sensor structure for sysctl(8)
* rc.conf(5) documentation for starting sensorsd(8)
* sensor_attach(9) et al documentation
* /sys/kern/kern_sensors.c
o sensor_attach(9) API for drivers to register ksensors
o sensor_task_register(9) API for the update task
o sysctl(3) glue code
o hw.sensors shadow tree for sysctl(8) internal magic
* <sys/sensors.h>
* HW_SENSORS definition for <sys/sysctl.h>
* sensors display for systat(1), including documentation
* sensorsd(8) and all applicable documentation

The userland part of the framework is entirely source-code
compatible with OpenBSD 4.1, 4.2 and -current as of today.

All sensor readings can be viewed with `sysctl hw.sensors`,
monitored in semi-realtime with `systat -sensors` and also
logged with `sensorsd`.

Submitted by: Constantine A. Murenin <cnst@FreeBSD.org>
Sponsored by: Google Summer of Code 2007 (GSoC2007/cnst-sensors)
Mentored by: syrinx
Tested by: many
OKed by: kensmith
Obtained from: OpenBSD (parts)


# 172456 05-Oct-2007 marius

Add an MLINKS for pci_find_dbsf.9.

Submitted by: ru
Approved by: re (gnn)


# 172053 05-Sep-2007 rwatson

Add MLINKS entries for various SYSCTL_*() macros documented in sysctl.9.

Approved by: re (bmah)
Submitted by: Constantine A. Murenin <cnst+freebsd@bugmail.mojo.ru>
Sponsored by: Google Summer of Code 2007


# 169777 19-May-2007 jhb

Document sx_xholder().


# 169543 13-May-2007 thompsa

Link the defunct MUTEX_PROFILING option to LOCK_PROFILING.


# 168203 01-Apr-2007 maxim

o Document vdropl(9) [1].
o Add an MLINK for vdropl().

Reviewed by: des [1]
Obtained from: wording from vgone(9)


# 168191 31-Mar-2007 jhb

Optimize sx locks to use simple atomic operations for the common cases of
obtaining and releasing shared and exclusive locks. The algorithms for
manipulating the lock cookie are very similar to that rwlocks. This patch
also adds support for exclusive locks using the same algorithm as mutexes.

A new sx_init_flags() function has been added so that optional flags can be
specified to alter a given locks behavior. The flags include SX_DUPOK,
SX_NOWITNESS, SX_NOPROFILE, and SX_QUITE which are all identical in nature
to the similar flags for mutexes.

Adaptive spinning on select locks may be enabled by enabling the
ADAPTIVE_SX kernel option. Only locks initialized with the SX_ADAPTIVESPIN
flag via sx_init_flags() will adaptively spin.

The common cases for sx_slock(), sx_sunlock(), sx_xlock(), and sx_xunlock()
are now performed inline in non-debug kernels. As a result, <sys/sx.h> now
requires <sys/lock.h> to be included prior to <sys/sx.h>.

The new kernel option SX_NOINLINE can be used to disable the aforementioned
inlining in non-debug kernels.

The size of struct sx has changed, so the kernel ABI is probably greatly
disturbed.

MFC after: 1 month
Submitted by: attilio
Tested by: kris, pjd


# 168066 30-Mar-2007 julian

Connect the locking man page to the build.
Next step is to add it as a "See Also" to related man pages.


# 167971 28-Mar-2007 maxim

o Trim unneeded backslash.


# 167970 28-Mar-2007 maxim

o Actually add MLINKs for priv(9) functions.


# 167952 27-Mar-2007 brueffer

Add MLINKs for priv(9) functions.


# 167387 09-Mar-2007 jhb

Allow threads to atomically release rw and sx locks while waiting for an
event. Locking primitives that support this (mtx, rw, and sx) now each
include their own foo_sleep() routine.
- Rename msleep() to _sleep() and change it's 'struct mtx' object to a
'struct lock_object' pointer. _sleep() uses the recently added
lc_unlock() and lc_lock() function pointers for the lock class of the
specified lock to release the lock while the thread is suspended.
- Add wrappers around _sleep() for mutexes (mtx_sleep()), rw locks
(rw_sleep()), and sx locks (sx_sleep()). msleep() still exists and
is now identical to mtx_sleep(), but it is deprecated.
- Rename SLEEPQ_MSLEEP to SLEEPQ_SLEEP.
- Rewrite much of sleep.9 to not be msleep(9) centric.
- Flesh out the 'RETURN VALUES' section in sleep.9 and add an 'ERRORS'
section.
- Add __nonnull(1) to _sleep() and msleep_spin() so that the compiler will
warn if you try to pass a NULL wait channel. The functions already have
a KASSERT to that effect.


# 167373 09-Mar-2007 jhb

- Document cv_wait_unlock(9).
- Don't claim that the mutex is atomically reacquired when a cv_wait
routine returns. There's nothing atomic or magical about the lock
reacquire. The only magic is that we atomically drop the lock by
placing the thread on the sleep queue before dropping the lock.


# 167371 09-Mar-2007 jhb

- Sort functions in the order that rwlock(9) and mutex(9) use.
- Markup sx_unlock() as a function rather than saying it is a macro.
The macro part is an implementation detail, and all the other sx_*lock()
functions are actually macros, too.
- Use the same style as rwlock(9) and mutex(9) to markup sx_assert() and
SX_SYSINIT() with respect to headers and kernel options.
- Add a missing MLINK.


# 167370 09-Mar-2007 jhb

- Sort rwlock functions similar to the order in mutex(9).
- Add a missing MLINK.


# 167176 02-Mar-2007 davidc

Add vfs_getopt.9 to the build, and add links for related functions.


# 167026 26-Feb-2007 rwatson

Add rw_wowned(9) symlink.


# 166966 25-Feb-2007 ru

Remove the traces of vm_page_unmanage().


# 166908 23-Feb-2007 jhb

Add a new kernel sleep function pause(9). pause(9) is for places that
want an equivalent of DELAY(9) that sleeps instead of spins. It accepts
a wmesg and a timeout and is not interrupted by signals. It uses a private
wait channel that should never be woken up by wakeup(9) or wakeup_one(9).

Glanced at by: phk


# 166794 16-Feb-2007 pjd

VFS_VPTOFH(9) was replaced with VOP_VPTOFH(9).
VFS_VPTOFH.9 was repo-copied to VOP_VPTOFH.9.

Repo-copy done by: joe


# 166662 12-Feb-2007 jhb

MLINK for bus_dmamap_load_mbuf_sg(9)


# 166328 29-Jan-2007 rwatson

Add MLINKS for sf_buf.9.


# 166309 28-Jan-2007 rwatson

Add a rudimentary man page for sf_bufs, based on my rudimentary
understanding of sf_bufs.


# 166022 15-Jan-2007 rrs

Reviewed by: rwatson
Approved by: gnn

Add a new function hashinit_flags() which allows NOT-waiting
for memory (or waiting). The old hashinit() function now
calls hashinit_flags(..., HASH_WAITOK);


# 165264 15-Dec-2006 rwatson

Add a basic man page for the socket(9) kernel programming interface used
by the NFS client and server, netsmb, netncp, etc.

Reviewed by: ru
Fixed by: ru


# 164606 25-Nov-2006 imp

devsw() was removed by phk:

revision 1.199
date: 2004/09/24 08:30:57; author: phk; state: Exp; lines: +0 -1
Remove the cdevsw() function which is now unused.

(the log is wrong, it was really devsw that was removed).

# we really need to actually document the functions in sys/conf.h as well
# as things like d_open...


# 164408 19-Nov-2006 ceri

Add manuals for cr_cansee(9) and p_cansee(9).
Thanks to Ruslan for the time he spent reviewing these.

Reviewed by: ru
Approved by: ru


# 164169 11-Nov-2006 ru

Fix build (forgotten MUTEX_PROFILING.9 -> LOCK_PROFILING.9).


# 164032 06-Nov-2006 rwatson

Add a new priv(9) kernel interface for checking the availability of
privilege for threads and credentials. Unlike the existing suser(9)
interface, priv(9) exposes a named privilege identifier to the privilege
checking code, allowing more complex policies regarding the granting of
privilege to be expressed. Two interfaces are provided, replacing the
existing suser(9) interface:

suser(td) -> priv_check(td, priv)
suser_cred(cred, flags) -> priv_check_cred(cred, priv, flags)

A comprehensive list of currently available kernel privileges may be
found in priv.h. New privileges are easily added as required, but the
comments on adding privileges found in priv.h and priv(9) should be read
before doing so.

The new privilege interface exposed sufficient information to the
privilege checking routine that it will now be possible for jail to
determine whether a particular privilege is granted in the check routine,
rather than relying on hints from the calling context via the
SUSER_ALLOWJAIL flag. For now, the flag is maintained, but a new jail
check function, prison_priv_check(), is exposed from kern_jail.c and used
by the privilege check routine to determine if the privilege is permitted
in jail. As a result, a centralized list of privileges permitted in jail
is now present in kern_jail.c.

The MAC Framework is now also able to instrument privilege checks, both
to deny privileges otherwise granted (mac_priv_check()), and to grant
privileges otherwise denied (mac_priv_grant()), permitting MAC Policy
modules to implement privilege models, as well as control a much broader
range of system behavior in order to constrain processes running with
root privilege.

The suser() and suser_cred() functions remain implemented, now in terms
of priv_check() and the PRIV_ROOT privilege, for use during the transition
and possibly continuing use by third party kernel modules that have not
been updated. The PRIV_DRIVER privilege exists to allow device drivers to
check privilege without adopting a more specific privilege identifier.

This change does not modify the actual security policy, rather, it
modifies the interface for privilege checks so changes to the security
policy become more feasible.

Sponsored by: nCircle Network Security, Inc.
Obtained from: TrustedBSD Project
Discussed on: arch@
Reviewed (at least in part) by: mlaier, jmg, pjd, bde, ceri,
Alex Lyashkov <umka at sevcity dot net>,
Skip Ford <skip dot ford at verizon dot net>,
Antoine Brodin <antoine dot brodin at laposte dot net>


# 163029 05-Oct-2006 ru

Sort MAN and MLINKS lists.


# 163026 05-Oct-2006 jmg

sort MLINKS properly

Pointed out by: ru


# 163013 04-Oct-2006 jmg

add man page talking about how to interface w/ the kqueue system so others
can write additional filters...

mdoc police please!


# 162951 02-Oct-2006 andre

Connect hash(9) to the build and add MLINKS for all functions.

Pointed out by: ru


# 162638 25-Sep-2006 imp

Document config_intrhook.

MFC After: 250 millifortnights


# 160308 12-Jul-2006 maxim

o Sort sx(9) MLINKS.


# 160300 12-Jul-2006 pjd

Document sx_xlocked(9).

Submitted by: ssouhlal


# 158861 23-May-2006 imp

Add a stub man page for device_get_sysctl{_ctx,tree}. Needs some
work, but is better than nothing. Any help appreciated.


# 158110 28-Apr-2006 rwatson

Add a basic man page for the sysctl(9) macro interfaces. Previously man
pages existed only for the dynamic sysctl interfaces. There's probably
more complete and accurate content, better advice, etc, that could be added
here.

Per scottl's suggest, add a small piece of moralizing text regarding the
fact that sysctl names quickly get embedded in system configuration files,
libraries, third party applications, and even books, so renaming and
removing names after they've been published is a tricky issue.

MFC after: 1 month


# 157954 22-Apr-2006 jmg

document the various bus_space_*_stream_? functions...


# 157884 19-Apr-2006 jhb

Add MLINKS for rwlock(9).


# 157520 04-Apr-2006 jmg

add links for the functions documented in bus_space.9...


# 155189 01-Feb-2006 glebius

Document read/write locks.

Reviewed by: jhb, ru


# 155086 31-Jan-2006 pjd

Add buffer corruption protection (RedZone) for kernel's malloc(9).
It detects both: buffer underflows and buffer overflows bugs at runtime
(on free(9) and realloc(9)) and prints backtraces from where memory was
allocated and from where it was freed.

Tested by: kris


# 154974 29-Jan-2006 mlaier

firmware(9) is a subsystem to load binary data into the kernel via a
specially crafted module. There are several handrolled sollutions to this
problem in the tree already which will be replaced with this. They include
iwi(4), ipw(4), ispfw(4) and digi(4).

No objection from: arch
MFC after: 2 weeks
X-MFC after: some drivers have been converted


# 153992 03-Jan-2006 jhb

- Don't list sleep() in the NAME section as we haven't had a sleep()
function in years.
- Change the 'ident' paramters to 'wchan' to match <sys/systm.h>.
- Use 'otherwise' in place of 'else' in one place so that this reads like
English rather than C.
- Document the new msleep_spin() function.
- Add history notes for msleep() and msleep_spin().


# 153923 31-Dec-2005 iedowse

Add basic documentation for many of the kernel USB functions that
USB device drivers use to talk to USB devices. This is probably
still a bit rough and it does not yet include the functions specific
to HID, ethernet, hubs, host controller drivers, task threads or
debugging.


# 150978 05-Oct-2005 jhb

Update this manpage:
- Remove references to cpu_critical_*() as they no longer exist.
- Explain that any preemptions that occur during a critical section are
deferred until the current thread exits the section.
- Remove a bogus example usage of a critical section.
- Note that one can interlock critical sections with spin mutexes in
certain situations.

MFC after: 3 days


# 150666 28-Sep-2005 ru

Sort MLINKS.


# 150628 27-Sep-2005 jhb

- Document atomic_fetchadd(9) and add a MLINK.
- Add arm and ppc to the list of archs not supporting operations on 64-bit
integers.
- Update the sample code for acquiring a mutex to be more recent and to
take into account the recent atomic_foo_ptr() changes.

MFC after: 1 week


# 150413 21-Sep-2005 rwatson

Add discussion of Giant, the MPSAFE flag, and NDHASGIANT() to namei(9).

Add a VFS_LOCK_GIANT(9)/VFS_UNLOCK_GIANT(9) man page.

Discussed with: jeff
MFC after: 3 days


# 148428 27-Jul-2005 scottl

Now that VFS_START.9 has been removed, don't try to reference it from the
Makefile.


# 147359 14-Jun-2005 imp

Don a flack jacket and start to document the FreeBSD bus_space
implementation. I took the NetBSD man page, and hacked it to, I hope,
to reflect the preliminary version of the bus space that Justin Gibbs
committed as part of the CAM integration in FreeBSD 3.0.

This isn't perfect, but it is better than we have now (which is, ahem,
nothing). Please coordinate changes to the file through me through
the 6.0 release.

Approved by: re (blanket for this one file)


# 147259 10-Jun-2005 hmp

Add manual page for newly added pmap_page_init(9) function, part of the
PMAP KPI.

Reviewed-by: alc


# 145333 20-Apr-2005 glebius

Manpage for unit allocator functions.

Reviewed by: phk


# 145103 15-Apr-2005 pjd

Add missing links.

MFC after: 2 weeks


# 144846 09-Apr-2005 pjd

Create links to crypto.9 for every crypto(9) function.

OK'ed by: sam
MFC after: 2 weeks


# 144750 07-Apr-2005 njl

Hook up new man page for devclass_get_drivers() to build

Reminded by: ru


# 142249 22-Feb-2005 brueffer

Connect memguard(9) to the build.


# 141428 07-Feb-2005 iedowse

Add a mechanism for associating a mutex with a callout when the
callout is first initialised, using a new function callout_init_mtx().
The callout system will acquire this mutex before calling the callout
function and release it on return.

In addition, the callout system uses the mutex to avoid most of the
complications and race conditions inherent in asynchronous timer
facilities, so mutex-protected callouts have much simpler semantics.
As long as the mutex is held when invoking callout_stop() or
callout_reset(), then these functions will guarantee that the callout
will be stopped, even if softclock() had already begun to process
the callout.

Existing Giant-locked callouts will automatically pick up the new
race-free semantics. This should close a number of race conditions
in the USB code and probably other areas of the kernel too.

There should be no change in behaviour for "MP-safe" callouts; these
still need to use the techniques mentioned in timeout(9) to avoid
race conditions.


# 139862 07-Jan-2005 maxim

Finish src part VFS_INIT.9 removal. Need to check www/.


# 138824 13-Dec-2004 imp

The format of the MLINKS entries is pairwise, not MLINKS += wise. So
list kernel_mount.9 the required number of times to allow make
installworld to complete.


# 138819 13-Dec-2004 trhodes

Add kernel_mount.9 and appropriate MLINKS to the build.


# 138426 06-Dec-2004 alc

This jumbo allocator has been removed from the kernel.


# 138348 03-Dec-2004 jkoshy

Add a manual page for the kernel's EVENTHANDLER facility.

Reviewed by: ru


# 138056 24-Nov-2004 rwatson

Link critical_enter.9 to critical.9 to make it easier to find.


# 137905 20-Nov-2004 jkoshy

Bring signal(9) in sync with -current.

Reviewed by: ru (mdoc changes)


# 136412 12-Oct-2004 jkoshy

Add a manual page for hashinit(9), hashdestroy(9) and phashinit(9).

Reviewed by: ru


# 136255 08-Oct-2004 glebius

Add more MLINKS for rtalloc.9

Approved by: ru


# 135839 27-Sep-2004 alc

Document the O(log n) algorithm for finding free space.

Submitted by: Mark W. Krentel


# 135454 19-Sep-2004 ru

Sort MAN and MLINKS in dictionary order ignoring case.


# 135438 18-Sep-2004 jmg

add MLINKs for the mbuf.9 man page..

MFC after: 3 days


# 135366 17-Sep-2004 brooks

Bring kernel time variable and access function docs up to date by
updating the list of variables and mentioning the bin(up)time functions.


# 133428 10-Aug-2004 joerg

Add documentation for log(9).

MFC after: 1 week


# 133265 07-Aug-2004 mlaier

Add altq(9) explaining about the IFQ_* and IFQ_DRV_* macros in if_var.h and
how to convert drivers.

Obtained from: NetBSD (with changes)
Reviewed by: josef


# 133252 07-Aug-2004 imp

It appears that cdevsw_add/remove were removed quite a while ago, so
remove them from here.


# 131886 09-Jul-2004 alfred

document vfs_suser.


# 130153 06-Jun-2004 pjd

Add missing link.


# 129468 20-May-2004 ru

Document mbuf tags based on the OpenBSD manpage.

Submitted by: Gleb Smirnoff


# 129456 19-May-2004 dwmalone

Add a man page for the kernel part of bpf. I made some edits to the
man page after Orla, so the mistakes are probably mine. Leave a
note on the door welcoming the mdoc police.

Submitted by: Orla McGann <orly@cnri.dit.ie>


# 129365 17-May-2004 hmp

Add rman_get_device(9) to SYNOPSIS, .Nm and MLINK it to
rman(9).


# 129190 13-May-2004 imp

The DEVICE_IDENTIFY man page refers to this, create a dummy one
directing people to device_add_child.


# 127133 17-Mar-2004 njl

Add bus_alloc_resource_any(9), which does bus_alloc_resource() with the
appropriate default values. Document it in the manpage.

Submitted by: Mark Santcroos <marks@ripe.net>
Reviewed by: imp, dfr, bde
Abstains: bde


# 126886 12-Mar-2004 jhb

Rewrite sleepqueue manpage to catch up to the new sleep queue interface.


# 126860 11-Mar-2004 pjd

Connect g_access(9) to the build.


# 126814 10-Mar-2004 jhb

- Document cv_broadcastpri().
- Remove references to cv_waitq_*() as they no longer exist.


# 126720 07-Mar-2004 josef

Document kernel functions securelevel_gt and securelevel_ge.

Approved by: simon(mentor)
Submitted by: Christian S.J. Peron <maneo@bsdpro.com>
PR: docs/62331
mdoc(7) cleanup by: ru


# 126689 06-Mar-2004 jkoshy

Link in contigmalloc(9) to the build.


# 126626 05-Mar-2004 bms

Fix a typo.


# 126619 04-Mar-2004 bms

Hook ieee80211 manpages up to the build; fix 1 snafu which crept in.

Noticed by: Matthias Schuendehuette
Pointy hat to: bms


# 126597 04-Mar-2004 bms

Add an MLINKS entry for radiotap(9).


# 126596 04-Mar-2004 bms

Initial import of documentation for net80211 interface code.
Of particular interest here is the ieee80211_radiotap(9) man page.

TODO: Flesh out ieee80211_node.9, ieee80211_proto.9.

Submitted by: bms (with help from Darron Broad)


# 126390 28-Feb-2004 le

Add MLINKs for MALLOC_DEFINE and MALLOC_DECLARE.

Approved by: grog (mentor)


# 126371 28-Feb-2004 phk

Add contents to manualpage for generic watchdog facility.
Formatting likely to break several UN resolutions.


# 126320 27-Feb-2004 des

Document sysctl_move_oid().


# 125715 11-Feb-2004 pjd

Create symbolic link for g_print_bio(9) manual page.

Approved by: scottl (mentor)


# 125700 11-Feb-2004 pjd

Added GEOM kernel API manuals to the build.

Reviewed by: scottl
Approved by: phk, scottl (mentor)


# 124964 25-Jan-2004 des

Add a manual page for the mutex profiling code.


# 124747 20-Jan-2004 ru

Use a single style for share/man/ makefiles:

- Sort MAN and MLINKS in "dictionary" order ignoring case.

- For multi-value MAN and multi-pair MLINKS, put each value/pair
on its own line, for easier sorting and so that further diffs
are easier to see.


# 124395 11-Jan-2004 rwatson

Add a basic manpage for vn_fullpath().

Sponsored by: DARPA, McAfee Research


# 124313 09-Jan-2004 simon

Add missing manual page links for rman(9) and sysctl_add_oid(9).

Submitted by: Lukas Ertl <l.ertl@univie.ac.at>
PR: docs/60088


# 123445 11-Dec-2003 jkoshy

Document a few kernel functions and the sysctl tunables that
affect their behaviour.


# 123256 07-Dec-2003 scottl

Add a manual page for the consolidated debugging commit.


# 122445 10-Nov-2003 hmp

Manual page for Asynchronous Logging Queues (ALQ) facility.

The manual page contains enough information to get someone started
with ALQ.

MLINKS have been added appropriately.

Approved by: jeff, des
Reviewed by: des, jeff, sam, brooks, rwatson, mtm


# 122092 05-Nov-2003 imp

resource_query_string is dead. Kill it.


# 120832 05-Oct-2003 bms

Add pmap_wired_count() and pmap_resident_count() to the pmap documentation.

Discussed with: peter


# 120723 03-Oct-2003 bms

Update the pmap(9) documentation to reflect the movement of pmap_prefault()
to the machine-independent VM layer, as per alc's recent commit.
Add a definition for the new pmap_is_prefaultable() helper function.


# 120588 29-Sep-2003 bms

Add manual pages for the vm_map(9) part of the VM.

Reviewed by: juli
Approved by: jake (mentor)


# 120586 29-Sep-2003 bms

Add manual pages for the vm_map(9) part of the VM.

Reviewed by: juli
Approved by: jake (mentor)


# 120496 26-Sep-2003 rwatson

Documentation of kernel disk_create() and disk_destroy() APIs. These
APIs permit disk device drivers to register and deregister storage devices
for use by storage device consumers. No doubt this API will change
more as time flies by, but this should be helpful to the creators of
new storage device drivers.

Reviewed by: phk


# 120446 25-Sep-2003 bms

Fix MLINKS.

Noticed by: bde
Pointy hat to: bms


# 120441 25-Sep-2003 bms

Add manual page documentation for the machine-independent PMAP subsystem.
Include documentation of alc's new pmap_extract_and_hold() function.

Reviewed by: hmp
Approved by: jake (mentor)


# 120401 24-Sep-2003 marcel

Hook up BUS_CONFIG_INTR.9


# 117836 21-Jul-2003 harti

Document uma_zone_set_max and its non-obvious behaviour.

Reviewed by: bmilekic


# 117669 16-Jul-2003 truckman

Document mutex pool API enhancements that allow creation and use of
multiple mutex pools.


# 117624 15-Jul-2003 harti

Add a facility for devices, specifically network interfaces, that require
large to huge amounts of small or medium sized receive buffers. The problem
with these situations is that they eat up the available DMA address space
very quickly when using mbufs or even mbuf clusters. Additionally this
facility provides a direct mapping between 32-bit integers and these buffers.
This is needed for devices originally designed for 32-bit systems. Ususally
the virtual address of the buffer is used as a handle to find the buffer as
soon as it is returned by the card. This does not work for 64-bit machines
and hence this mapping is needed.


# 116501 17-Jun-2003 hmp

Add MLINK for busdma(9) to bus_dma(9).
This resolves confusion for at least 10 people.

Suggested by: Bruce M. Simpson <bms@spc.org>
Approved by: des (mentor)


# 116258 12-Jun-2003 harti

This is a driver for the physical layer chips used in ATM interfaces.
It currently supports the PMC Sierra Lite, Ultra and 622 chips and
the IDT 77105. The driver handles media options and state in a consistent
manner for ATM drivers. The next commit to the midway driver will make
it use utopia.


# 116099 09-Jun-2003 hmp

Hook up pci(9) manual page to the build.

Approved by: des (mentor)


# 115876 05-Jun-2003 rwatson

Document VOP_LISTEXTATTR(9).

Obtained from: TrustedBSD Project
Sponsored by: DARPA, Network Associates Laboratories


# 115420 30-May-2003 hmp

Add the bus_dma(9) manual page to our section 9 collection. It
provides comprehensive documentation on FreeBSD's Bus DMA interface.

Approved by: gibbs, re@ (scottl)
Reviewed by: gibbs, scottl, des, sam, jake, tmm


# 115213 21-May-2003 ru

Link {be,le}{16,32,64}{enc,dec}.9 to byteorder.9.

Approved by: re (blanket)


# 115075 16-May-2003 hmp

Document the ``resource management'' routines in rman(9).

Submitted by: Bruce M. Simpson <bms@spc.org>
Reviewed by: mdodd

Approved by: des (mentor), re (scottl)


# 115072 16-May-2003 hmp

Add a manual page for the CTASSERT(9) macro.

Approved by: des (mentor), re (scottl)


# 114854 09-May-2003 hmp

Add missing MLINK for arc4rand(9). It is documented in
random(9) and referenced by gbde(4).

PR: docs/51254
Submitted by: Simon L. Nielsen <simon@nitro.dk>
Approved and Reviewed by: des (mentor), re (bmah)


# 113836 22-Apr-2003 imp

Document device_set_driver(9)

# now all driver_* functions used outside of subr_bus.o in my kernel
# are documented.


# 113835 22-Apr-2003 imp

Document device_printf(9).


# 113834 22-Apr-2003 imp

Document device_set_ivars(9) as well.


# 113830 21-Apr-2003 imp

man page for device_get_parent.


# 113829 21-Apr-2003 imp

device_is_alive already was documented in device_get_state, so remove the
separate man page. Document new device_is_attached there and remove that
new man page too.

Connect device_get_name to build, and install a link for
device_get_nameunit.

strangely nobody noticed this yet...


# 113810 21-Apr-2003 imp

Simple man page for new device_is_attached.


# 113809 21-Apr-2003 imp

Add a man page for device_is_alive.


# 112831 29-Mar-2003 imp

Document what bus_set_resource(9) does. It is used by bus drivers to
bind resources that client drivers later access.


# 112786 29-Mar-2003 kris

Correct a typo in previous commit


# 112774 29-Mar-2003 imp

Add a new man page for bus_activate_resource and
bus_deactivate_resource. It could use some improvement, and others
are welcomed to do so :-)


# 112737 28-Mar-2003 imp

Create a man page for bus_child_present(9), a function to see if a
given device is considered accessible by its parent device bus driver
(or its parent, etc).


# 112615 25-Mar-2003 jhb

Remove obsolete at_fork() and at_exit() manpages. Curiously, at_exec()
didn't have a manpage.

Reminded by: ru


# 107626 04-Dec-2002 chris

Document the following MAC policies:
o Biba: A data integrity policy
o BSD Extended: Support for the firewall-like access controls (ugidfw(8))
o MLS: Multi-level security, a confidentiality policy

(These files originally lived in src/share/man/man9)

Approved by: re (blanket)
Sponsored by: DARPA, Network Associates Labs
Obtained from: TrustedBSD Project


# 107479 01-Dec-2002 chris

Document the MLS policy

Approved by: re
Sponsored by: DARPA, Network Associates Labs
Obtained from: TrustedBSD Project


# 107119 20-Nov-2002 chris

Activate mac_biba.9

Approved by: re
Sponsored by: DARPA, Network Associates Labs


# 105665 21-Oct-2002 rwatson

Add mac(9), a man page providing a basic introduction to the concepts
associated with the TrustedBSD MAC Framework, as well as some credits
to developers and contributors.

Obtained from: TrustedBSD Project
Sponsored by: DARPA, Network Associates Laboratories


# 105382 18-Oct-2002 chris

Add a new man page describing the mac_bsdextended policy.

Obtained from: TrustedBSD Project
Sponsored by: DARPA, NAI Labs


# 105249 16-Oct-2002 mike

Remove the posix4(9) manual. It no longer contains relevant
information.


# 104488 04-Oct-2002 sam

manual pages for the new kernel crypto support (need work)

Obtained from: openbsd


# 99600 08-Jul-2002 julian

link in the man page for thread_exit
Also change some line breaks.


# 98849 26-Jun-2002 ken

At long last, commit the zero copy sockets code.

MAKEDEV: Add MAKEDEV glue for the ti(4) device nodes.

ti.4: Update the ti(4) man page to include information on the
TI_JUMBO_HDRSPLIT and TI_PRIVATE_JUMBOS kernel options,
and also include information about the new character
device interface and the associated ioctls.

man9/Makefile: Add jumbo.9 and zero_copy.9 man pages and associated
links.

jumbo.9: New man page describing the jumbo buffer allocator
interface and operation.

zero_copy.9: New man page describing the general characteristics of
the zero copy send and receive code, and what an
application author should do to take advantage of the
zero copy functionality.

NOTES: Add entries for ZERO_COPY_SOCKETS, TI_PRIVATE_JUMBOS,
TI_JUMBO_HDRSPLIT, MSIZE, and MCLSHIFT.

conf/files: Add uipc_jumbo.c and uipc_cow.c.

conf/options: Add the 5 options mentioned above.

kern_subr.c: Receive side zero copy implementation. This takes
"disposable" pages attached to an mbuf, gives them to
a user process, and then recycles the user's page.
This is only active when ZERO_COPY_SOCKETS is turned on
and the kern.ipc.zero_copy.receive sysctl variable is
set to 1.

uipc_cow.c: Send side zero copy functions. Takes a page written
by the user and maps it copy on write and assigns it
kernel virtual address space. Removes copy on write
mapping once the buffer has been freed by the network
stack.

uipc_jumbo.c: Jumbo disposable page allocator code. This allocates
(optionally) disposable pages for network drivers that
want to give the user the option of doing zero copy
receive.

uipc_socket.c: Add kern.ipc.zero_copy.{send,receive} sysctls that are
enabled if ZERO_COPY_SOCKETS is turned on.

Add zero copy send support to sosend() -- pages get
mapped into the kernel instead of getting copied if
they meet size and alignment restrictions.

uipc_syscalls.c:Un-staticize some of the sf* functions so that they
can be used elsewhere. (uipc_cow.c)

if_media.c: In the SIOCGIFMEDIA ioctl in ifmedia_ioctl(), avoid
calling malloc() with M_WAITOK. Return an error if
the M_NOWAIT malloc fails.

The ti(4) driver and the wi(4) driver, at least, call
this with a mutex held. This causes witness warnings
for 'ifconfig -a' with a wi(4) or ti(4) board in the
system. (I've only verified for ti(4)).

ip_output.c: Fragment large datagrams so that each segment contains
a multiple of PAGE_SIZE amount of data plus headers.
This allows the receiver to potentially do page
flipping on receives.

if_ti.c: Add zero copy receive support to the ti(4) driver. If
TI_PRIVATE_JUMBOS is not defined, it now uses the
jumbo(9) buffer allocator for jumbo receive buffers.

Add a new character device interface for the ti(4)
driver for the new debugging interface. This allows
(a patched version of) gdb to talk to the Tigon board
and debug the firmware. There are also a few additional
debugging ioctls available through this interface.

Add header splitting support to the ti(4) driver.

Tweak some of the default interrupt coalescing
parameters to more useful defaults.

Add hooks for supporting transmit flow control, but
leave it turned off with a comment describing why it
is turned off.

if_tireg.h: Change the firmware rev to 12.4.11, since we're really
at 12.4.11 plus fixes from 12.4.13.

Add defines needed for debugging.

Remove the ti_stats structure, it is now defined in
sys/tiio.h.

ti_fw.h: 12.4.11 firmware.

ti_fw2.h: 12.4.11 firmware, plus selected fixes from 12.4.13,
and my header splitting patches. Revision 12.4.13
doesn't handle 10/100 negotiation properly. (This
firmware is the same as what was in the tree previously,
with the addition of header splitting support.)

sys/jumbo.h: Jumbo buffer allocator interface.

sys/mbuf.h: Add a new external mbuf type, EXT_DISPOSABLE, to
indicate that the payload buffer can be thrown away /
flipped to a userland process.

socketvar.h: Add prototype for socow_setup.

tiio.h: ioctl interface to the character portion of the ti(4)
driver, plus associated structure/type definitions.

uio.h: Change prototype for uiomoveco() so that we'll know
whether the source page is disposable.

ufs_readwrite.c:Update for new prototype of uiomoveco().

vm_fault.c: In vm_fault(), check to see whether we need to do a page
based copy on write fault.

vm_object.c: Add a new function, vm_object_allocate_wait(). This
does the same thing that vm_object allocate does, except
that it gives the caller the opportunity to specify whether
it should wait on the uma_zalloc() of the object structre.

This allows vm objects to be allocated while holding a
mutex. (Without generating WITNESS warnings.)

vm_object_allocate() is implemented as a call to
vm_object_allocate_wait() with the malloc flag set to
M_WAITOK.

vm_object.h: Add prototype for vm_object_allocate_wait().

vm_page.c: Add page-based copy on write setup, clear and fault
routines.

vm_page.h: Add page based COW function prototypes and variable in
the vm_page structure.

Many thanks to Drew Gallatin, who wrote the zero copy send and receive
code, and to all the other folks who have tested and reviewed this code
over the years.


# 98074 10-Jun-2002 davidc

Add signal.9 and friends.


# 96852 18-May-2002 asmodai

Add description for uma_zcreate().

Submitted by: arr


# 95795 30-Apr-2002 asmodai

Prefix the remaining functions with uma_ as is now the case in UMA.


# 95794 30-Apr-2002 asmodai

zinit() does not exist anymore.


# 95786 30-Apr-2002 asmodai

Add a MLINKS to uma.9 from zone.9.


# 95783 30-Apr-2002 asmodai

Remove MLINKS to zinitna, it does not exist anymore.


# 95782 30-Apr-2002 asmodai

Remove MLINKS to zbootinit. This has been gone for a while now.


# 95741 29-Apr-2002 mike

Add links for bswap16.9, bswap32.9, and bswap64.9.


# 94493 12-Apr-2002 davidc

Add entries for selrecord.9.


# 93680 02-Apr-2002 arr

- Add notes about SX_SYSINIT and MTX_SYSINIT in order to document the
recent additions of these macros.
- Add in a MLINK to create SX_SYSINIT.9 and MTX_SYSINIT.9.


# 93673 02-Apr-2002 jhb

- Update to new suser() API.
- Spell privilege properly.
- Grammar nits.


# 93336 28-Mar-2002 dd

Add a manual page for the mtx_pool_* routines.

PR: 36350
Submitted by: Garrett Rooney <rooneg@electricjellyfish.net>
Reviewed by: dillon


# 92194 12-Mar-2002 archie

Add realloc() and reallocf(), and make free(NULL, ...) acceptable.

Reviewed by: alfred


# 91722 05-Mar-2002 mike

Create a manual to document the new kernel byte order conversion
functions.

Reviewed by: tmm


# 91577 03-Mar-2002 dd

Document cru2x().


# 90500 10-Feb-2002 dd

The routine is dev_depends(); consistently spell it that way.

PR: 34047
Submitted by: Maxime Henrion <mux@sneakerz.org>
Pointy hat to: dd


# 90324 06-Feb-2002 markm

Document entropy device bits.


# 90245 05-Feb-2002 green

Add a manpage for VOP_REVOKE(9).

Sponsored by: DARPA, NAI Labs


# 89806 25-Jan-2002 davidc

Merged all of the lockmgr functions into a single file (lock.9); as well,
some content and layout changes were made.

lock.9 had existed before but was never added to Makefile, so it was
never installed. That is why the duplicate files were created in the
first place.

Reviewed by: ru, alfred


# 89201 10-Jan-2002 ru

get_cyclecounter.9 has been repo-copied to get_cyclecount.9.


# 88951 06-Jan-2002 kbyanc

Document sbuf_trim() and sbuf_vprintf(); add MLINKs.
Clarify that the contents of a caller-supplied buffer are undefined and
should not be examined directly.

Reviewed by: des


# 88891 04-Jan-2002 jhb

Fully catch up to the recent critical section API change. Update the
content of the manpage and document cpu_critical_enter/exit.


# 87512 07-Dec-2001 davidc

Add a man page describing the fuctions directly related to network domains.

Reviewed by: alfred


# 87252 02-Dec-2001 alfred

More kernel vfs docco.

Xref vfs_mount(9) from vfs_mount(9)

Submitted by: Chad David <davidc@acns.ab.ca>
PR: docs/32431


# 87182 02-Dec-2001 alfred

Add manpages describing various vfs and vm APIs.

Submitted by: Chad David <davidc@acns.ab.ca>


# 86917 26-Nov-2001 ru

Bring the ucred(9) manpage in sync with the source.

Specifically, document the crshared() function and
fix the prototype and description of the crcopy()
function.

PR: docs/32275
Submitted by: Chad David <davidc@acns.ab.ca>
Reviewed by: jhb


# 85392 23-Oct-2001 jhb

Document sx_assert(9).


# 84460 04-Oct-2001 bde

Second round of spelling fixes for vm_page_io_finised. The function name
is actually vm_page_io_finish.


# 84458 04-Oct-2001 bde

Removed garbage:
- bus_generic_map_intr.9. This has been undead for more than 3 years
following the changes in rev.1.4 of sys/bus.h.
- CONDSPLASSERT.9, SPLASSERT.9. These have been undead since SMPng.
They were even less useful than most section 9 man pages -- the
interfaces described in them have never been used in the FreeBSD
source tree.


# 84175 30-Sep-2001 des

Token man page for pseudofs(9).


# 82434 27-Aug-2001 rwatson

o Attach vaccess_acl_posix1e.9 to the build.
o Cross-reference vaccess_acl_posix1e.9 from vaccess.9.

Obtained from: TrustedBSD Project


# 82422 27-Aug-2001 rwatson

o Hook up vaccess.9 to the build.

Submitted by: ru


# 82247 23-Aug-2001 jhb

Remove references to asleep/await.


# 82110 21-Aug-2001 alex

Link MULTI_DRIVER_MODULE.9 to DRIVER_MODULE.9


# 81645 14-Aug-2001 jasone

Implement kernel semaphores.

Reviewed by: jhb


# 81599 13-Aug-2001 jasone

Add sx_try_upgrade() and sx_downgrade().

Submitted by: Alexander Kabaev <ak03@gte.com>


# 81400 10-Aug-2001 ru

Add manpage for pgfind(9).

PR: docs/29552
Submitted by: Evan Sarmiento <kaworu@sektor7.ath.cx>


# 81360 09-Aug-2001 tmm

Document zdestroy().

Reviewed by: des


# 81273 08-Aug-2001 ru

s/vm_page_io_finised/vm_page_io_finished/

Submitted by: Chad David <davidc@colnta.acns.ab.ca>


# 81223 07-Aug-2001 jasone

Document sx_try_[sx]lock().


# 80679 30-Jul-2001 alfred

More updates from Chad.

Submitted by: Chad David <davidc@acns.ab.ca>
Reviewed by: sheldonh


# 80434 27-Jul-2001 chris

Add a short man page describing the vfs_unmountall() function.

MFC after: 1 week


# 79846 18-Jul-2001 alfred

Install and provide MLINKS for:
pbuf.9 vm_page_alloc.9 vm_page_copy.9 vm_page_flag.9 vm_page_hold.9
vm_page_insert.9 vm_page_io.9 vm_page_lookup.9 vm_page_protect.9
vm_page_sleep_busy.9 vm_page_wakeup.9 vm_page_wire.9
vm_page_zero_fill.9 vm_set_page_size.9


# 79783 16-Jul-2001 ru

Manpage for pfind() and zpfind().

Submitted by: Evan Sarmiento <kaworu@sektor7.ath.cx>


# 79727 14-Jul-2001 schweikh

Removed whitespace at end-of-line; no content changes. I simply did
cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//'

BTW, what editors are the culprits? I'm using vim and it shows
me whitespace at EOL in troff files with a thick blue block...

Reviewed by: Silence from cvs diff -b
MFC after: 7 days


# 79684 13-Jul-2001 ru

Add a few more manpages from Chad.
Fold major.9, minor.9, umajor.9, and uminor.9 into a single device_ids.9.


# 79515 10-Jul-2001 alfred

Sort MAN= section.


# 79513 10-Jul-2001 alfred

Install:
cdevsw_add.9 cdevsw_remove.9 devsw.9
major.9 minor.9 umajor.9 uminor.9 vn_isdisk.9


# 79507 10-Jul-2001 alfred

Link in new manpages:
BUF_LOCK.9 BUF_LOCKFREE.9 BUF_LOCKINIT.9
BUF_REFCNT.9 BUF_TIMELOCK.9 BUF_UNLOCK.9
lockcount.9 lockdestroy.9 lockmgr.9 lockmgr_printinfo.9 lockstatus.9


# 79447 09-Jul-2001 alfred

Link in manpages for vfs_busy, vfs_mount, vfs_unbusy, and vinvalbuf.


# 78922 28-Jun-2001 jhb

Add a new manpage to document the CTRx macros used when adding new KTR
tracepoints to kernel code.


# 77380 29-May-2001 dd

Link make_dev.9 to make_dev_alias.9 and depends_dev.9.


# 77361 28-May-2001 dd

Remove obsolete DEVFS manual pages. The routines they describe don't
exist in the new (phk's) DEVFS.

Approved by: phk


# 76285 04-May-2001 dd

Add printf.9, and add links to tprintf.9 and uprintf.9.


# 76101 28-Apr-2001 alex

Add SYSCALL_MODULE.9, a manpage for the SYSCALL_MODULE wrapper macro
for syscall klds.

Some text of this manpage is based on the comments in the example
syscall module written by Assar Westerlund.

Reviewed by: ru


# 75028 30-Mar-2001 jhb

Correct the MLINKS for mutex.9 to reflect the API change and add a new
MLINK for mtx_initialized.

Reminded by: rwatson


# 74910 28-Mar-2001 jhb

Add a manpage for the critical_enter/exit() functions.


# 74856 27-Mar-2001 ru

MAN[1-9] -> MAN.


# 74110 11-Mar-2001 alex

Add a manpage for the DEV_MODULE kernel macro.


# 74104 11-Mar-2001 alex

Add MODULE_DEPEND.9 and MODULE_VERSION.9


# 74084 10-Mar-2001 alex

Add DEVICE_IDENTIFY.9


# 74066 10-Mar-2001 bp

Add documentation for mchain API.

Reviewed by: asmodai, ru (mbchain.9)


# 74036 09-Mar-2001 alex

Add module.9 and DECLARE_MODULE.9


# 74012 09-Mar-2001 jhb

Document the ithread_* API used to manage interrupt threads and their
list of handlers.


# 73798 05-Mar-2001 jhb

Adjust swi.9 MLINKS to catch up to the new swi API.


# 73782 05-Mar-2001 jasone

Implement shared/exclusive locks.

Reviewed by: bmilekic, jake, jhb


# 73377 03-Mar-2001 markm

Extra MLINKS to reflect expansion of BUS_SETUP_INTR(9) manpage.


# 73310 02-Mar-2001 imp

Add link for resource_query_unit, now documented in the
resource_query_string man page.


# 73269 01-Mar-2001 asmodai

Hook Warner's resource_* manpages to the build.
This includes appropriate MLINKS for the other functions contained
within them.


# 72087 06-Feb-2001 bp

Add man page for VOP_GETVOBJECT, VOP_CREATEVOBJECT and VOP_DESTROYVOBJECT
operations.

Reviewed by: sheldonh


# 72079 06-Feb-2001 asmodai

Add vcount.9 / count_dev.9.
Touched up a bit and added some consistency to the text by your's truly.

PR: 23745
Submitted by: Andrew Stevenson <andrew@ugh.net.au>


# 71928 02-Feb-2001 bde

Removed vestiges of vop_mmap.


# 71723 27-Jan-2001 des

Add MLINKS for sbuf_clear() and sbuf_overflowed().


# 71714 27-Jan-2001 des

Add a man page for the zone allocator.


# 71444 23-Jan-2001 jhb

- Activate runqueue.9, scheduler.9, and sleepqueue.9 along with appropriate
MLINKS.
- Update MLINKS for mi_switch.9.


# 71320 21-Jan-2001 jasone

Remove MUTEX_DECLARE() and MTX_COLD. Instead, postpone full mutex
initialization until after malloc() is safe to call, then iterate through
all mutexes and complete their initialization.

This change is necessary in order to avoid some circular bootstrapping
dependencies.


# 71088 15-Jan-2001 jasone

Implement condition variables.


# 70067 15-Dec-2000 jhb

Catch up to the changes to the kthread API.


# 69992 13-Dec-2000 des

Add sbuf(9) man page with links to API function names.

Reviewed by: ru


# 69018 22-Nov-2000 alfred

Install DELAY(9).


# 69010 21-Nov-2000 markm

Add new man page to the mix.


# 69009 21-Nov-2000 markm

Whitespace-only change. Tidy up, alphabetise and wrap.


# 68800 15-Nov-2000 alfred

install/build accf_* manpages


# 68687 13-Nov-2000 jhb

Beef up the description of the kernel thread API.

Reviewed by: sheldonh, jasone


# 68686 13-Nov-2000 jhb

Describe the new software interrupt thread functionality.

Reviewed by: sheldonh, jasone


# 68685 13-Nov-2000 jhb

Add a manpage to document the atomic operations including a quick treatment
of memory barriers and the newish atomic variants that include them.

Reviewed by: sheldonh


# 67934 30-Oct-2000 ru

Add pfil.9 manpage to build after a repository copy.


# 67667 26-Oct-2000 jhb

Add in MLINKS for all of the various mutex functions to mutex.9


# 67664 26-Oct-2000 nik

Add a prototype mbuf.9 man page. Probably needs work, but it's a good
start.

PR: docs/22053
Submitted by: Yar Tikhiy <yar@comp.chem.msu.su>


# 67115 14-Oct-2000 markm

Add a man page for part of the PRNG API.


# 66774 06-Oct-2000 brian

Index: Makefile
===================================================================
RCS file: /home/ncvs/src/share/man/man9/Makefile,v
retrieving revision 1.75
diff -u -r1.75 Makefile
--- Makefile 2000/09/17 12:15:12 1.75
+++ Makefile 2000/10/06 23:24:26
@@ -69,6 +69,8 @@
MLINKS+=make_dev.9 destroy_dev.9
MLINKS+=malloc.9 FREE.9 malloc.9 MALLOC.9 malloc.9 free.9
MLINKS+=mi_switch.9 cpu_switch.9
+MLINKS+=namei.9 NDINIT.9
+MLINKS+=namei.9 NDFREE.9
MLINKS+=posix4.9 p1003_1b.9
MLINKS+=psignal.9 gsignal.9 psignal.9 pgsignal.9
MLINKS+=rtalloc.9 rtalloc1.9 rtalloc.9 rtalloc_ign.9


# 65977 17-Sep-2000 alex

Add DRIVER_MODULE.9, the manual page describing the kernel driver
declaration macro.
Thanks to Sheldon for a big patch with language/mdoc fixes.

Reviewed by: asmodai, sheldonh


# 65709 10-Sep-2000 jake

Add scant documentation for msleep.


# 65557 06-Sep-2000 jasone

Major update to the way synchronization is done in the kernel. Highlights
include:

* Mutual exclusion is used instead of spl*(). See mutex(9). (Note: The
alpha port is still in transition and currently uses both.)

* Per-CPU idle processes.

* Interrupts are run in their own separate kernel threads and can be
preempted (i386 only).

Partially contributed by: BSDi (BSD/OS)
Submissions by (at least): cp, dfr, dillon, grog, jake, jhb, sheldonh


# 65174 28-Aug-2000 dfr

Document kobj_class_compile_static().


# 64725 16-Aug-2000 markm

Mention more functions in the headers so whatis(1) can find them, and
create links to functions so added found.


# 63212 15-Jul-2000 abial

These patches implement dynamic sysctls. It's possible now to add
and remove sysctl oids at will during runtime - they don't rely on
linker sets. Also, the node oids can be referenced by more than
one kernel user, which means that it's possible to create partially
overlapping trees.

Add sysctl contexts to help programmers manage multiple dynamic
oids in convenient way.

Please see the manpages for detailed discussion, and example module
for typical use.

This work is based on ideas and code snippets coming from many
people, among them: Arun Sharma, Jonathan Lemon, Doug Rabson,
Brian Feldman, Kelly Yancey, Poul-Henning Kamp and others. I'd like
to specially thank Brian Feldman for detailed review and style
fixes.

PR: kern/16928
Reviewed by: dfr, green, phk


# 62953 11-Jul-2000 asmodai

Install accept_filter.9

Forgotten by: alfred


# 61431 08-Jun-2000 alex

Add bus_alloc_resource.9 and bus_release_resource.9.
bus_release_resource.9 contains a paragraph obtained from a mail
by Warner Losh <imp@FreeBSD.org> to myself.

Reviewed by: asmodai, hoek; in parts by msmith, mdodd and imp


# 61049 28-May-2000 dfr

Add documentation for taskqueue apis.


# 59092 08-Apr-2000 dfr

Add manpage for kernel object system.


# 58929 02-Apr-2000 asmodai

Add and install BUS_SETUP_INTR.9.
This effectively replaces BUS_CREATE_INTR.9 and BUS_CONNECT_INTR.9.

Reviewed by: n_hibma


# 58925 02-Apr-2000 asmodai

Get rid of the manpages for BUS_CREATE_INTR() and BUS_CONNECT_INTR().
These got replaced by BUS_SETUP_INTR().

This once again illustrates an API change without informing -doc, so
that these sort post cleanup actions could've been avoided.

And then people wonder why the docs suck so much at times.

Reviewed by: peter


# 58405 20-Mar-2000 bde

Actually install KASSERT.9.


# 58291 19-Mar-2000 asmodai

Add the manpage for CONDSPLASSERT().
This was based upon the manpage written by jmb for SPLASSERT().


# 58249 18-Mar-2000 asmodai

After about two months I am the first to notice that SPLASERT.9 never
got installed.

Also, correct the copyright to a more realistic date (1996->2000).
Fix some wordings and omissions.


# 55549 07-Jan-2000 phantom

Add new manpages for:
microtime(9)
nanotime(9)
getmicrotime(9)
getnanotime(9)
microuptime(9)
nanouptime(9)
getmicrouptime(9)
getnanouptime(9)
tvtohz(9)

Based on PR: docs/15889
Submitted by: Kelly Yancey <kbyanc@posi.net>


# 55430 05-Jan-2000 rwatson

Man pages for the VFS extended attribute and access control list vnops.

Reviewed by: eivind


# 55046 23-Dec-1999 bde

"Fixed" assorted bitrot. remove_dev() was renamed to destroy_dev().
VOP_ABORTOP() went away. at_shutdown() was replaced by undocumented
event handling. Rename remove_dev() here too, and remove the dead
and dead wrong man pages.


# 54033 02-Dec-1999 n_hibma

Add the device_get_children(9) man page.


# 51664 25-Sep-1999 chris

Document the make_dev(9) and remove_dev(9) facilities.
remove_dev(9) is created as a link to the existing make_dev(9) page.

Reviewed by: phk


# 51652 25-Sep-1999 chris

Document the devtoname(9) kernel interface.


# 51631 24-Sep-1999 dillon

More locking clarifications. Add skeleton manual page for VOP_LEASE


# 51203 12-Sep-1999 dfr

Add new manpage device_set_flags.9 and add links for
device_set_desc_copy.9 and device_get_flags.9.


# 51157 11-Sep-1999 chris

Add a link for uiomove.9 to uio.9


# 51140 10-Sep-1999 alfred

Document VFS changes:

VFS_CHECKEXP.9, now used to check export credentials
VFS_FHTOVP.9, only used for filehandle to vnode, no access checks are done.
VFS.9, inform people of the vfs_std* functions available to avoid
ugly casts to eopnotsup and making of dummy functions to return 0.


# 50891 04-Sep-1999 phantom

Replace stale references to device_add_child_after(9) with
device_child_add_ordered(9)

PR: 13210
Submitted by: Alexey Zelkin <phantom@cris.net>
Reviewed by: mpp
Forgotten by: dfr


# 50476 27-Aug-1999 peter

$Id$ -> $FreeBSD$


# 48112 22-Jun-1999 n_hibma

Add man page for device_quiet and friends


# 44834 17-Mar-1999 ghelmer

Document the flags and p parameters to VOP_LOCK and VOP_UNLOCK. Also,
at Doug Rabson's suggestion, add vn_lock(9) as an alternative name for
this manpage and note its calling convention.

PR: docs/9338


# 44525 06-Mar-1999 bde

Removed old scsi section 9 man pages. Only cd.9 has been converted to
cam. scsiconf.9, sd.9, and st.9 can now be found in the Attic.

Reviewed by: ken


# 44524 06-Mar-1999 bde

Fixed bitrot in synopsis (devfs_link was renamed to devfs_makelink).
Didn't fix bitrot in this page's name; just install a link.


# 43432 30-Jan-1999 nsouch

ppbconf.9 removed


# 42424 09-Jan-1999 obrien

Add MLINKS for devstat kernel interfaces.


# 42016 22-Dec-1998 dillon

Add manual page describing kernel buffer management system (i.e.
kern/vfs_bio.c).


# 41977 21-Dec-1998 dillon

Add manual page for experimental kernel asleep() and await() routines


# 40686 27-Oct-1998 nsouch

microseq.9: general purpose parallel microcode for ppbus(4)
ppbconf.9: general info about ppbus(4) structures


# 39697 27-Sep-1998 eivind

Add a manpage for namei().

Markup changes and review by: dfr


# 39258 15-Sep-1998 gibbs

Add devstat.9.


# 38786 03-Sep-1998 dfr

Add manpages for the new device framework.


# 34925 28-Mar-1998 dufault

Finish _POSIX_PRIORITY_SCHEDULING. Needs P1003_1B and
_KPOSIX_PRIORITY_SCHEDULING options to work. Changes:

Change all "posix4" to "p1003_1b". Misnamed files are left
as "posix4" until I'm told if I can simply delete them and add
new ones;

Add _POSIX_PRIORITY_SCHEDULING system calls for FreeBSD and Linux;

Add man pages for _POSIX_PRIORITY_SCHEDULING system calls;

Add options to LINT;

Minor fixes to P1003_1B code during testing.


# 34030 04-Mar-1998 dufault

Reviewed by: msmith, bde long ago
POSIX.4 headers and sysctl variables. Nothing should change
unless POSIX4 is defined or _POSIX_VERSION is set to 199309.


# 32576 16-Jan-1998 bde

Removed references to the man pages for the obsolete interfaces
VOP_BLKATOFF, VOP_SEEK, VOP_SELECT, VOP_TRUNCATE, VOP_UPDATE,
VOP_VALLOC and VOP_VFREE.


# 32156 01-Jan-1998 bde

Sorted lists. Use the same style as most Makefiles for `MLINKS+=' lines.


# 32155 01-Jan-1998 bde

Install devfs_remove_dev.9 and suser.9.


# 28121 12-Aug-1997 eivind

Activate the bios.9 manpage.

PR: 4215


# 24737 09-Apr-1997 mpp

Document wakeup_one().


# 24126 22-Mar-1997 mpp

Add malloc(9) to document the kernel malloc() and free() routines.

Obtained from: NetBSD w/changes to reflect current FreeBSD headers
and diagnostic messages.


# 24122 22-Mar-1997 mpp

Add vslock(9) to document the vslock() and vsunlock() kernel functions.

Obtained from: NetBSD


# 24120 22-Mar-1997 mpp

Add kernacc(9) that documents the kernacc() and useracc() kernel
functions.

Obtained from: NetBSD (renamed from access.9)


# 24119 22-Mar-1997 mpp

Add physio(9).

Obtained from: NetBSD w/minor FreeBSD changes


# 24118 22-Mar-1997 mpp

Add mi_switch.9. It documents the kernel mi_switch() and cpu_switch()
context switching functions.

Obtained from: NetBSD (renamed from ctxsw.9)


# 24116 22-Mar-1997 mpp

Add resettodr(9).

Obtained from: NetBSD


# 24115 22-Mar-1997 mpp

Add inittodr(9) to document how the system clock is initialized.
Obtained from NetBSD and then modified to reflect how things work
in FreeBSD, along with some minor changes to make a few points
clearer.


# 24114 22-Mar-1997 mpp

Add time(9) to document the kernel time variables. Obtained from
NetBSD and then modified by me to reflect some FreeBSD specific
things and to clarify some other pointed based on some old mail
from Bruce Evans about this man page.


# 23353 03-Mar-1997 dfr

This is the current draft of my filesystem manpages. Some files are
incomplete and some are just placeholders but I wanted to try to get
something at least into 2.2 on the grounds that what I have is a lot
better than nothing. I also wanted to commit something which documents
the interfaces in 2.2 before I start updating the documentation for 3.0.

This is a definite 2.2 candidate and is also relavent to 2.1 if people
still care about that branch.


# 22986 22-Feb-1997 peter

Revert $FreeBSD$ back to $Id$


# 22708 14-Feb-1997 mpp

Add boot(9) Obtained from NetBSD w/modifications by me.


# 22706 14-Feb-1997 mpp

Add MD5(9).

Obtained from: OpenBSD


# 22652 13-Feb-1997 mpp

Add psignal(9).

Obtained from: NetBSD


# 22650 13-Feb-1997 mpp

Add panic(9).

Obtained from: NetBSD


# 22497 09-Feb-1997 joerg

Various man pages describing the internals of the SCSI subsystem.

Submitted by: John-Mark Gurney <gurney_j@resnet.uoregon.edu>


# 22206 02-Feb-1997 joerg

Add a man page for the uio handling, after all the recent ramblings in
the hackers list.

Please correct me where i'm wrong.


# 21673 14-Jan-1997 jkh

Make the long-awaited change from $Id$ to $FreeBSD$

This will make a number of things easier in the future, as well as (finally!)
avoiding the Id-smashing problem which has plagued developers for so long.

Boy, I'm glad we're not using sup anymore. This update would have been
insane otherwise.


# 20603 17-Dec-1996 wollman

Create a new manual page describing how network interfaces and
addresses are glued together with the generic networking code.


# 18816 08-Oct-1996 wollman

Add an rtentry(9) page to describe the structure of a routing-table
entry and the metrics and flags which pertain thereto.


# 18810 08-Oct-1996 wollman

Document what I believe to be the interface of rtalloc*.


# 18690 04-Oct-1996 joerg

Reviewed by:
Submitted by:
Obtained from:


# 17659 19-Aug-1996 julian

Add man-pages for at_exit, at_fork and at_shutdown()
so that people can look and comment.
I'll add the at_fork and at_exit immediatly, but I'll
add teh at_shutdown later as it's more extensive
and I desire people's comments..

julian


# 15266 15-Apr-1996 mpp

Add man pages for the copy*, fetch*, and store* families of
kernel functions.

Also added timeout(9) to the makefile.

Reviewed by: joerg
Obtained from: NetBSD


# 15021 03-Apr-1996 joerg

Populate this. :)

Add a man page for tsleep()/wakeup().


# 14991 02-Apr-1996 scrappy

Makefile: added devfs_add_devswf.9, removed devfs_add_devsw.9

devfs_link.9: modified man page to reflect source code

devfs_add_devsw.9: replaced by devfs_add_devswf.9

devfs_add_devswf.9: proper function for adding devices to DEVFS


# 13153 01-Jan-1996 bde

Added new devfs manpages here too.


# 12829 14-Dec-1995 bde

Fixed manual section number.


# 12823 14-Dec-1995 phk

Add a slightly edited version of the style document.


# 12821 14-Dec-1995 phk

Add a section 9 about the kernel to out man pages.

Please help fill this out !