[PATCH] dlopen.3: ATTRIBUTES: Note functions that are thread-safe

[PATCH] dlopen.3: ATTRIBUTES: Note functions that are thread-safe

[Zeng Linggang]

After research, We think
* dlopen(),
* dlerror(),
* dlsym(),
* dlclose(),
* dladdr(),
* dlvsym()
are thread-safe. But, there are not
markings of them in glibc document.

Signed-off-by: Zeng Linggang <zenglg.jy-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
---
 man3/dlopen.3 | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/man3/dlopen.3 b/man3/dlopen.3
index cb5dbf9..53d3f16 100644
--- a/man3/dlopen.3
+++ b/man3/dlopen.3
@@ -396,6 +396,25 @@ provided by glibc since version 2.1,
 does the same as
 .BR dlsym ()
 but takes a version string as an additional argument.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbw29 lb lb
+l l l.
+Interface	Attribute	Value
+T{
+.BR dlopen (),
+.BR dlerror (),
+.BR dlsym (),
+.br
+.BR dlclose (),
+.BR dladdr (),
+.BR dlvsym ()
+T}	Thread safety	MT-Safe
+.TE
+
 .SH CONFORMING TO
 POSIX.1-2001 describes
 .BR dlclose (),
-- 
1.9.3

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH] error.3: ATTRIBUTES: Note functions that are/aren't thread-safe

[Zeng Linggang]

The markings match glibc markings.
markings of functions in glibc are:
- error:         MT-Safe locale
- error_at_line: MT-Unsafe race:error_at_line/error_one_per_line locale

Signed-off-by: Zeng Linggang <zenglg.jy-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
---
 man3/error.3 | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/man3/error.3 b/man3/error.3
index 7e1d47c..f040a26 100644
--- a/man3/error.3
+++ b/man3/error.3
@@ -118,6 +118,35 @@ is assigned the address of a function
 instead of prefixing the message with the program name and colon.
 The function should print a suitable string to
 .IR stderr .
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lb lb lbw37
+l l l.
+Interface	Attribute	Value
+T{
+.BR error ()
+T}	Thread safety	MT-Safe locale
+T{
+.BR error_at_line ()
+T}	Thread safety	T{
+MT-Unsafe race:error_at_line/error_one_per_line locale
+T}
+.TE
+
+The internal
+.I error_one_per_line
+variable is accessed (without any form of
+synchronization, but since it's an int used once, it should be safe
+enough) and, if this mode is enabled, static variables used to hold
+the last printed file name and line number are accessed and modified
+without synchronization; the update is not atomic and it occurs
+before disabling cancellation, so it can be interrupted after only
+one of the two variables is modified.  After that, it's very much
+like
+.BR error (3).
 .SH CONFORMING TO
 These functions and variables are GNU extensions, and should not be
 used in programs intended to be portable.
-- 
1.9.3

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH] rpc.3: ATTRIBUTES: Note functions that are thread-safe

[Zeng Linggang]

After research, We think
auth_destroy(), authnone_create(),
authunix_create(), authunix_create_default(),
callrpc(), clnt_broadcast(),
clnt_call(), clnt_destroy(),
clnt_create(), clnt_control(),
clnt_freeres(), clnt_geterr(),
clnt_pcreateerror(), clnt_perrno(),
clnt_perror(), clnt_spcreateerror(),
clnt_sperrno(), clnt_sperror(),
clntraw_create(), clnttcp_create(),
clntudp_create(), clntudp_bufcreate(),
get_myaddress(), pmap_getmaps(),
pmap_getport(), pmap_rmtcall(),
pmap_set(), pmap_unset(),
registerrpc(), svc_destroy(),
svc_freeargs(), svc_getargs(),
svc_getcaller(), svc_getreqset(),
svc_getreq(), svc_register(),
svc_run(), svc_sendreply(),
svc_unregister(), svcerr_auth(),
svcerr_decode(), svcerr_noproc(),
svcerr_noprog(), svcerr_progvers(),
svcerr_systemerr(), svcerr_weakauth(),
svcfd_create(), svcraw_create(),
svctcp_create(), svcudp_bufcreate(),
svcudp_create(), xdr_accepted_reply(),
xdr_authunix_parms(), xdr_callhdr(),
xdr_callmsg(), xdr_opaque_auth(),
xdr_pmap(), xdr_pmaplist(),
xdr_rejected_reply(), xdr_replymsg(),
xprt_register(), xprt_unregister(),
are thread-safe. But, there are not
markings of them in glibc document.

