summary refs log tree commit diff stats
path: root/compiler/liftlocals.nim
blob: 58c6189d40985a9532d5f63312a2343697c7342c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
#
#
#           The Nim Compiler
#        (c) Copyright 2015 Andreas Rumpf
#
#    See the file "copying.txt", included in this
#    distribution, for details about the copyright.
#

## This module implements the '.liftLocals' pragma.

import
  strutils, options, ast, msgs,
  idents, renderer, types, lowerings, lineinfos

from pragmas import getPragmaVal
from wordrecg import wLiftLocals

type
  Ctx = object
    partialParam: PSym
    objType: PType
    cache: IdentCache
    idgen: IdGenerator

proc interestingVar(s: PSym): bool {.inline.} =
  result = s.kind in {skVar, skLet, skTemp, skForVar, skResult} and
    sfGlobal notin s.flags

proc lookupOrAdd(c: var Ctx; s: PSym; info: TLineInfo): PNode =
  let field = addUniqueField(c.objType, s, c.cache, c.idgen)
  var deref = newNodeI(nkHiddenDeref, info)
  deref.typ = c.objType
  deref.add(newSymNode(c.partialParam, info))
  result = newNodeI(nkDotExpr, info)
  result.add(deref)
  result.add(newSymNode(field))
  result.typ = field.typ

proc liftLocals(n: PNode; i: int; c: var Ctx) =
  let it = n[i]
  case it.kind
  of nkSym:
    if interestingVar(it.sym):
      n[i] = lookupOrAdd(c, it.sym, it.info)
  of procDefs, nkTypeSection, nkMixinStmt, nkBindStmt: discard
  else:
    for i in 0..<it.safeLen:
      liftLocals(it, i, c)

proc lookupParam(params, dest: PNode): PSym =
  result = nil
  if dest.kind != nkIdent: return nil
  for i in 1..<params.len:
    if params[i].kind == nkSym and params[i].sym.name.id == dest.ident.id:
      return params[i].sym

proc liftLocalsIfRequested*(prc: PSym; n: PNode; cache: IdentCache; conf: ConfigRef;
                            idgen: IdGenerator): PNode =
  let liftDest = getPragmaVal(prc.ast, wLiftLocals)
  if liftDest == nil: return n
  let partialParam = lookupParam(prc.typ.n, liftDest)
  if partialParam.isNil:
    localError(conf, liftDest.info, "'$1' is not a parameter of '$2'" %
              [$liftDest, prc.name.s])
    return n
  let objType = partialParam.typ.skipTypes(abstractPtrs)
  if objType.kind != tyObject or tfPartial notin objType.flags:
    localError(conf, liftDest.info, "parameter '$1' is not a pointer to a partial object" % $liftDest)
    return n
  var c = Ctx(partialParam: partialParam, objType: objType, cache: cache, idgen: idgen)
  let w = newTree(nkStmtList, n)
  liftLocals(w, 0, c)
  result = w[0]
