cranelift_assembler_x64/
lib.rs

1//! A Cranelift-specific x64 assembler.
2//!
3//! All instructions known to this assembler are listed in the [`inst`] module.
4//! The [`Inst`] enumeration contains a variant for each, allowing matching over
5//! all these instructions. All of this is parameterized by a [`Registers`]
6//! trait, allowing users of this assembler to plug in their own register types.
7//!
8//! ```
9//! # use cranelift_assembler_x64::{Fixed, Imm8, inst, Inst, Registers};
10//! // Tell the assembler the type of registers we're using; we can always
11//! // encode a HW register as a `u8` (e.g., `eax = 0`).
12//! pub struct Regs;
13//! impl Registers for Regs {
14//!     type ReadGpr = u8;
15//!     type ReadWriteGpr = u8;
16//!     type WriteGpr = u8;
17//!     type ReadXmm = u8;
18//!     type ReadWriteXmm = u8;
19//!     type WriteXmm = u8;
20//! }
21//!
22//! // Then, build one of the `AND` instructions; this one operates on an
23//! // implicit `AL` register with an immediate. We can collect a sequence of
24//! // instructions by converting to the `Inst` type.
25//! let rax: u8 = 0;
26//! let and = inst::andb_i::new(Fixed(rax), Imm8::new(0b10101010));
27//! let seq: Vec<Inst<Regs>> = vec![and.into()];
28//!
29//! // Now we can encode this sequence into a code buffer.
30//! let mut buffer = vec![];
31//! for inst in seq {
32//!     inst.encode(&mut buffer);
33//! }
34//! assert_eq!(buffer, vec![0x24, 0b10101010]);
35//! ```
36//!
37//! With an [`Inst`], we can encode the instruction into a code buffer; see the
38//! [example](Inst).
39
40#![allow(
41    non_camel_case_types,
42    reason = "all of the generated struct names use snake case"
43)]
44
45mod api;
46mod custom;
47mod evex;
48mod features;
49mod fixed;
50pub mod gpr;
51mod imm;
52pub mod inst;
53mod mem;
54mod rex;
55mod vex;
56pub mod xmm;
57
58#[cfg(any(test, feature = "fuzz"))]
59pub mod fuzz;
60
61/// An assembly instruction; contains all instructions known to the assembler.
62///
63/// This wraps all [`inst`] structures into a single enumeration for collecting
64/// instructions.
65#[doc(inline)]
66// This re-exports, and documents, a module that is more convenient to use at
67// the library top-level.
68pub use inst::Inst;
69
70pub use api::{
71    AsReg, CodeSink, Constant, KnownOffset, Label, RegisterVisitor, Registers, TrapCode,
72};
73pub use features::{AvailableFeatures, Feature, Features};
74pub use fixed::Fixed;
75pub use gpr::{Gpr, NonRspGpr, Size};
76pub use imm::{Extension, Imm8, Imm16, Imm32, Imm64, Simm8, Simm16, Simm32};
77pub use mem::{
78    Amode, AmodeOffset, AmodeOffsetPlusKnownOffset, DeferredTarget, GprMem, Scale, XmmMem,
79};
80pub use rex::RexPrefix;
81pub use xmm::Xmm;
cranelift_assembler_x64/lib.rs

cranelift_assembler_x64/
lib.rs