Signed-off-by: Zeng Linggang <zenglg.jy-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
---
 man3/rpc.3 | 110 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 110 insertions(+)

diff --git a/man3/rpc.3 b/man3/rpc.3
index 9c6d2b4..20f532e 100644
--- a/man3/rpc.3
+++ b/man3/rpc.3
@@ -1100,6 +1100,116 @@ it should unregister itself with the RPC service package.
 This routine modifies the global variable
 .IR svc_fds .
 Service implementors usually do not need this routine.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbw35 lb lb
+l l l.
+Interface	Attribute	Value
+T{
+.BR auth_destroy (),
+.BR authnone_create (),
+.br
+.BR authunix_create (),
+.br
+.BR authunix_create_default (),
+.br
+.BR callrpc (),
+.BR clnt_broadcast (),
+.br
+.BR clnt_call (),
+.BR clnt_destroy (),
+.br
+.BR clnt_create (),
+.BR clnt_control (),
+.br
+.BR clnt_freeres (),
+.BR clnt_geterr (),
+.br
+.BR clnt_pcreateerror (),
+.BR clnt_perrno (),
+.br
+.BR clnt_perror (),
+.br
+.BR clnt_spcreateerror (),
+.br
+.BR clnt_sperrno (),
+.BR clnt_sperror (),
+.br
+.BR clntraw_create (),
+.BR clnttcp_create (),
+.br
+.BR clntudp_create (),
+.br
+.BR clntudp_bufcreate (),
+.br
+.BR get_myaddress (),
+.BR pmap_getmaps (),
+.br
+.BR pmap_getport (),
+.BR pmap_rmtcall (),
+.br
+.BR pmap_set (),
+.BR pmap_unset (),
+.br
+.BR registerrpc (),
+.BR svc_destroy (),
+.br
+.BR svc_freeargs (),
+.BR svc_getargs (),
+.br
+.BR svc_getcaller (),
+.BR svc_getreqset (),
+.br
+.BR svc_getreq (),
+.BR svc_register (),
+.br
+.BR svc_run (),
+.BR svc_sendreply (),
+.br
+.BR svc_unregister (),
+.BR svcerr_auth (),
+.br
+.BR svcerr_decode (),
+.BR svcerr_noproc (),
+.br
+.BR svcerr_noprog (),
+.BR svcerr_progvers (),
+.br
+.BR svcerr_systemerr (),
+.BR svcerr_weakauth (),
+.br
+.BR svcfd_create (),
+.BR svcraw_create (),
+.br
+.BR svctcp_create (),
+.br
+.BR svcudp_bufcreate (),
+.br
+.BR svcudp_create (),
+.BR xdr_accepted_reply (),
+.br
+.BR xdr_authunix_parms (),
+.br
+.BR xdr_callhdr (),
+.br
+.BR xdr_callmsg (),
+.BR xdr_opaque_auth (),
+.br
+.BR xdr_pmap (),
+.BR xdr_pmaplist (),
+.br
+.BR xdr_rejected_reply (),
+.br
+.BR xdr_replymsg (),
+.br
+.BR xprt_register (),
+.BR xprt_unregister ()
+T}	Thread safety	MT-Safe
+.TE
+
 .SH SEE ALSO
 .\" We don't have an rpc_secure.3 page in the set at the moment -- MTK, 19 Sep 05
 .\" .BR rpc_secure (3),
-- 
1.9.3

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH] xdr.3: ATTRIBUTES: Note functions that are thread-safe

[Zeng Linggang]

After research, We think
xdr_array(), xdr_bool(),
xdr_bytes(), xdr_char(),
xdr_destroy(), xdr_double(),
xdr_enum(), xdr_float(),
xdr_free(), xdr_getpos(),
xdr_inline(), xdr_int(),
xdr_long(), xdrmem_create(),
xdr_opaque(), xdr_pointer(),
xdrrec_create(), xdrrec_eof(),
xdrrec_endofrecord(),
xdrrec_skiprecord(),
xdr_reference(), xdr_setpos(),
xdr_short(), xdrstdio_create(),
xdr_string(), xdr_u_char(),
xdr_u_int(), xdr_u_long(),
xdr_u_short(), xdr_union(),
xdr_vector(), xdr_void(),
xdr_wrapstring(),
are thread-safe. But, there are not
markings of them in glibc document.

