source: general/genlib/liburcu.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY liburcu-download-http "https://lttng.org/files/urcu/userspace-rcu-&liburcu-version;.tar.bz2">
  <!ENTITY liburcu-download-ftp  " ">
  <!ENTITY liburcu-md5sum        "0cd5647788b048a5d6bbdb3b08d46299">
  <!ENTITY liburcu-size          "648 KB">
  <!ENTITY liburcu-buildsize     "25 MB (with tests)">
  <!ENTITY liburcu-time          "0.2 SBU (with tests)">

]>

<sect1 id="liburcu" xreflabel="liburcu-&liburcu-version;">
  <?dbhtml filename="liburcu.html"?>


  <title>liburcu-&liburcu-version;</title>

  <indexterm zone="liburcu">
    <primary sortas="a-liburcu">liburcu</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to liburcu</title>

    <para>
      The <application>userspace-rcu</application> package provides
      a set of userspace RCU (read-copy-update) libraries. These data synchronization
      libraries provide read-side access which scales linearly with the number of cores.
      It does so by allowing multiples copies of a given data structure to live at
      the same time, and by monitoring the data structure accesses to detect grace
      periods after which memory reclamation is possible.
    </para>

    &lfs121_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&liburcu-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&liburcu-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &liburcu-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &liburcu-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &liburcu-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &liburcu-time;
        </para>
      </listitem>
    </itemizedlist>

  </sect2>

  <sect2 role="installation">
    <title>Installation of liburcu</title>

    <para>
      Install <application>liburcu</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr    \
            --disable-static \
            --docdir=/usr/share/doc/liburcu-&liburcu-version; &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>
  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          liburcu.so,
          liburcu-bp.so,
          liburcu-cds.so,
          liburcu-common.so,
          liburcu-mb.so,
          liburcu-memb.so,
          liburcu-qsbr.so, and
          liburcu-signal.so
        </seg>
        <seg>
          /usr/include/urcu and
          /usr/share/doc/liburcu-&liburcu-version;
        </seg>
      </seglistitem>
    </segmentedlist>
<!--
    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="liburcu-lib">
        <term><filename class="libraryfile">liburcu.so</filename></term>
        <listitem>
          <para>
            provides for
          </para>
          <indexterm zone="liburcu liburcu-lib">
            <primary sortas="c-liburcu">liburcu.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
-->
  </sect2>

</sect1>