Compare commits

..

No commits in common. '1.0.0-prd' and 'master' have entirely different histories.

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!-- <!--
Copyright (c) 2019 OpenPOWER Foundation Copyright (c) 2019-2020 OpenPOWER Foundation
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
@ -34,7 +34,7 @@
<!-- TODO: Pick a Title for the new document --> <!-- TODO: Pick a Title for the new document -->
<title>Power Vector Intrinsic Programming Reference</title> <title>Power Vector Intrinsic Programming Reference</title>
<!-- TODO: Either add a subtitle or remove the following line --> <!-- TODO: Either add a subtitle or remove the following line -->
<!-- subtitle></subtitle --> <subtitle> </subtitle>


<info> <info>
<author> <author>
@ -50,11 +50,11 @@
</author> </author>
<copyright> <copyright>
<!-- TODO: Set copyright year --> <!-- TODO: Set copyright year -->
<year>2017-2019</year> <year>2017-2020</year>
<holder>OpenPOWER Foundation</holder> <holder>OpenPOWER Foundation</holder>
</copyright> </copyright>
<!-- TODO: Set the correct document releaseinfo --> <!-- TODO: Set the correct document releaseinfo -->
<releaseinfo>Revision 1.0.0_prd</releaseinfo> <releaseinfo>Revision 2.0.0_prd</releaseinfo>
<productname>OpenPOWER</productname> <productname>OpenPOWER</productname>
<pubdate/> <pubdate/>


@ -77,7 +77,7 @@
for vector programming on OpenPOWER systems, with an emphasis on examples for vector programming on OpenPOWER systems, with an emphasis on examples
of best practices. It further provides a reference for intrinsics of best practices. It further provides a reference for intrinsics
provided by compliant compilers on OpenPOWER systems.</para> provided by compliant compilers on OpenPOWER systems.</para>
<para>This document is a Non-standard Track, Work Group Specification work product owned by the <para>This document is a Standard Track, Work Group Specification work product owned by the
System Software Workgroup and handled in compliance with the requirements outlined in the System Software Workgroup and handled in compliance with the requirements outlined in the
<citetitle>OpenPOWER Foundation Work Group (WG) Process</citetitle> document. It was <citetitle>OpenPOWER Foundation Work Group (WG) Process</citetitle> document. It was
created using the <citetitle>Master Template Guide</citetitle> version &template_version;. created using the <citetitle>Master Template Guide</citetitle> version &template_version;.
@ -88,11 +88,21 @@
<revhistory> <revhistory>
<!-- TODO: Set the initial version information and clear any old information out --> <!-- TODO: Set the initial version information and clear any old information out -->
<revision> <revision>
<date>2019-11-12</date> <date>2021-09-08</date>
<revdescription> <revdescription>
<itemizedlist spacing="compact"> <itemizedlist spacing="compact">
<listitem> <listitem>
<para>Version 1.0.0_prd: Public Review Draft</para> <para>Version 2.0.0_prd public review draft</para>
</listitem>
</itemizedlist>
</revdescription>
</revision>
<revision>
<date>2020-08-11</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
<para>Version 1.0.0</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</revdescription> </revdescription>
@ -111,6 +121,7 @@
<xi:include href="ch_techniques.xml"/> <xi:include href="ch_techniques.xml"/>
<xi:include href="ch_vec_reference.xml"/> <xi:include href="ch_vec_reference.xml"/>
<!-- xi:include href="ch_scal_reference.xml"/ --> <!-- xi:include href="ch_scal_reference.xml"/ -->
<xi:include href="ch_mma_reference.xml"/>
<xi:include href="ch_isa_intrin_xref.xml"/> <xi:include href="ch_isa_intrin_xref.xml"/>
<!-- xi:include href="app_a.xml"/ --> <!-- xi:include href="app_a.xml"/ -->



File diff suppressed because it is too large Load Diff

