source: general/genlib/js91.xml@ 342453f

<?xml version="1.0" encoding="ISO-8859-1"?>
<!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;

<!-- for when firefox and js91 use same version
  <!ENTITY ff91-version       "&firefox-version;">
  and when they are on different versions - keep this for when
  we have moved to next firefox-esr (ff-91) and JS  has not moved
  <!ENTITY ff91-version       "&JS91-version;"> -->

<!-- <!ENTITY ff91-version       "&firefox-version;">-->
  <!ENTITY js91-download-http "&mozilla-http;/firefox/releases/&JS91-version;esr/source/firefox-&JS91-version;esr.source.tar.xz">
  <!ENTITY js91-download-ftp  " ">
  <!ENTITY js91-md5sum        "5bed22ca5921850b0fe250c512945f6f">
  <!ENTITY js91-size          "364 MB">
  <!ENTITY js91-buildsize     "3.1 GB (38 MB installed after removing 36MB static lib)">
  <!ENTITY js91-time          "2.4 SBU (with parallelism=4)">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>JS-&JS91-version;</title>

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

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

    <para>
      <application>JS</application> (also referred as
      <application>SpiderMonkey</application>) is Mozilla's JavaScript and
      WebAssembly Engine, written in C++ and Rust.
      In BLFS, the source code of JS is taken from Firefox.
    </para>

    &lfs111_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&js91-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&js91-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &js91-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &js91-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &js91-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &js91-time;
        </para>
      </listitem>
    </itemizedlist>
<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/js-&JS91-version;-python_3_10-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>
-->
    <bridgehead renderas="sect3">JS91 Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="icu"/>,
      <xref linkend="rust"/>, and
      <xref linkend="which"/>
      <!-- Should we list llvm here? -->
    </para>

    <!-- It seems nasm is only used for aarch64-win64. -->
    <!--bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="nasm"/>
    </para-->

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/js91"/>
    </para>
  </sect2>

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

    <note>
      <para>
        Unlike most other packages in BLFS, the instructions below require you
        to untar <filename>firefox-&JS91-version;esr.tar.xz</filename> and
        change into the <filename>firefox-&JS91-version;</filename> folder.
      </para>

      <para>
        Extracting the tarball
        will reset the permissions of the current directory to 0755 if you
        have permission to do that. If you do this in a directory where
        the sticky bit is set, such
        as <filename class="directory">/tmp</filename> it will end with error
        messages:
      </para>

<literallayout>tar: .: Cannot utime: Operation not permitted
tar: .: Cannot change mode to rwxr-xr-t: Operation not permitted
tar: Exiting with failure status due to previous errors
</literallayout>

      <para>
        This does finish with non-zero status, but it does
        <emphasis>NOT</emphasis> mean there is a real problem.
        Do not untar as the <systemitem class="username">root</systemitem> user
        in a directory where the sticky bit is set - that will unset it.
      </para>

    </note>
<!--
    <para>
      Apply a patch to allow building this package with Python-3.10 or
      later:
    </para>

<screen><userinput>patch -Np1 -i ../js-&JS91-version;-python_3_10-1.patch</userinput></screen>
-->
    <para>
      Install <application>JS</application> by running the following
      commands:
    </para>

     <note>
        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
         href="../../xincludes/mozshm.xml"/>

        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
         href="../../xincludes/mozconfigure.xml"/>

        <para>
          Compiling the C++ code respects $MAKEFLAGS and defaults to 'j1',
          the rust code will use all processors.
        </para>
     </note>


<screen><userinput>mkdir obj &amp;&amp;
cd    obj &amp;&amp;

CC=gcc CXX=g++ \
sh ../js/src/configure.in --prefix=/usr            \
                          --with-intl-api          \
                          --with-system-zlib       \
                          --with-system-icu        \
                          --disable-jemalloc       \
                          --disable-debug-symbols  \
                          --enable-readline        &amp;&amp;
