Merge remote-tracking branch 'upstream/master'

Author: trha

.travis.yml

@@ -8,36 +8,34 @@ license = "BSD-2-Clause"
 name = "detour"
 readme = "README.md"
 repository = "https://github.com/darfink/detour-rs"
-version = "0.5.0"
+version = "0.8.0"
+edition = "2018"
 
 [badges]
-
-[badges.appveyor]
-repository = "darfink/detour-rs"
-
-[badges.travis-ci]
-repository = "darfink/detour-rs"
+azure-devops = { project = "darfink/detour-rs", pipeline = "darfink.detour-rs" }
 
 [dependencies]
-boolinator = "2.4.0"
-cfg-if = "0.1.1"
-failure = "0.1.1"
-generic-array = "0.10"
-lazy_static = "1.0"
-libc = "0.2"
-matches = "0.1.6"
-mmap-fixed = "0.1"
-region = "0.3"
-slice-pool = "0.3.4"
-tap = "0.2.1"
+cfg-if = "1.0.0"
+generic-array = "0.14.1"
+lazy_static = "1.2"
+libc = "0.2.45"
+mmap = { package = "mmap-fixed", version = "0.1.0" }
+region = "2.0.0"
+slice-pool = "0.4.1"
+
+[dev-dependencies]
+matches = "0.1.8"
 
 [features]
 default = ["nightly"]
 nightly = []
 
-[target]
-
-[target."cfg(any(target_arch = \"x86\", target_arch = \"x86_64\"))"]
+[[example]]
+name = "messageboxw_detour"
+crate-type = ["cdylib"]
 
 [target."cfg(any(target_arch = \"x86\", target_arch = \"x86_64\"))".dependencies]
-libudis86-sys = "0.2.0"
+udis = { package = "libudis86-sys", version = "0.2.1" }
+
+[target."cfg(windows)".dev-dependencies]
+winapi = { version = "0.3.7", features = ["minwindef", "windef", "winnt", "libloaderapi"] }

Cargo.toml

@@ -1,11 +1,14 @@
-detour-rs
-=========
-[![Travis build status][travis-shield]][travis]
-[![Appveyor build status][appveyor-shield]][appveyor]
+<div align="center">
+
+# `detour-rs`
+
+[![Azure build Status][azure-shield]][azure]
 [![crates.io version][crate-shield]][crate]
 [![Documentation][docs-shield]][docs]
 [![Language (Rust)][rust-shield]][rust]
 
+</div>
+
 This is a cross-platform detour library developed in Rust. Beyond the basic
 functionality, this library handles branch redirects, RIP-relative
 instructions, hot-patching, NOP-padded functions, and allows the original