@ -23,13 +23,17 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_intro">
<section> <section>
<title>A Brief History</title> <title>A Brief History</title>
<para> <para>
The history of vector programming on Power processors begins The history of vector programming on <phrase
revisionflag="changed"><trademark
class="registered">Power</trademark></phrase> processors begins
with the AIM (Apple, IBM, Motorola) alliance in the 1990s. The with the AIM (Apple, IBM, Motorola) alliance in the 1990s. The
AIM partners developed the Power Vector Media Extension (VMX) to AIM partners developed the Power Vector Media Extension (VMX) to
accelerate multimedia applications, particularly image accelerate multimedia applications, particularly image
processing. VMX is the name still used by IBM for this processing. VMX is the name still used by IBM for this
instruction set. Freescale (formerly Motorola) used the instruction set. Freescale (formerly Motorola) used the
trademark "AltiVec," while Apple at one time called it "Velocity trademark <phrase revisionflag="changed"><trademark
class="trade">AltiVec</trademark>,</phrase> while Apple at one
time called it "Velocity
Engine." While VMX remains the most official name, the term Engine." While VMX remains the most official name, the term
AltiVec is still in common use today. Freescale's AltiVec AltiVec is still in common use today. Freescale's AltiVec
Technology Programming Interface Manual (the "AltiVec PIM") is Technology Programming Interface Manual (the "AltiVec PIM") is
@ -68,27 +72,35 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_intro">
also included AltiVec support, and was used in the Apple also included AltiVec support, and was used in the Apple
PowerMac G5. IBM initially omitted support for VMX from its PowerMac G5. IBM initially omitted support for VMX from its
server-class computers, but added support for it in the POWER6 server-class computers, but added support for it in the POWER6
server family. <phrase revisionflag="added">processor-based</phrase> server
family.
</para> </para>
<para> <para>
IBM extended VMX by introducing the Vector-Scalar Extension IBM extended VMX by introducing the Vector-Scalar Extension
(VSX) for the POWER7 family of processors. VSX adds 64 logical (VSX) for the <phrase revisionflag="changed"><trademark
Vector Scalar Registers (VSRs); however, to optimize the amount class="registered">POWER7</trademark></phrase> family of
processors. VSX adds sixty-four
128-bit vector-scalar registers (VSRs); however, to optimize the amount
of per-process register state, the registers overlap with the of per-process register state, the registers overlap with the
VRs and the scalar floating-point registers (FPRs) (see <xref VRs and the scalar floating-point registers (FPRs) (see <xref
linkend="VIPR.intro.unified" />). The VSRs can represent all linkend="VIPR.intro.unified" />). The VSRs can represent all
the data types representable by the VRs, and can also be treated the data types representable by the VRs, and can also be treated
as containing two 64-bit integers or two 64-bit double-precision as containing two 64-bit integers or two 64-bit double-precision
floating-point values. However, ISA support for two 64-bit floating-point values. However, ISA support for two 64-bit
integers in VSRs was limited until Version 2.07 (POWER8) of the integers in VSRs was limited until Version 2.07 (<phrase
revisionflag="changed"><trademark
class="registered">POWER8</trademark></phrase>) of the
Power ISA, and only the VRs are supported for these Power ISA, and only the VRs are supported for these
instructions. instructions.
</para> </para>
<para> <para>
Both the VMX and VSX instruction sets have been expanded for the Both the VMX and VSX instruction sets have been expanded for the
POWER8 and POWER9 processor families. Starting with POWER8, <phrase revisionflag="changed">POWER8, <trademark
class="registered">POWER9</trademark>, and <trademark
class="registered">Power10</trademark></phrase> processor
families. Starting with POWER8,
a VSR can now contain a single 128-bit integer; and starting a VSR can now contain a single 128-bit integer; and starting
with POWER9, a VSR can contain a single 128-bit floating-point with POWER9, a VSR can contain a single 128-bit IEEE floating-point
value. Again, the ISA currently only supports 128-bit value. Again, the ISA currently only supports 128-bit
operations on values in the VRs. operations on values in the VRs.
</para> </para>
@ -103,7 +115,10 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_intro">
The Power architecture has supported operation in either The Power architecture has supported operation in either
big-endian (BE) or little-endian (LE) mode from the big-endian (BE) or little-endian (LE) mode from the
beginning. However, IBM's Power servers were only shipped beginning. However, IBM's Power servers were only shipped
with big-endian operating systems (AIX, Linux, i5/OS) prior to with big-endian operating systems (<phrase
revisionflag="changed"><trademark
class="registered">AIX</trademark>, IBM i, <trademark
class="registered">Linux</trademark></phrase>) prior to
the introduction of POWER8. With POWER8, IBM began the introduction of POWER8. With POWER8, IBM began
supporting little-endian Linux distributions for the first supporting little-endian Linux distributions for the first
time, and introduced a new application binary interface (the time, and introduced a new application binary interface (the
@ -135,7 +150,9 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_intro">
<section xml:id="VIPR.intro.unified"> <section xml:id="VIPR.intro.unified">
<title>The Unified Vector Register Set</title> <title>The Unified Vector Register Set</title>
<para> <para>
In OpenPOWER-compliant processors, floating-point and vector In <phrase revisionflag="changed"><trademark
class="trade">OpenPOWER</trademark>-compliant</phrase>
processors, floating-point and vector
operations are implemented using a unified vector-scalar model. operations are implemented using a unified vector-scalar model.
As shown in <xref linkend="FPR-VSR" /> and <xref As shown in <xref linkend="FPR-VSR" /> and <xref
linkend="VR-VSR" />, there are 64 vector-scalar registers; each linkend="VR-VSR" />, there are 64 vector-scalar registers; each
@ -201,14 +218,17 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_intro">
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<emphasis role="underline">The XL compilers</emphasis>. <emphasis role="underline">The XL <phrase
revisionflag="added">and Open XL</phrase>
compilers</emphasis>. For XL <phrase
revisionflag="added">and Open XL</phrase> compilers provided
with the Linux Community Edition, you can provide feedback
to the XL compiler team via email
(<email>compinfo@cn.ibm.com</email>); for other editions of
XL <phrase revisionflag="added">and Open XL</phrase>
compilers, please open a <link
xlink:href="https://www.ibm.com/mysupport/s/">Case</link>.
</para> </para>
<note>
<para>
Reporting procedures for XL bugs on Linux are yet to be
determined.
</para>
</note>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</section> </section>
@ -234,7 +254,9 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_intro">
<emphasis>AltiVec Technology Program Interface <emphasis>AltiVec Technology Program Interface
Manual.</emphasis> Manual.</emphasis>
<emphasis> <emphasis>
<link xlink:href="https://www.nxp.com/docs/en/reference-manual/ALTIVECPIM.pdf">https://www.nxp.com/docs/en/reference-manual/ALTIVECPIM.pdf <!-- Note: the %2e substitution for the "." in the URL is needed to work around unknown issues
in the link creation in PDF documents -->
<link xlink:href="https://www.nxp.com/docs/en/reference-manual/ALTIVECPIM%2epdf">https://www.nxp.com/docs/en/reference-manual/ALTIVECPIM.pdf
</link> </link>
</emphasis> </emphasis>
</para> </para>
@ -244,7 +266,9 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_intro">
<emphasis>Intel Architecture Instruction Set Extensions and <emphasis>Intel Architecture Instruction Set Extensions and
Future Features Programming Reference.</emphasis> Future Features Programming Reference.</emphasis>
<emphasis> <emphasis>
<link xlink:href="https://software.intel.com/sites/default/files/managed/c5/15/architecture-instruction-set-extensions-programming-reference.pdf">https://software.intel.com/sites/default/files/managed/c5/15/architecture-instruction-set-extensions-programming-reference.pdf <!-- Note: the %2e substitution for the "." in the URL is needed to work around unknown issues
in the link creation in PDF documents -->
<link xlink:href="https://software.intel.com/sites/default/files/managed/c5/15/architecture-instruction-set-extensions-programming-reference%2epdf">https://software.intel.com/sites/default/files/managed/c5/15/architecture-instruction-set-extensions-programming-reference.pdf
</link> </link>
</emphasis> </emphasis>
</para> </para>
@ -257,6 +281,40 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_intro">
<link xlink:href="https://openpowerfoundation.org/?resource_lib=power-isa-version-3-0">https://openpowerfoundation.org/?resource_lib=power-isa-version-3-0 <link xlink:href="https://openpowerfoundation.org/?resource_lib=power-isa-version-3-0">https://openpowerfoundation.org/?resource_lib=power-isa-version-3-0
</link> </link>
</emphasis> </emphasis>
<phrase revisionflag="added">
Need to update this to Version 3.1B, which is not yet published.
</phrase>
</para>
</listitem>
<listitem>
<para>
<emphasis>POWER8 Processor User's Manual for the Single-Chip
Module.</emphasis>
<emphasis>
<link xlink:href="https://ibm.ent.box.com/s/649rlau0zjcc0yrulqf4cgx5wk3pgbfk">https://ibm.ent.box.com/s/649rlau0zjcc0yrulqf4cgx5wk3pgbfk
</link>
</emphasis>
</para>
</listitem>
<listitem>
<para>
<emphasis>POWER9 Processor User's Manual.</emphasis>
<emphasis>
<link
xlink:href="https://ibm.ent.box.com/s/tmklq90ze7aj8f4n32er1mu3sy9u8k3k">https://ibm.ent.box.com/s/tmklq90ze7aj8f4n32er1mu3sy9u8k3k
</link>
</emphasis>
</para>
</listitem>
<listitem revisionflag="added">
<para>
<emphasis>Power10 Processor User's Manual.</emphasis>
<emphasis>
<link
xlink:href="https://ibm.ent.box.com/s/tmklq90ze7aj8f4n32er1mu3sy9u8k3k">Not
yet available, link is to P9 user's manual
</link>
</emphasis>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -268,11 +326,24 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_intro">
</emphasis> </emphasis>
</para> </para>
</listitem> </listitem>
<listitem>
<para>
<emphasis>POWER8 In-Core Cryptography: The Unofficial
Guide.</emphasis>
<emphasis>
<link
xlink:href="https://github.com/noloader/POWER8-crypto/blob/master/power8-crypto.pdf">https://github.com/noloader/POWER8-crypto/blob/master/power8-crypto.pdf
</link>
</emphasis>
</para>
</listitem>
<listitem> <listitem>
<para> <para>
<emphasis>Using the GNU Compiler Collection.</emphasis> <emphasis>Using the GNU Compiler Collection.</emphasis>
<emphasis> <emphasis>
<link xlink:href="https://gcc.gnu.org/onlinedocs/gcc.pdf">https://gcc.gnu.org/onlinedocs/gcc.pdf <!-- Note: the %2e substitution for the "." in the URL is needed to work around unknown issues
in the link creation in PDF documents -->
<link xlink:href="https://gcc.gnu.org/onlinedocs/gcc%2epdf">https://gcc.gnu.org/onlinedocs/gcc.pdf
</link> </link>
</emphasis> </emphasis>
</para> </para>
@ -285,7 +356,63 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_intro">
</emphasis> </emphasis>
</para> </para>
</listitem> </listitem>
<listitem revisionflag="added">
<para>
<emphasis>The GNU C Library Project.</emphasis>
<emphasis>
<link xlink:href="https://www.gnu.org/software/libc">https://www.gnu.org/software/libc</link>
</emphasis>
</para>
</listitem>
<listitem revisionflag="added">
<para>
<emphasis>Matrix-Multiply Assist Best Practices Guide.</emphasis>
<emphasis>
<link xlink:href="http://www.redbooks.ibm.com/redpapers/pdfs/redp5612.pdf">https://www.redbooks.ibm.com/redpapers/pdfs/redp5612.pdf</link>
</emphasis>
</para>
</listitem>
</itemizedlist> </itemizedlist>
</section> </section>


<section xml:id="VIPR.intro.marks" revisionflag="added">
<title>Trademarks</title>
<para>
AIX, POWER7, POWER8, POWER9, and Power10 are trademarks or
registered trademarks of International Business Machines
Corporation. Linux is a registered trademark of Linus
Torvalds. Intel is a registered trademark of Intel Corporation
or its subsidiaries. AltiVec is a trademark of Freescale
Semiconductor, Inc.
</para>
</section>

<section xml:id="VIPR.intro.conf">
<title>Conformance to this Specification</title>
<orderedlist>
<listitem>
<para>
Vector programs on OpenPOWER systems should follow the guide
and best practices for vector programming as outlined in
<xref linkend="VIPR.biendian" /> and in <xref
linkend="section_techniques" />.
</para>
</listitem>
<listitem>
<para>
Compliant compilers on OpenPOWER systems should provide
suitable support for intrinsic functions, preferably as
built-in vector functions that translate to one or more
Power ISA instructions as described in <xref
linkend="VIPR.biendian" /> and in <xref
linkend="VIPR.vec-ref" />. Compliant compilers targeting a
supported ISA level (2.7 or 3.0, for example) should provide
support for all intrinsic functions valid for that ISA
level, except where an intrinsic function is marked as
phased in, deferred, or deprecated.
</para>
</listitem>
</orderedlist>
</section>

</chapter> </chapter>

File diff suppressed because it is too large Load Diff

@ -113,7 +113,10 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_techniques">
references. (<code>restrict</code> can be used only in C references. (<code>restrict</code> can be used only in C
when compiling for the C99 standard or later. when compiling for the C99 standard or later.
<code>__restrict__</code> is a language extension, available <code>__restrict__</code> is a language extension, available
in both GCC and Clang, that can be used for both C and C++.) in GCC, Clang, and the XL <phrase revisionflag="added">and
Open XL</phrase> compilers, that can be used without
restriction for both C and C++. See your compiler's user
manual for details.)
</para> </para>
<para> <para>
Suppose you have a function that takes two pointer Suppose you have a function that takes two pointer
@ -140,8 +143,9 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_techniques">
</para> </para>
<para> <para>
This reference provides intrinsics that are guaranteed to be This reference provides intrinsics that are guaranteed to be
portable across compliant compilers. In particular, both the portable across compliant compilers. In particular, the <phrase
GCC and Clang compilers for Power implement the intrinsics in revisionflag="changed">GCC, Clang, and Open XL</phrase>
compilers for Power implement the intrinsics in
this manual. The compilers may each implement many more this manual. The compilers may each implement many more
intrinsics, but the ones in this manual are the only ones intrinsics, but the ones in this manual are the only ones
guaranteed to be portable. So if you are using an interface not guaranteed to be portable. So if you are using an interface not
@ -159,8 +163,8 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_techniques">
<xref linkend="VIPR.techniques.apis" />). In particular, the <xref linkend="VIPR.techniques.apis" />). In particular, the
Power Vector Library (see <xref Power Vector Library (see <xref
linkend="VIPR.techniques.pveclib" />) provides additional linkend="VIPR.techniques.pveclib" />) provides additional
portability across compiler versions, as well as interfaces that portability across compiler and ISA versions, as well as
hide cases where assembly language is needed. interfaces that hide cases where assembly language is needed.
</para> </para>
</section> </section>


