aboutsummaryrefslogtreecommitdiffstats
path: root/src/hls/Renaming.v
blob: e4453d1c4322fac09ecf7eb39fed43a4cbb369b9 (plain)
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
Require Import compcert.common.AST.

Require Import vericert.hls.HTL.
Require Import vericert.hls.Verilog.
Require Import vericert.hls.AssocMap.

Require Import vericert.common.Statemonad.
Require Import vericert.common.Vericertlib.
Require Import vericert.common.Maps.

Record renumber_state: Type :=
  mk_renumber_state {
    renumber_freshreg : reg;
    renumber_regmap : PTree.t reg;
  }.

Module RenumberState <: State.
  Definition st := renumber_state.

  Definition st_prop (st1 st2 : st) := True.
  Hint Unfold st_prop : htl_renumber.

  Lemma st_refl : forall (s : st), st_prop s s.
  Proof. constructor. Qed.

  Lemma st_trans : forall s1 s2 s3, st_prop s1 s2 -> st_prop s2 s3 -> st_prop s1 s3.
  Proof. constructor. Qed.
End RenumberState.

Module RenumberMonad := Statemonad(RenumberState).
Module RenumberMonadExtra := Monad.MonadExtra(RenumberMonad).

Import RenumberMonad.
Import RenumberState.
Import RenumberMonadExtra.
Import MonadNotation.

Definition map_reg (r: reg) : mon reg :=
  fun st => OK
        (renumber_freshreg st)
        (mk_renumber_state (Pos.succ (renumber_freshreg st))
                          (PTree.set r (renumber_freshreg st) (renumber_regmap st)))
        ltac:(auto with htl_renumber).

Definition clear_regmap : mon unit :=
  fun st => OK
        tt
        (mk_renumber_state (renumber_freshreg st)
                          (PTree.empty reg))
        ltac:(auto with htl_renumber).

Definition renumber_reg (r : reg) : mon reg :=
  do st <- get;
  match PTree.get r (renumber_regmap st) with
  | Some reg' => ret reg'
  | None => map_reg r
  end.

