1 files changed, 3 insertions, 112 deletions
diff --git a/src/lib/libc/include/namespace.h b/src/lib/libc/include/namespace.h
index 60766afc0b..79692af0bc 100644
--- a/src/lib/libc/include/namespace.h
+++ b/src/lib/libc/include/namespace.h
@@ -1,4 +1,4 @@
-/*      $OpenBSD: namespace.h,v 1.12 2018/01/18 08:23:44 guenther Exp $ */
+/*      $OpenBSD: namespace.h,v 1.13 2019/05/13 20:00:32 guenther Exp $ */
 #ifndef _LIBC_NAMESPACE_H_
 #define _LIBC_NAMESPACE_H_
@@ -20,117 +20,8 @@
 */
 /*
- * The goal: calls from inside libc to other libc functions should be via
+ * For explanations of how to use these, see README
- * identifiers that are of hidden visibility and--to avoid confusion--are
+ * For explanations of why we use them and how they work, see DETAILS
- * in the reserved namespace.  By doing this these calls are protected
- * from overriding by applications and on many platforms can avoid creation
- * or use of GOT or PLT entries.  I've chosen a prefix of underbar-C-underbar
- * ("_libc_") for this.  These will not be declared directly; instead, the
- * gcc "asm labels" extension will be used rename the function.
- *
- * For syscalls which are cancellation points, such as wait4(), there
- * are identifiers that do not provide cancellation:
- *      _libc_wait4             hidden alias, for use internal to libc only
- *      _thread_sys_wait4       global name, for use outside libc only
- * ...and identifiers that do provide cancellation:
- *      wait4                   weak alias, for general use
- *      _libc_wait4_cancel      hidden alias, for use internal to libc only
- * Inside libc, the bare name ("wait4") binds to the version *without*
- * cancellation; the few times where cancellation is desired it can be
- * obtained by calling CANCEL(x) instead of just x.
- *
- * Some other calls need to be wrapped for reasons other than cancellation,
- * such as to provide functionality beyond the underlying syscall (e.g.,
- * sigaction).  For these, there are identifiers for the raw call, without
- * the wrapping:
- *      _libc_sigaction         hidden alias, for use internal to libc only
- *      _thread_sys_sigaction   global name, for use outside libc only
- * ...and identifiers that do provide the libc wrapping:
- *      sigaction               weak alias, for general use
- *      _libc_sigaction_wrap    hidden alias, for use internal to libc only
- * Inside libc, the bare name ("sigaction") binds to the wrapper; when the
- * raw version is necessary it can be obtained by calling HIDDEN(x) instead of
- * just x.
- *
- * For syscalls which are not cancellation points, such as getpid(),
- * the identifiers are just:
- *      _libc_getpid            hidden alias, for use internal to libc only
- *      _thread_sys_getpid      global name, for use outside libc only
- *      getpid                  weak alias, for use outside libc only
- *
- * By using gcc's "asm label" extension, we can usually avoid having
- * to type those prefixes in the .h and .c files.  However, for those
- * cases where a non-default binding is necessary we can use these macros
- * to get the desired identifier:
- *
- *   CANCEL(x)
- *      This expands to the internal, hidden name of a cancellation
- *      wrapper: _libc_x_cancel.  ex: CANCEL(fsync)(fd)
- *
- *   WRAP(x)
- *      This expands to the internal, hidden name of a non-cancellation
- *      wrapper: _libc_x_wrap.  ex: WRAP(sigprocmask)(set)
- *
- *
- * In order to actually set up the desired asm labels, we use these in
- * the internal .h files:
- *   PROTO_NORMAL(x)            Symbols used both internally and externally
- *      This makes gcc convert use of x to use _libc_x instead
- *      ex: PROTO_NORMAL(getpid)
- *
- *   PROTO_STD_DEPRECATED(x)    Standard C symbols that we don't want to use
- *      This just marks the symbol as deprecated, with no renaming.
- *      ex: PROTO_STD_DEPRECATED(strcpy)
- *
- *   PROTO_DEPRECATED(x)        Symbols not in ISO C that we don't want to use
- *      This marks the symbol as both weak and deprecated, with no renaming
- *      ex: PROTO_DEPRECATED(creat)
- *
- *   PROTO_CANCEL(x)            Functions that have cancellation wrappers
- *      Like PROTO_NORMAL(x), but also declares _libc_x_cancel
- *      ex: PROTO_CANCEL(wait4)
- *
- *   PROTO_WRAP(x)              Functions that have wrappers for other reasons
- *      Like PROTO_NORMAL(x), but also declares _libc_x_wrap.  Internal
- *      calls that want the wrapper's processing should invoke WRAP(x)(...)
- *      ex: PROTO_WRAP(sigaction)
- *
- *
- * Finally, to create the expected aliases, we use these in the .c files
- * where the definitions are:
- *   DEF_STRONG(x)              Symbols reserved to or specified by ISO C
- *      This defines x as a strong alias for _libc_x; this must only
- *      be used for symbols that are reserved by the C standard
- *      (or reserved in the external identifier namespace).
- *      Matches with PROTO_NORMAL()
- *      ex: DEF_STRONG(fopen)
- *
- *   DEF_WEAK(x)                Symbols used internally and not in ISO C
- *      This defines x as a weak alias for _libc_x
- *      Matches with PROTO_NORMAL()
- *      ex: DEF_WEAK(lseek)
- *
- *   DEF_CANCEL(x)              Symbols that have a cancellation wrapper
- *      This defines x as a weak alias for _libc_x_cancel.
- *      Matches with PROTO_CANCEL()
- *      ex: DEF_CANCEL(read)
- *
- *   DEF_WRAP(x)
- *      This defines x as a weak alias for _libc_x_wrap.
- *      Matches with PROTO_WRAP()
- *      ex: DEF_WRAP(sigaction)
- *
- *   DEF_SYS(x)
- *      This defines _thread_sys_x as a strong alias for _libc_x.  This should
- *      only be needed for syscalls that have C instead of asm stubs.
- *      Matches with PROTO_NORMAL(), PROTO_CANCEL(), or PROTO_WRAP()
- *      ex: DEF_SYS(pread)
- *
- *   MAKE_CLONE(dst, src)       Symbols that are exact clones of other symbols
- *      This declares _libc_dst as being the same type as dst, and makes
- *      _libc_dst a strong, hidden alias for _libc_src.  You still need to
- *      DEF_STRONG(dst) or DEF_WEAK(dst) to alias dst itself
- *      ex: MAKE_CLONE(SHA224Pad, SHA256Pad)
 */
 #include <sys/cdefs.h>  /* for __dso_hidden and __{weak,strong}_alias */