Signed-off-by: Zeng Linggang <zenglg.jy-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
---
 man3/xdr.3 | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)

diff --git a/man3/xdr.3 b/man3/xdr.3
index 0e2d939..2b83694 100644
--- a/man3/xdr.3
+++ b/man3/xdr.3
@@ -545,6 +545,68 @@ routines as arguments, and
 .BR xdr_string (),
 one of the most frequently used primitives, requires three.
 Returns one if it succeeds, zero otherwise.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbw31 lb lb
+l l l.
+Interface	Attribute	Value
+T{
+.BR xdr_array (),
+.BR xdr_bool (),
+.br
+.BR xdr_bytes (),
+.BR xdr_char (),
+.br
+.BR xdr_destroy (),
+.BR xdr_double (),
+.br
+.BR xdr_enum (),
+.BR xdr_float (),
+.br
+.BR xdr_free (),
+.BR xdr_getpos (),
+.br
+.BR xdr_inline (),
+.BR xdr_int (),
+.br
+.BR xdr_long (),
+.BR xdrmem_create (),
+.br
+.BR xdr_opaque (),
+.BR xdr_pointer (),
+.br
+.BR xdrrec_create (),
+.BR xdrrec_eof (),
+.br
+.BR xdrrec_endofrecord (),
+.br
+.BR xdrrec_skiprecord (),
+.br
+.BR xdr_reference (),
+.BR xdr_setpos (),
+.br
+.BR xdr_short (),
+.BR xdrstdio_create (),
+.br
+.BR xdr_string (),
+.BR xdr_u_char (),
+.br
+.BR xdr_u_int (),
+.BR xdr_u_long (),
+.br
+.BR xdr_u_short (),
+.BR xdr_union (),
+.br
+.BR xdr_vector (),
+.BR xdr_void (),
+.br
+.BR xdr_wrapstring ()
+T}	Thread safety	MT-Safe
+.TE
+
 .SH SEE ALSO
 .BR rpc (3)
 .LP
-- 
1.9.3

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] xdr.3: ATTRIBUTES: Note functions that are thread-safe

[Michael Kerrisk (man-pages)]

On 06/24/2015 11:28 AM, Zeng Linggang wrote:
> After research, We think
> xdr_array(), xdr_bool(),
> xdr_bytes(), xdr_char(),
> xdr_destroy(), xdr_double(),
> xdr_enum(), xdr_float(),
> xdr_free(), xdr_getpos(),
> xdr_inline(), xdr_int(),
> xdr_long(), xdrmem_create(),
> xdr_opaque(), xdr_pointer(),
> xdrrec_create(), xdrrec_eof(),
> xdrrec_endofrecord(),
> xdrrec_skiprecord(),
> xdr_reference(), xdr_setpos(),
> xdr_short(), xdrstdio_create(),
> xdr_string(), xdr_u_char(),
> xdr_u_int(), xdr_u_long(),
> xdr_u_short(), xdr_union(),
> xdr_vector(), xdr_void(),
> xdr_wrapstring(),
> are thread-safe. But, there are not
> markings of them in glibc document.


Thanks, Zeng Linggang. Applied. 

Cheers,

Michael



