Project

General

Profile

Template Description Language » History » Version 21

Alexander Kamkin, 03/18/2014 02:13 PM

1 5 Alexander Kamkin
h1. Template Description Language
2 4 Alexander Kamkin
3
_~By Artemiy Utekhin~_
4 1 Alexander Kamkin
5 21 Alexander Kamkin
*UNDER CONSTRUCTION*
6
7 6 Alexander Kamkin
{{toc}}
8
9 20 Alexander Kamkin
*Ruby-TDL (Ruby-Based Template Description Language)* is a Ruby-based domain specific language geared towards writing compact and reusable tests for microprocessors and other programmable devices. The language intends to look similar to the assembler of the target CPU (*TL, Target Language*) complemented by higher level features consisting of both standard Ruby and features specific to the Ruby-TDL implementation (*ML, Meta Language*). Ruby-TDL, in a sense, is similar to a macro processor - it generates code in the target language based on the provided meta language.
10 1 Alexander Kamkin
11 20 Alexander Kamkin
Since Ruby-TDL is built as a Ruby library providing an internal DSL no additional parsers are required. Currently, because of the extensive use of Java, Ruby-TDL templates can only be executed by the JRuby interpreter. CRuby will probably be supported at a later stage.
12 1 Alexander Kamkin
13 3 Artemiy Utekhin
h2. The translation process
14 1 Alexander Kamkin
15 20 Alexander Kamkin
Ruby-TDL code describes a template of a test program which is then translated into TL code using the API of the MicroTESK CPU model parser and simulator (and, by extension, the constraint solver and other MicroTESK components). The process can be described as follows:
16 1 Alexander Kamkin
17 3 Artemiy Utekhin
# Receiving model metadata from the simulator;
18
# Template pre-processing;
19
# Constructing commands in the simulator;
20
# Executing commands in the simulator;
21
# Receiving the assembler code from the simulator (based on the CPU Sim-nML description);
22
# Writing the TL output to target files.
23 1 Alexander Kamkin
24 3 Artemiy Utekhin
Depending on the circumstances some of these steps may be done concurrently. 
25 1 Alexander Kamkin
26 3 Artemiy Utekhin
h2. Configuration
27 1 Alexander Kamkin
28 3 Artemiy Utekhin
_Pending..._
29 1 Alexander Kamkin
30 3 Artemiy Utekhin
h2. Execution
31 1 Alexander Kamkin
32 7 Artemiy Utekhin
Right now there is a simple execution script that requires the name of a package containing the CPU model (which is responsible for simulating the target processor and is generated by the [[Sim-nML Translator]]), a template file and an optional output file (if it''s not provided the library uses the standard output to print out the results). To run a template, execute the following command:
33 1 Alexander Kamkin
34 7 Artemiy Utekhin
<pre>generate <model package> <template file.rb> [<output file.asm>]</pre>
35
36
Example:
37
38
<pre>generate arm mytemplates\arm_template.rb myresults\executable.asm</pre>
39 1 Alexander Kamkin
40 3 Artemiy Utekhin
h2. Writing templates
41 1 Alexander Kamkin
42 3 Artemiy Utekhin
h3. Basic features
43 1 Alexander Kamkin
44 20 Alexander Kamkin
The two core abstractions used by MicroTESK parser/simulator and Ruby-TDL are an *instruction* and an *addressing mode*. An instruction is rather self-explanatory, it simply represents a target assembler instruction. Every argument of an instruction is a parametrized *addressing mode* that explains the meaning of the provided values to the simulator. The mode could point to the registers, for instance, or to a specific memory location. It can also denote an immediate value - e.g. a simple integer or a string. Thus, a basic template is effectively a sequence of instructions with parametrized addressing modes as their arguments.
45 1 Alexander Kamkin
46 20 Alexander Kamkin
Each template is a class that inherits a basic Template class that provides most of the core Ruby-TDL functionality. So, to write a template you need to subclass Template first:
47 1 Alexander Kamkin
48 11 Andrei Tatarnikov
<pre><code class="ruby">require_relative "_path-to-the-rubymt-library_/mtruby"
49 1 Alexander Kamkin
50 11 Andrei Tatarnikov
class MyTemplate < Template</code></pre>
51 1 Alexander Kamkin
52 20 Alexander Kamkin
While processing a template Ruby-TDL calls its %pre%, %run% and %post% methods, loosely meaning the pre-conditions, the main body and the post-conditions. The %pre% method is mostly useful for setup common to many templates, the %post% method will be more important once sequential testing is introduced. Most of the template code is supposed to be in the %run% method. Thus, a template needs to override one or more of these methods, most commonly %run%.
53 1 Alexander Kamkin
54 3 Artemiy Utekhin
To get %pre% and %post% over with, the most common usage of these is to make a special non-executable class and then subclass it with the actual templates:
55 1 Alexander Kamkin
56 10 Andrei Tatarnikov
<pre><code class="ruby">require_relative "_path-to-the-rubymt-library_/mtruby"
57 1 Alexander Kamkin
58 3 Artemiy Utekhin
class MyPrepost < Template
59
  def initialize
