mach2 - GitLite

KO | EN

gitlite — search

#javascript #python #machine-learning #deep-learning #linux #macos #nodejs #windows #cli #kubernetes #vue #security #openai #open-source

mach2

(★ 50)

No description available.

File Explorer

Download Latest Version (.zip)

- - ci.yml
  - publish.yml
  - zizmor.yml
- build_fail.sh
- deploy_and_run_on_ios_simulator.rs
- run.sh
- dump_process_registers.rs
- - main.rs
- build.rs
- Cargo.toml
- - ipc_info.rs
  - mod.rs
  - zone_info.rs
- boolean.rs
- bootstrap.rs
- clock.rs
- clock_priv.rs
- clock_reply.rs
- clock_types.rs
- dyld.rs
- dyld_kernel.rs
- error.rs
- exc.rs
- exception_types.rs
- kern_return.rs
- lib.rs
- loader.rs
- mach_init.rs
- mach_port.rs
- mach_time.rs
- mach_types.rs
- mach_voucher_types.rs
- memory_object_types.rs
- message.rs
- mig.rs
- ndr.rs
- notify.rs
- policy.rs
- port.rs
- semaphore.rs
- structs.rs
- sync_policy.rs
- task.rs
- task_info.rs
- task_inspect.rs
- task_special_ports.rs
- thread_act.rs
- thread_policy.rs
- thread_special_ports.rs
- thread_state.rs
- thread_status.rs
- thread_switch.rs
- time_value.rs
- traps.rs
- vm.rs
- vm_attributes.rs
- vm_behavior.rs
- vm_inherit.rs
- vm_page_size.rs
- vm_prot.rs
- vm_purgable.rs
- vm_region.rs
- vm_statistics.rs
- vm_sync.rs
- vm_types.rs
.gitignore
Cargo.lock
Cargo.toml
LICENSE-APACHE
LICENSE-BSD
LICENSE-MIT
README.md
renovate.json

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# mach2

[![Latest Version]][crates.io] [![docs]][docs.rs]

A Rust interface to the **user-space** API of the Mach 3.0 kernel exposed in
`/usr/include/mach` that underlies macOS and is linked via `libSystem` (and
`libsystem_kernel`).

This library does not expose the **kernel-space** API of the Mach 3.0 kernel
exposed in
`SDK/System/Library/Frameworks/Kernel.framework/Versions/A/Headers/mach`.

That is, if you are writing a kernel-resident device drivers or some other
kernel extensions you have to use something else. The user-space kernel API is
often API-incompatible with the kernel space one, and even in the cases where
they match, they are sometimes ABI incompatible such that using this library
would have **undefined behavior**.

## Usage

Add the following to your `Cargo.toml` to conditionally include mach on those
platforms that support it.

```toml
[target.'cfg(target_vendor = "apple")'.dependencies.mach]
version = "0.6"
```

Available crate feature:

* **unstable** (disabled by default): Exposes newly changed APIs. Enabling this may
  bring breaking changes (see the breaking change policy).

### Breaking change policy

We do the following steps when an item is changed/removed on latest toolchain:

1. Deprecate an existing one
2. Declare a new one under the `unstable` feature
3. After a month or more since releasing a new version that contains that change,
  remove/change an older one

For instance, if const `FOO` value is changed from `3` to `4`,
we expose the newer one, i.e. `4`, under `unstable` first.
So the `unstable` users should notice the change on the first release since deprecating.
After a month or more, all the users should notice it.

## Examples

Examples can be found in the [examples](./examples) directory of this repository.

Since [`examples/dump_process_registers.rs`](./examples/dump_process_registers.rs) makes use of the `task_for_pid()` function, which requires elevated privileges, it is necessary to disable System Integrity Protection (SIP) and to be part of the `admin` or `_developer` group in order to run the example. However, do note that disabling SIP is in no way encouraged, and should only be done for development/debugging purposes.

1. Reboot macOS in recovery mode.
2. Click on `Options`.
3. Log in to your user.
4. In the menu click on `Utilities` and then `Terminal`.
5. In the terminal type the following command to disable SIP: `csrutil disable` (`csrutil enable` to re-enable SIP).
6. Reboot your machine.

To run the example, build it as follows:

```
cargo b --example dump_process_registers
```

Then run it using `sudo`:

```
sudo ./target/debug/examples/dump_process_registers
```

## Platform support

The following table describes the current CI set-up:

| Target                  | XCode  | build | ctest | run |
|-------------------------|--------|-------|-------|-----|
| `x86_64-apple-darwin`   | 26.1.0 | ✓     | ✓     | ✓   |
| `aarch64-apple-darwin`  | 26.1.0 | ✓     | ✓     | ✓   |
| `aarch64-apple-ios`     | 26.1.0 | ✓     | -     | -   |
| `aarch64-apple-ios-sim` | 26.1.0 | ✓     | -     | -   |
| `x86_64-apple-ios`      | 26.1.0 | ✓     | -     | -   |

## License

This project is licensed under either of

* A 2-clause BSD License ([LICENSE-BSD](LICENSE-BSD)), or
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
  http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
  http://opensource.org/licenses/MIT)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in `mach` by you, as defined in the Apache-2.0 license, shall be
triple licensed as above, without any additional terms or conditions.

To locally test the library, run:

```
TARGET=x86_64-apple-darwin RUST_VERSION=nightly ./ci/run.sh
```

where you can replace the `TARGET` and `RUST_VERSION` with the target you
want to test (e.g. `aarch64-apple-darwin`) and the Rust version you want to use for
the tests (e.g. `stable`, `1.33.0`, etc.).

[crates.io]: https://crates.io/crates/mach2
[Latest Version]: https://img.shields.io/crates/v/mach2.svg
[docs]: https://docs.rs/mach2/badge.svg
[docs.rs]: https://docs.rs/mach2