#
cargo/sources/
path.rs

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    602
    603
    604
    605
    606
    607
    608
    609
    610
    611
    612
    613
    614
    615
    616
    617
    618
    619
    620
    621
    622
    623
    624
    625
    626
    627
    628
    629
    630
    631
    632
    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    681
    682
    683
    684
    685
    686
    687
    688
    689
    690
    691
    692
    693
    694
    695
    696
    697
    698
    699
    700
    701
    702
    703
    704
    705
    706
    707
    708
    709
    710
    711
    712
    713
    714
    715
    716
    717
    718
    719
    720
    721
    722
    723
    724
    725
    726
    727
    728
    729
    730
    731
    732
    733
    734
    735
    736
    737
    738
    739
    740
    741
    742
    743
    744
    745
    746
    747
    748
    749
    750
    751
    752
    753
    754
    755
    756
    757
    758
    759
    760
    761
    762
    763
    764
    765
    766
    767
    768
    769
    770
    771
    772
    773
    774
    775
    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    786
    787
    788
    789
    790
    791
    792
    793
    794
    795
    796
    797
    798
    799
    800
    801
    802
    803
    804
    805
    806
    807
    808
    809
    810
    811
    812
    813
    814
    815
    816
    817
    818
    819
    820
    821
    822
    823
    824
    825
    826
    827
    828
    829
    830
    831
    832
    833
    834
    835
    836
    837
    838
    839
    840
    841
    842
    843
    844
    845
    846
    847
    848
    849
    850
    851
    852
    853
    854
    855
    856
    857
    858
    859
    860
    861
    862
    863
    864
    865
    866
    867
    868
    869
    870
    871
    872
    873
    874
    875
    876
    877
    878
    879
    880
    881
    882
    883
    884
    885
    886
    887
    888
    889
    890
    891
    892
    893
    894
    895
    896
    897
    898
    899
    900
    901
    902
    903
    904
    905
    906
    907
    908
    909
    910
    911
    912
    913
    914
    915
    916
    917
    918
    919
    920
    921
    922
    923
    924
    925
    926
    927
    928
    929
    930
    931
    932
    933
    934
    935
    936
    937
    938
    939
    940
    941
    942
    943
    944
    945
    946
    947
    948
    949
    950
    951
    952
    953
    954
    955
    956
    957
    958
    959
    960
    961
    962
    963
    964
    965
    966
    967
    968
    969
    970
    971
    972
    973
    974
    975
    976
    977
    978
    979
    980
    981
    982
    983
    984
    985
    986
    987
    988
    989
    990
    991
    992
    993
    994
    995
    996
    997
    998
    999
    1000
    1001
    1002
    1003
    1004
    1005
    1006
    1007
    1008
    1009
    1010
    1011
    1012
    1013
    1014
    1015
    1016
    1017
    1018
    1019
    1020
    1021
    1022
    1023
    1024
    1025
    1026
    1027
    1028
    1029

    use std::collections::{HashMap, HashSet};
    use std::fmt::{self, Debug, Formatter};
    use std::fs;
    use std::io;
    use std::path::{Path, PathBuf};
    use std::task::Poll;

    use crate::core::{Dependency, EitherManifest, Manifest, Package, PackageId, SourceId};
    use crate::ops;
    use crate::sources::source::MaybePackage;
    use crate::sources::source::QueryKind;
    use crate::sources::source::Source;
    use crate::sources::IndexSummary;
    use crate::util::errors::CargoResult;
    use crate::util::important_paths::find_project_manifest_exact;
    use crate::util::internal;
    use crate::util::toml::read_manifest;
    use crate::util::GlobalContext;
    use anyhow::Context as _;
    use cargo_util::paths;
    use filetime::FileTime;
    use gix::bstr::{BString, ByteVec};
    use gix::dir::entry::Status;
    use gix::index::entry::Stage;
    use ignore::gitignore::GitignoreBuilder;
    use tracing::{debug, info, trace, warn};
    use walkdir::WalkDir;

    /// A source that represents a package gathered at the root
    /// path on the filesystem.
    ///
    /// It also provides convenient methods like [`PathSource::list_files`] to
    /// list all files in a package, given its ability to walk the filesystem.
    pub struct PathSource<'gctx> {
        /// The unique identifier of this source.
        source_id: SourceId,
        /// The root path of this source.
        path: PathBuf,
        /// Packages that this sources has discovered.
        package: Option<Package>,
        gctx: &'gctx GlobalContext,
    }

    impl<'gctx> PathSource<'gctx> {
        /// Invoked with an absolute path to a directory that contains a `Cargo.toml`.
        ///
        /// This source will only return the package at precisely the `path`
        /// specified, and it will be an error if there's not a package at `path`.
        pub fn new(path: &Path, source_id: SourceId, gctx: &'gctx GlobalContext) -> Self {
            Self {
                source_id,
                path: path.to_path_buf(),
                package: None,
                gctx,
            }
        }

        /// Preloads a package for this source. The source is assumed that it has
        /// yet loaded any other packages.
        pub fn preload_with(pkg: Package, gctx: &'gctx GlobalContext) -> Self {
            let source_id = pkg.package_id().source_id();
            let path = pkg.root().to_owned();
            Self {
                source_id,
                path,
                package: Some(pkg),
                gctx,
            }
        }

        /// Gets the package on the root path.
        pub fn root_package(&mut self) -> CargoResult<Package> {
            trace!("root_package; source={:?}", self);

            self.load()?;

            match &self.package {
                Some(pkg) => Ok(pkg.clone()),
                None => Err(internal(format!(
                    "no package found in source {:?}",
                    self.path
                ))),
            }
        }

        /// List all files relevant to building this package inside this source.
        ///
        /// This function will use the appropriate methods to determine the
        /// set of files underneath this source's directory which are relevant for
        /// building `pkg`.
        ///
        /// The basic assumption of this method is that all files in the directory
        /// are relevant for building this package, but it also contains logic to
        /// use other methods like `.gitignore`, `package.include`, or
        /// `package.exclude` to filter the list of files.
        pub fn list_files(&self, pkg: &Package) -> CargoResult<Vec<PathBuf>> {
            list_files(pkg, self.gctx)
        }

        /// Gets the last modified file in a package.
        fn last_modified_file(&self, pkg: &Package) -> CargoResult<(FileTime, PathBuf)> {
            if self.package.is_none() {
                return Err(internal(format!(
                    "BUG: source `{:?}` was not loaded",
                    self.path
                )));
            }
            last_modified_file(&self.path, pkg, self.gctx)
        }

        /// Returns the root path of this source.
        pub fn path(&self) -> &Path {
            &self.path
        }

        /// Discovers packages inside this source if it hasn't yet done.
        pub fn load(&mut self) -> CargoResult<()> {
            if self.package.is_none() {
                self.package = Some(self.read_package()?);
            }

            Ok(())
        }

        fn read_package(&self) -> CargoResult<Package> {
            let path = self.path.join("Cargo.toml");
            let pkg = ops::read_package(&path, self.source_id, self.gctx)?;
            Ok(pkg)
        }
    }

    impl<'gctx> Debug for PathSource<'gctx> {
        fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
            write!(f, "the paths source")
        }
    }

    impl<'gctx> Source for PathSource<'gctx> {
        fn query(
            &mut self,
            dep: &Dependency,
            kind: QueryKind,
            f: &mut dyn FnMut(IndexSummary),
        ) -> Poll<CargoResult<()>> {
            self.load()?;
            if let Some(s) = self.package.as_ref().map(|p| p.summary()) {
                let matched = match kind {
                    QueryKind::Exact => dep.matches(s),
                    QueryKind::Alternatives => true,
                    QueryKind::Normalized => dep.matches(s),
                };
                if matched {
                    f(IndexSummary::Candidate(s.clone()))
                }
            }
            Poll::Ready(Ok(()))
        }

        fn supports_checksums(&self) -> bool {
            false
        }

        fn requires_precise(&self) -> bool {
            false
        }

        fn source_id(&self) -> SourceId {
            self.source_id
        }

        fn download(&mut self, id: PackageId) -> CargoResult<MaybePackage> {
            trace!("getting packages; id={}", id);
            self.load()?;
            let pkg = self.package.iter().find(|pkg| pkg.package_id() == id);
            pkg.cloned()
                .map(MaybePackage::Ready)
                .ok_or_else(|| internal(format!("failed to find {} in path source", id)))
        }

        fn finish_download(&mut self, _id: PackageId, _data: Vec<u8>) -> CargoResult<Package> {
            panic!("no download should have started")
        }

        fn fingerprint(&self, pkg: &Package) -> CargoResult<String> {
            let (max, max_path) = self.last_modified_file(pkg)?;
            // Note that we try to strip the prefix of this package to get a
            // relative path to ensure that the fingerprint remains consistent
            // across entire project directory renames.
            let max_path = max_path.strip_prefix(&self.path).unwrap_or(&max_path);
            Ok(format!("{} ({})", max, max_path.display()))
        }

        fn describe(&self) -> String {
            match self.source_id.url().to_file_path() {
                Ok(path) => path.display().to_string(),
                Err(_) => self.source_id.to_string(),
            }
        }

        fn add_to_yanked_whitelist(&mut self, _pkgs: &[PackageId]) {}

        fn is_yanked(&mut self, _pkg: PackageId) -> Poll<CargoResult<bool>> {
            Poll::Ready(Ok(false))
        }

        fn block_until_ready(&mut self) -> CargoResult<()> {
            self.load()
        }

        fn invalidate_cache(&mut self) {
            // Path source has no local cache.
        }

        fn set_quiet(&mut self, _quiet: bool) {
            // Path source does not display status
        }
    }

    /// A source that represents one or multiple packages gathered from a given root
    /// path on the filesystem.
    pub struct RecursivePathSource<'gctx> {
        /// The unique identifier of this source.
        source_id: SourceId,
        /// The root path of this source.
        path: PathBuf,
        /// Whether this source has loaded all package information it may contain.
        loaded: bool,
        /// Packages that this sources has discovered.
        ///
        /// Tracking all packages for a given ID to warn on-demand for unused packages
        packages: HashMap<PackageId, Vec<Package>>,
        /// Avoid redundant unused package warnings
        warned_duplicate: HashSet<PackageId>,
        gctx: &'gctx GlobalContext,
    }

    impl<'gctx> RecursivePathSource<'gctx> {
        /// Creates a new source which is walked recursively to discover packages.
        ///
        /// This is similar to the [`PathSource::new`] method except that instead
        /// of requiring a valid package to be present at `root` the folder is
        /// walked entirely to crawl for packages.
        ///
        /// Note that this should be used with care and likely shouldn't be chosen
        /// by default!
        pub fn new(root: &Path, source_id: SourceId, gctx: &'gctx GlobalContext) -> Self {
            Self {
                source_id,
                path: root.to_path_buf(),
                loaded: false,
                packages: Default::default(),
                warned_duplicate: Default::default(),
                gctx,
            }
        }

        /// Returns the packages discovered by this source. It may walk the
        /// filesystem if package information haven't yet loaded.
        pub fn read_packages(&mut self) -> CargoResult<Vec<Package>> {
            self.load()?;
            Ok(self
                .packages
                .iter()
                .map(|(pkg_id, v)| {
                    first_package(*pkg_id, v, &mut self.warned_duplicate, self.gctx).clone()
                })
                .collect())
        }

        /// List all files relevant to building this package inside this source.
        ///
        /// This function will use the appropriate methods to determine the
        /// set of files underneath this source's directory which are relevant for
        /// building `pkg`.
        ///
        /// The basic assumption of this method is that all files in the directory
        /// are relevant for building this package, but it also contains logic to
        /// use other methods like `.gitignore`, `package.include`, or
        /// `package.exclude` to filter the list of files.
        pub fn list_files(&self, pkg: &Package) -> CargoResult<Vec<PathBuf>> {
            list_files(pkg, self.gctx)
        }

        /// Gets the last modified file in a package.
        fn last_modified_file(&self, pkg: &Package) -> CargoResult<(FileTime, PathBuf)> {
            if !self.loaded {
                return Err(internal(format!(
                    "BUG: source `{:?}` was not loaded",
                    self.path
                )));
            }
            last_modified_file(&self.path, pkg, self.gctx)
        }

        /// Returns the root path of this source.
        pub fn path(&self) -> &Path {
            &self.path
        }

        /// Discovers packages inside this source if it hasn't yet done.
        pub fn load(&mut self) -> CargoResult<()> {
            if !self.loaded {
                self.packages = read_packages(&self.path, self.source_id, self.gctx)?;
                self.loaded = true;
            }

            Ok(())
        }
    }

    impl<'gctx> Debug for RecursivePathSource<'gctx> {
        fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
            write!(f, "the paths source")
        }
    }

    impl<'gctx> Source for RecursivePathSource<'gctx> {
        fn query(
            &mut self,
            dep: &Dependency,
            kind: QueryKind,
            f: &mut dyn FnMut(IndexSummary),
        ) -> Poll<CargoResult<()>> {
            self.load()?;
            for s in self
                .packages
                .iter()
                .filter(|(pkg_id, _)| pkg_id.name() == dep.package_name())
                .map(|(pkg_id, pkgs)| {
                    first_package(*pkg_id, pkgs, &mut self.warned_duplicate, self.gctx)
                })
                .map(|p| p.summary())
            {
                let matched = match kind {
                    QueryKind::Exact => dep.matches(s),
                    QueryKind::Alternatives => true,
                    QueryKind::Normalized => dep.matches(s),
                };
                if matched {
                    f(IndexSummary::Candidate(s.clone()))
                }
            }
            Poll::Ready(Ok(()))
        }

        fn supports_checksums(&self) -> bool {
            false
        }

        fn requires_precise(&self) -> bool {
            false
        }

        fn source_id(&self) -> SourceId {
            self.source_id
        }

        fn download(&mut self, id: PackageId) -> CargoResult<MaybePackage> {
            trace!("getting packages; id={}", id);
            self.load()?;
            let pkg = self.packages.get(&id);
            pkg.map(|pkgs| first_package(id, pkgs, &mut self.warned_duplicate, self.gctx).clone())
                .map(MaybePackage::Ready)
                .ok_or_else(|| internal(format!("failed to find {} in path source", id)))
        }

        fn finish_download(&mut self, _id: PackageId, _data: Vec<u8>) -> CargoResult<Package> {
            panic!("no download should have started")
        }

        fn fingerprint(&self, pkg: &Package) -> CargoResult<String> {
            let (max, max_path) = self.last_modified_file(pkg)?;
            // Note that we try to strip the prefix of this package to get a
            // relative path to ensure that the fingerprint remains consistent
            // across entire project directory renames.
            let max_path = max_path.strip_prefix(&self.path).unwrap_or(&max_path);
            Ok(format!("{} ({})", max, max_path.display()))
        }

        fn describe(&self) -> String {
            match self.source_id.url().to_file_path() {
                Ok(path) => path.display().to_string(),
                Err(_) => self.source_id.to_string(),
            }
        }

        fn add_to_yanked_whitelist(&mut self, _pkgs: &[PackageId]) {}

        fn is_yanked(&mut self, _pkg: PackageId) -> Poll<CargoResult<bool>> {
            Poll::Ready(Ok(false))
        }

        fn block_until_ready(&mut self) -> CargoResult<()> {
            self.load()
        }

        fn invalidate_cache(&mut self) {
            // Path source has no local cache.
        }

        fn set_quiet(&mut self, _quiet: bool) {
            // Path source does not display status
        }
    }

    fn first_package<'p>(
        pkg_id: PackageId,
        pkgs: &'p Vec<Package>,
        warned_duplicate: &mut HashSet<PackageId>,
        gctx: &GlobalContext,
    ) -> &'p Package {
        if pkgs.len() != 1 && warned_duplicate.insert(pkg_id) {
            let ignored = pkgs[1..]
                .iter()
                // We can assume a package with publish = false isn't intended to be seen
                // by users so we can hide the warning about those since the user is unlikely
                // to care about those cases.
                .filter(|pkg| pkg.publish().is_none())
                .collect::<Vec<_>>();
            if !ignored.is_empty() {
                use std::fmt::Write as _;

                let plural = if ignored.len() == 1 { "" } else { "s" };
                let mut msg = String::new();
                let _ = writeln!(&mut msg, "skipping duplicate package{plural} `{pkg_id}`:");
                for ignored in ignored {
                    let manifest_path = ignored.manifest_path().display();
                    let _ = writeln!(&mut msg, "  {manifest_path}");
                }
                let manifest_path = pkgs[0].manifest_path().display();
                let _ = writeln!(&mut msg, "in favor of {manifest_path}");
                let _ = gctx.shell().warn(msg);
            }
        }
        &pkgs[0]
    }

    /// List all files relevant to building this package inside this source.
    ///
    /// This function will use the appropriate methods to determine the
    /// set of files underneath this source's directory which are relevant for
    /// building `pkg`.
    ///
    /// The basic assumption of this method is that all files in the directory
    /// are relevant for building this package, but it also contains logic to
    /// use other methods like `.gitignore`, `package.include`, or
    /// `package.exclude` to filter the list of files.
    pub fn list_files(pkg: &Package, gctx: &GlobalContext) -> CargoResult<Vec<PathBuf>> {
        _list_files(pkg, gctx).with_context(|| {
            format!(
                "failed to determine list of files in {}",
                pkg.root().display()
            )
        })
    }

    /// See [`PathSource::list_files`].
    fn _list_files(pkg: &Package, gctx: &GlobalContext) -> CargoResult<Vec<PathBuf>> {
        let root = pkg.root();
        let no_include_option = pkg.manifest().include().is_empty();
        let git_repo = if no_include_option {
            discover_gix_repo(root)?
        } else {
            None
        };

        let mut exclude_builder = GitignoreBuilder::new(root);
        if no_include_option && git_repo.is_none() {
            // no include option and not git repo discovered (see rust-lang/cargo#7183).
            exclude_builder.add_line(None, ".*")?;
        }
        for rule in pkg.manifest().exclude() {
            exclude_builder.add_line(None, rule)?;
        }
        let ignore_exclude = exclude_builder.build()?;

        let mut include_builder = GitignoreBuilder::new(root);
        for rule in pkg.manifest().include() {
            include_builder.add_line(None, rule)?;
        }
        let ignore_include = include_builder.build()?;

        let ignore_should_package = |relative_path: &Path, is_dir: bool| {
            // "Include" and "exclude" options are mutually exclusive.
            if no_include_option {
                !ignore_exclude
                    .matched_path_or_any_parents(relative_path, is_dir)
                    .is_ignore()
            } else {
                if is_dir {
                    // Generally, include directives don't list every
                    // directory (nor should they!). Just skip all directory
                    // checks, and only check files.
                    return true;
                }
                ignore_include
                    .matched_path_or_any_parents(relative_path, /* is_dir */ false)
                    .is_ignore()
            }
        };

        let filter = |path: &Path, is_dir: bool| {
            let Ok(relative_path) = path.strip_prefix(root) else {
                return false;
            };

            let rel = relative_path.as_os_str();
            if rel == "Cargo.lock" {
                return pkg.include_lockfile();
            } else if rel == "Cargo.toml" {
                return true;
            }

            ignore_should_package(relative_path, is_dir)
        };

        // Attempt Git-prepopulate only if no `include` (see rust-lang/cargo#4135).
        if no_include_option {
            if let Some(repo) = git_repo {
                return list_files_gix(pkg, &repo, &filter, gctx);
            }
        }
        let mut ret = Vec::new();
        list_files_walk(pkg.root(), &mut ret, true, &filter, gctx)?;
        Ok(ret)
    }

    /// Returns [`Some(gix::Repository)`](gix::Repository) if the discovered repository
    /// (searched upwards from `root`) contains a tracked `<root>/Cargo.toml`.
    /// Otherwise, the caller should fall back on full file list.
    fn discover_gix_repo(root: &Path) -> CargoResult<Option<gix::Repository>> {
        let repo = match gix::ThreadSafeRepository::discover(root) {
            Ok(repo) => repo.to_thread_local(),
            Err(e) => {
                tracing::debug!(
                    "could not discover git repo at or above {}: {}",
                    root.display(),
                    e
                );
                return Ok(None);
            }
        };
        let index = repo
            .index_or_empty()
            .with_context(|| format!("failed to open git index at {}", repo.path().display()))?;
        let repo_root = repo.work_dir().ok_or_else(|| {
            anyhow::format_err!(
                "did not expect repo at {} to be bare",
                repo.path().display()
            )
        })?;
        let repo_relative_path = match paths::strip_prefix_canonical(root, repo_root) {
            Ok(p) => p,
            Err(e) => {
                warn!(
                    "cannot determine if path `{:?}` is in git repo `{:?}`: {:?}",
                    root, repo_root, e
                );
                return Ok(None);
            }
        };
        let manifest_path = gix::path::join_bstr_unix_pathsep(
            gix::path::to_unix_separators_on_windows(gix::path::into_bstr(repo_relative_path)),
            "Cargo.toml",
        );
        if index.entry_index_by_path(&manifest_path).is_ok() {
            return Ok(Some(repo));
        }
        // Package Cargo.toml is not in git, don't use git to guide our selection.
        Ok(None)
    }

    /// Lists files relevant to building this package inside this source by
    /// traversing the git working tree, while avoiding ignored files.
    ///
    /// This looks into Git sub-repositories as well, resolving them to individual files.
    /// Symlinks to directories will also be resolved, but walked as repositories if they
    /// point to one to avoid picking up `.git` directories.
    fn list_files_gix(
        pkg: &Package,
        repo: &gix::Repository,
        filter: &dyn Fn(&Path, bool) -> bool,
        gctx: &GlobalContext,
    ) -> CargoResult<Vec<PathBuf>> {
        debug!("list_files_gix {}", pkg.package_id());
        let options = repo
            .dirwalk_options()?
            .emit_untracked(gix::dir::walk::EmissionMode::Matching)
            .emit_ignored(None)
            .emit_tracked(true)
            .recurse_repositories(false)
            .symlinks_to_directories_are_ignored_like_directories(true)
            .emit_empty_directories(false);
        let index = repo.index_or_empty()?;
        let root = repo
            .work_dir()
            .ok_or_else(|| anyhow::format_err!("can't list files on a bare repository"))?;
        assert!(
            root.is_absolute(),
            "BUG: paths used internally are absolute, and the repo inherits that"
        );

        let pkg_path = pkg.root();
        let repo_relative_pkg_path = pkg_path.strip_prefix(root).unwrap_or(Path::new(""));
        let target_prefix = gix::path::to_unix_separators_on_windows(gix::path::into_bstr(
            repo_relative_pkg_path.join("target/"),
        ));
        let package_prefix =
            gix::path::to_unix_separators_on_windows(gix::path::into_bstr(repo_relative_pkg_path));

        let pathspec = {
            // Include the package root.
            let mut include = BString::from(":(top)");
            include.push_str(package_prefix.as_ref());

            // Exclude the target directory.
            let mut exclude = BString::from(":!(exclude,top)");
            exclude.push_str(target_prefix.as_ref());

            vec![include, exclude]
        };

        let mut files = Vec::<PathBuf>::new();
        let mut subpackages_found = Vec::new();
        for item in repo
            .dirwalk_iter(index.clone(), pathspec, Default::default(), options)?
            .filter(|res| {
                // Don't include Cargo.lock if it is untracked. Packaging will
                // generate a new one as needed.
                res.as_ref().map_or(true, |item| {
                    !(item.entry.status == Status::Untracked && item.entry.rela_path == "Cargo.lock")
                })
            })
            .map(|res| res.map(|item| (item.entry.rela_path, item.entry.disk_kind)))
            .chain(
                // Append entries that might be tracked in `<pkg_root>/target/`.
                index
                    .prefixed_entries(target_prefix.as_ref())
                    .unwrap_or_default()
                    .iter()
                    .filter(|entry| {
                        // probably not needed as conflicts prevent this to run, but let's be explicit.
                        entry.stage() == Stage::Unconflicted
                    })
                    .map(|entry| {
                        (
                            entry.path(&index).to_owned(),
                            // Do not trust what's recorded in the index, enforce checking the disk.
                            // This traversal is not part of a `status()`, and tracking things in `target/`
                            // is rare.
                            None,
                        )
                    })
                    .map(Ok),
            )
        {
            let (rela_path, kind) = item?;
            let file_path = root.join(gix::path::from_bstr(rela_path));
            if file_path.file_name().and_then(|name| name.to_str()) == Some("Cargo.toml") {
                // Keep track of all sub-packages found and also strip out all
                // matches we've found so far. Note, though, that if we find
                // our own `Cargo.toml`, we keep going.
                let path = file_path.parent().unwrap();
                if path != pkg_path {
                    debug!("subpackage found: {}", path.display());
                    files.retain(|p| !p.starts_with(path));
                    subpackages_found.push(path.to_path_buf());
                    continue;
                }
            }

            // If this file is part of any other sub-package we've found so far,
            // skip it.
            if subpackages_found.iter().any(|p| file_path.starts_with(p)) {
                continue;
            }

            let is_dir = kind.map_or(false, |kind| {
                if kind == gix::dir::entry::Kind::Symlink {
                    // Symlinks must be checked to see if they point to a directory
                    // we should traverse.
                    file_path.is_dir()
                } else {
                    kind.is_dir()
                }
            });
            if is_dir {
                // This could be a submodule, or a sub-repository. In any case, we prefer to walk
                // it with git-support to leverage ignored files and to avoid pulling in entire
                // .git repositories.
                match gix::open(&file_path) {
                    Ok(sub_repo) => {
                        files.extend(list_files_gix(pkg, &sub_repo, filter, gctx)?);
                    }
                    Err(_) => {
                        list_files_walk(&file_path, &mut files, false, filter, gctx)?;
                    }
                }
            } else if (filter)(&file_path, is_dir) {
                assert!(!is_dir);
                trace!("  found {}", file_path.display());
                files.push(file_path);
            }
        }

        return Ok(files);
    }

    /// Lists files relevant to building this package inside this source by
    /// walking the filesystem from the package root path.
    ///
    /// This is a fallback for [`list_files_gix`] when the package
    /// is not tracked under a Git repository.
    fn list_files_walk(
        path: &Path,
        ret: &mut Vec<PathBuf>,
        is_root: bool,
        filter: &dyn Fn(&Path, bool) -> bool,
        gctx: &GlobalContext,
    ) -> CargoResult<()> {
        let walkdir = WalkDir::new(path)
            .follow_links(true)
            .into_iter()
            .filter_entry(|entry| {
                let path = entry.path();
                let at_root = is_root && entry.depth() == 0;
                let is_dir = entry.file_type().is_dir();

                if !at_root && !filter(path, is_dir) {
                    return false;
                }

                if !is_dir {
                    return true;
                }

                // Don't recurse into any sub-packages that we have.
                if !at_root && path.join("Cargo.toml").exists() {
                    return false;
                }

                // Skip root Cargo artifacts.
                if is_root
                    && entry.depth() == 1
                    && path.file_name().and_then(|s| s.to_str()) == Some("target")
                {
                    return false;
                }

                true
            });
        for entry in walkdir {
            match entry {
                Ok(entry) => {
                    if !entry.file_type().is_dir() {
                        ret.push(entry.into_path());
                    }
                }
                Err(err) if err.loop_ancestor().is_some() => {
                    gctx.shell().warn(err)?;
                }
                Err(err) => match err.path() {
                    // If an error occurs with a path, filter it again.
                    // If it is excluded, Just ignore it in this case.
                    // See issue rust-lang/cargo#10917
                    Some(path) if !filter(path, path.is_dir()) => {}
                    // Otherwise, simply recover from it.
                    // Don't worry about error skipping here, the callers would
                    // still hit the IO error if they do access it thereafter.
                    Some(path) => ret.push(path.to_path_buf()),
                    None => return Err(err.into()),
                },
            }
        }

        Ok(())
    }

    /// Gets the last modified file in a package.
    fn last_modified_file(
        path: &Path,
        pkg: &Package,
        gctx: &GlobalContext,
    ) -> CargoResult<(FileTime, PathBuf)> {
        let mut max = FileTime::zero();
        let mut max_path = PathBuf::new();
        for file in list_files(pkg, gctx).with_context(|| {
            format!(
                "failed to determine the most recently modified file in {}",
                pkg.root().display()
            )
        })? {
            // An `fs::stat` error here is either because path is a
            // broken symlink, a permissions error, or a race
            // condition where this path was `rm`-ed -- either way,
            // we can ignore the error and treat the path's `mtime`
            // as `0`.
            let mtime = paths::mtime(&file).unwrap_or_else(|_| FileTime::zero());
            if mtime > max {
                max = mtime;
                max_path = file;
            }
        }
        trace!("last modified file {}: {}", path.display(), max);
        Ok((max, max_path))
    }

    fn read_packages(
        path: &Path,
        source_id: SourceId,
        gctx: &GlobalContext,
    ) -> CargoResult<HashMap<PackageId, Vec<Package>>> {
        let mut all_packages = HashMap::new();
        let mut visited = HashSet::<PathBuf>::new();
        let mut errors = Vec::<anyhow::Error>::new();

        trace!(
            "looking for root package: {}, source_id={}",
            path.display(),
            source_id
        );

        walk(path, &mut |dir| {
            trace!("looking for child package: {}", dir.display());

            // Don't recurse into hidden/dot directories unless we're at the toplevel
            if dir != path {
                let name = dir.file_name().and_then(|s| s.to_str());
                if name.map(|s| s.starts_with('.')) == Some(true) {
                    return Ok(false);
                }

                // Don't automatically discover packages across git submodules
                if dir.join(".git").exists() {
                    return Ok(false);
                }
            }

            // Don't ever look at target directories
            if dir.file_name().and_then(|s| s.to_str()) == Some("target")
                && has_manifest(dir.parent().unwrap())
            {
                return Ok(false);
            }

            if has_manifest(dir) {
                read_nested_packages(
                    dir,
                    &mut all_packages,
                    source_id,
                    gctx,
                    &mut visited,
                    &mut errors,
                )?;
            }
            Ok(true)
        })?;

        if all_packages.is_empty() {
            match errors.pop() {
                Some(err) => Err(err),
                None => {
                    if find_project_manifest_exact(path, "cargo.toml").is_ok() {
                        Err(anyhow::format_err!(
                    "Could not find Cargo.toml in `{}`, but found cargo.toml please try to rename it to Cargo.toml",
                    path.display()
                ))
                    } else {
                        Err(anyhow::format_err!(
                            "Could not find Cargo.toml in `{}`",
                            path.display()
                        ))
                    }
                }
            }
        } else {
            Ok(all_packages)
        }
    }

    fn nested_paths(manifest: &Manifest) -> Vec<PathBuf> {
        let mut nested_paths = Vec::new();
        let normalized = manifest.normalized_toml();
        let dependencies = normalized
            .dependencies
            .iter()
            .chain(normalized.build_dependencies())
            .chain(normalized.dev_dependencies())
            .chain(
                normalized
                    .target
                    .as_ref()
                    .into_iter()
                    .flat_map(|t| t.values())
                    .flat_map(|t| {
                        t.dependencies
                            .iter()
                            .chain(t.build_dependencies())
                            .chain(t.dev_dependencies())
                    }),
            );
        for dep_table in dependencies {
            for dep in dep_table.values() {
                let cargo_util_schemas::manifest::InheritableDependency::Value(dep) = dep else {
                    continue;
                };
                let cargo_util_schemas::manifest::TomlDependency::Detailed(dep) = dep else {
                    continue;
                };
                let Some(path) = dep.path.as_ref() else {
                    continue;
                };
                nested_paths.push(PathBuf::from(path.as_str()));
            }
        }
        nested_paths
    }

    fn walk(path: &Path, callback: &mut dyn FnMut(&Path) -> CargoResult<bool>) -> CargoResult<()> {
        if !callback(path)? {
            trace!("not processing {}", path.display());
            return Ok(());
        }

        // Ignore any permission denied errors because temporary directories
        // can often have some weird permissions on them.
        let dirs = match fs::read_dir(path) {
            Ok(dirs) => dirs,
            Err(ref e) if e.kind() == io::ErrorKind::PermissionDenied => return Ok(()),
            Err(e) => {
                let cx = format!("failed to read directory `{}`", path.display());
                let e = anyhow::Error::from(e);
                return Err(e.context(cx));
            }
        };
        let mut dirs = dirs.collect::<Vec<_>>();
        dirs.sort_unstable_by_key(|d| d.as_ref().ok().map(|d| d.file_name()));
        for dir in dirs {
            let dir = dir?;
            if dir.file_type()?.is_dir() {
                walk(&dir.path(), callback)?;
            }
        }
        Ok(())
    }

    fn has_manifest(path: &Path) -> bool {
        find_project_manifest_exact(path, "Cargo.toml").is_ok()
    }

    fn read_nested_packages(
        path: &Path,
        all_packages: &mut HashMap<PackageId, Vec<Package>>,
        source_id: SourceId,
        gctx: &GlobalContext,
        visited: &mut HashSet<PathBuf>,
        errors: &mut Vec<anyhow::Error>,
    ) -> CargoResult<()> {
        if !visited.insert(path.to_path_buf()) {
            return Ok(());
        }

        let manifest_path = find_project_manifest_exact(path, "Cargo.toml")?;

        let manifest = match read_manifest(&manifest_path, source_id, gctx) {
            Err(err) => {
                // Ignore malformed manifests found on git repositories
                //
                // git source try to find and read all manifests from the repository
                // but since it's not possible to exclude folders from this search
                // it's safer to ignore malformed manifests to avoid
                //
                // TODO: Add a way to exclude folders?
                info!(
                    "skipping malformed package found at `{}`",
                    path.to_string_lossy()
                );
                errors.push(err.into());
                return Ok(());
            }
            Ok(tuple) => tuple,
        };

        let manifest = match manifest {
            EitherManifest::Real(manifest) => manifest,
            EitherManifest::Virtual(..) => return Ok(()),
        };
        let nested = nested_paths(&manifest);
        let pkg = Package::new(manifest, &manifest_path);

        let pkg_id = pkg.package_id();
        all_packages.entry(pkg_id).or_default().push(pkg);

        // Registry sources are not allowed to have `path=` dependencies because
        // they're all translated to actual registry dependencies.
        //
        // We normalize the path here ensure that we don't infinitely walk around
        // looking for crates. By normalizing we ensure that we visit this crate at
        // most once.
        //
        // TODO: filesystem/symlink implications?
        if !source_id.is_registry() {
            for p in nested.iter() {
                let path = paths::normalize_path(&path.join(p));
                let result =
                    read_nested_packages(&path, all_packages, source_id, gctx, visited, errors);
                // Ignore broken manifests found on git repositories.
                //
                // A well formed manifest might still fail to load due to reasons
                // like referring to a "path" that requires an extra build step.
                //
                // See https://github.com/rust-lang/cargo/issues/6822.
                if let Err(err) = result {
                    if source_id.is_git() {
                        info!(
                            "skipping nested package found at `{}`: {:?}",
                            path.display(),
                            &err,
                        );
                        errors.push(err);
                    } else {
                        return Err(err);
                    }
                }
            }
        }

        Ok(())
    }