> Signed-off-by: Zeng Linggang <zenglg.jy-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
> ---
>  man3/xdr.3 | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 62 insertions(+)
> 
> diff --git a/man3/xdr.3 b/man3/xdr.3
> index 0e2d939..2b83694 100644
> --- a/man3/xdr.3
> +++ b/man3/xdr.3
> @@ -545,6 +545,68 @@ routines as arguments, and
>  .BR xdr_string (),
>  one of the most frequently used primitives, requires three.
>  Returns one if it succeeds, zero otherwise.
> +.SH ATTRIBUTES
> +For an explanation of the terms used in this section, see
> +.BR attributes (7).
> +.TS
> +allbox;
> +lbw31 lb lb
> +l l l.
> +Interface	Attribute	Value
> +T{
> +.BR xdr_array (),
> +.BR xdr_bool (),
> +.br
> +.BR xdr_bytes (),
> +.BR xdr_char (),
> +.br
> +.BR xdr_destroy (),
> +.BR xdr_double (),
> +.br
> +.BR xdr_enum (),
> +.BR xdr_float (),
> +.br
> +.BR xdr_free (),
> +.BR xdr_getpos (),
> +.br
> +.BR xdr_inline (),
> +.BR xdr_int (),
> +.br
> +.BR xdr_long (),
> +.BR xdrmem_create (),
> +.br
> +.BR xdr_opaque (),
> +.BR xdr_pointer (),
> +.br
> +.BR xdrrec_create (),
> +.BR xdrrec_eof (),
> +.br
> +.BR xdrrec_endofrecord (),
> +.br
> +.BR xdrrec_skiprecord (),
> +.br
> +.BR xdr_reference (),
> +.BR xdr_setpos (),
> +.br
> +.BR xdr_short (),
> +.BR xdrstdio_create (),
> +.br
> +.BR xdr_string (),
> +.BR xdr_u_char (),
> +.br
> +.BR xdr_u_int (),
> +.BR xdr_u_long (),
> +.br
> +.BR xdr_u_short (),
> +.BR xdr_union (),
> +.br
> +.BR xdr_vector (),
> +.BR xdr_void (),
> +.br
> +.BR xdr_wrapstring ()
> +T}	Thread safety	MT-Safe
> +.TE
> +
>  .SH SEE ALSO
>  .BR rpc (3)
>  .LP
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] rpc.3: ATTRIBUTES: Note functions that are thread-safe

[Michael Kerrisk (man-pages)]

On 06/24/2015 11:28 AM, Zeng Linggang wrote:
> After research, We think
> auth_destroy(), authnone_create(),
> authunix_create(), authunix_create_default(),
> callrpc(), clnt_broadcast(),
> clnt_call(), clnt_destroy(),
> clnt_create(), clnt_control(),
> clnt_freeres(), clnt_geterr(),
> clnt_pcreateerror(), clnt_perrno(),
> clnt_perror(), clnt_spcreateerror(),
> clnt_sperrno(), clnt_sperror(),
> clntraw_create(), clnttcp_create(),
> clntudp_create(), clntudp_bufcreate(),
> get_myaddress(), pmap_getmaps(),
> pmap_getport(), pmap_rmtcall(),
> pmap_set(), pmap_unset(),
> registerrpc(), svc_destroy(),
> svc_freeargs(), svc_getargs(),
> svc_getcaller(), svc_getreqset(),
> svc_getreq(), svc_register(),
> svc_run(), svc_sendreply(),
> svc_unregister(), svcerr_auth(),
> svcerr_decode(), svcerr_noproc(),
> svcerr_noprog(), svcerr_progvers(),
> svcerr_systemerr(), svcerr_weakauth(),
> svcfd_create(), svcraw_create(),
> svctcp_create(), svcudp_bufcreate(),
> svcudp_create(), xdr_accepted_reply(),
> xdr_authunix_parms(), xdr_callhdr(),
> xdr_callmsg(), xdr_opaque_auth(),
> xdr_pmap(), xdr_pmaplist(),
> xdr_rejected_reply(), xdr_replymsg(),
> xprt_register(), xprt_unregister(),
> are thread-safe. But, there are not
> markings of them in glibc document.


Thanks, Zeng Linggang. Applied. 

Cheers,

Michael



