picnoir/Systemd
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

man: be more explicit about thread safety of sd_journal

Browse source 
Triggered by https://bugzilla.redhat.com/show_bug.cgi?id=1609349

This adds two generic paragaphs we include via xinclude. One is the
"strict" version, which contains wording saying that we are thread
agnostic and what that means. And the other is the "safe" version, for
the cases we provide fully safety.

Let's then change most man pages to use either of these generic
paragraphs. With one exception: man/sd_journal_get_catalog.xml contains
both kinds of function, we hence use manual wording.
This commit is contained in:
Lennart Poettering 2018-08-03 16:43:30 +02:00
parent af560fc1da
commit 64a7ef8bc0
18 changed files with 68 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
man/libudev.xml
View file

@ -48,11 +48,9 @@
<citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>. <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
It is used to track library state and link objects together. No It is used to track library state and link objects together. No
global state is used by libudev, everything is always linked to global state is used by libudev, everything is always linked to
a udev context. Furthermore, multiple different udev contexts can a udev context.</para>
be used in parallel by multiple threads. However, a single context
must not be accessed by multiple threads in parallel. The caller <xi:include href="threads-aware.xml" xpointer="strict"/>
is responsible for providing suitable locking if they intend to use
it from multiple threads.</para>
<para>To introspect a local device on a system, a udev device <para>To introspect a local device on a system, a udev device
object can be created via object can be created via

17
man/sd-journal.xml
View file

@ -77,16 +77,15 @@
<refsect1> <refsect1>
<title>Thread safety</title> <title>Thread safety</title>
<para>Functions that operate on the <structname>sd_journal</structname> object are thread <para>Functions that operate on <structname>sd_journal</structname> objects are thread agnostic — given
agnostic — given <structname>sd_journal</structname> pointer may only be used from one thread at <structname>sd_journal</structname> pointer may only be used from one specific thread at all times (and it has to
a time, but multiple threads may use multiple such objects safely. Other functions — be the very same one during the entire lifetime of the object), but multiple, independent threads may use multiple,
those that are used to send entries to the journal, like independent objects safely. Other functions — those that are used to send entries to the journal, like
<citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry> <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry> and similar,
and similar, or those that are used to retrieve global information like or those that are used to retrieve global information like
<citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry> <citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
and
<citerefentry><refentrytitle>sd_journal_get_catalog_for_message_id</refentrytitle><manvolnum>3</manvolnum></citerefentry> <citerefentry><refentrytitle>sd_journal_get_catalog_for_message_id</refentrytitle><manvolnum>3</manvolnum></citerefentry>
— are thread-safe and may be called from multiple threads in parallel.</para> — are fully thread-safe and may be called from multiple threads in parallel.</para>
</refsect1> </refsect1>
<xi:include href="libsystemd-pkgconfig.xml" /> <xi:include href="libsystemd-pkgconfig.xml" />

3
man/sd_journal_enumerate_fields.xml
View file

@ -86,8 +86,7 @@
<refsect1> <refsect1>
<title>Notes</title> <title>Notes</title>
<para>All functions listed here are thread-agnostic and only a single thread may operate <xi:include href="threads-aware.xml" xpointer="strict" />
on a given <structname>sd_journal</structname> object.</para>
<xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/> <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
</refsect1> </refsect1>

11
man/sd_journal_get_catalog.xml
View file

@ -87,9 +87,14 @@
<refsect1> <refsect1>
<title>Notes</title> <title>Notes</title>
<para>Function <function>sd_journal_get_catalog()</function> is thread-agnostic and only a <para>Function <function>sd_journal_get_catalog()</function> is thread-agnostic and only
single thread may operate on a given <structname>sd_journal</structname> object. Function a single specific thread may operate on a given object during its entire lifetime. It's safe to allocate multiple
<function>sd_journal_get_catalog_for_message_id()</function> is thread-safe.</para> independent objects and use each from a specific thread in parallel. However, it's not safe to allocate such an
object in one thread, and operate or free it from any other, even if locking is used to ensure these threads don't
operate on it at the very same time.</para>
<para>Function <function>sd_journal_get_catalog_for_message_id()</function> is are thread-safe and may be called in
parallel from multiple threads.</para>
<xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/> <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
</refsect1> </refsect1>