60
    super
61
    @is_executable = no
62
  end
63 1 Alexander Kamkin
64 3 Artemiy Utekhin
  def pre
65
    # Your ''startup'' code goes here
66
  end
67 1 Alexander Kamkin
68 3 Artemiy Utekhin
  def post
69
    # Your ''cleanup'' code goes here
70
  end
71 9 Andrei Tatarnikov
end</code></pre>
72 1 Alexander Kamkin
73 11 Andrei Tatarnikov
<pre><code class="ruby">require_relative "_path-to-the-rubymt-library_/mtruby"
74 1 Alexander Kamkin
75 3 Artemiy Utekhin
class MyTemplate < MyPrepost
76
  def initialize
77
    super
78
    @is_executable = yes
79
  end
80
  
81
  def run
82
    # Your template code goes here
83
  end
84 11 Andrei Tatarnikov
end</code></pre>
85 1 Alexander Kamkin
86 3 Artemiy Utekhin
These methods essentially contain the instructions. The general instruction format is slightly more intimidating than the native assembler and looks like this:
87 1 Alexander Kamkin
88 16 Andrei Tatarnikov
<pre><code class="ruby">instruction_name addr_mode1(:arg1_1 => value, :arg1_2 => value, ...), addr_mode2(:arg2_1 => value, ...), ...</code></pre>
89 1 Alexander Kamkin
90 3 Artemiy Utekhin
So, for instance, if the simulator has an ADD(MEM(i), MEM(i)|IMM(i)) instruction, it would look like:
91 1 Alexander Kamkin
92 16 Andrei Tatarnikov
<pre><code class="ruby">add mem(:i => 42), imm(:i => 128)</code></pre>
93 1 Alexander Kamkin
94 3 Artemiy Utekhin
Thankfully, there are shortcuts. If there''s only one argument expected in the addressing mode, you can simply write its value and never have to worry about the argument name. And, by convention, the immediate values are always denoted in the simulator as the IMM addressing mode, so the template parser automatically accepts numbers and strings as such. Thus, in this case, the instruction can be simplified to:
95 1 Alexander Kamkin
96 16 Andrei Tatarnikov
<pre><code class="ruby">add mem(42), 128</code></pre>
97 3 Artemiy Utekhin
98 8 Artemiy Utekhin
As a matter of fact, if you''re sure about the order of addressing mode arguments, you can omit the names altogether and simply provide the values:
99
100 16 Andrei Tatarnikov
<pre><code class="ruby">instruction_name addr_mode1(value1, value2, ...) ...</code></pre>
101 8 Artemiy Utekhin
102 3 Artemiy Utekhin
If the name of the instruction conflicts with an already existing Ruby method, the instruction will be available with an %op_% prefix before its name.
103
104
h3. Test situations
105
106
_This section is to be taken with a grain of salt because the logic and the interface behind the situations is not yet finalized and mostly missing from the templates and shouldn''t be used yet_
107
108
_Big TODO: define what is a test situation_
109
110
To denote a test situation, add a Ruby block that describes situations to an instruction, this will loosely look like this (likely similar to the way the addressing modes are denoted):
111
112 17 Andrei Tatarnikov
<pre><code class="ruby">sub mem(42), mem(21) do overflow(:op1 => 123, :op2 => 456) end</code></pre>
113 3 Artemiy Utekhin
114
h3. Instruction blocks
115
116
Sometimes a certain test situation should influence more than just one instruction. In that case, you can pass the instructions in an atomic block that can optionally accept a Proc of situations as its argument (because Ruby doesn''t want to be nice and allow multiple blocks for a method, and passing a Hash of Proc can hardly be called comfortable).
117
118 12 Andrei Tatarnikov
<pre><code class="ruby">p = lambda { overflow(:op1 => 123, :op2 => 456) }
119 3 Artemiy Utekhin
120
atomic p {
121
  mov mem(25), mem(26)
122
  add mem(27), 28
123
  sub mem(29), 30
124 12 Andrei Tatarnikov
}</code></pre>
125 3 Artemiy Utekhin
126
h3. Groups and random selections
127
128
There are certain ways to group together or randomize addressing modes and instructions.
129
130
To group several addressing modes together (this only works if they have similar arguments) create a mode group like this:
131
132 17 Andrei Tatarnikov
<pre><code class="ruby">mode_group "my_group" [:mem, :imm]</code></pre>
133 3 Artemiy Utekhin
134
You can also set weights to each of the modes in the group like this:
135
136 17 Andrei Tatarnikov
<pre><code class="ruby">mode_group "my_group" {:mem => 1.5, :imm => 2.5}</code></pre>
137 3 Artemiy Utekhin
138
The name of the group is converted into a method in the Template class. To select a random mode from a group, use %sample% on this generated method:
139
140 17 Andrei Tatarnikov
<pre><code class="ruby">add mem(42), my_group.sample(21)</code></pre>
141 3 Artemiy Utekhin
142
_TODO: sampling already parametrized modes_
143
144
The first method of grouping instructions works in a similar manner with the same restrictions on arguments:
145
146 17 Andrei Tatarnikov
<pre><code class="ruby">group "i_group" [:add, :sub]</code></pre>
147 3 Artemiy Utekhin
148 17 Andrei Tatarnikov
<pre><code class="ruby">group "i_group" {:add => 0.3, :sub => 0.7]</code></pre>
149 3 Artemiy Utekhin
150 17 Andrei Tatarnikov
<pre><code class="ruby">i_group.sample mem(42), 21</code></pre>
151 3 Artemiy Utekhin
152
You can also run all of the instructions in a group at once by using the %all% method:
153
154 17 Andrei Tatarnikov
<pre><code class="ruby">i_group.all mem(42), 21</code></pre>
155 3 Artemiy Utekhin
156
The second one allows you to create a normal block of instructions, setting their arguments separately. 
157
158 17 Andrei Tatarnikov
<pre><code class="ruby">block_group "b_group" do
159 3 Artemiy Utekhin
  mov mem(25), mem(26)