> Signed-off-by: Zeng Linggang <zenglg.jy-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
> ---
>  man3/rpc.3 | 110 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 110 insertions(+)
> 
> diff --git a/man3/rpc.3 b/man3/rpc.3
> index 9c6d2b4..20f532e 100644
> --- a/man3/rpc.3
> +++ b/man3/rpc.3
> @@ -1100,6 +1100,116 @@ it should unregister itself with the RPC service package.
>  This routine modifies the global variable
>  .IR svc_fds .
>  Service implementors usually do not need this routine.
> +.SH ATTRIBUTES
> +For an explanation of the terms used in this section, see
> +.BR attributes (7).
> +.TS
> +allbox;
> +lbw35 lb lb
> +l l l.
> +Interface	Attribute	Value
> +T{
> +.BR auth_destroy (),
> +.BR authnone_create (),
> +.br
> +.BR authunix_create (),
> +.br
> +.BR authunix_create_default (),
> +.br
> +.BR callrpc (),
> +.BR clnt_broadcast (),
> +.br
> +.BR clnt_call (),
> +.BR clnt_destroy (),
> +.br
> +.BR clnt_create (),
> +.BR clnt_control (),
> +.br
> +.BR clnt_freeres (),
> +.BR clnt_geterr (),
> +.br
> +.BR clnt_pcreateerror (),
> +.BR clnt_perrno (),
> +.br
> +.BR clnt_perror (),
> +.br
> +.BR clnt_spcreateerror (),
> +.br
> +.BR clnt_sperrno (),
> +.BR clnt_sperror (),
> +.br
> +.BR clntraw_create (),
> +.BR clnttcp_create (),
> +.br
> +.BR clntudp_create (),
> +.br
> +.BR clntudp_bufcreate (),
> +.br
> +.BR get_myaddress (),
> +.BR pmap_getmaps (),
> +.br
> +.BR pmap_getport (),
> +.BR pmap_rmtcall (),
> +.br
> +.BR pmap_set (),
> +.BR pmap_unset (),
> +.br
> +.BR registerrpc (),
> +.BR svc_destroy (),
> +.br
> +.BR svc_freeargs (),
> +.BR svc_getargs (),
> +.br
> +.BR svc_getcaller (),
> +.BR svc_getreqset (),
> +.br
> +.BR svc_getreq (),
> +.BR svc_register (),
> +.br
> +.BR svc_run (),
> +.BR svc_sendreply (),
> +.br
> +.BR svc_unregister (),
> +.BR svcerr_auth (),
> +.br
> +.BR svcerr_decode (),
> +.BR svcerr_noproc (),
> +.br
> +.BR svcerr_noprog (),
> +.BR svcerr_progvers (),
> +.br
> +.BR svcerr_systemerr (),
> +.BR svcerr_weakauth (),
> +.br
> +.BR svcfd_create (),
> +.BR svcraw_create (),
> +.br
> +.BR svctcp_create (),
> +.br
> +.BR svcudp_bufcreate (),
> +.br
> +.BR svcudp_create (),
> +.BR xdr_accepted_reply (),
> +.br
> +.BR xdr_authunix_parms (),
> +.br
> +.BR xdr_callhdr (),
> +.br
> +.BR xdr_callmsg (),
> +.BR xdr_opaque_auth (),
> +.br
> +.BR xdr_pmap (),
> +.BR xdr_pmaplist (),
> +.br
> +.BR xdr_rejected_reply (),
> +.br
> +.BR xdr_replymsg (),
> +.br
> +.BR xprt_register (),
> +.BR xprt_unregister ()
> +T}	Thread safety	MT-Safe
> +.TE
> +
>  .SH SEE ALSO
>  .\" We don't have an rpc_secure.3 page in the set at the moment -- MTK, 19 Sep 05
>  .\" .BR rpc_secure (3),
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] error.3: ATTRIBUTES: Note functions that are/aren't thread-safe

[Michael Kerrisk (man-pages)]

On 06/24/2015 11:28 AM, Zeng Linggang wrote:
> The markings match glibc markings.
> markings of functions in glibc are:
> - error:         MT-Safe locale
> - error_at_line: MT-Unsafe race:error_at_line/error_one_per_line locale
> 
> Signed-off-by: Zeng Linggang <zenglg.jy-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>


Hi, Zeng Linggang. 

I'm having some trouble understanding the text you've added. Could you review
and resubmit, please? See below.

> ---
>  man3/error.3 | 29 +++++++++++++++++++++++++++++
>  1 file changed, 29 insertions(+)
> 
> diff --git a/man3/error.3 b/man3/error.3
> index 7e1d47c..f040a26 100644
> --- a/man3/error.3
> +++ b/man3/error.3
> @@ -118,6 +118,35 @@ is assigned the address of a function
>  instead of prefixing the message with the program name and colon.
>  The function should print a suitable string to
>  .IR stderr .
> +.SH ATTRIBUTES
> +For an explanation of the terms used in this section, see
> +.BR attributes (7).
> +.TS
> +allbox;
> +lb lb lbw37
> +l l l.
> +Interface	Attribute	Value
> +T{
> +.BR error ()
> +T}	Thread safety	MT-Safe locale
> +T{
> +.BR error_at_line ()
> +T}	Thread safety	T{
> +MT-Unsafe race:error_at_line/error_one_per_line locale
> +T}
> +.TE
> +
> +The internal
> +.I error_one_per_line
> +variable is accessed (without any form of
> +synchronization, but since it's an int used once, it should be safe
> +enough) and, if this mode is enabled, static variables used to hold

