Bug 2176934 - Review Request: x86-simd-sort - C++ header file library for high performance SIMD based sorting algorithms
Summary: Review Request: x86-simd-sort - C++ header file library for high performance ...
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Linux
unspecified
unspecified
Target Milestone: ---
Assignee: Benson Muite
QA Contact: Fedora Extras Quality Assurance
URL: https://github.com/intel/x86-simd-sort
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2023-03-09 17:51 UTC by Ali Erdinc Koroglu
Modified: 2023-04-26 11:09 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-04-26 11:09:21 UTC
Type: Bug
Embargoed:
benson_muite: fedora-review+


Attachments (Terms of Use)
The .spec file difference from Copr build 5619356 to 5655976 (1.40 KB, patch)
2023-03-17 16:12 UTC, Jakub Kadlčík
no flags Details | Diff
The .spec file difference from Copr build 5655976 to 5779249 (1.77 KB, patch)
2023-04-13 15:27 UTC, Jakub Kadlčík
no flags Details | Diff

Description Ali Erdinc Koroglu 2023-03-09 17:51:41 UTC
SPEC Url: https://download.copr.fedorainfracloud.org/results/aekoroglu/fedora/fedora-rawhide-x86_64/05619345-x86-simd-sort/x86-simd-sort.spec
SRPM Url: https://download.copr.fedorainfracloud.org/results/aekoroglu/fedora/fedora-rawhide-x86_64/05619345-x86-simd-sort/x86-simd-sort-1.0-1.fc39.src.rpm

Description:
C++ header file library for SIMD based 16-bit, 32-bit and 64-bit data type sorting on x86 processors. Source header files are available in src directory. We currently only have AVX-512 based implementation of quicksort. This repository also includes a test suite which can be built and run to test the sorting algorithms for correctness. It also has benchmarking code to compare its performance relative to std::sort.

Comment 1 Jakub Kadlčík 2023-03-09 17:57:47 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/5619356
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2176934-x86-simd-sort/fedora-rawhide-x86_64/05619356-x86-simd-sort/fedora-review/review.txt

Please take a look if any issues were found.

---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 2 Benson Muite 2023-03-12 09:29:40 UTC
Package Review
==============

Legend:
[x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated
[ ] = Manual review needed


Issues:
=======
- Header files in -devel subpackage, if present.
  Note: x86-simd-sort : /usr/include/avx512-common-qsort.h
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/#_devel_packages


===== MUST items =====

Generic:
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[x]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "BSD 3-Clause License", "*No copyright*
     MIT License", "MIT License BSD 3-Clause License". 8 files have unknown
     license. Detailed output of licensecheck in
     /home/FedoraPackaging/reviews/x86-simd-sort/2176934-x86-simd-sort/
     licensecheck.txt
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[-]: Package contains desktop file if it is a GUI application.
[!]: Development files must be in a -devel package
[x]: Package uses nothing in %doc for runtime.
[x]: Package consistently uses macros (instead of hard-coded directory
     names).
[x]: Package is named according to the Package Naming Guidelines.
[x]: Package does not generate any conflict.
[x]: Package obeys FHS, except libexecdir and /usr/target.
[-]: If the package is a rename of another package, proper Obsoletes and
     Provides are present.
[ ]: Requires correct, justified where necessary.
[x]: Spec file is legible and written in American English.
[-]: Package contains systemd file(s) if in need.
[ ]: Package is not known to require an ExcludeArch tag.
[-]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 10240 bytes in 1 files.
[ ]: Package complies to the Packaging Guidelines
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
[x]: Package installs properly.
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).
[x]: If (and only if) the source package includes the text of the
     license(s) in its own file, then that file, containing the text of the
     license(s) for the package is included in %license.
[x]: Package requires other packages for directories it uses.
[x]: Package must own all directories that it creates.
[x]: Package does not own files or directories owned by other packages.
[x]: Package uses either %{buildroot} or $RPM_BUILD_ROOT
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[x]: Macros in Summary, %description expandable at SRPM build time.
[x]: Dist tag is present.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Package must not depend on deprecated() packages.
[x]: Package use %makeinstall only when make install DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: Package does not use a name that already exists.
[x]: Package is not relocatable.
[x]: Sources used to build the package match the upstream source, as
     provided in the spec URL.