@ -202,7 +206,15 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_techniques">
responsible for following the calling conventions established by responsible for following the calling conventions established by
the ABI (see <xref linkend="VIPR.intro.links" />). Again, it is the ABI (see <xref linkend="VIPR.intro.links" />). Again, it is
best to look at examples. One place to find well-written best to look at examples. One place to find well-written
<code>.S</code> files is in the GLIBC project. <code>.S</code> files is in the <phrase
revisionflag="changed">GNU C Library project (see <xref
linkend="VIPR.intro.links" />).</phrase> You can also
study the assembly output from your favorite compiler, which can
be obtained with the <code>-S</code> or similar option, or by
using the <emphasis role="bold">objdump</emphasis> utility:
</para>
<para revisionflag="added">
<programlisting> objdump -dr &lt;binary or object file&gt;</programlisting>
</para> </para>
</section> </section>


@ -214,13 +226,18 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_techniques">
<section> <section>
<title>x86 Vector Portability Headers</title> <title>x86 Vector Portability Headers</title>
<para> <para>
Recent versions of the GCC and Clang open source compilers Recent versions of the <phrase revisionflag="changed">GCC,
provide "drop-in" portability headers for portions of the Clang, and Open XL</phrase> compilers
Intel Architecture Instruction Set Extensions (see <xref for Power provide "drop-in" portability headers for portions
of the <phrase revisionflag="changed"><trademark
class="registered">Intel</trademark></phrase> Architecture
Instruction Set Extensions (see <xref
linkend="VIPR.intro.links" />). These headers mirror the APIs linkend="VIPR.intro.links" />). These headers mirror the APIs
of Intel headers having the same names. Support is provided of Intel headers having the same names. As of this writing,
for the MMX and SSE layers, up through SSE4. At this time, no support is provided for the MMX and SSE layers, up through
support for the AVX layers is envisioned. SSE3 and portions of SSE4. No support for the AVX layers is
envisioned. The portability headers are available starting
with GCC 8.1 and Clang 9.0.0.
</para> </para>
<para> <para>
The portability headers provide the same semantics as the The portability headers provide the same semantics as the
@ -236,14 +253,18 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="section_techniques">
<para> <para>
Access to the portability APIs occurs automatically when Access to the portability APIs occurs automatically when
including one of the corresponding Intel header files, such as including one of the corresponding Intel header files, such as
<code>&lt;mmintrin.h&gt;</code>. <code>&lt;mmintrin.h&gt;</code>. <phrase
revisionflag="added">To enable the portability headers, you
must compile with
<code>-DNO_WARN_X86_INTRINSICS</code>.</phrase>
</para> </para>
</section> </section>
<section xml:id="VIPR.techniques.pveclib"> <section xml:id="VIPR.techniques.pveclib">
<title>The Power Vector Library (pveclib)</title> <title>The Power Vector Library (pveclib)</title>
<para>The Power Vector Library, also known as <para>The Power Vector Library, also known as
<code>pveclib</code>, is a separate project available from <code>pveclib</code>, is a separate project available from
github (see <xref linkend="VIPR.intro.links" />). The <phrase revisionflag="changed">GitHub</phrase> (see <xref
linkend="VIPR.intro.links" />). The
<code>pveclib</code> project builds on top of the intrinsics <code>pveclib</code> project builds on top of the intrinsics
described in this manual to provide higher-level vector described in this manual to provide higher-level vector
interfaces that are highly portable. The goals of the project interfaces that are highly portable. The goals of the project

