m2isar.transforms.encode_instructions.planner ============================================= .. py:module:: m2isar.transforms.encode_instructions.planner .. autoapi-nested-parse:: Deterministic, non-mutating planning for 32-bit custom instruction encodings. The prototype conservatively allocates one namespace across all model containers. It never widens logical operands or infers operand attributes from their names. Exceptions ---------- .. autoapisummary:: m2isar.transforms.encode_instructions.planner.EncodingError Classes ------- .. autoapisummary:: m2isar.transforms.encode_instructions.planner.EncodingPolicy m2isar.transforms.encode_instructions.planner.Field m2isar.transforms.encode_instructions.planner.Assignment m2isar.transforms.encode_instructions.planner.EncodingPlan Functions --------- .. autoapisummary:: m2isar.transforms.encode_instructions.planner.validate_pattern m2isar.transforms.encode_instructions.planner.overlaps m2isar.transforms.encode_instructions.planner.operand_requirements m2isar.transforms.encode_instructions.planner.candidates m2isar.transforms.encode_instructions.planner.available_codes m2isar.transforms.encode_instructions.planner.plan_encodings m2isar.transforms.encode_instructions.planner.apply_encoding_plan m2isar.transforms.encode_instructions.planner.model_instructions m2isar.transforms.encode_instructions.planner.plan_model m2isar.transforms.encode_instructions.planner.apply_model_plan Module Contents --------------- .. py:exception:: EncodingError Bases: :py:obj:`ValueError` An encoding request cannot be satisfied without changing its contract. .. py:class:: EncodingPolicy .. py:attribute:: opcodes :type: Tuple[int, ...] :value: (11, 43, 91, 123) .. py:attribute:: reservations :type: Tuple[Tuple[int, int], ...] :value: () .. py:attribute:: fixed_bits :type: Tuple[Tuple[str, int, int], ...] :value: () .. py:attribute:: decode_mask :type: int :value: 4294967295 .. py:method:: __post_init__() .. py:function:: validate_pattern(code, mask) .. py:function:: overlaps(a, b) .. py:class:: Field .. py:attribute:: name :type: str .. py:attribute:: offset :type: int .. py:attribute:: width :type: int .. py:attribute:: signed :type: bool .. py:attribute:: source_lower :type: int :value: 0 .. py:class:: Assignment .. py:attribute:: name :type: str .. py:attribute:: layout :type: str .. py:attribute:: code :type: int .. py:attribute:: mask :type: int .. py:attribute:: fields :type: Tuple[Field, ...] .. py:method:: encoding() Emit metamodel fields without changing operand descriptors or behavior. .. py:method:: to_dict() .. py:class:: EncodingPlan .. py:attribute:: assignments :type: Tuple[Assignment, ...] .. py:attribute:: errors :type: Tuple[str, ...] :value: () .. py:method:: raise_for_errors() .. py:method:: explain() .. py:method:: to_dict() .. py:function:: operand_requirements(instruction) .. py:function:: candidates(instruction) .. py:function:: available_codes(mask, opcodes, occupied, required=(0, 0)) Search discriminator bits, pruning subtrees covered by a reservation. .. py:function:: plan_encodings(instructions, policy=None, existing=(), assignments=None) Plan an iterable of unencoded instructions. Optional manifest pins assignments. Names must be unique. Existing encodings are (code, mask) pairs in this domain. Errors are collected and prevent application of the entire plan. .. py:function:: apply_encoding_plan(instructions, plan, copy=True) Return encoded copies by default; validate everything before in-place updates. .. py:function:: model_instructions(model) Collect shared instructions once, giving them stable qualified names. .. py:function:: plan_model(model, policy=None, assignments=None) .. py:function:: apply_model_plan(model, plan) Apply to a complete model copy, preserving aliases and updating containers.