├── .gitignore ├── Cargo.lock ├── Cargo.toml ├── LICENCE ├── README.md └── src └── main.rs /.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 = "ansi_term" 7 | version = "0.12.1" 8 | source = "registry+https://github.com/rust-lang/crates.io-index" 9 | checksum = "d52a9bb7ec0cf484c551830a7ce27bd20d67eac647e1befb56b0be4ee39a55d2" 10 | dependencies = [ 11 | "winapi", 12 | ] 13 | 14 | [[package]] 15 | name = "atty" 16 | version = "0.2.14" 17 | source = "registry+https://github.com/rust-lang/crates.io-index" 18 | checksum = "d9b39be18770d11421cdb1b9947a45dd3f37e93092cbf377614828a319d5fee8" 19 | dependencies = [ 20 | "hermit-abi", 21 | "libc", 22 | "winapi", 23 | ] 24 | 25 | [[package]] 26 | name = "autocfg" 27 | version = "1.0.1" 28 | source = "registry+https://github.com/rust-lang/crates.io-index" 29 | checksum = "cdb031dd78e28731d87d56cc8ffef4a8f36ca26c38fe2de700543e627f8a464a" 30 | 31 | [[package]] 32 | name = "bitflags" 33 | version = "0.7.0" 34 | source = "registry+https://github.com/rust-lang/crates.io-index" 35 | checksum = "aad18937a628ec6abcd26d1489012cc0e18c21798210f491af69ded9b881106d" 36 | 37 | [[package]] 38 | name = "bitflags" 39 | version = "1.2.1" 40 | source = "registry+https://github.com/rust-lang/crates.io-index" 41 | checksum = "cf1de2fe8c75bc145a2f577add951f8134889b4795d47466a54a5c846d691693" 42 | 43 | [[package]] 44 | name = "btrfs2" 45 | version = "1.2.2" 46 | source = "registry+https://github.com/rust-lang/crates.io-index" 47 | checksum = "43fd9314940548587aab32eda9ac5dac3b3462d2172f81366803756abfb732e7" 48 | dependencies = [ 49 | "crc", 50 | "flate2", 51 | "lazy_static", 52 | "libc", 53 | "minilzo", 54 | "nix 0.8.1", 55 | "uuid", 56 | ] 57 | 58 | [[package]] 59 | name = "build_const" 60 | version = "0.2.2" 61 | source = "registry+https://github.com/rust-lang/crates.io-index" 62 | checksum = "b4ae4235e6dac0694637c763029ecea1a2ec9e4e06ec2729bd21ba4d9c863eb7" 63 | 64 | [[package]] 65 | name = "case" 66 | version = "0.1.0" 67 | source = "registry+https://github.com/rust-lang/crates.io-index" 68 | checksum = "e88b166b48e29667f5443df64df3c61dc07dc2b1a0b0d231800e07f09a33ecc1" 69 | 70 | [[package]] 71 | name = "cc" 72 | version = "1.0.72" 73 | source = "registry+https://github.com/rust-lang/crates.io-index" 74 | checksum = "22a9137b95ea06864e018375b72adfb7db6e6f68cfc8df5a04d00288050485ee" 75 | 76 | [[package]] 77 | name = "cfg-if" 78 | version = "0.1.10" 79 | source = "registry+https://github.com/rust-lang/crates.io-index" 80 | checksum = "4785bdd1c96b2a846b2bd7cc02e86b6b3dbf14e7e53446c4f54c92a361040822" 81 | 82 | [[package]] 83 | name = "cfg-if" 84 | version = "1.0.0" 85 | source = "registry+https://github.com/rust-lang/crates.io-index" 86 | checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" 87 | 88 | [[package]] 89 | name = "clap" 90 | version = "2.34.0" 91 | source = "registry+https://github.com/rust-lang/crates.io-index" 92 | checksum = "a0610544180c38b88101fecf2dd634b174a62eef6946f84dfc6a7127512b381c" 93 | dependencies = [ 94 | "ansi_term", 95 | "atty", 96 | "bitflags 1.2.1", 97 | "strsim", 98 | "textwrap", 99 | "unicode-width", 100 | "vec_map", 101 | ] 102 | 103 | [[package]] 104 | name = "crc" 105 | version = "1.8.1" 106 | source = "registry+https://github.com/rust-lang/crates.io-index" 107 | checksum = "d663548de7f5cca343f1e0a48d14dcfb0e9eb4e079ec58883b7251539fa10aeb" 108 | dependencies = [ 109 | "build_const", 110 | ] 111 | 112 | [[package]] 113 | name = "derive-error" 114 | version = "0.0.5" 115 | source = "registry+https://github.com/rust-lang/crates.io-index" 116 | checksum = "eb6238eafbc141db51c6d0d599dde74224b28437c7cf7c3a1755e3e3e5e00806" 117 | dependencies = [ 118 | "case", 119 | "quote", 120 | "syn", 121 | ] 122 | 123 | [[package]] 124 | name = "fastar" 125 | version = "0.2.0" 126 | dependencies = [ 127 | "clap", 128 | "derive-error", 129 | "nix 0.20.2", 130 | "platter-walk", 131 | "reapfrog", 132 | "tar", 133 | "tempfile", 134 | ] 135 | 136 | [[package]] 137 | name = "filetime" 138 | version = "0.2.15" 139 | source = "registry+https://github.com/rust-lang/crates.io-index" 140 | checksum = "975ccf83d8d9d0d84682850a38c8169027be83368805971cc4f238c2b245bc98" 141 | dependencies = [ 142 | "cfg-if 1.0.0", 143 | "libc", 144 | "redox_syscall", 145 | "winapi", 146 | ] 147 | 148 | [[package]] 149 | name = "flate2" 150 | version = "0.2.20" 151 | source = "registry+https://github.com/rust-lang/crates.io-index" 152 | checksum = "e6234dd4468ae5d1e2dbb06fe2b058696fdc50a339c68a393aefbf00bc81e423" 153 | dependencies = [ 154 | "libc", 155 | "miniz-sys", 156 | ] 157 | 158 | [[package]] 159 | name = "getrandom" 160 | version = "0.2.3" 161 | source = "registry+https://github.com/rust-lang/crates.io-index" 162 | checksum = "7fcd999463524c52659517fe2cea98493cfe485d10565e7b0fb07dbba7ad2753" 163 | dependencies = [ 164 | "cfg-if 1.0.0", 165 | "libc", 166 | "wasi", 167 | ] 168 | 169 | [[package]] 170 | name = "hermit-abi" 171 | version = "0.1.19" 172 | source = "registry+https://github.com/rust-lang/crates.io-index" 173 | checksum = "62b467343b94ba476dcb2500d242dadbb39557df889310ac77c5d99100aaac33" 174 | dependencies = [ 175 | "libc", 176 | ] 177 | 178 | [[package]] 179 | name = "lazy_static" 180 | version = "0.2.11" 181 | source = "registry+https://github.com/rust-lang/crates.io-index" 182 | checksum = "76f033c7ad61445c5b347c7382dd1237847eb1bce590fe50365dcb33d546be73" 183 | 184 | [[package]] 185 | name = "libc" 186 | version = "0.2.112" 187 | source = "registry+https://github.com/rust-lang/crates.io-index" 188 | checksum = "1b03d17f364a3a042d5e5d46b053bbbf82c92c9430c592dd4c064dc6ee997125" 189 | 190 | [[package]] 191 | name = "memoffset" 192 | version = "0.6.5" 193 | source = "registry+https://github.com/rust-lang/crates.io-index" 194 | checksum = "5aa361d4faea93603064a027415f07bd8e1d5c88c9fbf68bf56a285428fd79ce" 195 | dependencies = [ 196 | "autocfg", 197 | ] 198 | 199 | [[package]] 200 | name = "minilzo" 201 | version = "0.1.2" 202 | source = "registry+https://github.com/rust-lang/crates.io-index" 203 | checksum = "ee71a22b211bc7faf000819d61b86519a2abd0d5bcf44677498ddfa3ef271da9" 204 | dependencies = [ 205 | "libc", 206 | "minilzo-sys", 207 | ] 208 | 209 | [[package]] 210 | name = "minilzo-sys" 211 | version = "0.1.0" 212 | source = "registry+https://github.com/rust-lang/crates.io-index" 213 | checksum = "ce123edaa554212f9aef7466ae6805c59ce71edd79ead0c2aa8e828e444de9e5" 214 | dependencies = [ 215 | "libc", 216 | ] 217 | 218 | [[package]] 219 | name = "miniz-sys" 220 | version = "0.1.12" 221 | source = "registry+https://github.com/rust-lang/crates.io-index" 222 | checksum = "1e9e3ae51cea1576ceba0dde3d484d30e6e5b86dee0b2d412fe3a16a15c98202" 223 | dependencies = [ 224 | "cc", 225 | "libc", 226 | ] 227 | 228 | [[package]] 229 | name = "mnt" 230 | version = "0.3.1" 231 | source = "registry+https://github.com/rust-lang/crates.io-index" 232 | checksum = "1587ebb20a5b04738f16cffa7e2526f1b8496b84f92920facd518362ff1559eb" 233 | dependencies = [ 234 | "libc", 235 | ] 236 | 237 | [[package]] 238 | name = "nix" 239 | version = "0.8.1" 240 | source = "registry+https://github.com/rust-lang/crates.io-index" 241 | checksum = "47e49f6982987135c5e9620ab317623e723bd06738fd85377e8d55f57c8b6487" 242 | dependencies = [ 243 | "bitflags 0.7.0", 244 | "cfg-if 0.1.10", 245 | "libc", 246 | "void", 247 | ] 248 | 249 | [[package]] 250 | name = "nix" 251 | version = "0.20.2" 252 | source = "registry+https://github.com/rust-lang/crates.io-index" 253 | checksum = "f5e06129fb611568ef4e868c14b326274959aa70ff7776e9d55323531c374945" 254 | dependencies = [ 255 | "bitflags 1.2.1", 256 | "cc", 257 | "cfg-if 1.0.0", 258 | "libc", 259 | "memoffset", 260 | ] 261 | 262 | [[package]] 263 | name = "platter-walk" 264 | version = "0.1.3" 265 | source = "registry+https://github.com/rust-lang/crates.io-index" 266 | checksum = "67ec9aa7f1678386801cc14d6268f3f6b5d36b0fd7dadf3a3b55371c1e46e7d5" 267 | dependencies = [ 268 | "btrfs2", 269 | "libc", 270 | "mnt", 271 | ] 272 | 273 | [[package]] 274 | name = "ppv-lite86" 275 | version = "0.2.15" 276 | source = "registry+https://github.com/rust-lang/crates.io-index" 277 | checksum = "ed0cfbc8191465bed66e1718596ee0b0b35d5ee1f41c5df2189d0fe8bde535ba" 278 | 279 | [[package]] 280 | name = "quote" 281 | version = "0.3.15" 282 | source = "registry+https://github.com/rust-lang/crates.io-index" 283 | checksum = "7a6e920b65c65f10b2ae65c831a81a073a89edd28c7cce89475bff467ab4167a" 284 | 285 | [[package]] 286 | name = "rand" 287 | version = "0.8.4" 288 | source = "registry+https://github.com/rust-lang/crates.io-index" 289 | checksum = "2e7573632e6454cf6b99d7aac4ccca54be06da05aca2ef7423d22d27d4d4bcd8" 290 | dependencies = [ 291 | "libc", 292 | "rand_chacha", 293 | "rand_core", 294 | "rand_hc", 295 | ] 296 | 297 | [[package]] 298 | name = "rand_chacha" 299 | version = "0.3.1" 300 | source = "registry+https://github.com/rust-lang/crates.io-index" 301 | checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88" 302 | dependencies = [ 303 | "ppv-lite86", 304 | "rand_core", 305 | ] 306 | 307 | [[package]] 308 | name = "rand_core" 309 | version = "0.6.3" 310 | source = "registry+https://github.com/rust-lang/crates.io-index" 311 | checksum = "d34f1408f55294453790c48b2f1ebbb1c5b4b7563eb1f418bcfcfdbb06ebb4e7" 312 | dependencies = [ 313 | "getrandom", 314 | ] 315 | 316 | [[package]] 317 | name = "rand_hc" 318 | version = "0.3.1" 319 | source = "registry+https://github.com/rust-lang/crates.io-index" 320 | checksum = "d51e9f596de227fda2ea6c84607f5558e196eeaf43c986b724ba4fb8fdf497e7" 321 | dependencies = [ 322 | "rand_core", 323 | ] 324 | 325 | [[package]] 326 | name = "reapfrog" 327 | version = "0.2.0" 328 | source = "registry+https://github.com/rust-lang/crates.io-index" 329 | checksum = "ac783b2962d99a9d320032a82f11d9ba044de6c3743b78b84a746edd2d644240" 330 | dependencies = [ 331 | "libc", 332 | ] 333 | 334 | [[package]] 335 | name = "redox_syscall" 336 | version = "0.2.10" 337 | source = "registry+https://github.com/rust-lang/crates.io-index" 338 | checksum = "8383f39639269cde97d255a32bdb68c047337295414940c68bdd30c2e13203ff" 339 | dependencies = [ 340 | "bitflags 1.2.1", 341 | ] 342 | 343 | [[package]] 344 | name = "remove_dir_all" 345 | version = "0.5.3" 346 | source = "registry+https://github.com/rust-lang/crates.io-index" 347 | checksum = "3acd125665422973a33ac9d3dd2df85edad0f4ae9b00dafb1a05e43a9f5ef8e7" 348 | dependencies = [ 349 | "winapi", 350 | ] 351 | 352 | [[package]] 353 | name = "strsim" 354 | version = "0.8.0" 355 | source = "registry+https://github.com/rust-lang/crates.io-index" 356 | checksum = "8ea5119cdb4c55b55d432abb513a0429384878c15dde60cc77b1c99de1a95a6a" 357 | 358 | [[package]] 359 | name = "syn" 360 | version = "0.11.11" 361 | source = "registry+https://github.com/rust-lang/crates.io-index" 362 | checksum = "d3b891b9015c88c576343b9b3e41c2c11a51c219ef067b264bd9c8aa9b441dad" 363 | dependencies = [ 364 | "quote", 365 | "synom", 366 | "unicode-xid", 367 | ] 368 | 369 | [[package]] 370 | name = "synom" 371 | version = "0.11.3" 372 | source = "registry+https://github.com/rust-lang/crates.io-index" 373 | checksum = "a393066ed9010ebaed60b9eafa373d4b1baac186dd7e008555b0f702b51945b6" 374 | dependencies = [ 375 | "unicode-xid", 376 | ] 377 | 378 | [[package]] 379 | name = "tar" 380 | version = "0.4.38" 381 | source = "registry+https://github.com/rust-lang/crates.io-index" 382 | checksum = "4b55807c0344e1e6c04d7c965f5289c39a8d94ae23ed5c0b57aabac549f871c6" 383 | dependencies = [ 384 | "filetime", 385 | "libc", 386 | "xattr", 387 | ] 388 | 389 | [[package]] 390 | name = "tempfile" 391 | version = "3.2.0" 392 | source = "registry+https://github.com/rust-lang/crates.io-index" 393 | checksum = "dac1c663cfc93810f88aed9b8941d48cabf856a1b111c29a40439018d870eb22" 394 | dependencies = [ 395 | "cfg-if 1.0.0", 396 | "libc", 397 | "rand", 398 | "redox_syscall", 399 | "remove_dir_all", 400 | "winapi", 401 | ] 402 | 403 | [[package]] 404 | name = "textwrap" 405 | version = "0.11.0" 406 | source = "registry+https://github.com/rust-lang/crates.io-index" 407 | checksum = "d326610f408c7a4eb6f51c37c330e496b08506c9457c9d34287ecc38809fb060" 408 | dependencies = [ 409 | "unicode-width", 410 | ] 411 | 412 | [[package]] 413 | name = "unicode-width" 414 | version = "0.1.9" 415 | source = "registry+https://github.com/rust-lang/crates.io-index" 416 | checksum = "3ed742d4ea2bd1176e236172c8429aaf54486e7ac098db29ffe6529e0ce50973" 417 | 418 | [[package]] 419 | name = "unicode-xid" 420 | version = "0.0.4" 421 | source = "registry+https://github.com/rust-lang/crates.io-index" 422 | checksum = "8c1f860d7d29cf02cb2f3f359fd35991af3d30bac52c57d265a3c461074cb4dc" 423 | 424 | [[package]] 425 | name = "uuid" 426 | version = "0.3.1" 427 | source = "registry+https://github.com/rust-lang/crates.io-index" 428 | checksum = "1a9ff57156caf7e22f37baf3c9d8f6ce8194842c23419dafcb0716024514d162" 429 | 430 | [[package]] 431 | name = "vec_map" 432 | version = "0.8.2" 433 | source = "registry+https://github.com/rust-lang/crates.io-index" 434 | checksum = "f1bddf1187be692e79c5ffeab891132dfb0f236ed36a43c7ed39f1165ee20191" 435 | 436 | [[package]] 437 | name = "void" 438 | version = "1.0.2" 439 | source = "registry+https://github.com/rust-lang/crates.io-index" 440 | checksum = "6a02e4885ed3bc0f2de90ea6dd45ebcbb66dacffe03547fadbb0eeae2770887d" 441 | 442 | [[package]] 443 | name = "wasi" 444 | version = "0.10.2+wasi-snapshot-preview1" 445 | source = "registry+https://github.com/rust-lang/crates.io-index" 446 | checksum = "fd6fbd9a79829dd1ad0cc20627bf1ed606756a7f77edff7b66b7064f9cb327c6" 447 | 448 | [[package]] 449 | name = "winapi" 450 | version = "0.3.9" 451 | source = "registry+https://github.com/rust-lang/crates.io-index" 452 | checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" 453 | dependencies = [ 454 | "winapi-i686-pc-windows-gnu", 455 | "winapi-x86_64-pc-windows-gnu", 456 | ] 457 | 458 | [[package]] 459 | name = "winapi-i686-pc-windows-gnu" 460 | version = "0.4.0" 461 | source = "registry+https://github.com/rust-lang/crates.io-index" 462 | checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" 463 | 464 | [[package]] 465 | name = "winapi-x86_64-pc-windows-gnu" 466 | version = "0.4.0" 467 | source = "registry+https://github.com/rust-lang/crates.io-index" 468 | checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" 469 | 470 | [[package]] 471 | name = "xattr" 472 | version = "0.2.2" 473 | source = "registry+https://github.com/rust-lang/crates.io-index" 474 | checksum = "244c3741f4240ef46274860397c7c74e50eb23624996930e484c16679633a54c" 475 | dependencies = [ 476 | "libc", 477 | ] 478 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "fastar" 3 | version = "0.2.0" 4 | authors = ["The8472"] 5 | description = "Fast tar archive creation for HDDs" 6 | keywords = ["linux", "cli", "tar", "archive"] 7 | repository = "https://github.com/the8472/fastar" 8 | readme = "README.md" 9 | categories = ["command-line-utilities", "filesystem"] 10 | license = "GPL-3.0" 11 | edition = "2021" 12 | 13 | include = [ 14 | "**/*.rs", 15 | "README.md", 16 | "LICENCE", 17 | "Cargo.toml", 18 | "Cargo.lock" 19 | ] 20 | 21 | [profile.release] 22 | lto = true 23 | opt-level = "s" 24 | panic = "abort" 25 | debug = false 26 | 27 | [dependencies] 28 | clap = "2.20" 29 | derive-error = "0.0.5" 30 | nix = "0.20.0" 31 | tar = "0.4.38" 32 | reapfrog = "0.2.0" 33 | platter-walk = "0.1.3" 34 | 35 | [dev-dependencies] 36 | tempfile = "3.2.0" 37 | -------------------------------------------------------------------------------- /LICENCE: -------------------------------------------------------------------------------- 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 | [![Version](https://img.shields.io/crates/v/fastar.svg)](https://crates.io/crates/fastar) 2 | 3 | # fastar 4 | 5 | A faster equivalent of `tar -cT <(find . -type f)`, optimized for tarring many small files stored on HDDs. 6 | 7 | Optimizations compared to gnu tar: 8 | 9 | * directory traversal based on physical disk layout. see [platter-walk](https://github.com/the8472/platter-walk) crate 10 | * readaheads across multiple files at once to keep the drive's command queue filled. see [reapfrog](https://github.com/the8472/reapfrog) crate 11 | * drops disk caches for files once they are read to prevent disk buffer thrashing. 12 | 13 | 14 | Limitations compared to gnu tar: 15 | 16 | * arguments must be directories 17 | * only archives regular files, not symlinks or empty directories 18 | * xattrs are not included 19 | * sparse files are zero-filled 20 | 21 | 22 | ## Building 23 | 24 | * indirect dependencies: libz, liblzo headers 25 | * `cargo build --release` 26 | 27 | ## Benchmarks 28 | 29 | ``` 30 | # ffcnt . -s 31 | files: 6680901 32 | bytes: 245271028476 33 | 34 | # echo 3 > /proc/sys/vm/drop_caches ; tar -c . | pv -at > /dev/null 35 | ^C0:02:45 [ 2.4MiB/s] 36 | 37 | # echo 3 > /proc/sys/vm/drop_caches ; tar -cT <(ffcnt --ls --type f --leaf-order content .) | pv -at > /dev/null 38 | ^C0:02:50 [4.11MiB/s] 39 | 40 | # echo 3 > /proc/sys/vm/drop_caches ; fastar . | pv -at > /dev/null 41 | ^C0:02:51 [9.28MiB/s] 42 | ``` -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | // fastar 2 | // Copyright (C) 2017 The 8472 3 | // 4 | // This program is free software; you can redistribute it and/or modify 5 | // it under the terms of the GNU General Public License as published by 6 | // the Free Software Foundation; either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU General Public License 15 | // along with this program; if not, write to the Free Software Foundation, 16 | // Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 17 | 18 | #[macro_use] extern crate clap; 19 | #[macro_use] extern crate derive_error; 20 | extern crate reapfrog; 21 | extern crate platter_walk; 22 | extern crate tar; 23 | extern crate nix; 24 | 25 | use std::io::*; 26 | use std::path::{Path, PathBuf}; 27 | use clap::{Arg, App}; 28 | use platter_walk::*; 29 | use std::fs::File; 30 | use tar::{Builder, Header, HeaderMode, EntryType}; 31 | use std::os::unix::io::{FromRawFd, AsRawFd}; 32 | use std::collections::HashMap; 33 | use std::os::linux::fs::MetadataExt; 34 | 35 | #[derive(Debug, Error)] 36 | enum CliError { 37 | Io(std::io::Error), 38 | Nix(nix::Error), 39 | OutputIsATty 40 | } 41 | 42 | struct Config { 43 | starting_points: Vec, 44 | order: Order, 45 | out: File, 46 | } 47 | 48 | 49 | fn process_args() -> std::result::Result { 50 | let matches = App::new("fast tar archive creator (for HDDs)") 51 | .version(crate_version!()) 52 | .arg(Arg::with_name("ord").long("leaf-order").required(false).takes_value(true).possible_values(&["inode","content", "dentry"]).help("optimize order for listing/stat/reads")) 53 | .arg(Arg::with_name("out").short("f").required(false).takes_value(true).help("write output to file instead of stdout")) 54 | .arg(Arg::with_name("dirs").index(1).multiple(true).required(false).help("directories to traverse [default: cwd]")) 55 | .get_matches(); 56 | 57 | let mut starting_points = matches.values_of_os("dirs").map(|it| it.map(Path::new).map(Path::to_owned).collect()).unwrap_or(vec![]); 58 | 59 | if starting_points.is_empty() { 60 | starting_points.push(std::env::current_dir()?); 61 | } 62 | 63 | let order = match matches.value_of("ord") { 64 | Some("inode") => Order::Inode, 65 | Some("content") =>Order::Content, 66 | Some("dentry") => Order::Dentries, 67 | _ => Order::Content 68 | }; 69 | 70 | 71 | const STDOUT : i32 = 1; 72 | 73 | let out = match matches.value_of("out") { 74 | Some(s) => std::fs::OpenOptions::new().create(true).write(true).open(s)?, 75 | None => unsafe { File::from_raw_fd(STDOUT) } 76 | }; 77 | 78 | if nix::unistd::isatty(out.as_raw_fd())? { 79 | return Err(CliError::OutputIsATty) 80 | } 81 | 82 | Ok(Config { 83 | out, 84 | starting_points, 85 | order 86 | }) 87 | } 88 | 89 | fn archive(config: Config) -> std::result::Result<(), CliError> { 90 | 91 | let mut dir_scanner = ToScan::new(); 92 | 93 | dir_scanner.set_order(config.order); 94 | 95 | for path in &config.starting_points { 96 | dir_scanner.add_root(path.to_owned())?; 97 | } 98 | 99 | dir_scanner.set_prefilter(Box::new(move |_,ft| ft.is_file())); 100 | 101 | let it = dir_scanner.filter_map(|e| e.ok()).map(|e| e.path().to_owned()); 102 | let mut reap = reapfrog::MultiFileReadahead::new(it); 103 | reap.dropbehind(true); 104 | 105 | 106 | let mut builder = Builder::new(BufWriter::new(config.out)); 107 | let mut hardlinks: HashMap<(u64, u64), PathBuf> = HashMap::new(); 108 | 109 | loop { 110 | match reap.next() { 111 | None => break, 112 | Some(Err(e)) => { 113 | eprintln!("{}", e); 114 | } 115 | Some(Ok(mut reader)) => { 116 | let mut p = reader.path().to_owned(); 117 | let meta = reader.metadata(); 118 | 119 | for path in &config.starting_points { 120 | if p.starts_with(path) { 121 | p = p.strip_prefix(path).unwrap().to_owned(); 122 | } 123 | } 124 | 125 | if meta.file_type().is_file() && meta.st_nlink() > 1 { 126 | let existing = hardlinks.entry((meta.st_dev(), meta.st_ino())).or_insert(p.clone()); 127 | if existing != &p { 128 | // hardlinked file we already visited 129 | let mut header = Header::new_gnu(); 130 | header.set_metadata_in_mode(&meta, HeaderMode::Deterministic); 131 | header.set_entry_type(EntryType::hard_link()); 132 | header.set_cksum(); 133 | builder.append_link(&mut header, &p, &existing)?; 134 | 135 | continue; 136 | } 137 | } 138 | 139 | let mut header = Header::new_gnu(); 140 | header.set_metadata_in_mode(&meta, HeaderMode::Deterministic); 141 | header.set_cksum(); 142 | builder.append_data(&mut header, &p, &mut reader)? 143 | } 144 | } 145 | } 146 | 147 | builder.into_inner()?; 148 | 149 | Ok(()) 150 | } 151 | 152 | 153 | fn main() -> std::result::Result<(), CliError> { 154 | let config = process_args()?; 155 | archive(config) 156 | } 157 | 158 | 159 | #[cfg(test)] 160 | mod test { 161 | use std::fs; 162 | use super::*; 163 | 164 | #[test] 165 | fn test_hardlinks() { 166 | let tempdir = tempfile::tempdir().unwrap(); 167 | let tmp_path = tempdir.path(); 168 | 169 | let out = File::create(tmp_path.join("out.tar")).unwrap(); 170 | fs::create_dir(tmp_path.join("in")).unwrap(); 171 | fs::create_dir(tmp_path.join("unpack")).unwrap(); 172 | File::create(tmp_path.join("in/a")).unwrap(); 173 | fs::hard_link(tmp_path.join("in/a"), tmp_path.join("in/b")).unwrap(); 174 | 175 | let config = Config { 176 | out, 177 | starting_points: vec![tmp_path.join("in").to_path_buf()], 178 | order: Order::Content 179 | }; 180 | 181 | archive(config).unwrap(); 182 | 183 | let mut archive = tar::Archive::new(File::open(tmp_path.join("out.tar")).unwrap()); 184 | 185 | archive.unpack(tmp_path.join("unpack")).unwrap(); 186 | 187 | assert!(tmp_path.join("unpack/a").exists()); 188 | assert!(tmp_path.join("unpack/b").exists()); 189 | 190 | assert_eq!(2, fs::read_dir(tmp_path.join("unpack")).unwrap().filter(|e| e.as_ref().unwrap().metadata().unwrap().st_nlink() == 2).count(), "two files, one hardlink"); 191 | } 192 | } --------------------------------------------------------------------------------