@@ -16,68 +19,87 @@ maintain this feature, not all desired functionality can be supported due to
 lack of cross-platform APIs. Therefore [EIP relocation](#appendix) is not
 supported.
 
-**NOTE**: Nightly is currently required for `static_detours!`.
+**NOTE**: Nightly is currently required for `static_detour!` and is enabled by
+default.
 
 ## Platforms
 
-- `x86/x64`: Windows, Linux & macOS.
-- `ARM`: Not implemented, but foundation exists.
+This library provides CI for these targets:
+
+- Linux
+  * `i686-unknown-linux-gnu`
+  * `x86_64-unknown-linux-gnu`
+  * `x86_64-unknown-linux-musl`
+- Windows
+  * `i686-pc-windows-gnu`
+  * `i686-pc-windows-msvc`
+  * `x86_64-pc-windows-gnu`
+  * `x86_64-pc-windows-msvc`
+- macOS
+  * ~~`i686-apple-darwin`~~
+  * `x86_64-apple-darwin`
 
 ## Installation
 
 Add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-detour = "0.5.0"
-```
-
-... and this to your crate root:
-
-```rust
-#[macro_use]
-extern crate detour;
+detour = "0.8.0"
 ```
 
 ## Example
 
 - A static detour (one of *three* different detours):
 
 ```rust
-#[macro_use] extern crate detour;
+use std::error::Error;
+use detour::static_detour;
 
-extern "C" fn add(x: i32, y: i32) -> i32 {
-    x + y
+static_detour! {
+  static Test: /* extern "X" */ fn(i32) -> i32;
 }
 
-static_detours! {
-    struct DetourAdd: extern "C" fn(i32, i32) -> i32;
+fn add5(val: i32) -> i32 {
+  val + 5
 }
 
-fn main() {
-    // Replaces the 'add' function with a closure that subtracts
-    let mut hook = unsafe { DetourAdd.initialize(add, |x, y| x - y).unwrap() };
+fn add10(val: i32) -> i32 {
+  val + 10
+}
+
+fn main() -> Result<(), Box<dyn Error>> {
+  // Reroute the 'add5' function to 'add10' (can also be a closure)
+  unsafe { Test.initialize(add5, add10)? };
+
+  assert_eq!(add5(1), 6);
+  assert_eq!(Test.call(1), 6);
 
-    assert_eq!(add(1, 5), 6);
-    assert_eq!(hook.is_enabled(), false);
+  // Hooks must be enabled to take effect
+  unsafe { Test.enable()? };
 
-    unsafe { hook.enable().unwrap(); }
+  // The original function is detoured to 'add10'
+  assert_eq!(add5(1), 11);
 
-    assert_eq!(add(1, 5), -4);
-    assert_eq!(hook.call(1, 5), 6);
+  // The original function can still be invoked using 'call'
+  assert_eq!(Test.call(1), 6);
 
-    // Change the detour whilst hooked
-    hook.set_detour(|x, y| x * y);
-    assert_eq!(add(5, 5), 25);
+  // It is also possible to change the detour whilst hooked
+  Test.set_detour(|val| val - 5);
+  assert_eq!(add5(5), 0);
 
-    unsafe { hook.disable().unwrap(); }
+  unsafe { Test.disable()? };
 
-    assert_eq!(hook.is_enabled(), false);
-    assert_eq!(hook.call(1, 5), 6);
-    assert_eq!(add(1, 5), 6);
+  assert_eq!(add5(1), 6);
+  Ok(())
 }
 ```
 
+- A Windows API hooking example is available [here](./examples/messageboxw_detour.rs); build it by running:
+```
+$ cargo build --example messageboxw_detour
+```
+
 ## Mentions
 
 Part of the library's external user interface was inspired by
@@ -90,7 +112,7 @@ derivative code of his work.
 
   *Should be performed whenever a function's prolog instructions
   are being executed, simultaneously as the function itself is being
-  detoured. This is done by halting all affected threads, copying the related
+  detoured. This is done by halting all affected threads, copying the affected
   instructions and appending a `JMP` to return to the function. This is
   barely ever an issue, and never in single-threaded environments, but YMMV.*
 
@@ -109,10 +131,8 @@ derivative code of his work.
   trailing `NOP` instructions will be replaced, to make room for the detour.*
 
 <!-- Links -->
-[travis-shield]: https://img.shields.io/travis/darfink/detour-rs.svg?style=flat-square&label=travis
-[travis]: https://travis-ci.org/darfink/detour-rs
-[appveyor-shield]: https://img.shields.io/appveyor/ci/darfink/detour-rs/master.svg?style=flat-square&label=appveyor
-[appveyor]: https://ci.appveyor.com/project/darfink/detour-rs
+[azure-shield]: https://img.shields.io/azure-devops/build/darfink/detour-rs/2/master?label=Azure%20Pipelines&logo=azure-pipelines&style=flat-square
+[azure]: https://dev.azure.com/darfink/detour-rs/_build/latest?definitionId=1&branchName=master
 [crate-shield]: https://img.shields.io/crates/v/detour.svg?style=flat-square
 [crate]: https://crates.io/crates/detour
 [rust-shield]: https://img.shields.io/badge/powered%20by-rust-blue.svg?style=flat-square

README.md

@@ -0,0 +1,34 @@
+stages:
+  - stage: test
+    displayName: Test
+    jobs:
+    - template: ci/cargo-job-per-channel-target.yml
+      parameters:
+        channels: [nightly]
+        targets:
+          - target: 'i686-pc-windows-msvc'
+          - target: 'i686-pc-windows-msvc'
+            channels: [stable]
+            cargoSteps:
+            - bash: $CARGO test --target $TARGET --no-default-features
+              displayName: Cargo test
+          - target: 'x86_64-pc-windows-msvc'
+          # - target: 'i686-pc-windows-gnu'
+          - target: 'x86_64-pc-windows-gnu'
+          # - target: 'i686-apple-darwin'
+          - target: 'x86_64-apple-darwin'
+            preSteps:
+            - script: cp ./ci/macos/* ~/.cargo
+              displayName: Configure custom linker
+          - target: 'i686-unknown-linux-gnu'
+            preSteps:
+            - script: sudo apt-get update && sudo apt-get install gcc-multilib
+              displayName: Install GCC 32-bit libs
+          - target: 'x86_64-unknown-linux-gnu'
+          - target: 'x86_64-unknown-linux-gnu'
+            channels: [stable]
+            cargoSteps:
+            - bash: $CARGO test --target $TARGET --no-default-features
+              displayName: Cargo test
+          # - target: 'x86_64-unknown-linux-musl'
+          #   cross: true

appveyor.yml

@@ -0,0 +1,25 @@
+# This template creates one job per channel-target.
+parameters:
+  # The default rust channels to use ('stable', 'beta' and/or 'nightly').
+  # This can also be overriden for each target.
+  channels: [stable]
+  # The target triples to use (e.g 'i686-apple-darwin')
+  targets: []
+
+jobs:
+- ${{ each target in parameters.targets }}:
+  - ${{ if target.channels }}:
+    - ${{ each channel in target.channels }}:
+      - template: cargo-job.yml
+        parameters:
+          identifier: ${{ format('rust_{0}_{1}', channel, replace(target.target, '-', '_')) }}
+          channel: ${{ channel }}
+          ${{ insert }}: ${{ target }}
+
+  - ${{ if not(target.channels) }}:
+    - ${{ each channel in parameters.channels }}:
+      - template: cargo-job.yml
+        parameters:
+          identifier: ${{ format('rust_{0}_{1}', channel, replace(target.target, '-', '_')) }}
+          channel: ${{ channel }}
+          ${{ insert }}: ${{ target }}