Aren
/
NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add RCS Id, sort sections.

This commit is contained in:
wiz 2019-08-28 22:11:25 +00:00
parent 0e4f0bc520
commit dd0e934ad9
1 changed files with 19 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
share/man/man9/thmap.9
View File

@ -1,3 +1,4 @@
.\" $NetBSD: thmap.9,v 1.2 2019/08/28 22:11:25 wiz Exp $
.\"
.\" Copyright (c) 2018 Mindaugas Rasiukevicius <rmind at noxt eu>
.\" All rights reserved.
@ -195,24 +196,6 @@ are
void (*free)(uintptr_t addr, size_t len);
.Ed
.\" -----
.Sh CAVEATS
The implementation uses pointer tagging and atomic operations.
This requires the base address and the allocations to provide at least word
alignment.
.Pp
While the
.Dv NULL
values may be inserted,
.Fn thmap_get
and
.Fn thmap_del
cannot indicate whether the key was not found or a key with a
.Dv NULL
value was found.
If the caller needs to indicate an "empty" value, it can use a
special pointer value, such as
.Li (void *)(uintptr_t)0x1 .
.\" -----
.Sh EXAMPLES
Simple case backed by
.Xr malloc 3 ,
@ -234,3 +217,21 @@ which could be used in multi-threaded environment:
.\" -----
.Sh AUTHORS
.An Mindaugas Rasiukevicius Aq Mt rmind@noxt.eu
.Sh CAVEATS
The implementation uses pointer tagging and atomic operations.
This requires the base address and the allocations to provide at least word
alignment.
.Pp
While the
.Dv NULL
values may be inserted,
.Fn thmap_get
and
.Fn thmap_del
cannot indicate whether the key was not found or a key with a
.Dv NULL
value was found.
If the caller needs to indicate an "empty" value, it can use a
special pointer value, such as
.Li (void *)(uintptr_t)0x1 .
.\" -----