160
  add mem(27), 28
161
  sub mem(29), 30
162 17 Andrei Tatarnikov
end</code></pre>
163 3 Artemiy Utekhin
164
In this case to set weights you should call a %prob% method before every instruction:
165
166 17 Andrei Tatarnikov
<pre><code class="ruby">block_group "b_group" do
167 3 Artemiy Utekhin
  prob 0.1
168
  mov mem(25), mem(26)
169
  prob 0.7
170
  add mem(27), 28
171
  prob 0.4
172
  sub mem(29), 30
173 17 Andrei Tatarnikov
end</code></pre>
174 3 Artemiy Utekhin
175
The usage is almost identical, but without providing the arguments as they are already set:
176
177 18 Andrei Tatarnikov
<pre><code class="ruby">b_group.sample
178
b_group.all</code></pre>
179 3 Artemiy Utekhin
180
_Not sure how does it work inside atomics when the group is defined outside, needs more consideration_
181
182
_TODO: Permutations_
183
184
Any normal Ruby code is allowed inside the blocks as well as the %run%-type methods, letting you write more complex or inter-dependent templates.
185 8 Artemiy Utekhin
186
h3. TODO: Labels
187
188
To set a label write:
189
190 18 Andrei Tatarnikov
<pre><code class="ruby">label :label_name</code></pre>
191 8 Artemiy Utekhin
192
To use a label in an instruction that accepts one (under the hood it''s just a simple immediate #IMM value - just not a pre-defined one until it''s actually defined):
193
194 18 Andrei Tatarnikov
<pre><code class="ruby">b greaterThan, :label_name</code></pre>
195 8 Artemiy Utekhin
196
h3. TODO: Debug
197
198
To get a value from registers use:
199
200 15 Andrei Tatarnikov
<pre><code class="ruby">get_reg_value("register_name", index)</code></pre>
201 8 Artemiy Utekhin
202
Right now the pre-processing and the execution of instructions are separated due to ambiguous logic regarding labels and various blocks and atomics. This may be changed later, so these special debugging blocks might become unnecessary. By default what''s written in the template is run during pre-processing so you have to use special blocks if you want to run some Ruby code during the execution stage, most likely some debugging.
203
204
To print some debug in the console during the execution of the instructions use the exec_debug block:
205
206 15 Andrei Tatarnikov
<pre><code class="ruby">exec_debug {
207 8 Artemiy Utekhin
  puts "R0: " + get_reg_value("GPR", 0).to_s + ", R1: " + get_reg_value("GPR", 1).to_s# + ", label code: " + self.send("cycle" + ind.to_s).to_s
208 15 Andrei Tatarnikov
}</code></pre>
209 8 Artemiy Utekhin
210
To save something that depends on the current state of the simulator to the resulting assembler code use exec_output that should return a string:
211
212 14 Andrei Tatarnikov
<pre><code class="ruby">exec_output {
213 8 Artemiy Utekhin
  "// The result should be " + self.get_reg_value("GPR", 0).to_s
214 13 Andrei Tatarnikov
}</code></pre>
215 8 Artemiy Utekhin
216
h3. TODO: Pipelines
217
218
_TODO in code first_