What does "this mode" refer to? That needs to be made clearer in
the text.

> +the last printed file name and line number are accessed and modified
> +without synchronization; the update is not atomic and it occurs
> +before disabling cancellation, so it can be interrupted after only
> +one of the two variables is modified.  After that, it's very much

What does "it" (in "it's") refer to? error_at_line()? 
That needs to be made clearer in the text.

> +like
> +.BR error (3).
>  .SH CONFORMING TO
>  These functions and variables are GNU extensions, and should not be
>  used in programs intended to be portable.

Thanks,

Michael



-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] error.3: ATTRIBUTES: Note functions that are/aren't thread-safe

[Zeng Linggang]

Hi, Michael

On Fri, 2015-07-17 at 00:05 +0200, Michael Kerrisk (man-pages) wrote:
> On 06/24/2015 11:28 AM, Zeng Linggang wrote:
> > The markings match glibc markings.
> > markings of functions in glibc are:
> > - error:         MT-Safe locale
> > - error_at_line: MT-Unsafe race:error_at_line/error_one_per_line locale
> > 
> > Signed-off-by: Zeng Linggang <zenglg.jy-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
> 
> 
> Hi, Zeng Linggang. 
> 
> I'm having some trouble understanding the text you've added. Could you review
> and resubmit, please? See below.

Sorry to bring so much trouble. I will resend this patch.

Best regards,
Zeng

> 
> > ---
> >  man3/error.3 | 29 +++++++++++++++++++++++++++++
> >  1 file changed, 29 insertions(+)
> > 
> > diff --git a/man3/error.3 b/man3/error.3
> > index 7e1d47c..f040a26 100644
> > --- a/man3/error.3
> > +++ b/man3/error.3
> > @@ -118,6 +118,35 @@ is assigned the address of a function
> >  instead of prefixing the message with the program name and colon.
> >  The function should print a suitable string to
> >  .IR stderr .
> > +.SH ATTRIBUTES
> > +For an explanation of the terms used in this section, see
> > +.BR attributes (7).
> > +.TS
> > +allbox;
> > +lb lb lbw37
> > +l l l.
> > +Interface	Attribute	Value
> > +T{
> > +.BR error ()
> > +T}	Thread safety	MT-Safe locale
> > +T{
> > +.BR error_at_line ()
> > +T}	Thread safety	T{
> > +MT-Unsafe race:error_at_line/error_one_per_line locale
> > +T}
> > +.TE
> > +
> > +The internal
> > +.I error_one_per_line
> > +variable is accessed (without any form of
> > +synchronization, but since it's an int used once, it should be safe
> > +enough) and, if this mode is enabled, static variables used to hold
> 
> What does "this mode" refer to? That needs to be made clearer in
> the text.
> 
> > +the last printed file name and line number are accessed and modified
> > +without synchronization; the update is not atomic and it occurs
> > +before disabling cancellation, so it can be interrupted after only
> > +one of the two variables is modified.  After that, it's very much
> 
> What does "it" (in "it's") refer to? error_at_line()? 
> That needs to be made clearer in the text.
> 
> > +like
> > +.BR error (3).
> >  .SH CONFORMING TO
> >  These functions and variables are GNU extensions, and should not be
> >  used in programs intended to be portable.
> 
> Thanks,
> 
> Michael
> 
> 
> 


--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH v2] error.3: ATTRIBUTES: Note functions that are/aren't thread-safe

[Zeng Linggang]

The markings match glibc markings.
markings of functions in glibc are:
- error:         MT-Safe locale
- error_at_line: MT-Unsafe race:error_at_line/error_one_per_line locale

Signed-off-by: Zeng Linggang <zenglg.jy-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
---
 man3/error.3 | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/man3/error.3 b/man3/error.3