make</userinput></screen>

    <para>
      To run the JS test suite, issue:
      <command>make -C js/src check-jstests
      JSTESTS_EXTRA_ARGS="--timeout 300 --wpt=disabled"</command>.
      It's recommended to redirect the output into a log.
      <!-- recheck when ICU gets upgraded -->
      Because we are building with system ICU, more than one hundred tests
      (out of a total of more than 40,000) are known to fail.
    </para>
    <para>
      To run the JIT test suite, issue:
      <command>make -C js/src check-jit-test
      JITTEST_EXTRA_ARGS="--timeout 300"</command>.
    </para>

    <caution>
      <para>
        An issue in the installation process causes any running program which
        links to JS91 shared library (for example, GNOME Shell) to crash if
        JS91 is upgraded or reinstalled.  To work around this issue, remove
        the old version of the JS91 shared library before installation:
      </para>

<screen role="root"><userinput>rm -fv /usr/lib/libmozjs-91.so</userinput></screen>
    </caution>

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

<screen role="root"><userinput>make install &amp;&amp;
rm -v /usr/lib/libjs_static.ajs &amp;&amp;
sed -i '/@NSPR_CFLAGS@/d' /usr/bin/js91-config</userinput></screen>

  </sect2>

  <!-- Several gjs-1.65.90 tests fail with js91.  Not sure why.
       OTOH an "otherwise" GNOME-3.36 environment works fine. -->

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <envar>CC=gcc CXX=g++</envar>: Upstream now prefers
      <application>clang</application>, override it like other Mozilla
      packages in BLFS book.
    </para>

    <para>
      <command>sh ../js/src/configure.in</command>:
      <filename>configure.in</filename> is actually a shell script, but
      the executable bit is not set in its permission mode so it's needed
      to explicitly run it with <command>sh</command>.
    </para>

    <para>
      <parameter>--with-intl-api</parameter>: This enables the
      internationalization functions required by
      <application>Gjs</application>.
    </para>

    <para>
      <parameter>--with-system-*</parameter>: These parameters allow the build system
      to use system versions of the above libraries. These are required for
      stability.
    </para>

    <para>
      <parameter>--enable-readline</parameter>: This switch enables Readline
      support in the JS shell.
    </para>

    <para>
      <parameter>--disable-jemalloc</parameter>: This switch disables the
      internal memory allocator used in JS91. jemalloc is only intended for
      the Firefox browser environment. For other applications using JS91,
      if JS91 uses jemalloc, the application may crash as items allocated
      in jemalloc allocator are freed on system (glibc) allocator.
    </para>

    <para>
      <parameter>--disable-debug-symbols</parameter>: Don't generate debug
      symbols since they are very large and most users won't need it. Remove
      it if you want to debug JS91.
    </para>

    <para>
      <command>rm -v /usr/lib/libjs_static.ajs</command>: Remove a large
      static library which is not used by any BLFS package.
    </para>

    <para>
      <command>sed -i '/@NSPR_CFLAGS@/d' /usr/bin/js91-config</command>:
      Prevent <command>js91-config</command> from using buggy CFLAGS.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          js91 and js91-config
        </seg>
        <seg>
          libmozjs-91.so
        </seg>
        <seg>
          /usr/include/mozjs-91
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="js91-js91">
        <term><command>js91</command></term>
        <listitem>
          <para>
            provides a command line interface to the
            <application>JavaScript</application> engine
          </para>
          <indexterm zone="js91 js91">
            <primary sortas="b-js91">js91</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="js91-config">
        <term><command>js91-config</command></term>
        <listitem>
          <para>
            is used to find the JS compiler and linker flags
          </para>
          <indexterm zone="js91 js91-config">
            <primary sortas="b-js91-config">js91-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libmozjs-91">
        <term><filename class="libraryfile">libmozjs-91.so</filename></term>
        <listitem>
          <para>
            contains the Mozilla JavaScript API functions
          </para>
          <indexterm zone="js91 libmozjs-91">
            <primary sortas="c-libmozjs91">libmozjs-91.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

</sect1>