Wed Aug 28 22:11:25 2019 UTC ()

Add RCS Id, sort sections.


(wiz)

diff -r1.1 -r1.2 src/share/man/man9/thmap.9

--- src/share/man/man9/thmap.9 2019/08/28 20:08:11	1.1
+++ src/share/man/man9/thmap.9 2019/08/28 22:11:25	1.2

 @@ -1,13 +1,14 @@
 .\" $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.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
 .\" are met:
 .\" 1. Redistributions of source code must retain the above copyright
 .\"    notice, this list of conditions and the following disclaimer.
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
 .\"
 @@ -185,52 +186,52 @@ Return 0 on success and \-1 on failure (
 Get the root node address.
 The returned address will be relative to the base address.
 .El
 .\" ---
 .Pp
 Members of
 .Vt thmap_ops_t
 are
 .Bd -literal
         uintptr_t (*alloc)(size_t len);
         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 ,
 which could be used in multi-threaded environment:
 .Bd -literal
 	thmap_t *kvmap;
 	struct obj *obj;
 	kvmap = thmap_create(0, NULL);
 	assert(kvmap != NULL);
 	...
 	obj = obj_create();
 	thmap_put(kvmap, "test", sizeof("test") - 1, obj);
 	...
 	obj = thmap_get(kvmap, "test", sizeof("test") - 1);
 	...
 	thmap_destroy(kvmap);
 .Ed
 .\" -----
 .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 .
 .\" -----