index 7e1d47c..7a92a76 100644
--- a/man3/error.3
+++ b/man3/error.3
@@ -118,6 +118,37 @@ is assigned the address of a function
 instead of prefixing the message with the program name and colon.
 The function should print a suitable string to
 .IR stderr .
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lb lb lbw37
+l l l.
+Interface	Attribute	Value
+T{
+.BR error ()
+T}	Thread safety	MT-Safe locale
+T{
+.BR error_at_line ()
+T}	Thread safety	T{
+MT-Unsafe race:error_at_line/error_one_per_line locale
+T}
+.TE
+
+The internal
+.I error_one_per_line
+variable is accessed (without any form of synchronization, but since
+it's an int used once, it should be safe enough) and, if
+.I error_one_per_line
+is set nonzero, the internal static variables(not exposed to users)
+used to hold the last printed file name and line number are accessed
+and modified without synchronization; the update is not atomic and it
+occurs before disabling cancellation, so it can be interrupted after
+only one of the two variables is modified. After that,
+.BR error_at_line (3)
+is very much like
+.BR error (3).
 .SH CONFORMING TO
 These functions and variables are GNU extensions, and should not be
 used in programs intended to be portable.
-- 
1.9.3



--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v2] error.3: ATTRIBUTES: Note functions that are/aren't thread-safe

[Michael Kerrisk (man-pages)]

Hello Zeng Linggang,

On 07/17/2015 05:15 AM, Zeng Linggang wrote:
> The markings match glibc markings.
> markings of functions in glibc are:
> - error:         MT-Safe locale
> - error_at_line: MT-Unsafe race:error_at_line/error_one_per_line locale

Thanks for fixing the patch. Applied.

Cheers,

Michael

> 
> Signed-off-by: Zeng Linggang <zenglg.jy-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
> ---
>  man3/error.3 | 31 +++++++++++++++++++++++++++++++
>  1 file changed, 31 insertions(+)
> 
> diff --git a/man3/error.3 b/man3/error.3
> index 7e1d47c..7a92a76 100644
> --- a/man3/error.3
> +++ b/man3/error.3
> @@ -118,6 +118,37 @@ is assigned the address of a function
>  instead of prefixing the message with the program name and colon.
>  The function should print a suitable string to
>  .IR stderr .
> +.SH ATTRIBUTES
> +For an explanation of the terms used in this section, see
> +.BR attributes (7).
> +.TS
> +allbox;
> +lb lb lbw37
> +l l l.
> +Interface	Attribute	Value
> +T{
> +.BR error ()
> +T}	Thread safety	MT-Safe locale
> +T{
> +.BR error_at_line ()
> +T}	Thread safety	T{
> +MT-Unsafe race:error_at_line/error_one_per_line locale
> +T}
> +.TE
> +
> +The internal
> +.I error_one_per_line
> +variable is accessed (without any form of synchronization, but since
> +it's an int used once, it should be safe enough) and, if
> +.I error_one_per_line
> +is set nonzero, the internal static variables(not exposed to users)
> +used to hold the last printed file name and line number are accessed
> +and modified without synchronization; the update is not atomic and it
> +occurs before disabling cancellation, so it can be interrupted after
> +only one of the two variables is modified. After that,
> +.BR error_at_line (3)
> +is very much like
> +.BR error (3).
>  .SH CONFORMING TO
>  These functions and variables are GNU extensions, and should not be
>  used in programs intended to be portable.
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] dlopen.3: ATTRIBUTES: Note functions that are thread-safe

[Michael Kerrisk (man-pages)]

Hello Zeng Linggang,

On 06/24/2015 11:28 AM, Zeng Linggang wrote:
> After research, We think
> * dlopen(),
> * dlerror(),
> * dlsym(),
> * dlclose(),
> * dladdr(),
> * dlvsym()
> are thread-safe. But, there are not
> markings of them in glibc document.

Thanks. I've applied this manually, since it happens that I am currently
working on splitting the dlopen(3) page into smaller pieces. So, it will
be a short while before your changes in this patch are released.

You might also want to check the thread safety of dlinfo(), dlmopen(),
and dladdr1(), since man pages for those functions will, I hope, soon
appear.

Cheers,

Michael


