blob: e659594addcf594ebf8e2573ba45f6945c8842c5 [file] [log] [blame]
<!-- Copyright (c) 2010-2025 Arm Limited or its affiliates. All rights reserved. -->
<!-- This document is Non-confidential and licensed under the BSD 3-clause license. -->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<!--FAVICON.ico-->
<meta name="msapplication-TileColor" content="#2b5797">
<meta name="msapplication-TileImage" content="../img/mstile-144x144.png">
<link rel="icon" href="../img/favicon.ico">
<title>Instruction.InstructionGroup - ARM Machine Readable Schema - 2.7.1</title>
<!--CSS-->
<link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../css/schema.css">
<link rel="stylesheet" type="text/css" href="../css/hljs-github.css">
</head>
<body>
<div class="container">
<div class="row heading">
<div class="col-md-6 pull-left"><a href="../index.html"><img src="../img/arm.svg" class="logo" /></a></div>
<div class="col-md-6 pull-left"><h1>AARCHMRS Schema <small>2.7.1</small></h1></div>
<!--Show the home button-->
<a href="../index.html"><div class="back-to-home">&nlarr; Home</div></a>
</div>
</div>
<div class="container">
<div class="row">
<h2>
<span class="title-namespace">Instruction.</span><span class=" title-type">InstructionGroup</span>
<!-- if oneOf is set, then type is ignored -->
<span class="type">object</span>
</h2>
<div class="static-markdown"><p>An <a class="schema_link" href="../Instruction/InstructionGroup_schema.html" title="Instruction.InstructionGroup">InstructionGroup</a> object is a subset of its parent encoding space.
<a class="schema_link" href="../Instruction/InstructionGroup_schema.html" title="Instruction.InstructionGroup">InstructionGroup</a> is used mainly for grouping similar instructions together
and allowing all instructions in a group to be conditional on the same feature.</p>
<p>The example below shows both of these uses of <a class="schema_link" href="../Instruction/InstructionGroup_schema.html" title="Instruction.InstructionGroup">InstructionGroup</a>. Note that
instances of <a class="schema_link" href="../Instruction/InstructionGroup_schema.html" title="Instruction.InstructionGroup">InstructionGroup</a> may be nested to arbitrary depth, provided that
the encoding space of the parent can be subdivided.</p></div>
</div>
<div class="row">
<div>
<!-- A simple object -->
<h3 class="type">object</h3>
<table class="table table-hover properties">
<thead>
<tr>
<th class="col-md-4">Properties</th>
<th class="col-md-4">Type</th>
<th class="col-md-4">Description</th>
</tr>
</thead>
<tbody>
<!-- properties -->
<tr id="/properties/_meta" class="property">
<th class="col-md-4">
<a href="#/properties/_meta">_meta</a>
</th>
<td class="col-md-4">
<a href="../Meta_schema.html" class="schema_link">Meta</a>
</td>
<td class="col-md-4">
<div><p>Metadata</p></div>
<div>
See
<a href="../Meta_schema.html" class="schema_link">Meta</a>
for more information.
</div>
</td>
</tr>
<tr id="/properties/_type" class="property">
<th class="col-md-4">
<a href="#/properties/_type">_type</a>
</th>
<td class="col-md-4">
</td>
<td class="col-md-4">
<dl>
<dt>Enum</dt>
<dd>
<code>Instruction.InstructionGroup</code>
</dd>
</dl>
</td>
</tr>
<tr id="/properties/children" class="property">
<th class="col-md-4">
<a href="#/properties/children">children</a>
</th>
<td class="col-md-4">
<div><span class="type">array</span> [</div>
<div class="items-oneOf">
<a href="" class="schema_link">#</a>
</div>
<div class="items-oneOf">
<a href="Instruction_schema.html" class="schema_link">Instruction</a>
</div>
<div>]</div>
</td>
<td class="col-md-4">
<div><p>Defines children nodes.</p>
<p>Any child node with a unique <code>name</code> that inherits its parent's <code>operation_id</code>,
unless it redefines the <code>operation_id</code>, in which case it overwrites
the behavior that is defined by the <code>operation_id</code> of this <a class="schema_link" href="../Instruction/InstructionGroup_schema.html" title="Instruction.InstructionGroup">InstructionGroup</a>.</p></div>
</td>
</tr>
<tr id="/properties/condition" class="property">
<th class="col-md-4">
<a href="#/properties/condition">condition</a>
</th>
<td class="col-md-4">
<a href="../Traits/HasCondition_schema.html#/definitions/condition" class="schema_link">Traits.HasCondition</a>
</td>
<td class="col-md-4">
<div>
See
<a href="../Traits/HasCondition_schema.html#/definitions/condition" class="schema_link">definitions.condition</a> in
<a href="../Traits/HasCondition_schema.html#/definitions/condition" class="schema_link">Traits.HasCondition</a>
for more information.
</div>
</td>
</tr>
<tr id="/properties/encoding" class="property">
<th class="col-md-4">
<a href="#/properties/encoding">encoding<sup>&loz;</sup></a>
</th>
<td class="col-md-4">
<a href="Encodeset/Encodeset_schema.html" class="schema_link">Encodeset.Encodeset</a>
</td>
<td class="col-md-4">
<div>
See
<a href="Encodeset/Encodeset_schema.html" class="schema_link">Encodeset.Encodeset</a>
for more information.
</div>
</td>
</tr>
<tr id="/properties/name" class="property">
<th class="col-md-4">
<a href="#/properties/name">name<sup>&loz;</sup></a>
</th>
<td class="col-md-4">
<a href="../AST/Identifier_schema.html#/definitions/c_identifier_regex" class="schema_link">AST.Identifier</a>
</td>
<td class="col-md-4">
<div><p>The machine-readable name of the <a class="schema_link" href="../Instruction/InstructionGroup_schema.html" title="Instruction.InstructionGroup">InstructionGroup</a>.</p></div>
<div>
See
<a href="../AST/Identifier_schema.html#/definitions/c_identifier_regex" class="schema_link">definitions.c_identifier_regex</a> in
<a href="../AST/Identifier_schema.html#/definitions/c_identifier_regex" class="schema_link">AST.Identifier</a>
for more information.
</div>
</td>
</tr>
<tr id="/properties/operation_id" class="property">
<th class="col-md-4">
<a href="#/properties/operation_id">operation_id</a>
</th>
<td class="col-md-4">
<ul class="inline list-type">
<li class="inline type">string</li>
<li class="inline type">null</li>
</ul>
</td>
<td class="col-md-4">
<div><p>The ID of an operation that describes the default behavior of unspecified encodings within the <a class="schema_link" href="../Instruction/InstructionGroup_schema.html" title="Instruction.InstructionGroup">InstructionGroup</a>. When absent, the <code>operation_id</code> of the parent node is implied.</p></div>
<dl>
<dt>Pattern</dt>
<dd><code title="Regex">/^(?!__)[a-zA-Z_][a-zA-Z0-9_]*$/</code></dd>
</dl>
<div>
<b>Default</b>
<pre class="schema-json"><code class="language-json">null</code></pre>
</div>
</td>
</tr>
<tr id="/properties/title" class="property">
<th class="col-md-4">
<a href="#/properties/title">title</a>
</th>
<td class="col-md-4">
<ul class="inline list-type">
<li class="inline type">string</li>
<li class="inline type">null</li>
</ul>
</td>
<td class="col-md-4">
<div><p>The human-readable name of the <a class="schema_link" href="../Instruction/InstructionGroup_schema.html" title="Instruction.InstructionGroup">InstructionGroup</a>.</p></div>
</td>
</tr>
<!-- patternProperties -->
<!-- object property attributes -->
<tr>
<td colspan="3">
<dl>
<dt>Additional Properties</dt>
<dd>Not Allowed</dd>
</dl>
</td>
</tr>
<tr>
<td colspan="3">
<dl>
<dt>&loz; Required</dt>
<dd>Properties marked with &loz; are required properties.</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<!-- array, and it has described items -->
</div>
<h5>Examples</h5>
<div>
<pre class="schema-json"><code class="language-json">{
&#34;_type&#34;: &#34;Instruction.InstructionGroup&#34;,
&#34;name&#34;: &#34;load_store&#34;,
&#34;condition&#34;: {
&#34;_type&#34;: &#34;AST.Function&#34;,
&#34;name&#34;: &#34;IsFeatureImplemented&#34;,
&#34;arguments&#34;: [
{
&#34;_type&#34;: &#34;AST.Identifier&#34;,
&#34;value&#34;: &#34;FEAT_Persistence&#34;
}
]
},
&#34;encoding&#34;: {
&#34;_type&#34;: &#34;Instruction.Encodeset.Encodeset&#34;,
&#34;width&#34;: 32,
&#34;values&#34;: []
},
&#34;title&#34;: &#34;Load/Store&#34;,
&#34;children&#34;: [
{
&#34;_type&#34;: &#34;Instruction.Instruction&#34;,
&#34;name&#34;: &#34;LOAD&#34;,
&#34;encoding&#34;: {
&#34;_type&#34;: &#34;Instruction.Encodeset.Encodeset&#34;,
&#34;width&#34;: 32,
&#34;values&#34;: []
},
&#34;operation_id&#34;: &#34;load_bytes&#34;
},
{
&#34;_type&#34;: &#34;Instruction.InstructionGroup&#34;,
&#34;name&#34;: &#34;stores&#34;,
&#34;encoding&#34;: {
&#34;_type&#34;: &#34;Instruction.Encodeset.Encodeset&#34;,
&#34;width&#34;: 32,
&#34;values&#34;: []
}
}
]
}</code></pre>
</div>
</div>
<div class="row schema">
<h3>Schema <small><a href="http://json-schema.org/draft-04/schema#">http://json-schema.org/draft-04/schema#</a></small></h3>
<pre class="schema-json"><code class="language-json">{
"type": "object",
"info": [
[
"An $(~Instruction.InstructionGroup) object is a subset of its parent encoding space.",
"$(~Instruction.InstructionGroup) is used mainly for grouping similar instructions together",
"and allowing all instructions in a group to be conditional on the same feature."
],
[
"The example below shows both of these uses of $(~Instruction.InstructionGroup). Note that",
"instances of $(~Instruction.InstructionGroup) may be nested to arbitrary depth, provided that",
"the encoding space of the parent can be subdivided."
]
],
"examples": [
{
"_type": "Instruction.InstructionGroup",
"name": "load_store",
"condition": {
"_type": "AST.Function",
"name": "IsFeatureImplemented",
"arguments": [
{
"_type": "AST.Identifier",
"value": "FEAT_Persistence"
}
]
},
"encoding": {
"_type": "Instruction.Encodeset.Encodeset",
"width": 32,
"values": []
},
"title": "Load/Store",
"children": [
{
"_type": "Instruction.Instruction",
"name": "LOAD",
"encoding": {
"_type": "Instruction.Encodeset.Encodeset",
"width": 32,
"values": []
},
"operation_id": "load_bytes"
},
{
"_type": "Instruction.InstructionGroup",
"name": "stores",
"encoding": {
"_type": "Instruction.Encodeset.Encodeset",
"width": 32,
"values": []
}
}
]
}
],
"properties": {
"_meta": {
"$ref": "../Meta.json",
"info": [
"Metadata"
]
},
"_type": {
"enum": [
"Instruction.InstructionGroup"
]
},
"name": {
"info": [
"The machine-readable name of the $(~Instruction.InstructionGroup)."
],
"$ref": "../AST/Identifier.json#/definitions/c_identifier_regex"
},
"title": {
"info": [
"The human-readable name of the $(~Instruction.InstructionGroup)."
],
"type": [
"string",
"null"
]
},
"encoding": {
"$ref": "Encodeset/Encodeset.json"
},
"condition": {
"$ref": "../Traits/HasCondition.json#/definitions/condition"
},
"children": {
"type": "array",
"info": [
"Defines children nodes.",
[
"Any child node with a unique `name` that inherits its parent's `operation_id`,",
"unless it redefines the `operation_id`, in which case it overwrites",
"the behavior that is defined by the `operation_id` of this $(~Instruction.InstructionGroup)."
]
],
"items": {
"oneOf": [
{
"$ref": "#"
},
{
"$ref": "Instruction.json"
}
]
}
},
"operation_id": {
"info": [
"The ID of an operation that describes the default behavior of unspecified encodings within the $(~Instruction.InstructionGroup). When absent, the `operation_id` of the parent node is implied."
],
"type": [
"string",
"null"
],
"pattern": "^(?!__)[a-zA-Z_][a-zA-Z0-9_]*$",
"default": null
}
},
"required": [
"name",
"encoding"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Instruction.InstructionGroup"
}</code></pre>
</div>
</div>
<div class="container">
<div class="footer text-right">
Copyright &copy; 2025 ARM Limited or its affiliates. All rights reserved.
</div>
</div>
<script src="../js/highlight/highlight.js"></script>
<script src="../js/highlight/languages/json.min.js"></script>
<script src="../js/highlight/languages/django.min.js"></script> <!-- JINJA2 -->
<script src="../js/highlight/languages/yaml.min.js"></script>
<script src="../js/highlight/languages/isa.js"></script>
<script type="text/javascript">
window.onload = function() {
hljs.configure({
cssSelector: ".schema-json code, .includes code, pre code",
noHighlightRe: /^(no-?highlight|nohl)$/i,
});
hljs.highlightAll()
};
</script>
</body>
</html>