diff --git a/.gitignore b/.gitignore index eccd7b4..b83d222 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1 @@ /target/ -**/*.rs.bk diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 8d804ae..7e10fbb 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -1,2 +1,4 @@ +# Contributors + * Initial `tac` development and AVX2 SIMD implementation by Mahmoud Al-Qudsi (@mqudsi) * NEON SIMD acceleration for aarch64 by @unrelentingtech diff --git a/Cargo.lock b/Cargo.lock index eb7d34b..a9a892c 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -18,8 +18,8 @@ dependencies = [ ] [[package]] -name = "tac" -version = "2.1.0" +name = "tac-k" +version = "0.1.1" dependencies = [ "memmap2", ] diff --git a/Cargo.toml b/Cargo.toml index 011afea..8456d45 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,16 +1,20 @@ [package] -name = "tac" +name = "tac-k" edition = "2021" -version = "2.1.0" -authors = ["Mahmoud Al-Qudsi "] +version = "0.1.1" +authors = ["Michael Yang "] description = "Print lines from file in reverse order" -homepage = "https://github.com/neosmart/tac" -repository = "https://github.com/neosmart/tac" +homepage = "https://github.com/my4ng/tack" +repository = "https://github.com/my4ng/tack" readme = "README.md" -keywords = ["tac", "reverse", "core", "utils"] +keywords = ["tac", "reverse", "core", "utils", "simd"] categories = ["command-line-utilities"] rust-version = "1.70" -license = "MIT" +license = "MIT OR Apache-2.0" [dependencies] memmap2 = "0.9" + +[[bin]] +name = "tac" +path = "src/main.rs" diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..d9a10c0 --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/LICENSE b/LICENSE-MIT similarity index 95% rename from LICENSE rename to LICENSE-MIT index 1d44791..0f9954d 100644 --- a/LICENSE +++ b/LICENSE-MIT @@ -1,5 +1,6 @@ MIT License +Copyright (c) 2024 Michael Yang Copyright (c) 2017 NeoSmart Technologies Permission is hereby granted, free of charge, to any person obtaining a copy diff --git a/README.md b/README.md index 61ed023..6cd6c3a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ -# tac +# Tack -`tac` is a high-performance, simd-accelerated, cross-platform rewrite of the [GNU `tac` utility](https://www.gnu.org/software/coreutils/manual/html_node/tac-invocation.html#tac-invocation) from Coreutils, released under a BSD-compatible (MIT) license. `tac` reads input from a file (or from `stdin`, but [see below](#implementation-notes)) and then prints it line-by-line backwards. +Tack is a **fork** of the [tac](https://github.com/neosmart/tac) crate. -This `tac` implementation uses simd-acceleration for new line detection (read more about that [here](https://neosmart.net/blog/2021/using-simd-acceleration-in-rust-to-create-the-worlds-fastest-tac/)) and utilizes memory-mapped files on all supported operating systems. It is additionally written in rust for maximum integrity and safety. +Tack is a high-performance, simd-accelerated, cross-platform rewrite of the [GNU `tac` utility](https://www.gnu.org/software/coreutils/manual/html_node/tac-invocation.html#tac-invocation) from Coreutils, released under MIT/Apache-2.0 licenses. `tac` reads input from a file (or from `stdin`, but [see below](#implementation-notes)) and then prints it line-by-line backwards. + +This `tac` implementation uses simd-acceleration for new line detection and utilizes memory-mapped files on all supported operating systems. It is additionally written in rust for maximum integrity and safety. + +The MSRV is **1.70**. ## Who needs a faster `tac` anyway? @@ -10,7 +14,7 @@ Good question. Try grepping through a multi-gigabyte web access log file in reve ## Usage -``` +```bash Usage: tac [OPTIONS] [FILE1..] Write each FILE to standard output, last line first. Reads from stdin if FILE is - or not specified. @@ -21,11 +25,11 @@ Options: --line-buffered Always flush output after each line. ``` -`tac` reads lines from any combination of `stdin` and/or zero or more files and writes the lines to the output in reverse order. +Tack reads lines from any combination of `stdin` and/or zero or more files and writes the lines to the output in reverse order. ### Example -``` +```bash $ echo -e "hello\nworld" | tac world hello @@ -33,19 +37,21 @@ hello ## Installation -`tac` may be installed via cargo, the rust package manager: +Tack may be built installed via cargo, the rust package manager: -``` -cargo install tac +```bash +cargo install tac-k --locked ``` -Help is humbly requested in getting `tac` into the package managers for various platforms. It's really a time-consuming task, especially for someone that only interacts with the various packaging tools once in a blue moon as opposed to on a daily basis. +or installed with pre-built binaries via `cargo-binstall`: -Currently arm64 (aarch64) NEON acceleration is only available with the nightly compiler. If using it, provide the `--features nightly` flag to `cargo` to enable support. +```bash +cargo binstall tac-k --locked +``` ## Implementation Notes -This implementation of `tac` uses SIMD instruction sets (AVX2, NEON) to accelerate the detection of new lines. The usage of memory-mapped files additionally boosts performance by avoiding slowdowns caused by context switches when reading from the input if speculative execution mitigations are enabled. It is significantly (2.55x if mitigations disabled, more otherwise) faster than the version of `tac` that ships with GNU Coreutils, in addition to being more liberally licensed. +This implementation of `tac` uses SIMD instruction sets (AVX2, NEON) to accelerate the detection of new lines if available. The usage of memory-mapped files additionally boosts performance by avoiding slowdowns caused by context switches when reading from the input if speculative execution mitigations are enabled. It is significantly (2.55x if mitigations disabled, more otherwise) faster than the version of `tac` that ships with GNU Coreutils, in addition to being more liberally licensed. **To obtain maximum performance:** @@ -54,9 +60,12 @@ This implementation of `tac` uses SIMD instruction sets (AVX2, NEON) to accelera * Use line-buffered output mode (`tac --line-buffered`) if tac is piping into another command rather than writing to the tty directly. This gives you "live" streaming of results and lets you terminate much sooner if you're only looking for the first _n_ matches. e.g. `tac --line-buffered access.log | grep foo` will print its first match much, much sooner than `tac access.log | grep foo` would. * In the same vein, if you are chaining the output of _n_ utilities, make sure that all commands up to _n_ - 1 are all using line-buffered mode unless you don't care about latency and only care about throughput. For example, to print the first two matches for some grep pattern: `tac --line-buffered access.log | grep --line-buffered foo | head -n2`. -## License and Copyright +## License + +Tack is licensed under either [MIT](LICENSE-MIT) and [Apache-2.0](LICENSE-APACHE) at your option. + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. -`tac` is released under the terms of the MIT public license. -Copyright Mahmoud Al-Qudsi 2017-2021. All rights not assigned by the MIT license are reserved. +## Contribution -As an open source project, `tac` would not exist without the tireless efforts of its various contributors - see [CONTRIBUTORS.md](/CONTRIBUTORS.md) for full details. +As an open source project, Tack would not exist without the tireless efforts of its various contributors - see [CONTRIBUTORS.md](CONTRIBUTORS.md) for full details.