Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sveinbjornt/searchfs

Command line tool to quickly search by filename on entire APFS and HFS+ volumes using the file system catalog.
https://github.com/sveinbjornt/searchfs

apfs apfs-volumes catalog-search command-line-tool hfs hfs-filesystem macos macosx search searchfs volume

Last synced: 13 days ago
JSON representation

Command line tool to quickly search by filename on entire APFS and HFS+ volumes using the file system catalog.

Host: GitHub
URL: https://github.com/sveinbjornt/searchfs
Owner: sveinbjornt
License: bsd-3-clause
Created: 2018-06-05T11:18:28.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2022-08-17T13:33:44.000Z (about 2 years ago)
Last Synced: 2024-10-25T05:53:36.706Z (21 days ago)
Topics: apfs, apfs-volumes, catalog-search, command-line-tool, hfs, hfs-filesystem, macos, macosx, search, searchfs, volume
Language: Objective-C
Homepage: https://sveinbjorn.org/searchfs
Size: 106 KB
Stars: 111
Watchers: 11
Forks: 8
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.txt
- Funding: .github/FUNDING.yml
- License: LICENSE.txt

Awesome Lists containing this project

README

[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![Language](https://img.shields.io/badge/language-objective--c-lightgrey)]()
[![Build](https://github.com/sveinbjornt/searchfs/actions/workflows/macos.yml/badge.svg)]()

# searchfs

searchfs icon

`searchfs` is a macOS command line tool to quickly search by filename on entire APFS and HFS+ volumes. Searching takes place at the driver level using the file system catalog. This means the volume's directory tree can be scanned much faster than with a standard recursive filename search using `find`.

Search is case-insensitive by default. Matching files are printed to standard output in the order they are found in the catalog. See the [man page](https://sveinbjorn.org/files/manpages/searchfs.1.html) for details.

[KatSearch](https://github.com/sveinbjornt/KatSearch) is a native graphical macOS application built on top of `searchfs`.

## Download

* [⇩ Download latest searchfs binary](https://sveinbjorn.org/files/software/searchfs.zip) (v0.3, <20 KB, Intel 64-bit, macOS 10.7 or later)
* [searchfs man page](https://sveinbjorn.org/files/manpages/searchfs.1.html) (HTML)

## Build & Install

* `git clone https://github.com/sveinbjornt/searchfs.git`
* `cd searchfs`
* `make`
* `make install`

Installs binary into `/usr/local/bin/`. Man page goes into `/usr/local/share/man/man1/`.

## Performance

According to my benchmarks, `searchfs` runs about 35-50% faster than `find` on APFS filesystems and many times faster on HFS+.

The following are benchmark results on a 2012 Retina MacBook Pro with an Apple-supplied 512 GB SSD running an APFS file system containing about 2 million files:

### searchfs
```shell
$ time searchfs "something"
0,01s user 33,15s system 32% cpu 1:23,59 total
```
### find
```shell
$ time find / -name "*something*"
9,53s user 67,64s system 49% cpu 2:37,39 total
```

Although I have yet to test this properly, `searchfs` is probably *much* faster than `find` on hard disk drives, which have higher seek times. It is also very fast indeed on file systems with a small number of files.

## History

Apple added file system catalog search to Mac OS with the introduction of the Hiearchical File System (HFS) back in 1985. HFS replaced the previous flat table structure in the old MFS file system with a catalog file using a B-tree structure. Unlike Windows' FAT file system, HFS (and later, HFS+) thus arranged the entire directory tree into one large file on the disk, with interlinked nodes that did not match the hierarchical folder structure. This meant that volumes could be searched very quickly regardless of size.

The Classic Mac OS exposed this functionality via the FSCatalogSearch() function, which iterated efficiently over the nodes, thus minimizing disk seek times. In the pre-SSD era, this gave the Mac a significant performance advantage over Windows when it came to full-volume search. For a long time, FSCatalogSearch continued to be available in Mac OS X / macOS via the Carbon APIs but it has now been deprecated and does not support APFS, Apple's new file system.

However, catalog search for both HFS+ and APFS is available in Darwin's low-level system libraries via the [searchfs()](https://www.unix.com/man-page/osx/2/searchfs/) function. The `searchfs` program makes use of this function.

## TODO

* Add support for macOS 10.15 Catalina
* The searchfs API supports searching the catalog for files based on size, owner, group, creation, modification or access date, finder flags, deprecated old-school file and creator types, and so on. Add that.

## Version History

### 11/05/2019 - **0.3**

* New -l flag lists all mounted volumes that support catalog search.
* Volume to search can now be specified via device name as well as mount path.
* Regex modifiers ^ and $ can now be used to match only at the start or end of a filenames.

### 26/04/2019 - **0.2**

* Fixed issue which prevented searchfs from working on older versions of macOS.
* Now fails silently when path lookup fails for a file system object ID.
* Now runs on macOS 10.7 or later.

### 14/07/2018 - **0.1**

* Initial release

## BSD License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.