> Signed-off-by: Zeng Linggang <zenglg.jy-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
> ---
>  man3/dlopen.3 | 19 +++++++++++++++++++
>  1 file changed, 19 insertions(+)
> 
> diff --git a/man3/dlopen.3 b/man3/dlopen.3
> index cb5dbf9..53d3f16 100644
> --- a/man3/dlopen.3
> +++ b/man3/dlopen.3
> @@ -396,6 +396,25 @@ provided by glibc since version 2.1,
>  does the same as
>  .BR dlsym ()
>  but takes a version string as an additional argument.
> +.SH ATTRIBUTES
> +For an explanation of the terms used in this section, see
> +.BR attributes (7).
> +.TS
> +allbox;
> +lbw29 lb lb
> +l l l.
> +Interface	Attribute	Value
> +T{
> +.BR dlopen (),
> +.BR dlerror (),
> +.BR dlsym (),
> +.br
> +.BR dlclose (),
> +.BR dladdr (),
> +.BR dlvsym ()
> +T}	Thread safety	MT-Safe
> +.TE
> +
>  .SH CONFORMING TO
>  POSIX.1-2001 describes
>  .BR dlclose (),
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH v2] dlopen.3: ATTRIBUTES: Note functions that are thread-safe

[Zeng Linggang]

After research, We think
* dlopen(),
* dlerror(),
* dlsym(),
* dlclose(),
* dladdr(),
* dlvsym(),
* dlinfo(),
* dlmopen(),
* dladdr1()
are thread-safe. But, there are not
markings of them in glibc document.

Signed-off-by: Zeng Linggang <zenglg.jy-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
---
 man3/dlopen.3 | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/man3/dlopen.3 b/man3/dlopen.3
index cb5dbf9..f8e8667 100644
--- a/man3/dlopen.3
+++ b/man3/dlopen.3
@@ -396,6 +396,29 @@ provided by glibc since version 2.1,
 does the same as
 .BR dlsym ()
 but takes a version string as an additional argument.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbw30 lb lb
+l l l.
+Interface	Attribute	Value
+T{
+.BR dlopen (),
+.BR dlerror (),
+.BR dlsym (),
+.br
+.BR dlclose (),
+.BR dladdr (),
+.BR dlvsym (),
+.br
+.BR dlinfo (),
+.BR dlmopen (),
+.BR dladdr1 ()
+T}	Thread safety	MT-Safe
+.TE
+
 .SH CONFORMING TO
 POSIX.1-2001 describes
 .BR dlclose (),
-- 
1.9.3



--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v2] dlopen.3: ATTRIBUTES: Note functions that are thread-safe

[Michael Kerrisk (man-pages)]

On 07/22/2015 01:16 PM, Zeng Linggang wrote:
> After research, We think
> * dlopen(),
> * dlerror(),
> * dlsym(),
> * dlclose(),
> * dladdr(),
> * dlvsym(),
> * dlinfo(),
> * dlmopen(),
> * dladdr1()
> are thread-safe. But, there are not
> markings of them in glibc document.

Thanks for the fast response, Zeng Linggang.
I've incorporated the new pieces from your patch.

Cheers,

Michael


> Signed-off-by: Zeng Linggang <zenglg.jy-BthXqXjhjHXQFUHtdCDX3A@public.gmane.org>
> ---
>  man3/dlopen.3 | 23 +++++++++++++++++++++++
>  1 file changed, 23 insertions(+)
> 
> diff --git a/man3/dlopen.3 b/man3/dlopen.3
> index cb5dbf9..f8e8667 100644
> --- a/man3/dlopen.3
> +++ b/man3/dlopen.3
> @@ -396,6 +396,29 @@ provided by glibc since version 2.1,
>  does the same as
>  .BR dlsym ()
>  but takes a version string as an additional argument.
> +.SH ATTRIBUTES
> +For an explanation of the terms used in this section, see
> +.BR attributes (7).
> +.TS
> +allbox;
> +lbw30 lb lb
> +l l l.
> +Interface	Attribute	Value
> +T{
> +.BR dlopen (),
> +.BR dlerror (),
> +.BR dlsym (),
> +.br
> +.BR dlclose (),
> +.BR dladdr (),
> +.BR dlvsym (),
> +.br
> +.BR dlinfo (),
> +.BR dlmopen (),
> +.BR dladdr1 ()
> +T}	Thread safety	MT-Safe
> +.TE
> +
>  .SH CONFORMING TO
>  POSIX.1-2001 describes
>  .BR dlclose (),
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html