File diff suppressed because it is too large Load Diff

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 17 KiB

@ -92,9 +92,9 @@ work group and should not be shared with
other Foundation members or the public other Foundation members or the public


The appropriate starting security for a new document is "workgroupConfidential". --> The appropriate starting security for a new document is "workgroupConfidential". -->
<!-- security>workgroupConfidential</security --> <security>workgroupConfidential</security>
<!-- security>foundationConfidential</security --> <!-- security>foundationConfidential</security -->
<security>public</security> <!-- security>public</security -->


<!-- TODO: Set the appropriate work flow status for the document. For documents <!-- TODO: Set the appropriate work flow status for the document. For documents
which are not "published" this will affect the document title page which are not "published" this will affect the document title page
@ -109,9 +109,9 @@ not yet been reviewed
review = this document is presently being reviewed review = this document is presently being reviewed


The appropriate starting security for a new document is "draft". --> The appropriate starting security for a new document is "draft". -->
<!-- documentStatus>draft</documentStatus --> <documentStatus>draft</documentStatus>
<documentStatus>review</documentStatus> <!-- documentStatus>review</documentStatus -->
<!-- documentStatus>publish</documentStatus --> <!-- documentStatus>published</documentStatus -->
</configuration> </configuration>
</execution> </execution>
</executions> </executions>