[x]: Spec file name must match the spec package %{name}, in the format
     %{name}.spec.
[x]: File names are valid UTF-8.
[x]: Packages must not store files under /srv, /opt or /usr/local

===== SHOULD items =====

Generic:
[-]: If the source package does not include license text(s) as a separate
     file from upstream, the packager SHOULD query upstream to include it.
[x]: Final provides and requires are sane (see attachments).
[ ]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[ ]: Patches link to upstream bugs/comments/lists or are otherwise
     justified.
[ ]: The placement of pkgconfig(.pc) files are correct.
     Note: x86-simd-sort : /usr/share/pkgconfig/x86-simd-sort.pc
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[-]: Package should compile and build into binary rpms on all supported
     architectures.
[!]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[x]: Reviewer should test that the package builds in mock.
[x]: Buildroot is not present
[x]: Package has no %clean section with rm -rf %{buildroot} (or
     $RPM_BUILD_ROOT)
[x]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: Sources can be downloaded from URI in Source: tag
[x]: SourceX is a working URL.
[x]: Spec use %global instead of %define unless justified.

===== EXTRA items =====

Generic:
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: x86-simd-sort-1.0-1.fc39.noarch.rpm
          x86-simd-sort-1.0-1.fc39.src.rpm
======================================================================== rpmlint session starts =======================================================================
rpmlint: 2.4.0
configuration:
    /usr/lib/python3.11/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-legacy-licenses.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
rpmlintrc: [PosixPath('/tmp/tmpdgvuxzs3')]
checks: 31, packages: 2

x86-simd-sort.noarch: W: devel-file-in-non-devel-package /usr/include/avx512-16bit-qsort.hpp
x86-simd-sort.noarch: W: devel-file-in-non-devel-package /usr/include/avx512-32bit-qsort.hpp
x86-simd-sort.noarch: W: devel-file-in-non-devel-package /usr/include/avx512-64bit-qsort.hpp
x86-simd-sort.noarch: W: devel-file-in-non-devel-package /usr/include/avx512-common-qsort.h
x86-simd-sort.noarch: W: devel-file-in-non-devel-package /usr/share/pkgconfig/x86-simd-sort.pc
========================================= 2 packages and 0 specfiles checked; 0 errors, 5 warnings, 0 badness; has taken 2.0 s ========================================




Rpmlint (installed packages)
----------------------------
============================ rpmlint session starts ============================
rpmlint: 2.4.0
configuration:
    /usr/lib/python3.11/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-legacy-licenses.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
checks: 31, packages: 1

x86-simd-sort.noarch: W: devel-file-in-non-devel-package /usr/include/avx512-16bit-qsort.hpp
x86-simd-sort.noarch: W: devel-file-in-non-devel-package /usr/include/avx512-32bit-qsort.hpp
x86-simd-sort.noarch: W: devel-file-in-non-devel-package /usr/include/avx512-64bit-qsort.hpp
x86-simd-sort.noarch: W: devel-file-in-non-devel-package /usr/include/avx512-common-qsort.h
x86-simd-sort.noarch: W: devel-file-in-non-devel-package /usr/share/pkgconfig/x86-simd-sort.pc
 1 packages and 0 specfiles checked; 0 errors, 5 warnings, 0 badness; has taken 0.1 s 



Source checksums
----------------
https://github.com/intel/x86-simd-sort/archive/v1.0/x86-simd-sort-1.0.tar.gz :
  CHECKSUM(SHA256) this package     : 90823bd359fb1cbb34511eb92812c63adb42fac5131fd8248fe7d92d47cc8c42
  CHECKSUM(SHA256) upstream package : 90823bd359fb1cbb34511eb92812c63adb42fac5131fd8248fe7d92d47cc8c42


