From Fedora Project Wiki
(Created page with " == Summary == <!-- A sentence or two summarizing what this change is and what it will do. This information is used for the overall changeset summary page for each release. N...")
 
m (Add trackers)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
= libffi 3.4 =


== Summary ==
== Summary ==
<!-- A sentence or two summarizing what this change is and what it will do. This information is used for the overall changeset summary page for each release.  
<!-- A sentence or two summarizing what this change is and what it will do. This information is used for the overall changeset summary page for each release. Note that motivation for the change should be in the Benefit to Fedora section below, and this part should answer the question "What?" rather than "Why?". -->
Note that motivation for the change should be in the Benefit to Fedora section below, and this part should answer the question "What?" rather than "Why?". -->
Update libffi in Fedora 36 from libffi 3.1 to libffi 3.4 (released June 28 2021), and provide a libffi3.1 compatibility package to handle the library SONAME transition.
Rebase libffi in Fedora 34 from libffi 3.1 to libffi 3.3.9000.


== Owner ==
== Owner ==
Line 10: Line 10:
This should link to your home wiki page so we know who you are.  
This should link to your home wiki page so we know who you are.  
-->
-->
* Name: [[User:djdelorie| DJ Delorie]]
* Name: [[User:codonell| Carlos O'Donell]]
<!-- Include you email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. -->
<!-- Include you email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. -->
* Email: dj@redhat.com
* Email: carlos@redhat.com
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
Line 22: Line 22:


== Current status ==
== Current status ==
[[Category:ChangePageIncomplete]]
[[Category:ChangeAcceptedF36]]
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
Line 32: Line 32:
[[Category:SystemWideChange]]
[[Category:SystemWideChange]]


* Targeted release: [[Releases/34 | Fedora 34 ]]  
* Targeted release: [[Releases/36 | Fedora Linux 36 ]]  
* Last updated: <!-- this is an automatic macro — you don't need to change this line -->  {{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}  
* Last updated: <!-- this is an automatic macro — you don't need to change this line -->  {{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}  
<!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page  
<!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page  
Line 41: Line 41:
CLOSED as NEXTRELEASE -> change is completed and verified and will be delivered in next release under development
CLOSED as NEXTRELEASE -> change is completed and verified and will be delivered in next release under development
-->
-->
* FESCo issue: <will be assigned by the Wrangler>
* FESCo issue: [https://pagure.io/fesco/issue/2650 #2650]
* Tracker bug: <will be assigned by the Wrangler>
* Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=1990553 #1990553]
* Release notes tracker: <will be assigned by the Wrangler>
* Release notes tracker: [https://pagure.io/fedora-docs/release-notes/issue/736 #736]


== Detailed Description ==
== Detailed Description ==
Line 49: Line 49:
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->


Libffi 3.3 was released in November 2019, about a year agoSince then, Intel Control-flow Enforcement Technology support has been added, which is a desirable feature for Fedora.  Fedora is currently bundling libffi 3.1, released in 2014. Due to the slow release schedule of libffi, this Change Request is targetting an unofficial "3.3.9000" source tree in order to bring in post-3.3 changes needed by Fedora (FIXME modify wording as libffi 3.4 schedule solidifies)
Libffi 3.4 was released in June 28 2021 after a long period of upstream testing supported directly by Fedora (DJ Delorie).  Intel Control-flow Enforcement Technology support has been added, which is a desirable feature for Fedora.  Fedora is currently using libffi 3.1, released in 2014.


Note that this change will require an SONAME bump due to ABI changes. Because this affects Python, a side-tagged build of libffi, Python, and DNF is recommended to stage this change. No compat package is planned, packages using libffi must rebuild.
This change will require a SONAME bump due to ABI changes. A libffi3.1 package has been prepared, and tested in a side-tag along with libffi 3.4, and supports a smooth transition between existing binaries and binaries using the new library. No package needs to be rebuilt, old packages will require and install the compat libffi3.1 package.
Approximately 38 packages depend on libffi.so.6; approximately 158 depend on libffi.rpm.
 
The libffi3.1 package would enter the distribution first, followed by libffi updated to version 3.4. Again, no packages need to be rebuilt for the transition to happen.


== Feedback ==
== Feedback ==
Line 92: Line 93:
Stay compatible with other distros which have updated already.
Stay compatible with other distros which have updated already.


Add support for Intel CET and Power10
Add support for Intel CET and Power10.


== Scope ==
== Scope ==
* Proposal owners: Update to libffi 3.3 plus other upstream patches (or 3.4 if scheduled in time)
* Proposal owners: Update to libffi 3.4
<!-- What work do the feature owners have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
<!-- What work do the feature owners have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->


* Other developers: Packages which link against libffi must be rebuilt.  Depending on your API usage, some code changes might be needed as well.
* Other developers: Packages which link against libffi do not need be rebuilt.  Depending on your API usage, some code changes might be required after the update, but existing builds will continue to work.
<!-- What work do other developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
<!-- What work do other developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->


* Release engineering: [https://pagure.io/releng/issues #Releng issue number] (a check of an impact with Release Engineering is needed) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Release engineering: [https://pagure.io/releng/issue/10213 Releng 10213]<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- Does this feature require coordination with release engineering (e.g. changes to installer image generation or update package delivery)?  Is a mass rebuild required?  include a link to the releng issue.  
<!-- Does this feature require coordination with release engineering (e.g. changes to installer image generation or update package delivery)?  Is a mass rebuild required?  include a link to the releng issue.  
The issue is required to be filed prior to feature submission, to ensure that someone is on board to do any process development work and testing and that all changes make it into the pipeline; a bullet point in a change is not sufficient communication -->
The issue is required to be filed prior to feature submission, to ensure that someone is on board to do any process development work and testing and that all changes make it into the pipeline; a bullet point in a change is not sufficient communication -->
Line 117: Line 118:
<!-- What happens to systems that have had a previous versions of Fedora installed and are updated to the version containing this change? Will anything require manual configuration or data migration? Will any existing functionality be no longer supported? -->
<!-- What happens to systems that have had a previous versions of Fedora installed and are updated to the version containing this change? Will anything require manual configuration or data migration? Will any existing functionality be no longer supported? -->


Packages built against the previous version of libffi will need to be upgraded in sync with this change, during any upgrade. Conversely, updating packages that use libffi will require libffi also be upgraded.
Packages built on the previous version of libffi will have an auto-requires on the old SONAME and will cause dnf to install libffi3.1 (compat package with runtime). When packages are rebuilt against libffi 3.4 they will automatically switch to using the new SONAME.


libffi's latest static trampolines feature has been disabled because it has an impact on gobject-introspection (https://gitlab.gnome.org/GNOME/gobject-introspection/-/merge_requests/283) and ghc (https://gitlab.haskell.org/ghc/ghc/-/issues/20051).


== How To Test ==
== How To Test ==
Line 137: Line 139:
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->


libffi includes its own testsuite.  However, running Python's test suite should also be done.
libffi includes its own testsuite.  A side-tag rebuild has been carried out to rebuild dependent packages and verify their correct operation, this includes:
 
* python3.9
* dnf
* gobject-introspection
* glib2
* p11-kit
* rubygem-ffi
* guile22
* git-annex
* php
* llvm
 
Correct operation of these packages was verified by reviewing testsuite results.


== User Experience ==
== User Experience ==
Line 157: Line 172:


<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
Approximately 38 packages depend on libffi.so.6 and will need rebuilds.  Approximately 158 packages depend on libffi's RPM.
The key dependencies for libffi are python and dnf. Correct operation of python and dnf during the transition requires the libffi3.1 compat package to allow a smooth rebuild path from one SONAME to the next. Verification of this was carried out in a side-tag in Fedora Rawhide.
<pre>
$ dnf repoquery --whatrequires libffi.so.6
cjs-1:4.7.0-0.2.20201019gitbefc11a.fc34.i686
ecl-0:20.4.24-3.fc33.i686
gjs-0:1.66.1-3.fc34.i686
glib2-0:2.67.0-1.fc34.i686
gnustep-base-libs-0:1.27.0-4.fc33.i686
gobject-introspection-0:1.66.1-1.fc34.i686
gobject-introspection-devel-0:1.66.1-1.fc34.i686
guile-5:2.0.14-22.fc34.i686
guile22-0:2.2.6-6.fc34.i686
libffi-devel-0:3.1-26.fc33.i686
librep-0:0.92.7-12.fc33.i686
libwayland-client-0:1.18.0-2.fc33.i686
libwayland-cursor-0:1.18.0-2.fc33.i686
libwayland-server-0:1.18.0-2.fc33.i686
llvm-libs-0:11.0.0-2.fc34.i686
llvm10-libs-0:10.0.0-10.fc34.i686
llvm5.0-libs-0:5.0.1-11.fc32.i686
llvm6.0-libs-0:6.0.1-10.fc32.i686
llvm7.0-libs-0:7.0.1-7.fc34.i686
llvm9.0-libs-0:9.0.1-8.fc33.i686
moarvm-0:0.2020.07-1.fc34.i686
p11-kit-0:0.23.21-2.fc34.i686
polyml-libs-0:5.8.1-2.fc33.i686
pygobject2-0:2.28.7-11.fc33.i686
pypy-libs-0:7.3.1-2.fc33.i686
pypy3-0:7.3.1-3.fc33.i686
python2.7-0:2.7.18-6.fc34.i686
python3-debug-0:3.9.0-1.fc34.i686
python3-gobject-base-0:3.38.0-2.fc34.i686
python3-libs-0:3.9.0-1.fc34.i686
python3.10-0:3.10.0~a1-2.fc34.i686
python3.5-0:3.5.10-3.fc34.i686
python3.6-0:3.6.12-3.fc34.i686
python3.7-0:3.7.9-3.fc34.i686
python3.8-0:3.8.6-2.fc34.i686
racket-minimal-0:7.4-3.fc33.i686
ruby-libs-0:2.7.2-135.fc34.i686
yosys-0:0.9-8.fc34.i686
</pre>


== Contingency Plan ==
== Contingency Plan ==


<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
* Contingency mechanism: Revert to libffi 3.1
* Contingency mechanism: Revert to libffi 3.1 (dropping libffi3.1 and the libffi 3.4 update)
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
* Contingency deadline: Beta freeze, or any mass rebuild.
* Contingency deadline: 2021-08-24
<!-- Does finishing this feature block the release, or can we ship with the feature in incomplete state? -->
<!-- Does finishing this feature block the release, or can we ship with the feature in incomplete state? -->
* Blocks release? No
* Blocks release? No
Line 215: Line 189:
libffi includes its own documentation.  No additional documentation work is required.
libffi includes its own documentation.  No additional documentation work is required.


== Release Notes ==


The libffi 3.4 release notes:
* Add static trampoline support for Linux on x86_64 and ARM64.
* Add support for Alibaba's CSKY architecture.
* Add support for Kalray's KVX architecture.
* Add support for Intel Control-flow Enforcement Technology (CET).
* Add support for ARM Pointer Authentication (PA).
* Fix 32-bit PPC regression.
* Fix MIPS soft-float problem.
* Enable tmpdir override with the $LIBFFI_TMPDIR environment variable.
* Enable compatibility with MSVC runtime stack checking.
* Reject float and small integer argument in ffi_prep_cif_var().
    * Callers must promote these types themselves.


== Release Notes ==
Additional important changes for Fedora users (from libffi 3.1 to libffi 3.4):
* Add RISC-V support.
* New API in support of GO closures.
* Add IEEE754 binary128 long double support for 64-bit Power
* Default to Microsoft's 64-bit long double ABI with Visual C++.
* GNU compiler uses 80 bits (128 in memory) FFI_GNUW64 ABI.
* Add Windows on ARM64 (WOA) support.
* Add Windows 32-bit ARM support.
* Raw java (gcj) API deprecated.
* Add pre-built PDF documentation to source distribution.
* Many new test cases and bug fixes.


libffi does not public formal release notes.  A change list can be found in libffi's git history: https://github.com/libffi/libffi/commits/master
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this change, indicate them here.  A link to upstream documentation will often satisfy this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release.  
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this change, indicate them here.  A link to upstream documentation will often satisfy this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release.  

Latest revision as of 15:57, 5 August 2021

libffi 3.4

Summary

Update libffi in Fedora 36 from libffi 3.1 to libffi 3.4 (released June 28 2021), and provide a libffi3.1 compatibility package to handle the library SONAME transition.

Owner

Current status

Detailed Description

Libffi 3.4 was released in June 28 2021 after a long period of upstream testing supported directly by Fedora (DJ Delorie). Intel Control-flow Enforcement Technology support has been added, which is a desirable feature for Fedora. Fedora is currently using libffi 3.1, released in 2014.

This change will require a SONAME bump due to ABI changes. A libffi3.1 package has been prepared, and tested in a side-tag along with libffi 3.4, and supports a smooth transition between existing binaries and binaries using the new library. No package needs to be rebuilt, old packages will require and install the compat libffi3.1 package.

The libffi3.1 package would enter the distribution first, followed by libffi updated to version 3.4. Again, no packages need to be rebuilt for the transition to happen.

Feedback

Benefit to Fedora

Stay up to date with upstream libffi, including bug fixes et al.

Stay compatible with other distros which have updated already.

Add support for Intel CET and Power10.

Scope

  • Proposal owners: Update to libffi 3.4
  • Other developers: Packages which link against libffi do not need be rebuilt. Depending on your API usage, some code changes might be required after the update, but existing builds will continue to work.
  • Policies and guidelines: The policies and guidelines do not need to be updated.
  • Trademark approval: N/A (not needed for this Change)
  • Alignment with Objectives: None

Upgrade/compatibility impact

Packages built on the previous version of libffi will have an auto-requires on the old SONAME and will cause dnf to install libffi3.1 (compat package with runtime). When packages are rebuilt against libffi 3.4 they will automatically switch to using the new SONAME.

libffi's latest static trampolines feature has been disabled because it has an impact on gobject-introspection (https://gitlab.gnome.org/GNOME/gobject-introspection/-/merge_requests/283) and ghc (https://gitlab.haskell.org/ghc/ghc/-/issues/20051).

How To Test

libffi includes its own testsuite. A side-tag rebuild has been carried out to rebuild dependent packages and verify their correct operation, this includes:

  • python3.9
  • dnf
  • gobject-introspection
  • glib2
  • p11-kit
  • rubygem-ffi
  • guile22
  • git-annex
  • php
  • llvm

Correct operation of these packages was verified by reviewing testsuite results.

User Experience

The new version of libffi, aside from the usual internal bugfixes and tweaks, introduces support for Intel CET and Power10.

Dependencies

The key dependencies for libffi are python and dnf. Correct operation of python and dnf during the transition requires the libffi3.1 compat package to allow a smooth rebuild path from one SONAME to the next. Verification of this was carried out in a side-tag in Fedora Rawhide.

Contingency Plan

  • Contingency mechanism: Revert to libffi 3.1 (dropping libffi3.1 and the libffi 3.4 update)
  • Contingency deadline: 2021-08-24
  • Blocks release? No
  • Blocks product? N/A

Documentation

libffi includes its own documentation. No additional documentation work is required.

Release Notes

The libffi 3.4 release notes:

* Add static trampoline support for Linux on x86_64 and ARM64.
* Add support for Alibaba's CSKY architecture.
* Add support for Kalray's KVX architecture.
* Add support for Intel Control-flow Enforcement Technology (CET).
* Add support for ARM Pointer Authentication (PA).
* Fix 32-bit PPC regression.
* Fix MIPS soft-float problem.
* Enable tmpdir override with the $LIBFFI_TMPDIR environment variable.
* Enable compatibility with MSVC runtime stack checking.
* Reject float and small integer argument in ffi_prep_cif_var().
   * Callers must promote these types themselves.

Additional important changes for Fedora users (from libffi 3.1 to libffi 3.4):

* Add RISC-V support.
* New API in support of GO closures.
* Add IEEE754 binary128 long double support for 64-bit Power
* Default to Microsoft's 64-bit long double ABI with Visual C++.
* GNU compiler uses 80 bits (128 in memory) FFI_GNUW64 ABI.
* Add Windows on ARM64 (WOA) support.
* Add Windows 32-bit ARM support.
* Raw java (gcj) API deprecated.
* Add pre-built PDF documentation to source distribution.
* Many new test cases and bug fixes.