development/cargo
development/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo synced 2024-07-02 16:09:07 +00:00
Code Issues Projects Releases Wiki Activity
17,800 Commits 76 Branches 99 Tags 85 MiB
Rust 95.3%
Roff 4.3%
JavaScript 0.2%
Shell 0.1%
3ff54e575e
Go to file
Weihang Lo 3ff54e575e
feat: use stable hash from rustc-stable-hash 
This helps `-Ztrim-paths` build a stable cross-platform path for the
registry and git sources. Sources files then can be found from the same
path when debugging.

See https://github.com/rust-lang/cargo/issues/13171#issuecomment-1864899037

A few caveats:

* This will invalidate the current downloaded caches.
  Need to put this in the Cargo CHANGELOG.
* As a consequence of changing how `SourceId` is hashed, the global cache
  tracker is also affected because Cargo writes source identifiers (e.g.
  `index.crates.io-6f17d22bba15001f`) to SQLite.
  * 6e236509b2/src/cargo/core/global_cache_tracker.rs (L388-L391)
* The performance of rustc-stable-hash is slightly worse than the old
  SipHasher in std on short things like `SourceId`, but for long stuff
  like fingerprint. See appendix.

StableHasher is used in several places (some might not be needed?):

* Rebuild detection (fingerprints)
  * Rustc version, including all the CLI args running `rustc -vV`.
    * 6e236509b2/src/cargo/util/rustc.rs (L326)
    * 6e236509b2/src/cargo/util/rustc.rs (L381)
  * Build caches
    * 6e236509b2/src/cargo/core/compiler/fingerprint/mod.rs (L1456)
* Compute rustc `-C metadata`
  * stable hash for SourceId
    * 6e236509b2/src/cargo/core/package_id.rs (L207)
  * Also read and hash contents from custom target JSON file.
    * 6e236509b2/src/cargo/core/compiler/compile_kind.rs (L81-L91)
* `UnitInner::dep_hash`
  * This is to distinguish same units having different features set between normal and build dependencies.
    * 6e236509b2/src/cargo/ops/cargo_compile/mod.rs (L627)
* Hash file contents for `cargo package` to verify if files were modified before and after the build.
  * 6e236509b2/src/cargo/ops/cargo_package.rs (L999)
* Rusc diagnostics deduplication
  * 6e236509b2/src/cargo/core/compiler/job_queue/mod.rs (L311)
* Places using `SourceId` identifier like `registry/src` path,
  and `-Zscript` target directories.

Appendix
--------

Benchmark on x86_64-unknown-linux-gnu

```
bench_hasher/RustcStableHasher/URL
                        time:   [33.843 ps 33.844 ps 33.845 ps]
                        change: [-0.0167% -0.0049% +0.0072%] (p = 0.44 > 0.05)
                        No change in performance detected.
Found 10 outliers among 100 measurements (10.00%)
  5 (5.00%) low severe
  3 (3.00%) high mild
  2 (2.00%) high severe
bench_hasher/SipHasher/URL
                        time:   [18.954 ns 18.954 ns 18.955 ns]
                        change: [-0.1281% -0.0951% -0.0644%] (p = 0.00 < 0.05)
                        Change within noise threshold.
Found 14 outliers among 100 measurements (14.00%)
  3 (3.00%) low severe
  4 (4.00%) low mild
  3 (3.00%) high mild
  4 (4.00%) high severe
bench_hasher/RustcStableHasher/lorem ipsum
                        time:   [659.18 ns 659.20 ns 659.22 ns]
                        change: [-0.0192% -0.0062% +0.0068%] (p = 0.34 > 0.05)
                        No change in performance detected.
Found 12 outliers among 100 measurements (12.00%)
  4 (4.00%) low severe
  3 (3.00%) low mild
  3 (3.00%) high mild
  2 (2.00%) high severe
bench_hasher/SipHasher/lorem ipsum
                        time:   [1.2006 µs 1.2008 µs 1.2010 µs]
                        change: [+0.0117% +0.0467% +0.0808%] (p = 0.01 < 0.05)
                        Change within noise threshold.
Found 1 outliers among 100 measurements (1.00%)
  1 (1.00%) high mild
```
2024-06-20 13:37:45 -04:00
.cargo feat: Add an xtask to generate lint documentation 2024-06-06 23:03:53 -06:00
.github chore(ci): Upgrade cargo-semver-checks 2024-06-13 11:46:41 -05:00
benches Add a dry_run argument to resolve_ws(). 2024-06-05 17:58:08 +02:00
ci ci: big ⚠️ to ensure the CNAME file is always there 2023-10-18 21:31:10 -04:00
crates test: fix the [FINISHED] escape 2024-06-18 13:58:56 -04:00
credential chore: Bump version for internal crates 2024-06-13 13:38:32 -05:00
src feat: use stable hash from rustc-stable-hash 2024-06-20 13:37:45 -04:00
tests Auto merge of #14093 - heisen-li:alias_command_config, r=weihanglo 2024-06-19 19:13:39 +00:00
.gitignore Fix target entry in .gitignore 2024-04-29 07:39:04 +10:00
.ignore chore: Don't show genned docs in ripgrep 2022-08-31 16:13:32 -05:00
build.rs add support for reading git-commit-info 2024-04-30 10:44:27 +02:00
Cargo.lock feat: use stable hash from rustc-stable-hash 2024-06-20 13:37:45 -04:00
Cargo.toml feat: use stable hash from rustc-stable-hash 2024-06-20 13:37:45 -04:00
CHANGELOG.md docs(change): Don't mention non-existent workspace.badges 2024-06-10 21:12:08 -05:00
clippy.toml chore: Communicate motivation for AtomucU64 2023-11-16 12:34:02 -06:00
CODE_OF_CONDUCT.md Add CoC 2023-01-25 10:18:15 +00:00
CONTRIBUTING.md docs: remove review capacity notice 2023-10-18 13:24:09 -04:00
deny.toml Fix some typos 2023-09-24 23:10:07 +08:00
LICENSE-APACHE HTTPS all the things 2019-01-30 15:34:37 -05:00
LICENSE-MIT Remove inaccurate (misattributed) copyright notices 2017-07-26 17:19:24 -07:00
LICENSE-THIRD-PARTY HTTPS all the things 2019-01-30 15:34:37 -05:00
publish.py Chore(publish.py): Add cargo-test-* to publication list 2024-03-26 11:17:34 +01:00
README.md doc: point to nightly cargo doc 2023-06-07 10:13:05 +01:00
triagebot.toml refactor: cargo_generate_lockfile -> cargo_update. 2024-06-05 11:54:51 +02:00
windows.manifest.xml Add a windows manifest file 2023-12-07 14:24:58 +00:00

