Chris@82: (*
Chris@82:  * Copyright (c) 1997-1999 Massachusetts Institute of Technology
Chris@82:  * Copyright (c) 2003, 2007-14 Matteo Frigo
Chris@82:  * Copyright (c) 2003, 2007-14 Massachusetts Institute of Technology
Chris@82:  *
Chris@82:  * This program is free software; you can redistribute it and/or modify
Chris@82:  * it under the terms of the GNU General Public License as published by
Chris@82:  * the Free Software Foundation; either version 2 of the License, or
Chris@82:  * (at your option) any later version.
Chris@82:  *
Chris@82:  * This program is distributed in the hope that it will be useful,
Chris@82:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@82:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@82:  * GNU General Public License for more details.
Chris@82:  *
Chris@82:  * You should have received a copy of the GNU General Public License
Chris@82:  * along with this program; if not, write to the Free Software
Chris@82:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
Chris@82:  *
Chris@82:  *)
Chris@82: 
Chris@82: (* utilities common to all generators *)
Chris@82: open Util
Chris@82: 
Chris@82: let choose_simd a b = if !Simdmagic.simd_mode then b else a
Chris@82: 
Chris@82: let unique_array n = array n (fun _ -> Unique.make ())
Chris@82: let unique_array_c n = 
Chris@82:   array n (fun _ -> 
Chris@82:     (Unique.make (), Unique.make ()))
Chris@82: 
Chris@82: let unique_v_array_c veclen n = 
Chris@82:   array veclen (fun _ ->
Chris@82:     unique_array_c n)
Chris@82: 
Chris@82: let locative_array_c n rarr iarr loc vs = 
Chris@82:   array n (fun i -> 
Chris@82:     let klass = Unique.make () in
Chris@82:     let (rloc, iloc) = loc i in
Chris@82:     (Variable.make_locative rloc klass rarr i vs,
Chris@82:      Variable.make_locative iloc klass iarr i vs))
Chris@82: 
Chris@82: let locative_v_array_c veclen n rarr iarr loc vs = 
Chris@82:   array veclen (fun v ->
Chris@82:     array n (fun i -> 
Chris@82:       let klass = Unique.make () in
Chris@82:       let (rloc, iloc) = loc v i in
Chris@82:       (Variable.make_locative rloc klass (rarr v) i vs,
Chris@82:        Variable.make_locative iloc klass (iarr v) i vs)))
Chris@82: 
Chris@82: let temporary_array n = 
Chris@82:   array n (fun i -> Variable.make_temporary ())
Chris@82: 
Chris@82: let temporary_array_c n = 
Chris@82:   let tmpr = temporary_array n
Chris@82:   and tmpi = temporary_array n
Chris@82:   in 
Chris@82:   array n (fun i -> (tmpr i, tmpi i))
Chris@82: 
Chris@82: let temporary_v_array_c veclen n =
Chris@82:   array veclen (fun v -> temporary_array_c n)
Chris@82: 
Chris@82: let temporary_array_c n = 
Chris@82:   let tmpr = temporary_array n
Chris@82:   and tmpi = temporary_array n
Chris@82:   in 
Chris@82:   array n (fun i -> (tmpr i, tmpi i))
Chris@82: 
Chris@82: let load_c (vr, vi) = Complex.make (Expr.Load vr, Expr.Load vi)
Chris@82: let load_r (vr, vi) = Complex.make (Expr.Load vr, Expr.Num (Number.zero))
Chris@82: 
Chris@82: let twiddle_array nt w =
Chris@82:   array (nt/2) (fun i ->
Chris@82:     let stride = choose_simd (C.SInteger 1) (C.SConst "TWVL") 
Chris@82:     and klass = Unique.make () in
Chris@82:     let (refr, refi) = (C.array_subscript w stride (2 * i),
Chris@82: 			C.array_subscript w stride (2 * i + 1))
Chris@82:     in
Chris@82:     let (kr, ki) = (Variable.make_constant klass refr,
Chris@82: 		    Variable.make_constant klass refi)  
Chris@82:     in
Chris@82:     load_c (kr, ki))
Chris@82: 
Chris@82: 
Chris@82: let load_array_c n var = array n (fun i -> load_c (var i))
Chris@82: let load_array_r n var = array n (fun i -> load_r (var i))
Chris@82: let load_array_hc n var = 
Chris@82:   array n (fun i -> 
Chris@82:     if (i < n - i) then
Chris@82:       load_c (var i)
Chris@82:     else if (i > n - i) then
Chris@82:       Complex.times Complex.i (load_c (var (n - i)))
Chris@82:     else
Chris@82:       load_r (var i))
Chris@82: 
Chris@82: let load_v_array_c veclen n var =
Chris@82:   array veclen (fun v -> load_array_c n (var v))
Chris@82: 
Chris@82: let store_c (vr, vi) x = [Complex.store_real vr x; Complex.store_imag vi x]
Chris@82: let store_r (vr, vi) x = Complex.store_real vr x
Chris@82: let store_i (vr, vi) x = Complex.store_imag vi x
Chris@82: 
Chris@82: let assign_array_c n dst src =
Chris@82:   List.flatten
Chris@82:     (rmap (iota n)
Chris@82:        (fun i ->
Chris@82: 	 let (ar, ai) = Complex.assign (dst i) (src i)
Chris@82: 	 in [ar; ai]))
Chris@82: let assign_v_array_c veclen n dst src =
Chris@82:   List.flatten
Chris@82:     (rmap (iota veclen)
Chris@82:        (fun v ->
Chris@82: 	 assign_array_c n (dst v) (src v)))
Chris@82: 
Chris@82: let vassign_v_array_c veclen n dst src =
Chris@82:   List.flatten
Chris@82:     (rmap (iota n) (fun i ->
Chris@82:       List.flatten
Chris@82: 	(rmap (iota veclen)
Chris@82: 	   (fun v ->
Chris@82: 	     let (ar, ai) = Complex.assign (dst v i) (src v i)
Chris@82: 	     in [ar; ai]))))
Chris@82: 
Chris@82: let store_array_r n dst src =
Chris@82:   rmap (iota n)
Chris@82:     (fun i -> store_r (dst i) (src i))
Chris@82: 
Chris@82: let store_array_c n dst src =
Chris@82:   List.flatten
Chris@82:     (rmap (iota n)
Chris@82:        (fun i -> store_c (dst i) (src i)))
Chris@82: 
Chris@82: let store_array_hc n dst src =
Chris@82:   List.flatten
Chris@82:     (rmap (iota n)
Chris@82:        (fun i -> 
Chris@82: 	 if (i < n - i) then
Chris@82: 	   store_c (dst i) (src i)
Chris@82: 	 else if (i > n - i) then
Chris@82: 	   []
Chris@82: 	 else 
Chris@82: 	   [store_r (dst i) (Complex.real (src i))]))
Chris@82: 	
Chris@82: 
Chris@82: let store_v_array_c veclen n dst src =
Chris@82:   List.flatten
Chris@82:     (rmap (iota veclen)
Chris@82:        (fun v ->
Chris@82: 	 store_array_c n (dst v) (src v)))
Chris@82: 
Chris@82: 
Chris@82: let elementwise f n a = array n (fun i -> f (a i))
Chris@82: let conj_array_c = elementwise Complex.conj
Chris@82: let real_array_c = elementwise Complex.real
Chris@82: let imag_array_c = elementwise Complex.imag
Chris@82: 
Chris@82: let elementwise_v f veclen n a = 
Chris@82:   array veclen (fun v ->
Chris@82:     array n (fun i -> f (a v i)))
Chris@82: let conj_v_array_c = elementwise_v Complex.conj
Chris@82: let real_v_array_c = elementwise_v Complex.real
Chris@82: let imag_v_array_c = elementwise_v Complex.imag
Chris@82: 
Chris@82: 
Chris@82: let transpose f i j = f j i
Chris@82: let symmetrize f i j = if i <= j then f i j else f j i
Chris@82: 
Chris@82: (* utilities for command-line parsing *)
Chris@82: let standard_arg_parse_fail _ = failwith "too many arguments"
Chris@82: 
Chris@82: let dump_dag alist =
Chris@82:   let fnam = !Magic.dag_dump_file in
Chris@82:   if (String.length fnam > 0) then
Chris@82:     let ochan = open_out fnam in
Chris@82:     begin
Chris@82:       To_alist.dump (output_string ochan) alist;
Chris@82:       close_out ochan;
Chris@82:     end
Chris@82: 
Chris@82: let dump_alist alist =
Chris@82:   let fnam = !Magic.alist_dump_file in
Chris@82:   if (String.length fnam > 0) then
Chris@82:     let ochan = open_out fnam in
Chris@82:     begin
Chris@82:       Expr.dump (output_string ochan) alist;
Chris@82:       close_out ochan;
Chris@82:     end
Chris@82: 
Chris@82: let dump_asched asched =
Chris@82:   let fnam = !Magic.asched_dump_file in
Chris@82:   if (String.length fnam > 0) then
Chris@82:     let ochan = open_out fnam in
Chris@82:     begin
Chris@82:       Annotate.dump (output_string ochan) asched;
Chris@82:       close_out ochan;
Chris@82:     end
Chris@82: 
Chris@82: (* utilities for optimization *)
Chris@82: let standard_scheduler dag =
Chris@82:   let optim = Algsimp.algsimp dag in
Chris@82:   let alist = To_alist.to_assignments optim in
Chris@82:   let _ = dump_alist alist in
Chris@82:   let _ = dump_dag alist in
Chris@82:     if !Magic.precompute_twiddles then
Chris@82:       Schedule.isolate_precomputations_and_schedule alist 
Chris@82:     else
Chris@82:       Schedule.schedule alist 
Chris@82: 
Chris@82: let standard_optimizer dag =
Chris@82:   let sched = standard_scheduler dag in
Chris@82:   let annot = Annotate.annotate [] sched in
Chris@82:   let _ = dump_asched annot in
Chris@82:   annot
Chris@82: 
Chris@82: let size = ref None
Chris@82: let sign = ref (-1)
Chris@82: 
Chris@82: let speclist = [
Chris@82:   "-n", Arg.Int(fun i -> size := Some i), " generate a codelet of size <n>";
Chris@82:   "-sign",
Chris@82:   Arg.Int(fun i -> 
Chris@82:     if (i > 0) then
Chris@82:       sign := 1
Chris@82:     else
Chris@82:       sign := (-1)),
Chris@82:   " sign of transform";
Chris@82: ]
Chris@82: 
Chris@82: let check_size () =
Chris@82:   match !size with
Chris@82:   | Some i -> i
Chris@82:   | None -> failwith "must specify -n"
Chris@82: 
Chris@82: let expand_name name = if name = "" then "noname" else name
Chris@82: 
Chris@82: let declare_register_fcn name =
Chris@82:   if name = "" then
Chris@82:     "void NAME(planner *p)\n"
Chris@82:   else 
Chris@82:     "void " ^ (choose_simd "X" "XSIMD") ^
Chris@82:       "(codelet_" ^ name ^ ")(planner *p)\n"
Chris@82: 
Chris@82: let stringify name = 
Chris@82:   if name = "" then "STRINGIZE(NAME)" else 
Chris@82:     choose_simd ("\"" ^ name ^ "\"")
Chris@82:       ("XSIMD_STRING(\"" ^ name ^ "\")")
Chris@82: 
Chris@82: let parse user_speclist usage =
Chris@82:   Arg.parse
Chris@82:     (user_speclist @ speclist @ Magic.speclist @ Simdmagic.speclist)
Chris@82:     standard_arg_parse_fail
Chris@82:     usage
Chris@82: 
Chris@82: let rec list_to_c = function
Chris@82:     [] -> ""
Chris@82:   | [a] -> (string_of_int a)
Chris@82:   | a :: b -> (string_of_int a) ^ ", " ^ (list_to_c b)
Chris@82: 
Chris@82: let rec list_to_comma = function
Chris@82:   | [a; b] -> C.Comma (a, b)
Chris@82:   | a :: b -> C.Comma (a, list_to_comma b)
Chris@82:   | _ -> failwith "list_to_comma"
Chris@82: 
Chris@82: 
Chris@82: type stride = Stride_variable | Fixed_int of int | Fixed_string of string
Chris@82: 
Chris@82: let either_stride a b =
Chris@82:   match a with
Chris@82:     Fixed_int x -> C.SInteger x
Chris@82:   | Fixed_string x -> C.SConst x
Chris@82:   | _ -> b
Chris@82: 
Chris@82: let stride_fixed = function
Chris@82:     Stride_variable -> false
Chris@82:   | _ -> true
Chris@82: 
Chris@82: let arg_to_stride s =
Chris@82:   try
Chris@82:     Fixed_int (int_of_string s)
Chris@82:   with Failure "int_of_string" -> 
Chris@82:     Fixed_string s
Chris@82: 
Chris@82: let stride_to_solverparm = function
Chris@82:     Stride_variable -> "0"
Chris@82:   | Fixed_int x -> string_of_int x
Chris@82:   | Fixed_string x -> x
Chris@82: 
Chris@82: let stride_to_string s = function
Chris@82:     Stride_variable -> s
Chris@82:   | Fixed_int x -> string_of_int x
Chris@82:   | Fixed_string x -> x
Chris@82: 
Chris@82: (* output the command line *)
Chris@82: let cmdline () =
Chris@82:   List.fold_right (fun a b -> a ^ " " ^ b) (Array.to_list Sys.argv) ""
Chris@82: 
Chris@82: let unparse tree =
Chris@82:   "/* Generated by: " ^ (cmdline ()) ^ "*/\n\n" ^
Chris@82:   (C.print_cost tree) ^
Chris@82:   (if String.length !Magic.inklude > 0 
Chris@82:   then
Chris@82:     (Printf.sprintf "#include \"%s\"\n\n" !Magic.inklude)
Chris@82:   else "") ^
Chris@82:   (if !Simdmagic.simd_mode then
Chris@82:     Simd.unparse_function tree
Chris@82:   else
Chris@82:     C.unparse_function tree)
Chris@82: 
Chris@82: let finalize_fcn ast = 
Chris@82:   let mergedecls = function
Chris@82:       C.Block (d1, [C.Block (d2, s)]) -> C.Block (d1 @ d2, s)
Chris@82:     | x -> x
Chris@82:   and extract_constants =
Chris@82:     if !Simdmagic.simd_mode then 
Chris@82:       Simd.extract_constants 
Chris@82:     else
Chris@82:       C.extract_constants
Chris@82: 	
Chris@82:   in mergedecls (C.Block (extract_constants ast, [ast; C.Simd_leavefun]))
Chris@82: 
Chris@82: let twinstr_to_string vl x =
Chris@82:   if !Simdmagic.simd_mode then 
Chris@82:     Twiddle.twinstr_to_simd_string vl x
Chris@82:   else
Chris@82:     Twiddle.twinstr_to_c_string x
Chris@82: 
Chris@82: let make_volatile_stride n x = 
Chris@82:   C.CCall ("MAKE_VOLATILE_STRIDE", C.Comma((C.Integer n), x))