T0b1/wasmtime
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[meta] Rejigger comments in cdsl/formats;

Browse Source
This commit is contained in:
Benjamin Bouvier
2019-04-12 18:28:47 +02:00
parent faa9b25691
commit d2d2cdcd78
1 changed files with 20 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
cranelift/codegen/meta/src/cdsl/formats.rs
View File

@@ -10,10 +10,6 @@ use cranelift_entity::{entity_impl, PrimaryMap};
/// ///
/// This corresponds to a single member of a variant of the `InstructionData` /// This corresponds to a single member of a variant of the `InstructionData`
/// data type. /// data type.
///
/// :param iform: Parent `InstructionFormat`.
/// :param kind: Immediate Operand kind.
/// :param member: Member name in `InstructionData` variant.
#[derive(Debug)] #[derive(Debug)]
pub struct FormatField { pub struct FormatField {
/// Immediate operand number in parent. /// Immediate operand number in parent.
@@ -22,39 +18,36 @@ pub struct FormatField {
/// Immediate operand kind. /// Immediate operand kind.
pub kind: OperandKind, pub kind: OperandKind,
/// Member name in InstructionDate variant. /// Member name in InstructionData variant.
pub member: &'static str, pub member: &'static str,
} }
/// Every instruction opcode has a corresponding instruction format which /// Every instruction opcode has a corresponding instruction format which determines the number of
/// determines the number of operands and their kinds. Instruction formats are /// operands and their kinds. Instruction formats are identified structurally, i.e., the format of
/// identified structurally, i.e., the format of an instruction is derived from /// an instruction is derived from the kinds of operands used in its declaration.
/// the kinds of operands used in its declaration.
/// ///
/// The instruction format stores two separate lists of operands: Immediates /// The instruction format stores two separate lists of operands: Immediates and values. Immediate
/// and values. Immediate operands (including entity references) are /// operands (including entity references) are represented as explicit members in the
/// represented as explicit members in the `InstructionData` variants. The /// `InstructionData` variants. The value operands are stored differently, depending on how many
/// value operands are stored differently, depending on how many there are. /// there are. Beyond a certain point, instruction formats switch to an external value list for
/// Beyond a certain point, instruction formats switch to an external value /// storing value arguments. Value lists can hold an arbitrary number of values.
/// list for storing value arguments. Value lists can hold an arbitrary number
/// of values.
/// ///
/// All instruction formats must be predefined in the meta shared/formats module. /// All instruction formats must be predefined in the meta shared/formats.rs module.
///
/// :param kinds: List of `OperandKind` objects describing the operands.
/// :param name: Instruction format name in CamelCase. This is used as a Rust
/// variant name in both the `InstructionData` and `InstructionFormat`
/// enums.
/// :param typevar_operand: Index of the value input operand that is used to
/// infer the controlling type variable. By default, this is `0`, the first
/// `value` operand. The index is relative to the values only, ignoring
/// immediate operands.
#[derive(Debug)] #[derive(Debug)]
pub struct InstructionFormat { pub struct InstructionFormat {
/// Instruction format name in CamelCase. This is used as a Rust variant name in both the
/// `InstructionData` and `InstructionFormat` enums.
pub name: &'static str, pub name: &'static str,
pub num_value_operands: usize, pub num_value_operands: usize,
pub has_value_list: bool, pub has_value_list: bool,
pub imm_fields: Vec<FormatField>, pub imm_fields: Vec<FormatField>,
/// Index of the value input operand that is used to infer the controlling type variable. By
/// default, this is `0`, the first `value` operand. The index is relative to the values only,
/// ignoring immediate operands.
pub typevar_operand: Option<usize>, pub typevar_operand: Option<usize>,
} }
@@ -162,7 +155,7 @@ impl InstructionFormatBuilder {
} }
} }
#[derive(Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)] #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct InstructionFormatIndex(u32); pub struct InstructionFormatIndex(u32);
entity_impl!(InstructionFormatIndex); entity_impl!(InstructionFormatIndex);