README.md

Cargo

Cargo downloads your Rust project’s dependencies and compiles your project.

To start using Cargo, learn more at The Cargo Book.

To start developing Cargo itself, read the Cargo Contributor Guide.

Code Status

CI

Code documentation: https://doc.rust-lang.org/nightly/nightly-rustc/cargo/

Installing Cargo

Cargo is distributed by default with Rust, so if you've got rustc installed locally you probably also have cargo installed locally.

Compiling from Source

Requirements

Cargo requires the following tools and packages to build:

Other requirements:

The following are optional based on your platform and needs.

  • pkg-config — This is used to help locate system packages, such as libssl headers/libraries. This may not be required in all cases, such as using vendored OpenSSL, or on Windows.

  • OpenSSL — Only needed on Unix-like systems and only if the vendored-openssl Cargo feature is not used.

    This requires the development headers, which can be obtained from the libssl-dev package on Ubuntu or openssl-devel with apk or yum or the openssl package from Homebrew on macOS.

    If using the vendored-openssl Cargo feature, then a static copy of OpenSSL will be built from source instead of using the system OpenSSL. This may require additional tools such as perl and make.

    On macOS, common installation directories from Homebrew, MacPorts, or pkgsrc will be checked. Otherwise it will fall back to pkg-config.

    On Windows, the system-provided Schannel will be used instead.

    LibreSSL is also supported.

Optional system libraries:

The build will automatically use vendored versions of the following libraries. However, if they are provided by the system and can be found with pkg-config, then the system libraries will be used instead:

  • libcurl — Used for network transfers.
  • libgit2 — Used for fetching git dependencies.
  • libssh2 — Used for SSH access to git repositories.
  • libz (aka zlib) — Used for data compression.

It is recommended to use the vendored versions as they are the versions that are tested to work with Cargo.

Compiling

First, you'll want to check out this repository

git clone https://github.com/rust-lang/cargo.git
cd cargo

With cargo already installed, you can simply run:

cargo build --release

Adding new subcommands to Cargo

Cargo is designed to be extensible with new subcommands without having to modify Cargo itself. See the Wiki page for more details and a list of known community-developed subcommands.

Releases

Cargo releases coincide with Rust releases. High level release notes are available as part of Rust's release notes. Detailed release notes are available in this repo at CHANGELOG.md.

Reporting issues

Found a bug? We'd love to know about it!

Please report all issues on the GitHub issue tracker.

Contributing

See the Cargo Contributor Guide for a complete introduction to contributing to Cargo.

License

Cargo is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.

Third party software

This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (https://www.openssl.org/).

In binary form, this product includes software that is licensed under the terms of the GNU General Public License, version 2, with a linking exception, which can be obtained from the upstream repository.

See LICENSE-THIRD-PARTY for details.