├── .github └── workflows │ ├── release.yml │ └── rust.yml ├── .gitignore ├── Cargo.lock ├── Cargo.toml ├── LICENSE ├── README.md ├── docs └── img │ └── screenshot.png ├── src ├── lib.rs ├── main.rs └── platform.rs └── tests ├── e2e.rs └── scripts └── hello /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | 3 | on: 4 | push: 5 | tags: 6 | - "*" 7 | 8 | workflow_dispatch: 9 | 10 | env: 11 | CARGO_TERM_COLOR: always 12 | 13 | jobs: 14 | release: 15 | name: Build for ${{ matrix.target }} 16 | runs-on: ${{ matrix.os }} 17 | strategy: 18 | matrix: 19 | include: 20 | - os: ubuntu-latest 21 | target: x86_64-unknown-linux-gnu 22 | exe: catp 23 | - os: ubuntu-latest 24 | target: x86_64-unknown-linux-musl 25 | exe: catp 26 | steps: 27 | - uses: actions/checkout@v2 28 | - uses: actions-rs/toolchain@v1 29 | with: 30 | profile: minimal 31 | toolchain: stable 32 | target: ${{ matrix.target }} 33 | - name: Run tests 34 | run: cargo test --release --target ${{ matrix.target }} --verbose 35 | - name: Build release 36 | run: cargo build --release --target ${{ matrix.target }} 37 | - uses: actions/upload-artifact@v2 38 | with: 39 | name: catp-${{ matrix.target }} 40 | path: target/${{ matrix.target }}/release/${{ matrix.exe }} 41 | - name: Zip Release 42 | uses: TheDoctor0/zip-release@0.6.1 43 | with: 44 | type: zip 45 | filename: catp-${{ matrix.target }}.zip 46 | directory: target/${{ matrix.target }}/release/ 47 | path: ${{ matrix.exe }} 48 | - name: Publish 49 | uses: softprops/action-gh-release@v1 50 | if: startsWith(github.ref, 'refs/tags/') 51 | with: 52 | files: target/${{ matrix.target }}/release/catp-${{ matrix.target }}.zip 53 | generate_release_notes: true 54 | draft: true 55 | publish-crate: 56 | name: Publish to crates.io 57 | if: startsWith(github.ref, 'refs/tags/') 58 | runs-on: ubuntu-latest 59 | needs: release 60 | steps: 61 | - uses: actions/checkout@v2 62 | - uses: actions-rs/toolchain@v1 63 | with: 64 | profile: minimal 65 | toolchain: stable 66 | - name: Publish 67 | env: 68 | CARGO_REGISTRY_TOKEN: ${{ secrets.CRATES_IO_API_TOKEN }} 69 | run: cargo publish 70 | -------------------------------------------------------------------------------- /.github/workflows/rust.yml: -------------------------------------------------------------------------------- 1 | name: Rust 2 | 3 | on: 4 | pull_request: 5 | branches: ["*"] 6 | push: 7 | branches: ["main", "dev"] 8 | 9 | concurrency: 10 | # Documentation suggests ${{ github.head_ref }}, but that's only available on pull_request/pull_request_target triggers, so using ${{ github.ref }}. 11 | # On main, we want all builds to complete even if merging happens faster to make it easier to discover at which point something broke. 12 | group: ${{ github.ref == 'refs/heads/main' && format('ci-main-{0}', github.sha) || format('ci-{0}', github.ref) }} 13 | cancel-in-progress: true 14 | 15 | env: 16 | CARGO_TERM_COLOR: always 17 | 18 | jobs: 19 | lints: 20 | name: Lints 21 | runs-on: ubuntu-latest 22 | steps: 23 | - uses: actions/checkout@v2 24 | - uses: actions-rs/toolchain@v1 25 | with: 26 | profile: minimal 27 | toolchain: stable 28 | components: clippy 29 | - uses: Swatinem/rust-cache@v1 30 | - name: Clippy 31 | run: cargo clippy -- -D warnings 32 | 33 | build: 34 | name: Build for ${{ matrix.target }} 35 | runs-on: ${{ matrix.os }} 36 | strategy: 37 | matrix: 38 | include: 39 | - os: ubuntu-latest 40 | exe: catp 41 | target: x86_64-unknown-linux-gnu 42 | 43 | steps: 44 | - uses: actions/checkout@v2 45 | - uses: actions-rs/toolchain@v1 46 | with: 47 | profile: minimal 48 | toolchain: stable 49 | - uses: Swatinem/rust-cache@v1 50 | - name: Build 51 | run: cargo build 52 | - name: Run tests 53 | run: cargo test --verbose 54 | - uses: actions/upload-artifact@v2 55 | with: 56 | name: catp-${{ matrix.target }} 57 | path: target/debug/${{ matrix.exe }} 58 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | -------------------------------------------------------------------------------- /Cargo.lock: -------------------------------------------------------------------------------- 1 | # This file is automatically @generated by Cargo. 2 | # It is not intended for manual editing. 3 | version = 3 4 | 5 | [[package]] 6 | name = "anyhow" 7 | version = "1.0.58" 8 | source = "registry+https://github.com/rust-lang/crates.io-index" 9 | checksum = "bb07d2053ccdbe10e2af2995a2f116c1330396493dc1269f6a91d0ae82e19704" 10 | 11 | [[package]] 12 | name = "atty" 13 | version = "0.2.14" 14 | source = "registry+https://github.com/rust-lang/crates.io-index" 15 | checksum = "d9b39be18770d11421cdb1b9947a45dd3f37e93092cbf377614828a319d5fee8" 16 | dependencies = [ 17 | "hermit-abi", 18 | "libc", 19 | "winapi", 20 | ] 21 | 22 | [[package]] 23 | name = "autocfg" 24 | version = "1.1.0" 25 | source = "registry+https://github.com/rust-lang/crates.io-index" 26 | checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa" 27 | 28 | [[package]] 29 | name = "bitflags" 30 | version = "1.3.2" 31 | source = "registry+https://github.com/rust-lang/crates.io-index" 32 | checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" 33 | 34 | [[package]] 35 | name = "catp" 36 | version = "0.2.0" 37 | dependencies = [ 38 | "anyhow", 39 | "clap", 40 | "nix", 41 | ] 42 | 43 | [[package]] 44 | name = "cfg-if" 45 | version = "1.0.0" 46 | source = "registry+https://github.com/rust-lang/crates.io-index" 47 | checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" 48 | 49 | [[package]] 50 | name = "clap" 51 | version = "3.2.14" 52 | source = "registry+https://github.com/rust-lang/crates.io-index" 53 | checksum = "54635806b078b7925d6e36810b1755f2a4b5b4d57560432c1ecf60bcbe10602b" 54 | dependencies = [ 55 | "atty", 56 | "bitflags", 57 | "clap_derive", 58 | "clap_lex", 59 | "indexmap", 60 | "once_cell", 61 | "strsim", 62 | "termcolor", 63 | "textwrap", 64 | ] 65 | 66 | [[package]] 67 | name = "clap_derive" 68 | version = "3.2.7" 69 | source = "registry+https://github.com/rust-lang/crates.io-index" 70 | checksum = "759bf187376e1afa7b85b959e6a664a3e7a95203415dba952ad19139e798f902" 71 | dependencies = [ 72 | "heck", 73 | "proc-macro-error", 74 | "proc-macro2", 75 | "quote", 76 | "syn", 77 | ] 78 | 79 | [[package]] 80 | name = "clap_lex" 81 | version = "0.2.4" 82 | source = "registry+https://github.com/rust-lang/crates.io-index" 83 | checksum = "2850f2f5a82cbf437dd5af4d49848fbdfc27c157c3d010345776f952765261c5" 84 | dependencies = [ 85 | "os_str_bytes", 86 | ] 87 | 88 | [[package]] 89 | name = "hashbrown" 90 | version = "0.12.3" 91 | source = "registry+https://github.com/rust-lang/crates.io-index" 92 | checksum = "8a9ee70c43aaf417c914396645a0fa852624801b24ebb7ae78fe8272889ac888" 93 | 94 | [[package]] 95 | name = "heck" 96 | version = "0.4.0" 97 | source = "registry+https://github.com/rust-lang/crates.io-index" 98 | checksum = "2540771e65fc8cb83cd6e8a237f70c319bd5c29f78ed1084ba5d50eeac86f7f9" 99 | 100 | [[package]] 101 | name = "hermit-abi" 102 | version = "0.1.19" 103 | source = "registry+https://github.com/rust-lang/crates.io-index" 104 | checksum = "62b467343b94ba476dcb2500d242dadbb39557df889310ac77c5d99100aaac33" 105 | dependencies = [ 106 | "libc", 107 | ] 108 | 109 | [[package]] 110 | name = "indexmap" 111 | version = "1.9.1" 112 | source = "registry+https://github.com/rust-lang/crates.io-index" 113 | checksum = "10a35a97730320ffe8e2d410b5d3b69279b98d2c14bdb8b70ea89ecf7888d41e" 114 | dependencies = [ 115 | "autocfg", 116 | "hashbrown", 117 | ] 118 | 119 | [[package]] 120 | name = "libc" 121 | version = "0.2.126" 122 | source = "registry+https://github.com/rust-lang/crates.io-index" 123 | checksum = "349d5a591cd28b49e1d1037471617a32ddcda5731b99419008085f72d5a53836" 124 | 125 | [[package]] 126 | name = "memoffset" 127 | version = "0.6.5" 128 | source = "registry+https://github.com/rust-lang/crates.io-index" 129 | checksum = "5aa361d4faea93603064a027415f07bd8e1d5c88c9fbf68bf56a285428fd79ce" 130 | dependencies = [ 131 | "autocfg", 132 | ] 133 | 134 | [[package]] 135 | name = "nix" 136 | version = "0.24.2" 137 | source = "registry+https://github.com/rust-lang/crates.io-index" 138 | checksum = "195cdbc1741b8134346d515b3a56a1c94b0912758009cfd53f99ea0f57b065fc" 139 | dependencies = [ 140 | "bitflags", 141 | "cfg-if", 142 | "libc", 143 | "memoffset", 144 | ] 145 | 146 | [[package]] 147 | name = "once_cell" 148 | version = "1.13.0" 149 | source = "registry+https://github.com/rust-lang/crates.io-index" 150 | checksum = "18a6dbe30758c9f83eb00cbea4ac95966305f5a7772f3f42ebfc7fc7eddbd8e1" 151 | 152 | [[package]] 153 | name = "os_str_bytes" 154 | version = "6.2.0" 155 | source = "registry+https://github.com/rust-lang/crates.io-index" 156 | checksum = "648001efe5d5c0102d8cea768e348da85d90af8ba91f0bea908f157951493cd4" 157 | 158 | [[package]] 159 | name = "proc-macro-error" 160 | version = "1.0.4" 161 | source = "registry+https://github.com/rust-lang/crates.io-index" 162 | checksum = "da25490ff9892aab3fcf7c36f08cfb902dd3e71ca0f9f9517bea02a73a5ce38c" 163 | dependencies = [ 164 | "proc-macro-error-attr", 165 | "proc-macro2", 166 | "quote", 167 | "syn", 168 | "version_check", 169 | ] 170 | 171 | [[package]] 172 | name = "proc-macro-error-attr" 173 | version = "1.0.4" 174 | source = "registry+https://github.com/rust-lang/crates.io-index" 175 | checksum = "a1be40180e52ecc98ad80b184934baf3d0d29f979574e439af5a55274b35f869" 176 | dependencies = [ 177 | "proc-macro2", 178 | "quote", 179 | "version_check", 180 | ] 181 | 182 | [[package]] 183 | name = "proc-macro2" 184 | version = "1.0.40" 185 | source = "registry+https://github.com/rust-lang/crates.io-index" 186 | checksum = "dd96a1e8ed2596c337f8eae5f24924ec83f5ad5ab21ea8e455d3566c69fbcaf7" 187 | dependencies = [ 188 | "unicode-ident", 189 | ] 190 | 191 | [[package]] 192 | name = "quote" 193 | version = "1.0.20" 194 | source = "registry+https://github.com/rust-lang/crates.io-index" 195 | checksum = "3bcdf212e9776fbcb2d23ab029360416bb1706b1aea2d1a5ba002727cbcab804" 196 | dependencies = [ 197 | "proc-macro2", 198 | ] 199 | 200 | [[package]] 201 | name = "strsim" 202 | version = "0.10.0" 203 | source = "registry+https://github.com/rust-lang/crates.io-index" 204 | checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623" 205 | 206 | [[package]] 207 | name = "syn" 208 | version = "1.0.98" 209 | source = "registry+https://github.com/rust-lang/crates.io-index" 210 | checksum = "c50aef8a904de4c23c788f104b7dddc7d6f79c647c7c8ce4cc8f73eb0ca773dd" 211 | dependencies = [ 212 | "proc-macro2", 213 | "quote", 214 | "unicode-ident", 215 | ] 216 | 217 | [[package]] 218 | name = "termcolor" 219 | version = "1.1.3" 220 | source = "registry+https://github.com/rust-lang/crates.io-index" 221 | checksum = "bab24d30b911b2376f3a13cc2cd443142f0c81dda04c118693e35b3835757755" 222 | dependencies = [ 223 | "winapi-util", 224 | ] 225 | 226 | [[package]] 227 | name = "textwrap" 228 | version = "0.15.0" 229 | source = "registry+https://github.com/rust-lang/crates.io-index" 230 | checksum = "b1141d4d61095b28419e22cb0bbf02755f5e54e0526f97f1e3d1d160e60885fb" 231 | 232 | [[package]] 233 | name = "unicode-ident" 234 | version = "1.0.2" 235 | source = "registry+https://github.com/rust-lang/crates.io-index" 236 | checksum = "15c61ba63f9235225a22310255a29b806b907c9b8c964bcbd0a2c70f3f2deea7" 237 | 238 | [[package]] 239 | name = "version_check" 240 | version = "0.9.4" 241 | source = "registry+https://github.com/rust-lang/crates.io-index" 242 | checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f" 243 | 244 | [[package]] 245 | name = "winapi" 246 | version = "0.3.9" 247 | source = "registry+https://github.com/rust-lang/crates.io-index" 248 | checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" 249 | dependencies = [ 250 | "winapi-i686-pc-windows-gnu", 251 | "winapi-x86_64-pc-windows-gnu", 252 | ] 253 | 254 | [[package]] 255 | name = "winapi-i686-pc-windows-gnu" 256 | version = "0.4.0" 257 | source = "registry+https://github.com/rust-lang/crates.io-index" 258 | checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" 259 | 260 | [[package]] 261 | name = "winapi-util" 262 | version = "0.1.5" 263 | source = "registry+https://github.com/rust-lang/crates.io-index" 264 | checksum = "70ec6ce85bb158151cae5e5c87f95a8e97d2c0c4b001223f33a334e3ce5de178" 265 | dependencies = [ 266 | "winapi", 267 | ] 268 | 269 | [[package]] 270 | name = "winapi-x86_64-pc-windows-gnu" 271 | version = "0.4.0" 272 | source = "registry+https://github.com/rust-lang/crates.io-index" 273 | checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" 274 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "catp" 3 | version = "0.2.0" 4 | edition = "2021" 5 | description = "Print the output of a running process" 6 | authors = ["Yujia Qiao "] 7 | include = ["src/**/*", "LICENSE", "README.md", "build.rs"] 8 | license = "GPL-3.0" 9 | repository = "https://github.com/rapiz1/catp" 10 | readme = "README.md" 11 | 12 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 13 | 14 | [dependencies] 15 | clap = { version = "3.2.14", features = ["derive"] } 16 | nix = { version = "0.24.2", features = ["ptrace", "process", "uio"] } 17 | anyhow = "1.0.58" 18 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # catp 2 | 3 | [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/rapiz1/catp)](https://github.com/rapiz1/catp/releases) 4 | ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/rapiz1/catp/Rust/main) 5 | 6 | Print the output of *a running process* 7 | 8 | ![screenshot](docs/img/screenshot.png) 9 | 10 | ```plain 11 | catp 0.2.0 12 | Print the output of a running process 13 | 14 | USAGE: 15 | catp [OPTIONS] 16 | 17 | ARGS: 18 | PID of the process to print 19 | 20 | OPTIONS: 21 | -h, --help Print help information 22 | -v, --verbose Print more verbose information to stderr 23 | -V, --version Print version information 24 | ``` 25 | 26 | ## Why 27 | 28 | Sometimes a process is redirected to `/dev/null` because we don't expect to check its output. 29 | However, we may regret that decision and don't want to restart the process. 30 | 31 | Or we just don't know where a running process is printing to. 32 | 33 | Then just type `catp`! 34 | 35 | ## How It Works 36 | 37 | `catp` uses `ptrace` to intercept syscall and extracts data from the syscall `write`. 38 | So it should work for most applications. Since it slows down the syscall, it may impact the performance of IO-sensitive applications. 39 | 40 | `catp` requires `ptrace` privilege to run, which in most systems means root. 41 | 42 | ## Get Started 43 | 44 | Download the binary from [release](https://github.com/rapiz1/catp/releases). The one with `gnu` should work with a really recent glibc version. If that's not working, try the `musl` one. 45 | 46 | ## Platform 47 | 48 | Currently only x86_64 Linux is supported. 49 | -------------------------------------------------------------------------------- /docs/img/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yujqiao/catp/14c5e5ba7d655554bb3689da6a5ab1f174688883/docs/img/screenshot.png -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | mod platform; 2 | 3 | use std::io::{self, IoSliceMut}; 4 | 5 | use anyhow::{Context, Result}; 6 | use clap::Parser; 7 | use nix::errno::Errno; 8 | use nix::libc::{SYS_write, STDERR_FILENO, STDOUT_FILENO}; 9 | use nix::sys::uio::{process_vm_readv, RemoteIoVec}; 10 | use nix::sys::wait::WaitStatus; 11 | use nix::sys::{ptrace, wait}; 12 | use nix::unistd::Pid; 13 | use platform::{PlatformRegs, SysWriteArgs}; 14 | 15 | #[derive(Parser, Debug)] 16 | #[clap(version, about, long_about = None)] 17 | pub struct CatpArgs { 18 | // TODO: Maybe handle multi-threaded programs. Implement -f --follow-forks 19 | // Trace child processes as they are created by currently traced processes as 20 | // a result of the fork(2), vfork(2) and clone(2) system calls. 21 | /// PID of the process to print 22 | pub pid: u32, 23 | 24 | /// Print more verbose information to stderr 25 | #[clap(short, long, action, default_value_t = false)] 26 | pub verbose: bool, 27 | } 28 | 29 | fn vm_read_data(pid: Pid, ptr: usize, len: usize) -> Result> { 30 | let mut buf = vec![0u8; len]; 31 | let mut local = [IoSliceMut::new(buf.as_mut_slice())]; 32 | let remote = [RemoteIoVec { 33 | base: ptr as usize, 34 | len: len as usize, 35 | }]; 36 | process_vm_readv(pid, &mut local, &remote)?; 37 | 38 | Ok(buf) 39 | } 40 | 41 | fn read_data(pid: Pid, ptr: usize, len: usize) -> Result> { 42 | vm_read_data(pid, ptr, len) 43 | } 44 | 45 | pub fn catp( 46 | args: CatpArgs, 47 | stdout: &mut T, 48 | stderr: &mut S, 49 | ) -> Result<()> { 50 | let verbose = args.verbose; 51 | if verbose { 52 | eprintln!("{:#?}", args); 53 | } 54 | 55 | // if args.follow_forks { 56 | // unimplemented!(); 57 | // } 58 | 59 | let pid = Pid::from_raw(args.pid as i32); 60 | let opts = ptrace::Options::PTRACE_O_TRACESYSGOOD; 61 | ptrace::attach(pid).with_context(|| "attach")?; 62 | 63 | let mut first_ptrace_stop = true; 64 | let mut in_syscall = false; 65 | loop { 66 | match wait::wait() { 67 | Ok(WaitStatus::PtraceSyscall(pid)) => { 68 | if in_syscall { 69 | in_syscall = false; 70 | } else { 71 | let regs = ptrace::getregs(pid).with_context(|| "getregs")?; 72 | let sysno = regs.get_sysno(); 73 | if sysno == SYS_write as usize { 74 | if verbose { 75 | eprintln!("{:?}, {:?}", pid, regs); 76 | } 77 | let fd: i32 = regs.get_fd(); 78 | if fd == STDOUT_FILENO || fd == STDERR_FILENO { 79 | let ptr = regs.get_ptr(); 80 | let len = regs.get_len(); 81 | let data = read_data(pid, ptr, len).with_context(|| "read_data")?; 82 | if verbose { 83 | eprintln!("{}, {:?} {:?} {:?}", fd, ptr, len, data); 84 | } 85 | if fd == STDOUT_FILENO { 86 | stdout.write_all(&data)?; 87 | } else { 88 | stderr.write_all(&data)?; 89 | } 90 | } 91 | } 92 | in_syscall = true; 93 | } 94 | ptrace::syscall(pid, None).with_context(|| "syscall")?; 95 | } 96 | Ok(WaitStatus::Stopped(pid, sig)) => { 97 | if first_ptrace_stop 98 | && ptrace::setoptions(pid, opts) 99 | .with_context(|| "setoptions") 100 | .is_ok() 101 | { 102 | first_ptrace_stop = false; 103 | // This should be a SIGSTP sent by attach. Suppress it 104 | ptrace::syscall(pid, None).with_context(|| "syscall")? 105 | } else { 106 | ptrace::syscall(pid, sig).with_context(|| "syscall")? 107 | } 108 | } 109 | Ok(_) => break, 110 | Err(Errno::ECHILD) => break, 111 | Err(e) => { 112 | return Err(e.into()); 113 | } 114 | } 115 | } 116 | 117 | Ok(()) 118 | } 119 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | use anyhow::Result; 2 | use catp::{catp, CatpArgs}; 3 | use clap::Parser; 4 | 5 | fn main() -> Result<()> { 6 | let args = CatpArgs::parse(); 7 | 8 | catp(args, &mut std::io::stdout(), &mut std::io::stderr()) 9 | } 10 | -------------------------------------------------------------------------------- /src/platform.rs: -------------------------------------------------------------------------------- 1 | use nix::libc::user_regs_struct; 2 | 3 | // Implement this trait to add new architectures 4 | pub trait PlatformRegs { 5 | fn get_args(&self, no: usize) -> usize; 6 | fn get_sysno(&self) -> usize; 7 | } 8 | 9 | pub trait SysWriteArgs { 10 | fn get_fd(&self) -> i32; 11 | 12 | fn get_len(&self) -> usize; 13 | 14 | fn get_ptr(&self) -> usize; 15 | } 16 | 17 | impl SysWriteArgs for T { 18 | fn get_fd(&self) -> i32 { 19 | self.get_args(0) as i32 20 | } 21 | 22 | fn get_ptr(&self) -> usize { 23 | self.get_args(1) as usize 24 | } 25 | 26 | fn get_len(&self) -> usize { 27 | self.get_args(2) as usize 28 | } 29 | } 30 | 31 | #[cfg(target_arch = "x86_64")] 32 | impl PlatformRegs for user_regs_struct { 33 | fn get_args(&self, no: usize) -> usize { 34 | match no { 35 | 0 => self.rdi as usize, 36 | 1 => self.rsi as usize, 37 | 2 => self.rdx as usize, 38 | _ => panic!("get args out of range"), 39 | } 40 | } 41 | 42 | fn get_sysno(&self) -> usize { 43 | self.orig_rax as usize 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /tests/e2e.rs: -------------------------------------------------------------------------------- 1 | use catp::{catp, CatpArgs}; 2 | use std::{io::Read, process, thread}; 3 | 4 | #[test] 5 | fn hello() { 6 | let mut p = process::Command::new("tests/scripts/hello") 7 | .stdin(process::Stdio::piped()) 8 | .stderr(process::Stdio::piped()) 9 | .stdout(process::Stdio::piped()) 10 | .spawn() 11 | .unwrap(); 12 | 13 | let args = CatpArgs { 14 | pid: p.id(), 15 | verbose: false, 16 | }; 17 | 18 | let t = thread::spawn(move || { 19 | let mut stdout: Vec = vec![]; 20 | let mut stderr: Vec = vec![]; 21 | catp(args, &mut stdout, &mut stderr).unwrap(); 22 | (stdout, stderr) 23 | }); 24 | 25 | // Start hello 26 | drop(p.stdin.take()); 27 | 28 | let (actual_stdout, actual_stderr) = t.join().unwrap(); 29 | let _ = p.wait(); 30 | 31 | let mut expected_stderr = vec![]; 32 | p.stderr 33 | .take() 34 | .unwrap() 35 | .read_to_end(&mut expected_stderr) 36 | .unwrap(); 37 | 38 | let mut expected_stdout = vec![]; 39 | p.stdout 40 | .take() 41 | .unwrap() 42 | .read_to_end(&mut expected_stdout) 43 | .unwrap(); 44 | 45 | assert_eq!(actual_stdout, expected_stdout); 46 | assert_eq!(actual_stderr, expected_stderr); 47 | } 48 | -------------------------------------------------------------------------------- /tests/scripts/hello: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | read -r 4 | 5 | i=0 6 | 7 | while [[ i -lt 5 ]] 8 | do 9 | echo hello $i "$(date -Is)" 10 | # bash is tricky! this actually writes to 1 instead of 2 11 | # don't know how to write to 2 in bash 12 | # echo world $i "$(date -Is)" >&2 13 | i=$((i+1)) 14 | sleep 0.5 15 | done 16 | --------------------------------------------------------------------------------