3
man/sd_journal_get_cursor.xml
View file

@ -98,8 +98,7 @@
<refsect1> <refsect1>
<title>Notes</title> <title>Notes</title>
<para>All functions listed here are thread-agnostic and only a single thread may operate <xi:include href="threads-aware.xml" xpointer="strict" />
on a given <structname>sd_journal</structname> object.</para>
<xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/> <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
</refsect1> </refsect1>

3
man/sd_journal_get_cutoff_realtime_usec.xml
View file

@ -96,8 +96,7 @@
<refsect1> <refsect1>
<title>Notes</title> <title>Notes</title>
<para>All functions listed here are thread-agnostic and only a single thread may operate <xi:include href="threads-aware.xml" xpointer="strict" />
on a given <structname>sd_journal</structname> object.</para>
<xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/> <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
</refsect1> </refsect1>

8
man/sd_journal_get_data.xml
View file

@ -156,7 +156,13 @@
success or a negative errno-style error code.</para> success or a negative errno-style error code.</para>
</refsect1> </refsect1>
<xi:include href="libsystemd-pkgconfig.xml" /> <refsect1>
<title>Notes</title>
<xi:include href="threads-aware.xml" xpointer="strict"/>
<xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
</refsect1>
<refsect1> <refsect1>
<title>Examples</title> <title>Examples</title>

11
man/sd_journal_get_fd.xml
View file

