From c460520e179975d0c4f000cef7eeae5c998a53bf Mon Sep 17 00:00:00 2001 From: "A. Maitland Bottoms" Date: Sun, 25 Feb 2024 08:51:33 -0500 Subject: [PATCH] Import volk_3.1.2-1.debian.tar.xz [dgit import tarball volk 3.1.2-1 volk_3.1.2-1.debian.tar.xz] --- changelog | 686 +++++++++++++++++++++++++++++++ control | 83 ++++ copyright | 152 +++++++ libvolk-bin.install | 2 + libvolk-bin.manpages | 3 + libvolk-dev.install | 4 + libvolk-doc.doc-base | 19 + libvolk-doc.docs | 1 + libvolk3.1.install | 1 + not-not-installed | 6 + patches/doxygen-pdf | 74 ++++ patches/omit-doxygen-build-paths | 81 ++++ patches/optional-static-apps | 25 ++ patches/series | 3 + rules | 19 + source/format | 1 + upstream/metadata | 4 + volk-config-info.1 | 45 ++ volk_modtool.1 | 112 +++++ volk_profile.1 | 5 + watch | 4 + 21 files changed, 1330 insertions(+) create mode 100644 changelog create mode 100644 control create mode 100644 copyright create mode 100644 libvolk-bin.install create mode 100644 libvolk-bin.manpages create mode 100644 libvolk-dev.install create mode 100644 libvolk-doc.doc-base create mode 100644 libvolk-doc.docs create mode 100644 libvolk3.1.install create mode 100644 not-not-installed create mode 100644 patches/doxygen-pdf create mode 100644 patches/omit-doxygen-build-paths create mode 100644 patches/optional-static-apps create mode 100644 patches/series create mode 100755 rules create mode 100644 source/format create mode 100644 upstream/metadata create mode 100644 volk-config-info.1 create mode 100644 volk_modtool.1 create mode 100644 volk_profile.1 create mode 100644 watch diff --git a/changelog b/changelog new file mode 100644 index 0000000..4f23754 --- /dev/null +++ b/changelog @@ -0,0 +1,686 @@ +volk (3.1.2-1) unstable; urgency=medium + + * New upstream release. + - Replace sse2neon with native NEON + - Remove loop unrolling + - Simplify Spiral-generated code + + -- A. Maitland Bottoms Sun, 25 Feb 2024 08:51:33 -0500 + +volk (3.1.1-4) unstable; urgency=medium + + * fix clean rule to keep sse2neon.h in place + + -- A. Maitland Bottoms Tue, 30 Jan 2024 19:00:06 -0500 + +volk (3.1.1-3) unstable; urgency=medium + + * Just patch in sse2neon.h where it should be. + + -- A. Maitland Bottoms Tue, 30 Jan 2024 13:36:17 -0500 + +volk (3.1.1-2) unstable; urgency=medium + + * arm64 build uses sse2neon.h + update debian/watch and debian/rules to provide it + + -- A. Maitland Bottoms Tue, 30 Jan 2024 13:36:08 -0500 + +volk (3.1.1-1) unstable; urgency=medium + + * New upstream release + This is a maintenance release to fix subtle bugs in many areas and to + improve our tests where possible. All in all, our CI is more stable now + and catches more errors. + CI fixes + - Allow for rounding error in float-to-int conversions + - Allow for rounding error in `volk_32fc_s32f_magnitude_16i` + - Allow for rounding error in float-to-int interleave + - Add missing `volk_16_byteswap_u_orc` to puppet + - Fix 64-bit integer testing + - Build and test neonv7 protokernels on armv7 + + kernels + - Remove broken sse32 kernels + - Fix flaky `fm_detect` test + - Fix flaky `mod_range` test + - Remove unnecessary volatiles from `volk_32fc_s32f_magnitude_16i` + - Remove SSE protokernels written in assembly + - Remove inline assembler from `volk_32fc_convert_16ic_neon` + - Use bit shifts in generic and `byte_shuffle` reverse + - Remove disabled SSE4.1 dot product + - Fix `conv_k7_r2` kernel and puppet + - Remove unused argument from renormalize + - Align types in ORC function signatures + - Uncomment AVX2 implementation + - Renormalize in every iteration on AVX2 + - Remove extraneous permutations + - Compute the minimum over both register lanes + - `volk_32fc_s32f_atan2_32f`: Add NaN tests for avx2 and avx2fma code + + fixes + - Express version information in decimal + - Remove `__VOLK_VOLATILE` + - Remove references to simdmath library + - cmake: Switch to GNUInstallDirs + - fprintf: Remove fprintf statements from `volk_malloc` + - release: Prepare release with updated files + - Get the sse2neon.h file to a git submodule to avoid random copies. + + -- A. Maitland Bottoms Tue, 30 Jan 2024 00:13:23 -0500 + +volk (3.1.0-3) unstable; urgency=medium + + * add powerpc to cpu-features dependency + + -- A. Maitland Bottoms Sat, 16 Dec 2023 09:31:28 -0500 + +volk (3.1.0-2) unstable; urgency=medium + + * Avoid ORC on x32, led to test failures + * include argilo-volk/all-i386-patches + * update available cpu-features architecture list + * Express version information in decimal + * add debian/upstream/metadata + * clean __pycahe__ (Closes: #1048046) + + -- A. Maitland Bottoms Fri, 15 Dec 2023 17:57:14 -0500 + +volk (3.1.0-1) experimental; urgency=medium + + * New upstream release + Improved CMake build + Better tests + New kernel API (old API still available) + New and Updated kernels + * Upload to experimental for soversion bump + + -- A. Maitland Bottoms Tue, 05 Dec 2023 18:12:20 -0500 + +volk (3.0.0-2) unstable; urgency=medium + + * upload to unstable + + -- A. Maitland Bottoms Sat, 15 Jul 2023 21:58:53 -0400 + +volk (3.0.0-1) experimental; urgency=medium + + * New upstream release + - License switch to LGPLv3+ + - Fix build for 32 bit arm with neon + - Add experimental support for MIPS and RISC-V + * Upload to experimental for package renames and soversion bump + + -- A. Maitland Bottoms Sat, 14 Jan 2023 14:01:06 -0500 + +volk (2.5.2-3) unstable; urgency=medium + + * orc 1:0.4.33-1 dropped building static library, + so now volk will drop building its static library too. (Closes: #1026593) + + -- A. Maitland Bottoms Tue, 20 Dec 2022 20:03:23 -0500 + +volk (2.5.2-2) unstable; urgency=medium + + * revert changes to kernels/volk/volk_8u_x2_encodeframepolar_8u.h + made by make-acc-happy patch since version 1.3-1 (Closes: #1021856) + + -- A. Maitland Bottoms Sat, 15 Oct 2022 23:41:48 -0400 + +volk (2.5.2-1) unstable; urgency=medium + + * New upstream release. + * volk_8u_x4_conv_k7_r2_8u + - Add NEON implementation `neonspiral` via `sse2neon.h` + * Fixes + - Fix out-of-bounds reads + - Fix broken neon kernels + - Fix float to int conversion + * CMake + - Suppress superfluous warning + - Fix Python install path calculation and documentation + + -- A. Maitland Bottoms Sun, 04 Sep 2022 12:00:56 -0400 + +volk (2.5.1-2) unstable; urgency=medium + + * VolkPython use posix prefix scheme (Closes: #1009394) + + -- A. Maitland Bottoms Tue, 12 Apr 2022 18:39:33 -0400 + +volk (2.5.1-1) unstable; urgency=medium + + * New upstream release. + + -- A. Maitland Bottoms Sun, 13 Feb 2022 00:18:58 -0500 + +volk (2.5.0-2) unstable; urgency=medium + + * upload to unstable + * with some upstream bugfixes + + -- A. Maitland Bottoms Thu, 21 Oct 2021 23:30:05 -0400 + +volk (2.5.0-1) experimental; urgency=medium + + * New upstream release + * Use libcpu-features-dev on powerpc and x32 (Closes: #978602) + * Mention volk-config-info and volk_modtool in description (Closes: #989263) + * Upload to experimental for soversion bump + + -- A. Maitland Bottoms Thu, 10 Jun 2021 18:29:47 -0400 + +volk (2.4.1-2) unstable; urgency=medium + + [ Shengjing Zhu ] + * Use system cpu_features package + + [ A. Maitland Bottoms ] + * Adopt Use system cpu_features package patch (Closes: #978096) + + -- A. Maitland Bottoms Sun, 27 Dec 2020 15:16:07 -0500 + +volk (2.4.1-1) unstable; urgency=medium + + * New upstream release + + -- A. Maitland Bottoms Thu, 17 Dec 2020 23:53:21 -0500 + +volk (2.4.0-4) unstable; urgency=medium + + * skip cpu_features on "Unsupported OS" kFreeBSD + * bump Standards-Version - no other changes. + + -- A. Maitland Bottoms Tue, 15 Dec 2020 19:53:16 -0500 + +volk (2.4.0-3) unstable; urgency=medium + + * Fix binary-indep build (Closes: #976300) + * Upload to unstable + + -- A. Maitland Bottoms Thu, 03 Dec 2020 20:43:29 -0500 + +volk (2.4.0-2) experimental; urgency=medium + + * Make use of cpu_features a CMake option with sensible defaults per arch + + -- A. Maitland Bottoms Mon, 30 Nov 2020 16:19:19 -0500 + +volk (2.4.0-1) experimental; urgency=medium + + * New upstream release + * cpu_features git submodule packaged as cpu-features source component. + * Upload to experimental for soversion bump + + -- A. Maitland Bottoms Sun, 22 Nov 2020 12:35:43 -0500 + +volk (2.3.0-3) unstable; urgency=medium + + * update to v2.3.0-14-g91e5d07 + emit an emms instruction after using the mmx extension + + -- A. Maitland Bottoms Tue, 30 Jun 2020 19:48:20 -0400 + +volk (2.3.0-2) unstable; urgency=medium + + * Upload to unstable + + -- A. Maitland Bottoms Mon, 11 May 2020 07:26:03 -0400 + +volk (2.3.0-1) experimental; urgency=medium + + * New upstream release, to experimental for soversion bump + * Kernels + - volk: accurate exp kernel + - exp: Rename SSE4.1 to SSE2 kernel + - Add 32f_s32f_add_32f kernel + - This kernel adds in vector + scalar functionality + - Fix the broken index max kernels + - Treat the mod_range puppet as such + - Add puppet for power spectral density kernel + - Updated log10 calcs to use faster log2 approach + - fix: Use unaligned load + - divide: Optimize complexmultiplyconjugate + + -- A. Maitland Bottoms Sat, 09 May 2020 15:42:23 -0400 + +volk (2.2.1-3) unstable; urgency=medium + + * update to v2.2.1-34-gd4756c5 + + -- A. Maitland Bottoms Sun, 05 Apr 2020 10:37:46 -0400 + +volk (2.2.1-2) unstable; urgency=medium + + * update to v2.2.1-11-gfaf230e + * cmake: Remove the ORC from the VOLK public link interface + * Fix the broken index max kernels + + -- A. Maitland Bottoms Fri, 27 Mar 2020 21:48:10 -0400 + +volk (2.2.1-1) unstable; urgency=high + + * New upstream bugfix release + reason for high urgency: + - Fix loop bound in AVX rotator (only one fixed in 2.2.0-3) + - Fix out-of-bounds read in AVX2 square dist kernel + - Fix length checks in AVX2 index max kernels + + -- A. Maitland Bottoms Mon, 24 Feb 2020 18:08:05 -0500 + +volk (2.2.0-3) unstable; urgency=high + + * Update to v2.2.0-6-g5701f8f + reason for high urgency: + - Fix loop bound in AVX rotator + + -- A. Maitland Bottoms Sun, 23 Feb 2020 23:49:18 -0500 + +volk (2.2.0-2) unstable; urgency=medium + + * Upload to unstable + + -- A. Maitland Bottoms Tue, 18 Feb 2020 17:56:58 -0500 + +volk (2.2.0-1) experimental; urgency=medium + + * New upstream release + - Remove build dependency on python six + - Fixup VolkConfigVersion + - add volk_version.h + + -- A. Maitland Bottoms Sun, 16 Feb 2020 18:25:20 -0500 + +volk (2.1.0-2) unstable; urgency=medium + + * Upload to unstable + + -- A. Maitland Bottoms Sun, 05 Jan 2020 23:17:57 -0500 + +volk (2.1.0-1) experimental; urgency=medium + + * New upstream release + - The AVX FMA rotator bug is fixed + - VOLK offers `volk::vector<>` for C++ to follow RAII + - Use C++17 `std::filesystem` + - This enables VOLK to be built without Boost if available! + - lots of bugfixes + - more optimized kernels, especially more NEON versions + * Upload to experimental for new ABI library package libvolk2.1 + + -- A. Maitland Bottoms Sun, 22 Dec 2019 10:27:36 -0500 + +volk (2.0.0-3) unstable; urgency=medium + + * update to v2.0.0-4-gf04a46f + + -- A. Maitland Bottoms Thu, 14 Nov 2019 22:47:23 -0500 + +volk (2.0.0-2) unstable; urgency=medium + + * Upload to unstable + + -- A. Maitland Bottoms Mon, 12 Aug 2019 22:49:11 -0400 + +volk (2.0.0-1) experimental; urgency=medium + + * New upstream release + + -- A. Maitland Bottoms Wed, 07 Aug 2019 23:31:20 -0400 + +volk (1.4-4) unstable; urgency=medium + + * working volk_modtool with Python 3 + * build and install libvolk.a + + -- A. Maitland Bottoms Mon, 29 Oct 2018 01:32:05 -0400 + +volk (1.4-3) unstable; urgency=medium + + * update to v1.4-9-g297fefd + Added an AVX protokernel for volk_32fc_x2_32f_square_dist_scalar_mult_32f + fixed a buffer over-read and over-write in + volk_32fc_x2_s32f_square_dist_scalar_mult_32f_a_avx + Fix 32u_reverse_32u for ARM + + -- A. Maitland Bottoms Sat, 12 May 2018 15:25:04 -0400 + +volk (1.4-2) unstable; urgency=medium + + * Upload to unstable, needed by gnuradio (>= 3.7.12.0) + + -- A. Maitland Bottoms Tue, 03 Apr 2018 01:03:19 -0400 + +volk (1.4-1) experimental; urgency=medium + + * New upstream release + upstream changelog http://libvolk.org/release-v14.html + + -- A. Maitland Bottoms Tue, 27 Mar 2018 22:57:42 -0400 + +volk (1.3.1-1) unstable; urgency=medium + + * New upstream bugfix release + * Refresh all debian patches for use with git am + + -- A. Maitland Bottoms Tue, 27 Mar 2018 21:54:29 -0400 + +volk (1.3-3) unstable; urgency=medium + + * update to v1.3-23-g0109b2e + * update debian/libvolk1-dev.abi.tar.gz.amd64 + * Add breaks/replaces gnuradio (<=3.7.2.1) (LP: #1614235) + + -- A. Maitland Bottoms Sun, 04 Feb 2018 13:12:21 -0500 + +volk (1.3-2) unstable; urgency=medium + + * update to v1.3-16-g28b03a9 + apps: fix profile update reading end of lines + qa: lower tolerance for 32fc_mag to fix issue #96 + * include upstream master patch to sort input files + + -- A. Maitland Bottoms Sun, 27 Aug 2017 13:44:55 -0400 + +volk (1.3-1) unstable; urgency=medium + + * New upstream release + * The index_max kernels were named with the wrong output datatype. To + fix this there are new kernels that return a 32u (int32_t) and the + existing kernels had their signatures changed to return 16u (int16_t). + * The output to stdout and stderr has been shuffled around. There is no + longer a message that prints what VOLK machine is being used and the + warning messages go to stderr rather than stdout. + * The 32fc_index_max kernels previously were only accurate to the SSE + register width (4 points). This was a pretty serious and long-lived + bug that's been fixed and the QA updated appropriately. + + -- A. Maitland Bottoms Sat, 02 Jul 2016 16:30:47 -0400 + +volk (1.2.2-2) unstable; urgency=medium + + * update to v1.2.2-11-g78c8bc4 (to follow gnuradio maint branch) + + -- A. Maitland Bottoms Sun, 19 Jun 2016 14:44:15 -0400 + +volk (1.2.2-1) unstable; urgency=medium + + * New upstream release + + -- A. Maitland Bottoms Fri, 08 Apr 2016 00:12:10 -0400 + +volk (1.2.1-2) unstable; urgency=medium + + * Upstream patches: + Fix some CMake complaints + The fix for compilation with cmake 3.5 + + -- A. Maitland Bottoms Wed, 23 Mar 2016 17:47:54 -0400 + +volk (1.2.1-1) unstable; urgency=medium + + * New upstream release + + -- A. Maitland Bottoms Sun, 07 Feb 2016 19:38:32 -0500 + +volk (1.2-1) unstable; urgency=medium + + * New upstream release + + -- A. Maitland Bottoms Thu, 24 Dec 2015 20:28:13 -0500 + +volk (1.1.1-5) experimental; urgency=medium + + * update to v1.1.1-22-gef53547 to support gnuradio 3.7.9 + + -- A. Maitland Bottoms Fri, 11 Dec 2015 13:12:55 -0500 + +volk (1.1.1-4) unstable; urgency=medium + + * more lintian fixes + + -- A. Maitland Bottoms Wed, 25 Nov 2015 21:49:58 -0500 + +volk (1.1.1-3) unstable; urgency=medium + + * Lintian fixes Pre-Depends + + -- A. Maitland Bottoms Thu, 19 Nov 2015 21:24:27 -0500 + +volk (1.1.1-2) unstable; urgency=medium + + * Note that libvolk1-dev replaces files in gnuradio-dev versions <<3.7.8 + (Closes: #802646) again. Thanks Andreas Beckmann. + + -- A. Maitland Bottoms Fri, 13 Nov 2015 18:45:49 -0500 + +volk (1.1.1-1) unstable; urgency=medium + + * New upstream release + * New architectures exist for the AVX2 and FMA ISAs. + * The profiler now generates buffers that are vlen + a tiny amount and + generates random data to fill buffers. This is intended to catch bugs + in protokernels that write beyond num_points. + * Note that libvolk1-dev replaces files in earlier gnuradio-dev versions + (Closes: #802646) + + -- A. Maitland Bottoms Sun, 01 Nov 2015 18:45:43 -0500 + +volk (1.1-4) unstable; urgency=medium + + * update to v1.1-12-g264addc + + -- A. Maitland Bottoms Tue, 29 Sep 2015 23:41:50 -0400 + +volk (1.1-3) unstable; urgency=low + + * drop dh_acc to get reproducible builds + + -- A. Maitland Bottoms Fri, 11 Sep 2015 22:57:06 -0400 + +volk (1.1-2) unstable; urgency=low + + * use dh-acc + + -- A. Maitland Bottoms Mon, 07 Sep 2015 15:45:20 -0400 + +volk (1.1-1) unstable; urgency=medium + + * re-organize package naming convention + * New upstream release tag v1.1 + New architectures exist for the AVX2 and FMA ISAs. Along + with the build-system support the following kernels have + no proto-kernels taking advantage of these architectures: + + * 32f_x2_dot_prod_32f + * 32fc_x2_multiply_32fc + * 64_byteswap + * 32f_binary_slicer_8i + * 16u_byteswap + * 32u_byteswap + + QA/profiler + ----------- + + The profiler now generates buffers that are vlen + a tiny + amount and generates random data to fill buffers. This is + intended to catch bugs in protokernels that write beyond + num_points. + + -- A. Maitland Bottoms Wed, 26 Aug 2015 09:22:48 -0400 + +volk (1.0.2-2) unstable; urgency=low + + * Use SOURCE_DATE_EPOCH from the environment, if defined, + rather than current date and time to implement volk_build_date() + (embedding build date in a library does not help reproducible builds) + * add watch file + + -- A. Maitland Bottoms Sat, 15 Aug 2015 17:43:15 -0400 + +volk (1.0.2-1) unstable; urgency=medium + + * Maintenance release 24 Jul 2015 by Nathan West + * The major change is the CMake logic to add ASM protokernels. Rather + than depending on CFLAGS and ASMFLAGS we use the results of VOLK's + built in has_ARCH tests. All configurations should work the same as + before, but manually specifying CFLAGS and ASMFLAGS on the cmake call + for ARM native builds should no longer be necessary. + * The 32fc_s32fc_x2_rotator_32fc generic protokernel now includes a + previously implied header. + * Finally, there is a fix to return the "best" protokernel to the + dispatcher when no volk_config exists. Thanks to Alexandre Raymond for + pointing this out. + * with maint branch patch: + kernels-add-missing-include-arm_neon.h + * removed unused build-dependency on liboil0.3-dev (closes: #793626) + + -- A. Maitland Bottoms Wed, 05 Aug 2015 00:43:40 -0400 + +volk (1.0.1-1) unstable; urgency=low + + * Maintenance Release v1.0.1 08 Jul 2015 by Nathan West + This is a maintenance release with bug fixes since the initial release of + v1.0 in April. + + * Contributors + + The following authors have contributed code to this release: + + Doug Geiger doug.geiger@bioradiation.net + Elliot Briggs elliot.briggs@gmail.com + Marcus Mueller marcus@hostalia.de + Nathan West nathan.west@okstate.edu + Tom Rondeau tom@trondeau.com + + * Kernels + + Several bug fixes in different kernels. The NEON implementations of the + following kernels have been fixed: + + 32f_x2_add_32f + 32f_x2_dot_prod_32f + 32fc_s32fc_multiply_32fc + 32fc_x2_multiply_32fc + + Additionally the NEON asm based 32f_x2_add_32f protokernels were not being + used and are now included and available for use via the dispatcher. + + The 32f_s32f_x2_fm_detect_32f kernel now has a puppet. This solves QA seg + faults on 32-bit machines and provide a better test for this kernel. + + The 32fc_s32fc_x2_rotator_32fc generic protokernel replaced cabsf with + hypotf for better Android support. + + * Building + + Static builds now trigger the applications (volk_profile and + volk-config-info) to be statically linked. + + The file gcc_x86_cpuid.h has been removed since it was no longer being + used. Previously it provided cpuid functionality for ancient compilers + that we do not support. + + All build types now use -Wall. + + * QA and Testing + + The documentation around the --update option to volk_profile now makes it + clear that the option will only profile kernels without entries in + volk_profile. The signature of run_volk_tests with expanded args changed + signed types to unsigned types to reflect the actual input. + + The remaining changes are all non-functional changes to address issues + from Coverity. + + -- A. Maitland Bottoms Fri, 10 Jul 2015 17:57:42 -0400 + +volk (1.0-5) unstable; urgency=medium + + * native-armv7-build-support skips neon on Debian armel (Closes: #789972) + + -- A. Maitland Bottoms Sat, 04 Jul 2015 12:36:36 -0400 + +volk (1.0-4) unstable; urgency=low + + * update native-armv7-build-support patch from gnuradio volk package + + -- A. Maitland Bottoms Thu, 25 Jun 2015 16:38:49 -0400 + +volk (1.0-3) unstable; urgency=medium + + * Add Breaks/Replaces (Closes: #789893, #789894) + * Allow failing tests + + -- A. Maitland Bottoms Thu, 25 Jun 2015 12:46:06 -0400 + +volk (1.0-2) unstable; urgency=medium + + * kernels-add-missing-math.h-include-to-rotator + + -- A. Maitland Bottoms Wed, 24 Jun 2015 21:09:32 -0400 + +volk (1.0-1) unstable; urgency=low + + * Initial package (Closes: #782417) + Initial Release 11 Apr 2015 by Nathan West + + VOLK 1.0 is available. This is the first release of VOLK as an independently + tracked sub-project of GNU Radio. + + * Contributors + + VOLK has been tracked separately from GNU Radio since 2014 Dec 23. + Contributors between the split and the initial release are + + Albert Holguin aholguin_77@yahoo.com + Doug Geiger doug.geiger@bioradiation.net + Elliot Briggs elliot.briggs@gmail.com + Julien Olivain julien.olivain@lsv.ens-cachan.fr + Michael Dickens michael.dickens@ettus.com + Nathan West nathan.west@okstate.edu + Tom Rondeau tom@trondeau.com + + * QA + + The test and profiler have significantly changed. The profiler supports + run-time changes to vlen and iters to help kernel development and provide + more flexibility on embedded systems. Additionally there is a new option + to update an existing volk_profile results file with only new kernels which + will save time when updating to newer versions of VOLK + + The QA system creates a static list of kernels and test cases. The QA + testing and profiler iterate over this static list rather than each source + file keeping its own list. The QA also emits XML results to + lib/.unittest/kernels.xml which is formatted similarly to JUnit results. + + * Modtool + + Modtool was updated to support the QA and profiler changes. + + * Kernels + + New proto-kernels: + + 16ic_deinterleave_real_8i_neon + 16ic_s32f_deinterleave_32f_neon + fix preprocessor errors for some compilers on byteswap and popcount puppets + + ORC was moved to the asm kernels directory. + volk_malloc + + The posix_memalign implementation of Volk_malloc now falls back to a standard + malloc if alignment is 1. + + * Miscellaneous + + Several build system and cmake changes have made it possible to build VOLK + both independently with proper soname versions and in-tree for projects + such as GNU Radio. + + The static builds take advantage of cmake object libraries to speed up builds. + + Finally, there are a number of changes to satisfy compiler warnings and make + QA work on multiple machines. + + -- A. Maitland Bottoms Sun, 12 Apr 2015 23:20:41 -0400 diff --git a/control b/control new file mode 100644 index 0000000..a104ede --- /dev/null +++ b/control @@ -0,0 +1,83 @@ +Source: volk +Section: libdevel +Priority: optional +Maintainer: A. Maitland Bottoms +Build-Depends: cmake, + debhelper-compat (= 13), + dh-python, + libcpu-features-dev [amd64 arm64 armel armhf i386 mips64el ppc64 ppc64el riscv64 s390x powerpc x32], + liborc-0.4-dev [!x32], + python3-dev, + python3-mako +Build-Depends-Indep: doxygen, graphviz +Standards-Version: 4.6.2 +Rules-Requires-Root: no +Homepage: https://libvolk.org +Vcs-Browser: https://salsa.debian.org/bottoms/pkg-volk +Vcs-Git: https://salsa.debian.org/bottoms/pkg-volk.git + +Package: libvolk3.1 +Section: libs +Architecture: any +Pre-Depends: ${misc:Pre-Depends} +Depends: ${misc:Depends}, ${shlibs:Depends} +Multi-Arch: same +Recommends: libvolk-bin +Suggests: libvolk-dev +Description: vector optimized functions + Vector-Optimized Library of Kernels is designed to help applications + work with the processor's SIMD instruction sets. These are very + powerful vector operations that can give signal processing a huge + boost in performance. + +Package: libvolk-dev +Architecture: any +Pre-Depends: ${misc:Pre-Depends} +Depends: libvolk3.1 (=${binary:Version}), ${misc:Depends} +Breaks: libvolk1-dev, libvolk1.0-dev, libvolk2-dev +Replaces: libvolk1-dev, libvolk1.0-dev, libvolk2-dev +Suggests: libvolk-doc +Multi-Arch: same +Description: vector optimized function headers + Vector-Optimized Library of Kernels is designed to help applications + work with the processor's SIMD instruction sets. These are very + powerful vector operations that can give signal processing a huge + boost in performance. + . + This package contains the header files. + For documentation, see libvolk-doc. + +Package: libvolk-bin +Section: libs +Architecture: any +Pre-Depends: ${misc:Pre-Depends} +Depends: libvolk3.1 (=${binary:Version}), + ${misc:Depends}, + ${python3:Depends}, + ${shlibs:Depends} +Breaks: libvolk1-bin, libvolk1.0-bin, libvolk2-bin +Replaces: libvolk1-bin, libvolk1.0-bin, libvolk2-bin +Description: vector optimized runtime tools + Vector-Optimized Library of Kernels is designed to help applications + work with the processor's SIMD instruction sets. These are very + powerful vector operations that can give signal processing a huge + boost in performance. + . + This package includes: the volk_profile tool to customize settings for + the system; volk_modtool to create new optimized modules; and + volk-config-info to show settings. + +Package: libvolk-doc +Section: doc +Architecture: all +Multi-Arch: foreign +Depends: ${misc:Depends} +Recommends: www-browser +Description: vector optimized library documentation + Vector-Optimized Library of Kernels is designed to help applications + work with the processor's SIMD instruction sets. These are very + powerful vector operations that can give signal processing a huge + boost in performance. + . + This package includes the Doxygen generated documentation in + /usr/share/doc/libvolk-dev/html/index.html diff --git a/copyright b/copyright new file mode 100644 index 0000000..440c5dc --- /dev/null +++ b/copyright @@ -0,0 +1,152 @@ +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: volk +Upstream-Contact: http://libvolk.org/ +Source: + https://github.com/gnuradio/volk +Comment: + Debian packages by A. Maitland Bottoms + . + Upstream Maintainers: + Johannes Demel + Michael Dickens +Copyright: 2014-2023 Free Software Foundation, Inc. +License: LGPL-3+ + +Files: * +Copyright: 2006, 2009-2023, Free Software Foundation, Inc. +License: LGPL-3+ + +Files: apps/volk_profile.h +Copyright: 2014-2020 Free Software Foundation, Inc. +License: LGPL-3+ + +Files: appveyor.yml +Copyright: 2016 Paul Cercueil +License: LGPL-3+ + +Files: cmake/* +Copyright: 2014-2020 Free Software Foundation, Inc. +License: LGPL-3+ + +Files: cmake/Modules/* +Copyright: 2006, 2009-2020, Free Software Foundation, Inc. +License: LGPL-3+ + +Files: cmake/Modules/CMakeParseArgumentsCopy.cmake +Copyright: 2010 Alexander Neundorf +License: Kitware-BSD + All rights reserved. + . + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + . + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + . + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + . + * Neither the names of Kitware, Inc., the Insight Software Consortium, + nor the names of their contributors may be used to endorse or promote + products derived from this software without specific prior written + permission. + . + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +Files: cmake/Modules/FindORC.cmake + cmake/Modules/VolkConfig.cmake.in +Copyright: 2014-2015 Free Software Foundation, Inc. +License: LGPL-3+ + +Files: cmake/msvc/* +Copyright: 2006-2008, Alexander Chemeris +License: BSD-2-clause + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are met: + . + 1. Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + . + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + . + 3. The name of the author may be used to endorse or promote products + derived from this software without specific prior written permission. + . + THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED + WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO + EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; + OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, + WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR + OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +Files: debian/* +Copyright: 2015-2020 Free Software Foundation, Inc +License: LGPL-3+ +Comment: assigned by A. Maitland Bottoms + +Files: docs/* +Copyright: 2014-2015 Free Software Foundation, Inc. +License: LGPL-3+ + +Files: gen/archs.xml + gen/machines.xml +Copyright: 2014-2015 Free Software Foundation, Inc. +License: LGPL-3+ + +Files: include/volk/volk_common.h + include/volk/volk_complex.h + include/volk/volk_prefs.h +Copyright: 2014-2015 Free Software Foundation, Inc. +License: LGPL-3+ + +Files: kernels/volk/asm/* +Copyright: 2014-2015 Free Software Foundation, Inc. +License: LGPL-3+ + +Files: kernels/volk/volk_16u_byteswappuppet_16u.h + kernels/volk/volk_32u_byteswappuppet_32u.h + kernels/volk/volk_64u_byteswappuppet_64u.h +Copyright: 2014-2015 Free Software Foundation, Inc. +License: LGPL-3+ + +Files: lib/kernel_tests.h + lib/qa_utils.cc + lib/qa_utils.h + lib/volk_prefs.c +Copyright: 2014-2015 Free Software Foundation, Inc. +License: LGPL-3+ + +License: LGPL-3+ + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + . + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + . + You should have received a copy of the GNU Lesser General Public License + along with this program. If not, see . + . + On Debian systems, the complete text of the GNU Lesser General + Public License version 3 can be found in "/usr/share/common-licenses/LGPL-3". diff --git a/libvolk-bin.install b/libvolk-bin.install new file mode 100644 index 0000000..2f34922 --- /dev/null +++ b/libvolk-bin.install @@ -0,0 +1,2 @@ +usr/bin/volk* +usr/lib/python3*/site-packages/* usr/lib/python3/dist-packages/ diff --git a/libvolk-bin.manpages b/libvolk-bin.manpages new file mode 100644 index 0000000..95bae9e --- /dev/null +++ b/libvolk-bin.manpages @@ -0,0 +1,3 @@ +debian/volk-config-info.1 +debian/volk_modtool.1 +debian/volk_profile.1 diff --git a/libvolk-dev.install b/libvolk-dev.install new file mode 100644 index 0000000..4b391be --- /dev/null +++ b/libvolk-dev.install @@ -0,0 +1,4 @@ +usr/include/* +usr/lib/*/*volk*so +usr/lib/*/cmake/volk +usr/lib/*/pkgconfig/*volk* diff --git a/libvolk-doc.doc-base b/libvolk-doc.doc-base new file mode 100644 index 0000000..1174c64 --- /dev/null +++ b/libvolk-doc.doc-base @@ -0,0 +1,19 @@ +Document: libvolk-doc +Title: Vector-Optimized Library of Kernels Reference Manual +Author: GNU Radio Developers +Abstract: VOLK is the Vector-Optimized Library of Kernels. + It is a library that contains kernels of hand-written SIMD code for + different mathematical operations. Since each SIMD architecture can + be very different and no compiler has yet come along to handle + vectorization properly or highly efficiently, VOLK approaches the + problem differently. For each architecture or platform that a + developer wishes to vectorize for, a new proto-kernel is added to + VOLK. At runtime, VOLK will select the correct proto-kernel. In this + way, the users of VOLK call a kernel for performing the operation + that is platform/architecture agnostic. This allows us to write + portable SIMD code. +Section: Programming/C++ + +Format: HTML +Index: /usr/share/doc/libvolk-dev/html/index.html +Files: /usr/share/doc/libvolk-dev/html/*.html diff --git a/libvolk-doc.docs b/libvolk-doc.docs new file mode 100644 index 0000000..87dd314 --- /dev/null +++ b/libvolk-doc.docs @@ -0,0 +1 @@ +obj-*/html diff --git a/libvolk3.1.install b/libvolk3.1.install new file mode 100644 index 0000000..e4252f4 --- /dev/null +++ b/libvolk3.1.install @@ -0,0 +1 @@ +usr/lib/*/libvolk.so.* diff --git a/not-not-installed b/not-not-installed new file mode 100644 index 0000000..6f354d0 --- /dev/null +++ b/not-not-installed @@ -0,0 +1,6 @@ +usr/bin/list_cpu_features +usr/lib/*/cmake/CpuFeatures/CpuFeaturesConfig.cmake +usr/lib/*/cmake/CpuFeatures/CpuFeaturesConfigVersion.cmake +usr/lib/*/cmake/CpuFeatures/CpuFeaturesTargets-relwithdebinfo.cmake +usr/lib/*/cmake/CpuFeatures/CpuFeaturesTargets.cmake +usr/lib/*/libcpu_features.a diff --git a/patches/doxygen-pdf b/patches/doxygen-pdf new file mode 100644 index 0000000..3ae7ec7 --- /dev/null +++ b/patches/doxygen-pdf @@ -0,0 +1,74 @@ +Author: A. Maitland Bottoms +Forwarded: not-needed +Description: doxygen pdf + Work-In-Progress Debian inclusion of PDF format documentation. + +--- a/docs/CMakeLists.txt ++++ b/docs/CMakeLists.txt +@@ -10,6 +10,15 @@ + + message(STATUS "Doxygen found. Building docs ...") + ++ find_package(LATEX COMPONENTS PDFLATEX) ++ ++ if(ENABLE_DOXYGEN_PDF AND LATEX_FOUND) ++ set(enable_pdf_docs YES) ++ message(STATUS "latex found. Building PDF docs ...") ++ else() ++ set(enable_pdf_docs NO) ++ endif() ++ + configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_BINARY_DIR}/Doxyfile + @ONLY) + +@@ -20,4 +29,12 @@ + COMMENT "Generating documentation with Doxygen" + VERBATIM) + ++ add_custom_target( ++ volk_pdf_doc ++ make ++ DEPENDS volk_doc ++ WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/latex ++ COMMENT "Generating PDF documentation with Doxygen" ++ VERBATIM) ++ + endif(DOXYGEN_FOUND) +--- a/docs/Doxyfile.in ++++ b/docs/Doxyfile.in +@@ -1795,7 +1795,7 @@ + # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. + # The default value is: YES. + +-GENERATE_LATEX = NO ++GENERATE_LATEX = @enable_pdf_docs@ + + # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a + # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +@@ -1815,7 +1815,7 @@ + # the output language. + # This tag requires that the tag GENERATE_LATEX is set to YES. + +-LATEX_CMD_NAME = latex ++LATEX_CMD_NAME = xelatex + + # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate + # index for LaTeX. +@@ -1864,7 +1864,7 @@ + # If left blank no extra packages will be included. + # This tag requires that the tag GENERATE_LATEX is set to YES. + +-EXTRA_PACKAGES = ++EXTRA_PACKAGES = {amsmath} {pmboxdraw} {unicode-math} + + # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the + # generated LaTeX document. The header should contain everything until the first +@@ -2366,7 +2366,7 @@ + # set to NO + # The default value is: YES. + +-HAVE_DOT = NO ++HAVE_DOT = YES + + # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed + # to run in parallel. When set to 0 doxygen will base this on the number of diff --git a/patches/omit-doxygen-build-paths b/patches/omit-doxygen-build-paths new file mode 100644 index 0000000..c31d8ee --- /dev/null +++ b/patches/omit-doxygen-build-paths @@ -0,0 +1,81 @@ +From 58cc2b105211f0e5beab4dc228b478ebe105be06 Mon Sep 17 00:00:00 2001 +From: "A. Maitland Bottoms" +Date: Sun, 4 Sep 2022 21:37:45 -0400 +Subject: [PATCH] omit doxygen build paths + +Use reproducible-builds friendly configuration settings. + +Signed-off-by: A. Maitland Bottoms +--- + docs/Doxyfile.in | 14 +++++++------- + 1 file changed, 7 insertions(+), 7 deletions(-) + +--- a/docs/Doxyfile.in ++++ b/docs/Doxyfile.in +@@ -170,7 +170,7 @@ + # will be relative from the directory where doxygen is started. + # This tag requires that the tag FULL_PATH_NAMES is set to YES. + +-STRIP_FROM_PATH = ++STRIP_FROM_PATH = @CMAKE_BINARY_DIR@ @CMAKE_SOURCE_DIR@ + + # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the + # path mentioned in the documentation of a class, which tells the reader which +@@ -179,7 +179,7 @@ + # specify the list of include paths that are normally passed to the compiler + # using the -I flag. + +-STRIP_FROM_INC_PATH = ++STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@ @CMAKE_BINARY_DIR@ + + # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but + # less readable) file names. This can be useful is your file systems doesn't +@@ -736,7 +736,7 @@ + # list will mention the files that were used to generate the documentation. + # The default value is: YES. + +-SHOW_USED_FILES = YES ++SHOW_USED_FILES = NO + + # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This + # will remove the Files entry from the Quick Index and from the Folder Tree View +@@ -953,7 +953,11 @@ + @CMAKE_SOURCE_DIR@/cpu_features \ + @CMAKE_SOURCE_DIR@/include/volk/sse2neon \ + @CMAKE_SOURCE_DIR@/README.md \ +- @CMAKE_SOURCE_DIR@/docs/AUTHORS_RESUBMITTING_UNDER_LGPL_LICENSE.md ++ @CMAKE_SOURCE_DIR@/docs/AUTHORS_RESUBMITTING_UNDER_LGPL_LICENSE.md \ ++ @CMAKE_SOURCE_DIR@/cmake \ ++ @CMAKE_SOURCE_DIR@/apps \ ++ @CMAKE_SOURCE_DIR@/lib/*qa* \ ++ @CMAKE_SOURCE_DIR@/tmpl + + # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or + # directories that are symbolic links (a Unix file system feature) are excluded +@@ -1108,7 +1112,7 @@ + # link to the documentation. + # The default value is: YES. + +-REFERENCES_LINK_SOURCE = YES ++REFERENCES_LINK_SOURCE = NO + + # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the + # source code will show a tooltip with additional information such as prototype, +@@ -1118,7 +1122,7 @@ + # The default value is: YES. + # This tag requires that the tag SOURCE_BROWSER is set to YES. + +-SOURCE_TOOLTIPS = YES ++SOURCE_TOOLTIPS = NO + + # If the USE_HTAGS tag is set to YES then the references to source code will + # point to the HTML generated by the htags(1) tool instead of doxygen built-in +@@ -1259,7 +1263,7 @@ + # that doxygen normally uses. + # This tag requires that the tag GENERATE_HTML is set to YES. + +-HTML_FOOTER = ++HTML_FOOTER = "" + + # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style + # sheet that is used by each HTML page. It can be used to fine-tune the look of diff --git a/patches/optional-static-apps b/patches/optional-static-apps new file mode 100644 index 0000000..dd6a478 --- /dev/null +++ b/patches/optional-static-apps @@ -0,0 +1,25 @@ +Author: A. Maitland Bottoms +Forwarded: not-needed +Description: optional static apps + For Debian, build apps with static libs if ENABLE_STATIC_APPS. + +--- a/apps/CMakeLists.txt ++++ b/apps/CMakeLists.txt +@@ -42,7 +42,7 @@ + endif() + target_link_libraries(volk_profile PRIVATE std::filesystem) + +-if(ENABLE_STATIC_LIBS) ++if(ENABLE_STATIC_LIBS AND ENABLE_STATIC_APPS) + target_link_libraries(volk_profile PRIVATE volk_static) + set_target_properties(volk_profile PROPERTIES LINK_FLAGS "-static") + else() +@@ -58,7 +58,7 @@ + add_executable(volk-config-info volk-config-info.cc + ${CMAKE_CURRENT_SOURCE_DIR}/volk_option_helpers.cc) + +-if(ENABLE_STATIC_LIBS) ++if(ENABLE_STATIC_LIBS AND ENABLE_STATIC_APPS) + target_link_libraries(volk-config-info volk_static) + set_target_properties(volk-config-info PROPERTIES LINK_FLAGS "-static") + else() diff --git a/patches/series b/patches/series new file mode 100644 index 0000000..b146f2a --- /dev/null +++ b/patches/series @@ -0,0 +1,3 @@ +optional-static-apps +omit-doxygen-build-paths +# doxygen-pdf diff --git a/rules b/rules new file mode 100755 index 0000000..56ba3b2 --- /dev/null +++ b/rules @@ -0,0 +1,19 @@ +#!/usr/bin/make -f +#export DEB_BUILD_MAINT_OPTIONS += hardening=+all +#export DH_VERBOSE=1 + +%: + dh $@ --with python3 + +override_dh_auto_build-indep: + cmake --build obj-* --target all + cmake --build obj-* --target volk_doc +# cmake --build obj-* --target volk_pdf_doc + +override_dh_auto_install: + dh_auto_install + find debian -type d -empty -delete + +override_dh_auto_clean: + dh_auto_clean + rm -rf gen/__pycache__ diff --git a/source/format b/source/format new file mode 100644 index 0000000..163aaf8 --- /dev/null +++ b/source/format @@ -0,0 +1 @@ +3.0 (quilt) diff --git a/upstream/metadata b/upstream/metadata new file mode 100644 index 0000000..30bf7d4 --- /dev/null +++ b/upstream/metadata @@ -0,0 +1,4 @@ +--- +Bug-Database: https://github.com/gnuradio/volk/issues +Bug-Submit: https://github.com/gnuradio/volk/issues/new +Repository-Browse: https://github.com/gnuradio/volk diff --git a/volk-config-info.1 b/volk-config-info.1 new file mode 100644 index 0000000..e8d6efd --- /dev/null +++ b/volk-config-info.1 @@ -0,0 +1,45 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.10. +.TH VOLK-CONFIG-INFO "1" "July 2014" "volk-config-info 0.1" "User Commands" +.SH NAME +volk-config-info \- pkgconfig-like tool for Vector Optimized Library of Kernels 0.1 +.SH DESCRIPTION +.SS "Program options: volk-config-info [options]:" +.TP +\fB\-h\fR [ \fB\-\-help\fR ] +print help message +.TP +\fB\-\-prefix\fR +print VOLK installation prefix +.TP +\fB\-\-builddate\fR +print VOLK build date (RFC2822 format) +.TP +\fB\-\-cc\fR +print VOLK C compiler version +.TP +\fB\-\-cflags\fR +print VOLK CFLAGS +.TP +\fB\-\-all\-machines\fR +print VOLK machines built into library +.TP +\fB\-\-avail\-machines\fR +print VOLK machines the current platform can use +.TP +\fB\-\-machine\fR +print the VOLK machine that will be used +.TP +\fB\-v\fR [ \fB\-\-version\fR ] +print VOLK version +.SH "SEE ALSO" +The full documentation for +.B volk-config-info +is maintained as a Texinfo manual. If the +.B info +and +.B volk-config-info +programs are properly installed at your site, the command +.IP +.B info volk-config-info +.PP +should give you access to the complete manual. diff --git a/volk_modtool.1 b/volk_modtool.1 new file mode 100644 index 0000000..752e7f5 --- /dev/null +++ b/volk_modtool.1 @@ -0,0 +1,112 @@ +.TH GNURADIO "1" "August 2013" "volk_modtool 3.7" "User Commands" +.SH NAME +volk_modtool \- tailor VOLK modules +.SH DESCRIPTION +The volk_modtool tool is installed along with VOLK as a way of helping +to construct, add to, and interogate the VOLK library or companion +libraries. +.P +volk_modtool is installed into $prefix/bin. +.P +VOLK modtool enables creating standalone (out-of-tree) VOLK modules +and provides a few tools for sharing VOLK kernels between VOLK +modules. If you need to design or work with VOLK kernels away from +the canonical VOLK library, this is the tool. If you need to tailor +your own VOLK library for whatever reason, this is the tool. +.P +The canonical VOLK library installs a volk.h and a libvolk.so. Your +own library will install volk_$name.h and libvolk_$name.so. Ya Gronk? +Good. +.P +There isn't a substantial difference between the canonical VOLK +module and any other VOLK module. They're all peers. Any module +created via VOLK modtool will come complete with a default +volk_modtool.cfg file associating the module with the base from which +it came, its distinctive $name and its destination (or path). These +values (created from user input if VOLK modtool runs without a +user-supplied config file or a default config file) serve as default +values for some VOLK modtool actions. It's more or less intended for +the user to change directories to the top level of a created VOLK +module and then run volk_modtool to take advantage of the values +stored in the default volk_modtool.cfg file. +.P +Apart from creating new VOLK modules, VOLK modtool allows you to list +the names of kernels in other modules, list the names of kernels in +the current module, add kernels from another module into the current +module, and remove kernels from the current module. When moving +kernels between modules, VOLK modtool does its best to keep the qa +and profiling code for those kernels intact. If the base has a test +or a profiling call for some kernel, those calls will follow the +kernel when VOLK modtool adds that kernel. If QA or profiling +requires a puppet kernel, the puppet kernel will follow the original +kernel when VOLK modtool adds that original kernel. VOLK modtool +respects puppets. +.P +====================================================================== +.P +.SH Installing a new VOLK Library: +.P +Run the command "volk_modtool -i". This will ask you three questions: +.P + name: // the name to give your VOLK library: volk_ + destination: // directory new source tree is built under -- must exists. + // It will create /volk_ + base: // the directory containing the original VOLK source code +.P +This will build a new skeleton directory in the destination provided +with the name volk_. It will contain the necessary structure to +build: +.P + mkdir build + cd build + cmake -DCMAKE_INSTALL_PREFIX=/opt/volk ../ + make + sudo make install +.P +Right now, the library is empty and contains no kernels. Kernels can +be added from another VOLK library using the '-a' option. If not +specified, the kernel will be extracted from the base VOLK +directory. Using the '-b' allows us to specify another VOLK library to +use for this purpose. +.P + volk_modtool -a -n 32fc_x2_conjugate_dot_prod_32fc +.P +This will put the code for the new kernel into +/volk_/kernels/volk_/ +.P +Other kernels must be added by hand. See the following webpages for +more information about creating VOLK kernels: + http://gnuradio.org/doc/doxygen/volk_guide.html + http://gnuradio.org/redmine/projects/gnuradio/wiki/Volk +.P +====================================================================== +.P +.SH OPTIONS +.P +Options for Adding and Removing Kernels: + -a, --add_kernel + Add kernel from existing VOLK module. Uses the base VOLK module + unless -b is used. Use -n to specify the kernel name. + Requires: -n. + Optional: -b +.P + -A, --add_all_kernels + Add all kernels from existing VOLK module. Uses the base VOLK + module unless -b is used. + Optional: -b +.P + -x, --remove_kernel + Remove kernel from module. + Required: -n. + Optional: -b +.P +Options for Listing Kernels: + -l, --list + Lists all kernels available in the base VOLK module. +.P + -k, --kernels + Lists all kernels in this VOLK module. +.P + -r, --remote-list + Lists all kernels in another VOLK module that is specified + using the -b option. diff --git a/volk_profile.1 b/volk_profile.1 new file mode 100644 index 0000000..405facb --- /dev/null +++ b/volk_profile.1 @@ -0,0 +1,5 @@ +.TH UHD_FFT "1" "March 2012" "volk_profile 3.5" "User Commands" +.SH NAME +volk_profile \- Quality Assurance application for libvolk functions +.SH DESCRIPTION +Writes profile results to a file. diff --git a/watch b/watch new file mode 100644 index 0000000..e5648ce --- /dev/null +++ b/watch @@ -0,0 +1,4 @@ +version=4 + opts="filenamemangle=s%(?:.*?)?v?(\d[\d.]*@ARCHIVE_EXT@)%@PACKAGE@-$1%,uversionmangle=s/-rc/~rc/" \ + https://github.com/gnuradio/volk/tags \ + (?:.*?/)?v?@ANY_VERSION@@ARCHIVE_EXT@ debian uupdate -- 2.30.2