Fixpoint renumber_expr (expr : Verilog.expr) :=
  match expr with
  | Vlit val => ret (Vlit val)
  | Vvar reg =>
    do reg' <- renumber_reg reg;
    ret (Vvar reg')
  | Vvari reg e =>
    do reg' <- renumber_reg reg;
    do e' <- renumber_expr e;
    ret (Vvari reg' e')
  | Vinputvar reg =>
    do reg' <- renumber_reg reg;
    ret (Vvar reg')
  | Vbinop op e1 e2 =>
    do e1' <- renumber_expr e1;
    do e2' <- renumber_expr e2;
    ret (Vbinop op e1' e2')
  | Vunop op e =>
    do e' <- renumber_expr e;
    ret (Vunop op e')
  | Vternary e1 e2 e3 =>
    do e1' <- renumber_expr e1;
    do e2' <- renumber_expr e2;
    do e3' <- renumber_expr e3;
    ret (Vternary e1' e2' e3')
  | Vrange r e1 e2 =>
    do e1' <- renumber_expr e1;
    do e2' <- renumber_expr e2;
    do r' <- renumber_reg r;
    ret (Vrange r e1' e2')
  end.

  Definition renumber_cases_ (renumber_stmnt_ : Verilog.stmnt -> mon Verilog.stmnt) :=
    fix renumber_cases (cs : stmnt_expr_list) :=
      match cs with
      | Stmntnil  => ret Stmntnil
      | Stmntcons c_e c_s tl =>
        do c_e' <- renumber_expr c_e;
        do c_s' <- renumber_stmnt_ c_s;
        do tl' <- renumber_cases tl;
        ret (Stmntcons c_e' c_s' tl')
      end.

Fixpoint renumber_stmnt (stmnt : Verilog.stmnt) :=
  match stmnt with
  | Vskip => ret Vskip
  | Vseq s1 s2 =>
    do s1' <- renumber_stmnt s1;
    do s2' <- renumber_stmnt s2;
    ret (Vseq s1' s2')
  | Vcond e s1 s2 =>
    do e' <- renumber_expr e;
    do s1' <- renumber_stmnt s1;
    do s2' <- renumber_stmnt s2;
    ret (Vcond e' s1' s2')
  | Vcase e cs def =>
    do e' <- renumber_expr e;
    do cs' <- renumber_cases_ renumber_stmnt cs;
    do def' <- match def with
              | None => ret None
              | Some d => do def' <- renumber_stmnt d; ret (Some def')
              end;
    ret (Vcase e' cs' def')
  | Vblock e1 e2 =>
    do e1' <- renumber_expr e1;
    do e2' <- renumber_expr e2;
    ret (Vblock e1' e2')
  | Vnonblock e1 e2 =>
    do e1' <- renumber_expr e1;
    do e2' <- renumber_expr e2;
    ret (Vnonblock e1' e2')
  end.

Program Definition renumber_ram (mr : option HTL.ram) : mon (option HTL.ram) :=
  match mr with
  | None => ret None
  | Some r =>
    do ram_addr' <- renumber_reg (ram_addr r);
    do ram_en' <- renumber_reg (ram_en r);
    do ram_d_in' <- renumber_reg (ram_d_in r);
    do ram_d_out' <- renumber_reg (ram_d_out r);
    do ram_wr_en' <- renumber_reg (ram_wr_en r);
    do ram_u_en' <- renumber_reg (ram_u_en r);
    match decide_ram_ordering ram_addr' ram_en' ram_d_in' ram_d_out' ram_wr_en' ram_u_en' with
    | left wf => ret (Some (mk_ram (ram_size r) (ram_mem r) ram_en' ram_u_en' ram_addr' ram_wr_en' ram_d_in' ram_d_out' wf))
    | right _ => error (Errors.msg "Renaming: Incorrect ordering of RAM registers")
    end
  end.

Fixpoint xrenumber_reg_assocmap {A} (regmap : list (reg * A)) : mon (list (reg * A)) :=
  match regmap with
  | nil => ret nil
  | (r, v) :: l =>
    do r' <- renumber_reg r;
    do l' <- xrenumber_reg_assocmap l;
    ret ((r', v) :: l')
  end.

Definition renumber_reg_assocmap {A} (regmap : AssocMap.t A) : mon (AssocMap.t A) :=
  do l <- xrenumber_reg_assocmap (AssocMap.elements regmap);
  ret (AssocMap_Properties.of_list l).

Definition renumber_module (m : HTL.module) : mon HTL.module :=
    do mod_params' <- traverselist renumber_reg (HTL.mod_params m);

    do mod_st' <- renumber_reg (HTL.mod_st m);
    do mod_finish' <- renumber_reg (HTL.mod_finish m);
    do mod_return' <- renumber_reg (HTL.mod_return m);
    do mod_stk' <- renumber_reg (HTL.mod_stk m);
    do mod_start' <- renumber_reg (HTL.mod_start m);
    do mod_reset' <- renumber_reg (HTL.mod_reset m);
    do mod_clk' <- renumber_reg (HTL.mod_clk m);

    do mod_ram' <- renumber_ram (HTL.mod_ram m);

    do mod_controllogic' <- traverse_ptree1 renumber_stmnt (HTL.mod_controllogic m);
    do mod_datapath' <- traverse_ptree1 renumber_stmnt (HTL.mod_datapath m);

    do mod_scldecls' <- renumber_reg_assocmap (HTL.mod_scldecls m);
    do mod_arrdecls' <- renumber_reg_assocmap (HTL.mod_arrdecls m);
    do mod_externctrl' <- renumber_reg_assocmap (HTL.mod_externctrl m);

    do _ <- clear_regmap;

    match zle (Z.pos (max_pc_map mod_datapath')) Integers.Int.max_unsigned,
          zle (Z.pos (max_pc_map mod_controllogic')) Integers.Int.max_unsigned,
          decide_order mod_st' mod_finish' mod_return' mod_stk' mod_start' mod_reset' mod_clk',
          max_list_dec mod_params' mod_st',
          decide_ram_wf mod_clk' mod_ram' with
    | left LEDATA, left LECTRL, left MORD, left WFPARAMS, left WFRAM =>
      ret (HTL.mkmodule
          mod_params'
          mod_datapath'
          mod_controllogic'
          (HTL.mod_entrypoint m)
          mod_st'
          mod_stk'
          (HTL.mod_stk_len m)
          mod_finish'
          mod_return'
          mod_start'
          mod_reset'
          mod_clk'
          mod_scldecls'
          mod_arrdecls'
          mod_externctrl'
          mod_ram'
          (conj (max_pc_wf _ _ LECTRL) (max_pc_wf _ _ LEDATA))
          MORD
          WFRAM
          WFPARAMS)
    | right _, _, _, _, _ => error (Errors.msg "Renaming: More than 2^32 datapath states")
    | _, right _, _, _, _ => error (Errors.msg "Renaming: More than 2^32 controlpath states")
    | _, _, right _, _, _ => error (Errors.msg "Renaming: Incorrect ordering of control registers")
    | _, _, _, right _, _ => error (Errors.msg "Renaming: Parameter registers conflict with control registers")
    | _, _, _, _, right _ => error (Errors.msg "Renaming: Ram address register conflicts with control registers")
    end.

Definition renumber_fundef (fundef : HTL.fundef) : mon HTL.fundef :=
  match fundef with
  | Internal m => do renumbered <- renumber_module m; ret (Internal renumbered)
  | _ => ret fundef
  end.

Section TRANSF_PROGRAM_STATEFUL.
  Import RenumberMonad.
  Import RenumberState.
  Import RenumberMonadExtra.
  Import MonadNotation.

  Variables A B V : Type.
  Variable transf_fun: ident -> A -> RenumberMonad.mon B.

  Fixpoint transf_globdefs (l: list (ident * globdef A V)) : RenumberMonad.mon (list (ident * globdef B V)) :=
    match l with
    | nil => RenumberMonad.ret nil
    | (id, Gfun f) :: l' =>
      do tf <- transf_fun id f;
      do tl' <- transf_globdefs l';
      RenumberMonad.ret ((id, Gfun tf) :: tl')
    | (id, Gvar v) :: l' =>
      do tl' <- transf_globdefs l';
      RenumberMonad.ret ((id, Gvar v) :: tl')
    end.

  Definition transform_stateful_program (init_state : RenumberState.st) (p: AST.program A V) : Errors.res (AST.program B V) :=
    RenumberMonad.run_mon init_state (
                        do gl' <- transf_globdefs p.(prog_defs);
                        RenumberMonad.ret (mkprogram gl' p.(prog_public) p.(prog_main))).

End TRANSF_PROGRAM_STATEFUL.

Definition transf_program (p : HTL.program) : Errors.res HTL.program :=
  transform_stateful_program _ _ _
                              (fun _ f => renumber_fundef f)
                              (mk_renumber_state 2%positive (PTree.empty reg))
                              p.

Definition match_prog : HTL.program -> HTL.program -> Prop := fun _ _ => True.

Instance TransfRenamingLink : Linking.TransfLink match_prog.
Admitted.

Lemma transf_program_match : forall p tp,
  Renaming.transf_program p = Errors.OK tp -> match_prog p tp.
Admitted.

Lemma transf_program_correct : forall p tp,
  match_prog p tp -> Smallstep.forward_simulation (HTL.semantics p) (HTL.semantics tp).
Admitted.