@ -37,8 +37,7 @@ This can be accomplished with the following steps:
The project which controls the look and feel of the document is the The project which controls the look and feel of the document is the
[Docs-Maven-Plugin project](https://github.com/OpenPOWERFoundation/Docs-Maven-Plugin), an [Docs-Maven-Plugin project](https://github.com/OpenPOWERFoundation/Docs-Maven-Plugin), an
OpenPOWER Foundation private project on GitHub. To obtain access to the Maven Plugin project, OpenPOWER Foundation private project on GitHub. To obtain access to the Maven Plugin project,
contact Jeff Scheel \([scheel@us.ibm.com](mailto://scheel@us.ibm.com)\) or contact TSC Chair of the OpenPOWER Foundation \([tsc-chair@openpowerfoundation.org](mailto://tsc-chair@openpowerfoundation.org)\) or
Jeff Brown \([jeffdb@us.ibm.com](mailto://jeffdb@us.ibm.com)\).


## License ## License
This project is licensed under the Apache V2 license. More information This project is licensed under the Apache V2 license. More information

@ -19,5 +19,6 @@
enable all document builds from the top level --> enable all document builds from the top level -->
<module>Porting_Vector_Intrinsics</module> <module>Porting_Vector_Intrinsics</module>
<module>Intrinsics_Reference</module> <module>Intrinsics_Reference</module>
<module>pvipr-errata-1.0</module>
</modules> </modules>
</project> </project>

@ -0,0 +1,110 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2021 OpenPOWER Foundation

Licensed under the GNU Free Documentation License, Version 1.3;
with no Invariants Sections, with no Front-Cover Texts,
and with no Back-Cover Texts (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.gnu.org/licenses/fdl-1.3.txt

-->

<!-- The following entity variable is used to reflect the version of the
template document master used for building a document. This value
should be set by copy of the of template used to create a new
document and should not be changed. Use of this value is in
in the Abstract section in this file. -->
<!DOCTYPE book [
<!ENTITY template_version "1.1.0">
]>

<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="bk_main">

<title>OpenPOWER PVIPR Errata</title>
<subtitle>For POWER Intrinsics Reference v1.5</subtitle>

<info>
<author>
<personname>
System Software Work Group
</personname>
<email>syssw-chair@openpowerfoundation.org</email>
<affiliation>
<orgname>OpenPower Foundation</orgname>
</affiliation>
</author>
<copyright>
<year>2021</year>
<holder>OpenPOWER Foundation</holder>
</copyright>
<releaseinfo>Revision 1.0</releaseinfo>
<productname>OpenPOWER</productname>
<pubdate/>

<!-- TODO: Select one of the two following legalnotice role= values:
"apache2" for an Apache V2 license or
"opfExternal" for an official OpenPOWER Foundation external license text.
If you don't know which one to select, change to "opfExternal" and ask your TSC representative. -->
<!-- legalnotice role="apache2" -->
<!-- legalnotice role="opfExternal" -->
<!-- Following matches the ABI itself -->
<legalnotice role="gnuFreeDoc">

<annotation>
<remark>Copyright details are filled in by the template.</remark>
</annotation>
</legalnotice>

<!-- TODO: Update the following text with the correct document description (first paragraph),
Work Group name, and Work Product track (both in second paragraph). -->
<abstract>
<para>This document provides errata against version 1.0 of the
POWER Vector Intrinsics Programming Reference Specification. These
errata should be considered part of said specification until such
time as a newer version of the full specification is published.</para>
<para>This document is a Non-standard Track, Work Group Note work
product owned by the System Software Workgroup and handled in compliance
with the requirements outlined in the <citetitle>OpenPOWER Foundation
Work Group (WG) Process</citetitle> document. It was created using the
<citetitle>Document Development Guide</citetitle> version
&template_version;. Comments, questions, etc. can be submitted to the
public mailing list for the parent specification at
<email>syssw-programming-guides@mailinglist.openpowerfoundation.org</email>.</para>
</abstract>

<revhistory>
<!-- TODO: Set the initial version information and clear any old information out -->
<revision>
<date>2021-06-09</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
<para>Revision 1.0</para>
</listitem>
</itemizedlist>
</revdescription>
</revision>
</revhistory>
</info>

<!-- The ch_preface.xml file is required by all documents -->
<xi:include href="../../Docs-Master/common/ch_preface.xml"/>

<!-- TODO: Add your chapter heading files here. Remove both files and insert your own. -->
<!-- See the template document for naming conventions and location of files. -->
<xi:include href="ch_errata.xml"/>

<!-- The app_foundation.xml appendix file is required by all documents. -->
<xi:include href="../../Docs-Master/common/app_foundation.xml"/>

<!-- TODO: The following template document may be modified to create additional appendices as needed. -->
<!-- xi:include href="app_template.xml"/ -->

</book>

@ -0,0 +1,110 @@
<!--
Copyright (c) 2021 OpenPOWER Foundation

Licensed under the GNU Free Documentation License, Version 1.3;
with no Invariants Sections, with no Front-Cover Texts,
and with no Back-Cover Texts (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.gnu.org/licenses/fdl-1.3.txt

-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en"
xml:id="dbdoclet.50655240_pgfId-1156194">

<title>Errata</title>
<para>The following sections of version 1.0 of the POWER Vector Intrinsics
Programming Reference are modified as specified.</para>
<section>
<title>Section 4.2, Built-In Vector Functions</title>
<para>
<emphasis role="underline">Problem</emphasis>: For intrinsics that
represent vector load and store operations, the arguments that
represent offsets from a pointer are listed as having type "signed
long long." Although this is correct for 64-bit code, and this is
a 64-bit specification, it is recognized that this is not
compatible with existing 32-bit implementations. This can be
resolved using the type "signed long" instead, which is 64 bits on
a 64-bit system and 32 bits on a 32-bit system.
</para>
<para>
<emphasis role="underline">Resolution</emphasis>: The following
changes are incorporated for each of the specified built-in
functions.
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">vec_ld</emphasis>: All types in column
<emphasis role="bold">a</emphasis> are changed to <emphasis
role="bold">signed long</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">vec_lde</emphasis>: All types in column
<emphasis role="bold">a</emphasis> are changed to <emphasis
role="bold">signed long</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">vec_ldl</emphasis>: All types in column
<emphasis role="bold">a</emphasis> are changed to <emphasis
role="bold">signed long</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">vec_st</emphasis>: All types in column
<emphasis role="bold">b</emphasis> are changed to <emphasis
role="bold">signed long</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">vec_ste</emphasis>: All types in column
<emphasis role="bold">b</emphasis> are changed to <emphasis
role="bold">signed long</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">vec_stl</emphasis>: All types in column
<emphasis role="bold">b</emphasis> are changed to <emphasis
role="bold">signed long</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">vec_xl</emphasis>: All types in column
<emphasis role="bold">a</emphasis> are changed to <emphasis
role="bold">signed long</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">vec_xl_be</emphasis>: All types in column
<emphasis role="bold">a</emphasis> are changed to <emphasis
role="bold">signed long</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">vec_xst</emphasis>: All types in column
<emphasis role="bold">b</emphasis> are changed to <emphasis
role="bold">signed long</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">vec_xst_be</emphasis>: All types in column
<emphasis role="bold">b</emphasis> are changed to <emphasis
role="bold">signed long</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>
</chapter>

@ -0,0 +1,155 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2021 OpenPOWER Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<parent>

<groupId>org.openpowerfoundation.docs</groupId>
<artifactId>workgroup-pom</artifactId>
<version>1.0.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>

<artifactId>pvipr-1_0-errata</artifactId>

<packaging>jar</packaging>

<name>POWER Vector Intrinsics Programming Reference 1.0 Errata</name>

<properties>
<!-- This is set by Jenkins according to the branch. -->
<release.path.name></release.path.name>
<comments.enabled>0</comments.enabled>
</properties>
<!-- ################################################ -->
<!-- USE "mvn clean generate-sources" to run this POM -->
<!-- ################################################ -->
<build>
<plugins>
<plugin>

<groupId>org.openpowerfoundation.docs</groupId>

<artifactId>openpowerdocs-maven-plugin</artifactId>
<!-- version set in ../pom.xml -->
<executions>
<execution>
<id>generate-webhelp</id>
<goals>
<goal>generate-webhelp</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<!-- These parameters only apply to webhelp -->
<enableDisqus>${comments.enabled}</enableDisqus>
<disqusShortname>openpower-template-guide</disqusShortname>
<enableGoogleAnalytics>1</enableGoogleAnalytics>
<googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
<generateToc>
appendix toc,title
article/appendix nop
article toc,title
book toc,title,figure,table,example,equation
book/appendix nop
book/chapter nop
chapter toc,title
chapter/section nop
section toc
part toc,title
reference toc,title
set toc,title
</generateToc>
<!-- The following elements sets the autonumbering of sections in output for chapter numbers but no numbered sections-->
<sectionAutolabel>1</sectionAutolabel>
<tocSectionDepth>3</tocSectionDepth>
<sectionLabelIncludesComponentLabel>1</sectionLabelIncludesComponentLabel>

<webhelpDirname>pvipr-1_0-errata</webhelpDirname>

<pdfFilenameBase>pvipr-1_0-errata</pdfFilenameBase>

<!-- TODO: Define the appropriate work product type. These values are defined by the IPR Policy.
Consult with the Work Group Chair or a Technical Steering Committee member if you have
questions about which value to select.

If no value is provided below, the document will default to "Work Group Notes".-->
<workProduct>workgroupNotes</workProduct>
<!-- workProduct>workgroupSpecification</workProduct -->
<!-- workProduct>candidateStandard</workProduct -->
<!-- workProduct>openpowerStandard</workProduct -->

<!-- TODO: Set the appropriate security policy for the document. For documents
which are not "public" this will affect the document title page and
create a vertical running ribbon on the internal margin of the
security status in all CAPS. Values and definitions are formally
defined by the IPR policy. A layman's definition follows:

public = this document may be shared outside the
foundation and thus this setting must be
used only when completely sure it allowed
foundationConfidential = this document may be shared freely with
OpenPOWER Foundation members but may not be
shared publicly
workgroupConfidential = this document may only be shared within the
work group and should not be shared with
other Foundation members or the public

The appropriate starting security for a new document is "workgroupConfidential". -->
<!-- security>workgroupConfidential</security -->
<!-- security>foundationConfidential</security -->
<security>public</security>

<!-- TODO: Set the appropriate work flow status for the document. For documents
which are not "published" this will affect the document title page
and create a vertical running ribbon on the internal margin of the
security status in all CAPS. Values and definitions are formally
defined by the IPR policy. A layman's definition follows:

published = this document has completed all reviews and has
been published
draft = this document is actively being updated and has
not yet been reviewed
review = this document is presently being reviewed

The appropriate starting security for a new document is "draft". -->
<!-- documentStatus>draft</documentStatus -->
<!-- documentStatus>review</documentStatus -->
<documentStatus>published</documentStatus>
</configuration>
</execution>
</executions>
<configuration>
<!-- These parameters apply to pdf and webhelp -->
<xincludeSupported>true</xincludeSupported>
<sourceDirectory>.</sourceDirectory>
<includes>
bk_main.xml
</includes>

<!-- **TODO: Set to the correct project URL. This likely needs input from the TSC. -->
<!-- canonicalUrlBase>http://openpowerfoundation.org/docs/template-guide/content</canonicalUrlBase -->
<glossaryCollection>${basedir}/../glossary/glossary-terms.xml</glossaryCollection>
<includeCoverLogo>1</includeCoverLogo>
<coverUrl>www.openpowerfoundation.org</coverUrl>
</configuration>
</plugin>
</plugins>
</build>
</project>
Loading…
Cancel
Save