diff --git a/src/lib/libc/include/namespace.h b/src/lib/libc/include/namespace.h index 60766afc0b..79692af0bc 100644 --- a/src/lib/libc/include/namespace.h +++ b/src/lib/libc/include/namespace.h
@@ -1,4 +1,4 @@
1	/* $OpenBSD: namespace.h,v 1.12 2018/01/18 08:23:44 guenther Exp $ */	1	/* $OpenBSD: namespace.h,v 1.13 2019/05/13 20:00:32 guenther Exp $ */
2		2
3	#ifndef _LIBC_NAMESPACE_H_	3	#ifndef _LIBC_NAMESPACE_H_
4	#define _LIBC_NAMESPACE_H_	4	#define _LIBC_NAMESPACE_H_
@@ -20,117 +20,8 @@
20	*/	20	*/
21		21
22	/*	22	/*
23	* The goal: calls from inside libc to other libc functions should be via	23	* For explanations of how to use these, see README
24	* identifiers that are of hidden visibility and--to avoid confusion--are	24	* For explanations of why we use them and how they work, see DETAILS
25	* in the reserved namespace. By doing this these calls are protected
26	* from overriding by applications and on many platforms can avoid creation
27	* or use of GOT or PLT entries. I've chosen a prefix of underbar-C-underbar
28	* ("_libc_") for this. These will not be declared directly; instead, the
29	* gcc "asm labels" extension will be used rename the function.
30	*
31	* For syscalls which are cancellation points, such as wait4(), there
32	* are identifiers that do not provide cancellation:
33	* _libc_wait4 hidden alias, for use internal to libc only
34	* _thread_sys_wait4 global name, for use outside libc only
35	* ...and identifiers that do provide cancellation:
36	* wait4 weak alias, for general use
37	* _libc_wait4_cancel hidden alias, for use internal to libc only
38	* Inside libc, the bare name ("wait4") binds to the version without
39	* cancellation; the few times where cancellation is desired it can be
40	* obtained by calling CANCEL(x) instead of just x.
41	*
42	* Some other calls need to be wrapped for reasons other than cancellation,
43	* such as to provide functionality beyond the underlying syscall (e.g.,
44	* sigaction). For these, there are identifiers for the raw call, without
45	* the wrapping:
46	* _libc_sigaction hidden alias, for use internal to libc only
47	* _thread_sys_sigaction global name, for use outside libc only
48	* ...and identifiers that do provide the libc wrapping:
49	* sigaction weak alias, for general use
50	* _libc_sigaction_wrap hidden alias, for use internal to libc only
51	* Inside libc, the bare name ("sigaction") binds to the wrapper; when the
52	* raw version is necessary it can be obtained by calling HIDDEN(x) instead of
53	* just x.
54	*
55	* For syscalls which are not cancellation points, such as getpid(),
56	* the identifiers are just:
57	* _libc_getpid hidden alias, for use internal to libc only
58	* _thread_sys_getpid global name, for use outside libc only
59	* getpid weak alias, for use outside libc only
60	*
61	* By using gcc's "asm label" extension, we can usually avoid having
62	* to type those prefixes in the .h and .c files. However, for those
63	* cases where a non-default binding is necessary we can use these macros
64	* to get the desired identifier:
65	*
66	* CANCEL(x)
67	* This expands to the internal, hidden name of a cancellation
68	* wrapper: _libc_x_cancel. ex: CANCEL(fsync)(fd)
69	*
70	* WRAP(x)
71	* This expands to the internal, hidden name of a non-cancellation
72	* wrapper: _libc_x_wrap. ex: WRAP(sigprocmask)(set)
73	*
74	*
75	* In order to actually set up the desired asm labels, we use these in
76	* the internal .h files:
77	* PROTO_NORMAL(x) Symbols used both internally and externally
78	* This makes gcc convert use of x to use _libc_x instead
79	* ex: PROTO_NORMAL(getpid)
80	*
81	* PROTO_STD_DEPRECATED(x) Standard C symbols that we don't want to use
82	* This just marks the symbol as deprecated, with no renaming.
83	* ex: PROTO_STD_DEPRECATED(strcpy)
84	*
85	* PROTO_DEPRECATED(x) Symbols not in ISO C that we don't want to use
86	* This marks the symbol as both weak and deprecated, with no renaming
87	* ex: PROTO_DEPRECATED(creat)
88	*
89	* PROTO_CANCEL(x) Functions that have cancellation wrappers
90	* Like PROTO_NORMAL(x), but also declares _libc_x_cancel
91	* ex: PROTO_CANCEL(wait4)
92	*
93	* PROTO_WRAP(x) Functions that have wrappers for other reasons
94	* Like PROTO_NORMAL(x), but also declares _libc_x_wrap. Internal
95	* calls that want the wrapper's processing should invoke WRAP(x)(...)
96	* ex: PROTO_WRAP(sigaction)
97	*
98	*
99	* Finally, to create the expected aliases, we use these in the .c files
100	* where the definitions are:
101	* DEF_STRONG(x) Symbols reserved to or specified by ISO C
102	* This defines x as a strong alias for _libc_x; this must only
103	* be used for symbols that are reserved by the C standard
104	* (or reserved in the external identifier namespace).
105	* Matches with PROTO_NORMAL()
106	* ex: DEF_STRONG(fopen)
107	*
108	* DEF_WEAK(x) Symbols used internally and not in ISO C
109	* This defines x as a weak alias for _libc_x
110	* Matches with PROTO_NORMAL()
111	* ex: DEF_WEAK(lseek)
112	*
113	* DEF_CANCEL(x) Symbols that have a cancellation wrapper
114	* This defines x as a weak alias for _libc_x_cancel.
115	* Matches with PROTO_CANCEL()
116	* ex: DEF_CANCEL(read)
117	*
118	* DEF_WRAP(x)
119	* This defines x as a weak alias for _libc_x_wrap.
120	* Matches with PROTO_WRAP()
121	* ex: DEF_WRAP(sigaction)
122	*
123	* DEF_SYS(x)
124	* This defines _thread_sys_x as a strong alias for _libc_x. This should
125	* only be needed for syscalls that have C instead of asm stubs.
126	* Matches with PROTO_NORMAL(), PROTO_CANCEL(), or PROTO_WRAP()
127	* ex: DEF_SYS(pread)
128	*
129	* MAKE_CLONE(dst, src) Symbols that are exact clones of other symbols
130	* This declares _libc_dst as being the same type as dst, and makes
131	* _libc_dst a strong, hidden alias for _libc_src. You still need to
132	* DEF_STRONG(dst) or DEF_WEAK(dst) to alias dst itself
133	* ex: MAKE_CLONE(SHA224Pad, SHA256Pad)
134	*/	25	*/
135		26
136	#include <sys/cdefs.h> /* for __dso_hidden and __{weak,strong}_alias */	27	#include <sys/cdefs.h> /* for __dso_hidden and __{weak,strong}_alias */