Requires
--------
x86-simd-sort (rpmlib, GLIBC filtered):
    /usr/bin/pkg-config



Provides
--------
x86-simd-sort:
    pkgconfig(x86-simd-sort)
    x86-simd-sort



Generated by fedora-review 0.9.0 (6761b6c) last change: 2022-08-23
Command line :/usr/bin/fedora-review -b 2176934
Buildroot used: fedora-rawhide-x86_64
Active plugins: Generic, Shell-api
Disabled plugins: C/C++, R, Haskell, Perl, fonts, Ocaml, PHP, SugarActivity, Ruby, Java, Python
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comments:
a) This should be a -devel package as it will be used to build other software
b) Most Fedora packages target x86 cpus with minimum SSE instructions.  Some users may not be able to run
software built with this, though compilers will be able to build for cpus with avx512 even on 
hardware without avx512. 
c) There are tests available, can these be run if avx512 instructions are available?
d) Can this be used in cross-compilation? If not, maybe it should be x86 only?

Comment 3 Benson Muite 2023-03-13 05:55:13 UTC
Please see https://docs.fedoraproject.org/en-US/packaging-guidelines/#_packaging_header_only_libraries
Need to use a -devel package with 
Provides: x86-simd-sort-static = %{version}-%{release}

Comment 5 Jakub Kadlčík 2023-03-17 16:12:29 UTC
Created attachment 1951507 [details]
The .spec file difference from Copr build 5619356 to 5655976

Comment 6 Jakub Kadlčík 2023-03-17 16:12:31 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/5655976
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2176934-x86-simd-sort/fedora-rawhide-x86_64/05655976-x86-simd-sort/fedora-review/review.txt

Please take a look if any issues were found.

---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 7 Benson Muite 2023-03-19 11:43:35 UTC
Thanks for the updates. The test does not need to be packaged, but can be run, either test
if avx512 instructions are available and if so run directly, if not perhaps use QEMU. For
an example using QEMU see:
https://src.fedoraproject.org/rpms/xbyak_aarch64/blob/rawhide/f/xbyak_aarch64.spec

Changes to the meson.build file does not create a test. Made a pull request to enable tests
to build using meson:
https://github.com/intel/x86-simd-sort/pull/21

The executables for tests and benchmarks should build even if avx512 instructions are not
available, but need not be packaged.  The license and README files can then be put in the
devel package.

Comment 9 Jakub Kadlčík 2023-04-13 15:27:40 UTC
Created attachment 1957355 [details]
The .spec file difference from Copr build 5655976 to 5779249

Comment 10 Jakub Kadlčík 2023-04-13 15:27:42 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/5779249
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2176934-x86-simd-sort/fedora-rawhide-x86_64/05779249-x86-simd-sort/fedora-review/review.txt

Please take a look if any issues were found.

---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 11 Benson Muite 2023-04-17 02:28:48 UTC
Thanks for the updates. Approved.

Comment 12 Benson Muite 2023-04-17 08:58:50 UTC
On importing rather than glob the entire include directory
%{_includedir}/*
perhaps use
%{_includedir}/*.hpp
%{_includedir}/*.h

Comment 13 Ali Erdinc Koroglu 2023-04-26 06:46:02 UTC
Sure I'll do that, thanks.

Comment 14 Fedora Admin user for bugzilla script actions 2023-04-26 06:47:13 UTC
The Pagure repository was created at https://src.fedoraproject.org/rpms/x86-simd-sort

Comment 15 Miro Hrončok 2023-04-26 08:10:05 UTC
can't install x86-simd-sort-devel:
  - nothing provides x86-simd-sort = 1.0-1.fc39 needed by x86-simd-sort-devel-1.0-1.fc39.noarch

Comment 16 Ali Erdinc Koroglu 2023-04-26 10:00:01 UTC
Thank you Miro good catch, could you please try this

sudo dnf upgrade --refresh --advisory=FEDORA-2023-d9f453c43d

Comment 17 Miro Hrončok 2023-04-26 11:09:21 UTC
Works.


Note You need to log in before you can comment on or make changes to this bug.