@ -226,14 +226,9 @@ else {
<refsect1> <refsect1>
<title>Notes</title> <title>Notes</title>
<para>The <function>sd_journal_get_fd()</function>, <xi:include href="threads-aware.xml" xpointer="strict"/>
<function>sd_journal_get_events()</function>,
<function>sd_journal_reliable_fd()</function>, <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
<function>sd_journal_process()</function> and
<function>sd_journal_wait()</function> interfaces are available as
a shared library, which can be compiled and linked to with the
<constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
file.</para>
</refsect1> </refsect1>
<refsect1> <refsect1>

8
man/sd_journal_get_realtime_usec.xml
View file

@ -89,7 +89,13 @@
<function>sd_journal_get_monotonic_usec()</function>.</para> <function>sd_journal_get_monotonic_usec()</function>.</para>
</refsect1> </refsect1>
<xi:include href="libsystemd-pkgconfig.xml" /> <refsect1>
<title>Notes</title>
<xi:include href="threads-aware.xml" xpointer="strict"/>
<xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
</refsect1>
<refsect1> <refsect1>
<title>See Also</title> <title>See Also</title>

3
man/sd_journal_get_usage.xml
View file

@ -56,8 +56,7 @@
<refsect1> <refsect1>
<title>Notes</title> <title>Notes</title>
<para>All functions listed here are thread-agnostic and only a single thread may operate <xi:include href="threads-aware.xml" xpointer="strict"/>
on a given <structname>sd_journal</structname> object.</para>
<xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/> <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
</refsect1> </refsect1>

3
man/sd_journal_has_runtime_files.xml
View file

@ -66,8 +66,7 @@
<refsect1> <refsect1>
<title>Notes</title> <title>Notes</title>
<para>All functions listed here are thread-agnostic and only a single thread may operate <xi:include href="threads-aware.xml" xpointer="strict"/>
on a given <structname>sd_journal</structname> object.</para>
<xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/> <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
</refsect1> </refsect1>

3
man/sd_journal_next.xml
View file

@ -122,8 +122,7 @@
<refsect1> <refsect1>
<title>Notes</title> <title>Notes</title>
<para>All functions listed here are thread-agnostic and only a single thread may operate <xi:include href="threads-aware.xml" xpointer="strict"/>
on a given <structname>sd_journal</structname> object.</para>
<xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/> <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
</refsect1> </refsect1>

13
man/sd_journal_open.xml
View file

@ -6,7 +6,8 @@
SPDX-License-Identifier: LGPL-2.1+ SPDX-License-Identifier: LGPL-2.1+
--> -->
<refentry id="sd_journal_open"> <refentry id="sd_journal_open"
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo> <refentryinfo>
<title>sd_journal_open</title> <title>sd_journal_open</title>
@ -184,15 +185,9 @@
<refsect1> <refsect1>
<title>Notes</title> <title>Notes</title>
<para>All functions listed here are thread-agnostic and only a single thread may operate <xi:include href="threads-aware.xml" xpointer="strict"/>
on a given <structname>sd_journal</structname> object.</para>
<para>The <function>sd_journal_open()</function>, <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
<function>sd_journal_open_directory()</function> and
<function>sd_journal_close()</function> interfaces are available
as a shared library, which can be compiled and linked to with the
<constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
file.</para>
</refsect1> </refsect1>
<refsect1> <refsect1>

3
man/sd_journal_print.xml
View file

@ -177,7 +177,8 @@ sd_journal_send("MESSAGE=Hello World, this is PID %lu!", (unsigned long) getpid(
<refsect1> <refsect1>
<title>Thread safety</title> <title>Thread safety</title>
<para>All functions listed here are thread-safe and may be called in parallel from multiple threads.</para>
<xi:include href="threads-aware.xml" xpointer="safe"/>
<para><function>sd_journal_sendv()</function> is "async signal safe" in the meaning of <citerefentry <para><function>sd_journal_sendv()</function> is "async signal safe" in the meaning of <citerefentry
project='man-pages'><refentrytitle>signal-safety</refentrytitle><manvolnum>7</manvolnum></citerefentry>. project='man-pages'><refentrytitle>signal-safety</refentrytitle><manvolnum>7</manvolnum></citerefentry>.

3
man/sd_journal_query_unique.xml
View file

@ -126,8 +126,7 @@
<refsect1> <refsect1>
<title>Notes</title> <title>Notes</title>
<para>All functions listed here are thread-agnostic and only a single thread may operate <xi:include href="threads-aware.xml" xpointer="strict"/>
on a given <structname>sd_journal</structname> object.</para>
<xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/> <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
</refsect1> </refsect1>

3
man/sd_journal_seek_head.xml
View file

@ -120,8 +120,7 @@
<refsect1> <refsect1>
<title>Notes</title> <title>Notes</title>
<para>All functions listed here are thread-agnostic and only a single thread may operate <xi:include href="threads-aware.xml" xpointer="strict"/>
on a given <structname>sd_journal</structname> object.</para>
<xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/> <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
</refsect1> </refsect1>

3
man/sd_journal_stream_fd.xml
View file

@ -92,8 +92,7 @@
<refsect1> <refsect1>
<title>Notes</title> <title>Notes</title>
<para>Function <function>sd_journal_stream_fd()</function> is thread-safe and may be called <xi:include href="threads-aware.xml" xpointer="safe"/>
from multiple threads.</para>
<xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/> <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
</refsect1> </refsect1>

17
man/threads-aware.xml Normal file
View file

@ -0,0 +1,17 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!--
SPDX-License-Identifier: LGPL-2.1+
-->
<refsect1>
<para id="strict">All functions listed here are thread-agnostic and only a single specific thread may operate on a
given object during its entire lifetime. It's safe to allocate multiple independent objects and use each from a
specific thread in parallel. However, it's not safe to allocate such an object in one thread, and operate or free it
from any other, even if locking is used to ensure these threads don't operate on it at the very same time.</para>
<para id="safe">All functions listed here are thread-safe and may be called in parallel from multiple threads.</para>
</refsect1>