p;gt; <span class="Special">Real_hardware_types</span><span class="Delimiter">;</span> <span id="L9" class="LineNr"> 9 </span><span class="Delimiter">:(before &quot;Begin transform_all&quot;)</span> <span id="L10" class="LineNr">10 </span><a href='099hardware_checks.cc.html#L14'>setup_real_hardware_types</a><span class="Delimiter">();</span> <span id="L11" class="LineNr">11 </span><span class="Delimiter">:(before &quot;End transform_all&quot;)</span> <span id="L12" class="LineNr">12 </span><a href='099hardware_checks.cc.html#L25'>teardown_real_hardware_types</a><span class="Delimiter">();</span> <span id="L13" class="LineNr">13 </span><span class="Delimiter">:(code)</span> <span id="L14" class="LineNr">14 </span><span class="Normal">void</span> <a href='099hardware_checks.cc.html#L14'>setup_real_hardware_types</a><span class="Delimiter">()</span> <span class="Delimiter">{</span> <span id="L15" class="LineNr">15 </span> <span class="Special">Real_hardware_types</span><span class="Delimiter">.</span>push_back<span class="Delimiter">(</span><a href='099hardware_checks.cc.html#L19'>parse_type</a><span class="Delimiter">(</span><span class="Constant">&quot;address:screen&quot;</span><span class="Delimiter">));</span> <span id="L16" class="LineNr">16 </span> <span class="Special">Real_hardware_types</span><span class="Delimiter">.</span>push_back<span class="Delimiter">(</span><a href='099hardware_checks.cc.html#L19'>parse_type</a><span class="Delimiter">(</span><span class="Constant">&quot;address:console&quot;</span><span class="Delimiter">));</span> <span id="L17" class="LineNr">17 </span> <span class="Special">Real_hardware_types</span><span class="Delimiter">.</span>push_back<span class="Delimiter">(</span><a href='099hardware_checks.cc.html#L19'>parse_type</a><span class="Delimiter">(</span><span class="Constant">&quot;address:resources&quot;</span><span class="Delimiter">));</span> <span id="L18" class="LineNr">18 </span><span class="Delimiter">}</span> <span id="L19" class="LineNr">19 </span>type_tree* <a href='099hardware_checks.cc.html#L19'>parse_type</a><span class="Delimiter">(</span>string s<span class="Delimiter">)</span> <span class="Delimiter">{</span> <span id="L20" class="LineNr">20 </span> reagent x<span class="Delimiter">(</span><span class="Constant">&quot;x:&quot;</span>+s<span class="Delimiter">);</span> <span id="L21" class="LineNr">21 </span> type_tree* result = x<span class="Delimiter">.</span>type<span class="Delimiter">;</span> <span id="L22" class="LineNr">22 </span> x<span class="Delimiter">.</span>type = <span class="Constant">NULL</span><span class="Delimiter">;</span> <span class="Comment">// don't deallocate on return</span> <span id="L23" class="LineNr">23 </span> <span class="Identifier">return</span> result<span class="Delimiter">;</span> <span id="L24" class="LineNr">24 </span><span class="Delimiter">}</span> <span id="L25" class="LineNr">25 </span><span class="Normal">void</span> <a href='099hardware_checks.cc.html#L25'>teardown_real_hardware_types</a><span class="Delimiter">()</span> <span class="Delimiter">{</span> <span id="L26" class="LineNr">26 </span> <span class="Normal">for</span> <span class="Delimiter">(</span><span class="Normal">int</span> i = <span class="Constant">0</span><span class="Delimiter">;</span> i &lt; <a href='001help.cc.html#L141'>SIZE</a><span class="Delimiter">(</span><span class="Special">Real_hardware_types</span><span class="Delimiter">);</span> ++i<span class="Delimiter">)</span> <span id="L27" class="LineNr">27 </span> <span class="Normal">delete</span> <span class="Special">Real_hardware_types</span><span class="Delimiter">.</span>at<span class="Delimiter">(</span>i<span class="Delimiter">);</span> <span id="L28" class="LineNr">28 </span> <span class="Special">Real_hardware_types</span><span class="Delimiter">.</span><a href='050scenario.cc.html#L60'>clear</a><span class="Delimiter">();</span> <span id="L29" class="LineNr">29 </span><span class="Delimiter">}</span> <span id="L30" class="LineNr">30 </span> <span id="L31" class="LineNr">31 </span><span class="Delimiter">:(before &quot;End Checks&quot;)</span> <span id="L32" class="LineNr">32 </span><span class="Special">Transform</span><span class="Delimiter">.</span>push_back<span class="Delimiter">(</span><a href='099hardware_checks.cc.html#L34'>check_for_misuse_of_real_hardware</a><span class="Delimiter">);</span> <span id="L33" class="LineNr">33 </span><span class="Delimiter">:(code)</span> <span id="L34" class="LineNr">34 </span><span class="Normal">void</span> <a href='099hardware_checks.cc.html#L34'>check_for_misuse_of_real_hardware</a><span class="Delimiter">(</span><span class="Normal">const</span> <a href='010vm.cc.html#L14'>recipe_ordinal</a> r<span class="Delimiter">)</span> <span class="Delimiter">{</span> <span id="L35" class="LineNr">35 </span> <span class="Normal">const</span> recipe&amp; caller = get<span class="Delimiter">(</span><span class="Special">Recipe</span><span class="Delimiter">,</span> r<span class="Delimiter">);</span> <span id="L36" class="LineNr">36 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>caller<span class="Delimiter">.</span>name == <span class="Constant">&quot;main&quot;</span><span class="Delimiter">)</span> <span class="Identifier">return</span><span class="Delimiter">;</span> <span id="L37" class="LineNr">37 </span> <span class="Normal">if</span> <span class="Delimiter">(</span><a href='001help.cc.html#L77'>starts_with</a><span class="Delimiter">(</span>caller<span class="Delimiter">.</span>name<span class="Delimiter">,</span> <span class="Constant">&quot;scenario_&quot;</span><span class="Delimiter">))</span> <span class="Identifier">return</span><span class="Delimiter">;</span> <span id="L38" class="LineNr">38 </span> <a href='003trace.cc.html#L189'>trace</a><span class="Delimiter">(</span><span class="Constant">9991</span><span class="Delimiter">,</span> <span class="Constant">&quot;transform&quot;</span><span class="Delimiter">)</span> &lt;&lt; <span class="Constant">&quot;--- check if <a href='010vm.cc.html#L19'>recipe</a> &quot;</span> &lt;&lt; caller<span class="Delimiter">.</span>name &lt;&lt; <span class="Constant">&quot; has any dependency-injection mistakes&quot;</span> &lt;&lt; <a href='003trace.cc.html#L225'>end</a><span class="Delimiter">();</span> <span id="L39" class="LineNr">39 </span> <span class="Normal">for</span> <span class="Delimiter">(</span><span class="Normal">int</span> index = <span class="Constant">0</span><span class="Delimiter">;</span> index &lt; <a href='001help.cc.html#L141'>SIZE</a><span class="Delimiter">(</span>caller<span class="Delimiter">.</span>steps<span class="Delimiter">);</span> ++index<span class="Delimiter">)</span> <span class="Delimiter">{</span> <span id="L40" class="LineNr">40 </span> <span class="Normal">const</span> instruction&amp; inst = caller<span class="Delimiter">.</span>steps<span class="Delimiter">.</span>at<span class="Delimiter">(</span>index<span class="Delimiter">);</span> <span id="L41" class="LineNr">41 </span> <span class="Normal">if</span> <span class="Delimiter">(</span><a href='028call_return.cc.html#L115'>is_primitive</a><span class="Delimiter">(</span>inst<span class="Delimiter">.</span>operation<span class="Delimiter">))</span> <span class="Identifier">continue</span><span class="Delimiter">;</span> <span id="L42" class="LineNr">42 </span> <span class="Normal">for</span> <span class="Delimiter">(</span><span class="Normal">int</span> i = <span class="Constant">0</span><span class="Delimiter">;</span> i &lt; <a href='001help.cc.html#L141'>SIZE</a><span class="Delimiter">(</span>inst<span class="Delimiter">.</span>ingredients<span class="Delimiter">);</span> ++i<span class="Delimiter">)</span> <span class="Delimiter">{</span> <span id="L43" class="LineNr">43 </span> <span class="Normal">const</span> reagent&amp; ing = inst<span class="Delimiter">.</span>ingredients<span class="Delimiter">.</span>at<span class="Delimiter">(</span>i<span class="Delimiter">);</span> <span id="L44" class="LineNr">44 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>!is_literal<span class="Delimiter">(</span>ing<span class="Delimiter">)</span> || ing<span class="Delimiter">.</span>name != <span class="Constant">&quot;0&quot;</span><span class="Delimiter">)</span> <span class="Identifier">continue</span><span class="Delimiter">;</span> <span id="L45" class="LineNr">45 </span> <span class="Normal">const</span> recipe&amp; callee = get<span class="Delimiter">(</span><span class="Special">Recipe</span><span class="Delimiter">,</span> inst<span class="Delimiter">.</span>operation<span class="Delimiter">);</span> <span id="L46" class="LineNr">46 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>!callee<span class="Delimiter">.</span>has_header<span class="Delimiter">)</span> <span class="Identifier">continue</span><span class="Delimiter">;</span> <span id="L47" class="LineNr">47 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>i &gt;= <a href='001help.cc.html#L141'>SIZE</a><span class="Delimiter">(</span>callee<span class="Delimiter">.</span>ingredients<span class="Delimiter">))</span> <span class="Identifier">continue</span><span class="Delimiter">;</span> <span id="L48" class="LineNr">48 </span> <span class="Normal">const</span> reagent&amp; expected_ing = callee<span class="Delimiter">.</span>ingredients<span class="Delimiter">.</span>at<span class="Delimiter">(</span>i<span class="Delimiter">);</span> <span id="L49" class="LineNr">49 </span> <span class="Normal">for</span> <span class="Delimiter">(</span><span class="Normal">int</span> j = <span class="Constant">0</span><span class="Delimiter">;</span> j &lt; <a href='001help.cc.html#L141'>SIZE</a><span class="Delimiter">(</span><span class="Special">Real_hardware_types</span><span class="Delimiter">);</span> ++j<span class="Delimiter">)</span> <span class="Delimiter">{</span> <span id="L50" class="LineNr">50 </span> <span class="Normal">if</span> <span class="Delimiter">(</span>*<span class="Special">Real_hardware_types</span><span class="Delimiter">.</span>at<span class="Delimiter">(</span>j<span class="Delimiter">)</span> == *expected_ing<span class="Delimiter">.</span>type<span class="Delimiter">)</span> <span id="L51" class="LineNr">51 </span> <a href='003trace.cc.html#L196'>raise</a> &lt;&lt; <a href='013update_operation.cc.html#L25'>maybe</a><span class="Delimiter">(</span>caller<span class="Delimiter">.</span>name<span class="Delimiter">)</span> &lt;&lt; <span class="Constant">&quot;'&quot;</span> &lt;&lt; to_original_string<span class="Delimiter">(</span>inst<span class="Delimiter">)</span> &lt;&lt; <span class="Constant">&quot;': only 'main' can pass 0 into a &quot;</span> &lt;&lt; <a href='028call_return.cc.html#L163'>to_string</a><span class="Delimiter">(</span>expected_ing<span class="Delimiter">.</span>type<span class="Delimiter">)</span> &lt;&lt; <span class="cSpecial">'\n'</span> &lt;&lt; <a href='003trace.cc.html#L225'>end</a><span class="Delimiter">();</span> <span id="L52" class="LineNr">52 </span> <span class="Delimiter">}</span> <span id="L53" class="LineNr">53 </span> <span class="Delimiter">}</span> <span id="L54" class="LineNr">54 </span> <span class="Delimiter">}</span> <span id="L55" class="LineNr">55 </span><span class="Delimiter">}</span> <span id="L56" class="LineNr">56 </span> <span id="L57" class="LineNr">57 </span><span class="Delimiter">:(scenarios transform)</span> <span id="L58" class="LineNr">58 </span><span class="Delimiter">:(scenario warn_on_using_real_screen_directly_in_non_main_recipe)</span> <span id="L59" class="LineNr">59 </span><span class="Special">% Hide_errors = true;</span> <span id="L60" class="LineNr">60 </span><span class="muRecipe">def</span> foo [ <span id="L61" class="LineNr">61 </span> print <span class="Constant">0</span><span class="Delimiter">,</span> <span class="Constant">34</span> <span id="L62" class="LineNr">62 </span>] <span id="L63" class="LineNr">63 </span><span class="traceContains">+error: foo: 'print 0, 34': only 'main' can pass 0 into a (address screen)</span> </pre> </body> </html> <!-- vim: set foldmethod=manual : -->