Update and cleanup HiPE records

The bulk of the changes concerns cleanups and code refactorings concerning
record constructions that assigned 'undefined' to record fields whose type
did not contain this value. See commit 8ce35b2.

While at it, some new type definitions were introduced and type names were
used instead of record type notation.  Minor code cleaups were also done.

10 files changed, 65 insertions, 59 deletions

diff --git a/lib/hipe/cerl/cerl_cconv.erl b/lib/hipe/cerl/cerl_cconv.erl
index 0fc28be5f3..ac9d01ab0e 100644
--- a/lib/hipe/cerl/cerl_cconv.erl
+++ b/lib/hipe/cerl/cerl_cconv.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2004-2009. All Rights Reserved.
+%% Copyright Ericsson AB 2004-2015. All Rights Reserved.
 %% 
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -710,7 +710,7 @@ ren__new() ->
 ren__add(Key, Value, Ren) ->
     dict:store(Key, Value, Ren).
 
-ren__map(Key, Ren) ->  
+ren__map(Key, Ren) ->
     case dict:find(Key, Ren) of
 	{ok, Value} ->
 	    Value;
@@ -722,11 +722,14 @@ ren__map(Key, Ren) ->
 %% ---------------------------------------------------------------------
 %% State
 
--record(state, {module :: module(), function :: {atom(), arity()},
-		names, refs, defs = []}).
+-record(state, {module             :: module(),
+		function           :: {atom(), arity()} | 'undefined',
+		names = sets:new() :: sets:set(),  %% XXX: refine
+		refs  = dict:new() :: dict:dict(), %% XXX: refine
+		defs  = []}).
 
 s__new(Module) ->
-    #state{module = Module, names = sets:new(), refs = dict:new()}.
+    #state{module = Module}.
 
 s__add_function_name(Name, S) ->
     S#state{names = sets:add_element(Name, S#state.names)}.
diff --git a/lib/hipe/cerl/cerl_hipeify.erl b/lib/hipe/cerl/cerl_hipeify.erl
index 8691e80cac..6611abd204 100644
--- a/lib/hipe/cerl/cerl_hipeify.erl
+++ b/lib/hipe/cerl/cerl_hipeify.erl
@@ -1,7 +1,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2003-2012. All Rights Reserved.
+%% Copyright Ericsson AB 2003-2015. All Rights Reserved.
 %% 
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -623,12 +623,12 @@ ren__map(Key, Ren) ->
 %% ---------------------------------------------------------------------
 %% State
 
-%% pmatch = 'true' | 'false' | 'no_duplicates' | 'duplicate_all'
+-type pmatch() :: 'true' | 'false' | 'no_duplicates' | 'duplicate_all'.
 
--record(state, {module::atom(),
-		function::{atom(), 0..256},
-		pmatch=true,
-		revisit = false}).
+-record(state, {module          :: module(),
+		function        :: {atom(), arity()} | 'undefined',
+		pmatch = true   :: pmatch(),
+		revisit = false :: boolean()}).
 
 s__new(Module) ->
     #state{module = Module}.
diff --git a/lib/hipe/flow/cfg.hrl b/lib/hipe/flow/cfg.hrl
index f79fff4efe..641ec102db 100644
--- a/lib/hipe/flow/cfg.hrl
+++ b/lib/hipe/flow/cfg.hrl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2007-2014. All Rights Reserved.
+%% Copyright Ericsson AB 2007-2015. All Rights Reserved.
 %% 
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -34,11 +34,13 @@
 %%
 -record(cfg_info, {'fun'         :: mfa(),
                    start_label   :: cfg_lbl(),
+                   %% TODO: merge is_closure and closure_arity into one field
                    is_closure    :: boolean(),
-                   closure_arity :: arity(),
+                   closure_arity = none :: 'none' | arity(),
                    is_leaf       :: boolean(),
                    params,     % :: list()
                    info = []}).  %% this field seems not needed; take out??
+-type cfg_info() :: #cfg_info{}.
 
 %%
 %% Data is a triple with a dict of constants, a list of labels and an integer
@@ -49,6 +51,6 @@
 %% The following is to be used by other modules
 %%
 -record(cfg, {table = gb_trees:empty() :: gb_trees:tree(),
-              info                     :: #cfg_info{},
+              info                     :: cfg_info(),
               data                     :: cfg_data()}).
 -type cfg() :: #cfg{}.
diff --git a/lib/hipe/icode/hipe_icode.erl b/lib/hipe/icode/hipe_icode.erl
index 5c7003b0ed..9692eebb10 100644
--- a/lib/hipe/icode/hipe_icode.erl
+++ b/lib/hipe/icode/hipe_icode.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2001-2013. All Rights Reserved.
+%% Copyright Ericsson AB 2001-2015. All Rights Reserved.
 %%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -631,59 +631,59 @@ mk_icode(Fun, Params, IsClosure, IsLeaf, Code, VarRange, LabelRange) ->
 
 -spec mk_icode(mfa(), [icode_var()], boolean(), boolean(), [icode_instr()],
 	       hipe_consttab(), {non_neg_integer(),non_neg_integer()}, 
-	       {icode_lbl(),icode_lbl()}) -> #icode{}.
+	       {icode_lbl(),icode_lbl()}) -> icode().
 mk_icode(Fun, Params, IsClosure, IsLeaf, Code, Data, VarRange, LabelRange) ->
   #icode{'fun'=Fun, params=Params, code=Code,
 	 data=Data, is_closure=IsClosure, is_leaf=IsLeaf,
 	 var_range=VarRange, label_range=LabelRange}.
 
--spec icode_fun(#icode{}) -> mfa().
+-spec icode_fun(icode()) -> mfa().
 icode_fun(#icode{'fun' = MFA}) -> MFA.
 
--spec icode_params(#icode{}) -> [icode_var()].
+-spec icode_params(icode()) -> [icode_var()].
 icode_params(#icode{params = Params}) -> Params.
 
--spec icode_params_update(#icode{}, [icode_var()]) -> #icode{}.
+-spec icode_params_update(icode(), [icode_var()]) -> icode().
 icode_params_update(Icode, Params) -> 
   Icode#icode{params = Params}.
 
--spec icode_is_closure(#icode{}) -> boolean().
+-spec icode_is_closure(icode()) -> boolean().
 icode_is_closure(#icode{is_closure = Closure}) -> Closure.
 
--spec icode_is_leaf(#icode{}) -> boolean().
+-spec icode_is_leaf(icode()) -> boolean().
 icode_is_leaf(#icode{is_leaf = Leaf}) -> Leaf.
 
--spec icode_code(#icode{}) -> icode_instrs().
+-spec icode_code(icode()) -> icode_instrs().
 icode_code(#icode{code = Code}) -> Code.
 
--spec icode_code_update(#icode{}, icode_instrs()) -> #icode{}.
+-spec icode_code_update(icode(), icode_instrs()) -> icode().
 icode_code_update(Icode, NewCode) -> 
   Vmax = highest_var(NewCode),
   Lmax = highest_label(NewCode),
   Icode#icode{code = NewCode, var_range = {0,Vmax}, label_range = {0,Lmax}}.
 
--spec icode_data(#icode{}) -> hipe_consttab().
+-spec icode_data(icode()) -> hipe_consttab().
 icode_data(#icode{data=Data}) -> Data.
 
-%% %% -spec icode_data_update(#icode{}, hipe_consttab()) -> #icode{}.
+%% %% -spec icode_data_update(icode(), hipe_consttab()) -> icode().
 %% icode_data_update(Icode, NewData) -> Icode#icode{data=NewData}.
 
--spec icode_var_range(#icode{}) -> {non_neg_integer(), non_neg_integer()}.
+-spec icode_var_range(icode()) -> {non_neg_integer(), non_neg_integer()}.
 icode_var_range(#icode{var_range = VarRange}) -> VarRange.
 
--spec icode_label_range(#icode{}) -> {non_neg_integer(), non_neg_integer()}.
+-spec icode_label_range(icode()) -> {non_neg_integer(), non_neg_integer()}.
 icode_label_range(#icode{label_range = LabelRange}) -> LabelRange.
 
--spec icode_info(#icode{}) -> icode_info().
+-spec icode_info(icode()) -> icode_info().
 icode_info(#icode{info = Info}) -> Info.
 
--spec icode_info_update(#icode{}, icode_info()) -> #icode{}.
+-spec icode_info_update(icode(), icode_info()) -> icode().
 icode_info_update(Icode, Info) -> Icode#icode{info = Info}.
 
--spec icode_closure_arity(#icode{}) -> arity().
+-spec icode_closure_arity(icode()) -> arity().
 icode_closure_arity(#icode{closure_arity = Arity}) -> Arity.
 
--spec icode_closure_arity_update(#icode{}, arity()) -> #icode{}.
+-spec icode_closure_arity_update(icode(), arity()) -> icode().
 icode_closure_arity_update(Icode, Arity) -> Icode#icode{closure_arity = Arity}.
   
 
@@ -1709,7 +1709,7 @@ mk_new_label() ->
 %% @doc Removes comments from Icode.
 %%
 
--spec strip_comments(#icode{}) -> #icode{}.
+-spec strip_comments(icode()) -> icode().
 strip_comments(ICode) ->
   icode_code_update(ICode, no_comments(icode_code(ICode))).
 
diff --git a/lib/hipe/icode/hipe_icode.hrl b/lib/hipe/icode/hipe_icode.hrl
index 9b24c4914e..3bb7bae019 100644
--- a/lib/hipe/icode/hipe_icode.hrl
+++ b/lib/hipe/icode/hipe_icode.hrl
@@ -170,8 +170,9 @@
 
 -record(icode, {'fun'		:: mfa(),
 		params		:: [icode_var()],
+		%% TODO: merge is_closure and closure_arity into one field
 		is_closure	:: boolean(),
-		closure_arity	:: arity(),
+		closure_arity = none	:: 'none' | arity(),
 		is_leaf 	:: boolean(),
 		code = []	:: icode_instrs(),
 		data		:: hipe_consttab(),
diff --git a/lib/hipe/icode/hipe_icode_exceptions.erl b/lib/hipe/icode/hipe_icode_exceptions.erl
index 41556ab80f..f03ce2faaa 100644
--- a/lib/hipe/icode/hipe_icode_exceptions.erl
+++ b/lib/hipe/icode/hipe_icode_exceptions.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2004-2014. All Rights Reserved.
+%% Copyright Ericsson AB 2004-2015. All Rights Reserved.
 %% 
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -85,7 +85,7 @@
 
 %%----------------------------------------------------------------------------
 
--spec fix_catches(#cfg{}) -> #cfg{}.
+-spec fix_catches(cfg()) -> cfg().
 
 fix_catches(CFG) ->
   {Map, State} = build_mapping(find_catches(init_state(CFG))),
@@ -393,10 +393,10 @@ get_renaming(C, Map) ->
 %%---------------------------------------------------------------------
 %% State abstraction
 
--record(state, {cfg					:: #cfg{},
+-record(state, {cfg					:: cfg(),
 		changed = false				:: boolean(),
-		succ					:: #cfg{},
-		pred					:: #cfg{},
+		succ					:: cfg(),
+		pred					:: cfg(),
 		start_labels				:: [icode_lbl(),...],
 		visited = hipe_icode_cfg:none_visited()	:: gb_sets:set(),
 		out     = gb_trees:empty()		:: gb_trees:tree(),
@@ -404,13 +404,8 @@ get_renaming(C, Map) ->
 	       }).
 
 init_state(CFG) ->
-  State = #state{cfg = CFG},
-  refresh_state_cache(State).
-
-refresh_state_cache(State) ->
-  CFG = State#state.cfg,
   SLs = [hipe_icode_cfg:start_label(CFG)],
-  State#state{succ = CFG, pred = CFG, start_labels = SLs}.
+  #state{cfg = CFG, succ = CFG, pred = CFG, start_labels = SLs}.
 
 get_cfg(State) ->
   State#state.cfg.
@@ -466,7 +461,8 @@ get_bb_code(L, State) ->
 set_bb_code(L, Code, State) ->
   CFG = State#state.cfg,
   CFG1 = hipe_icode_cfg:bb_add(CFG, L, hipe_bb:mk_bb(Code)),
-  refresh_state_cache(State#state{cfg = CFG1}).
+  SLs = [hipe_icode_cfg:start_label(CFG1)],
+  State#state{cfg = CFG1, succ = CFG1, pred = CFG1, start_labels = SLs}.
 
 get_new_catches_in(L, State) ->
   Ps = get_pred(L, State),
diff --git a/lib/hipe/icode/hipe_icode_ssa_struct_reuse.erl b/lib/hipe/icode/hipe_icode_ssa_struct_reuse.erl
index e350a6ff18..7613024787 100644
--- a/lib/hipe/icode/hipe_icode_ssa_struct_reuse.erl
+++ b/lib/hipe/icode/hipe_icode_ssa_struct_reuse.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2007-2014. All Rights Reserved.
+%% Copyright Ericsson AB 2007-2015. All Rights Reserved.
 %% 
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -314,7 +314,7 @@ node_create(Label, Pred, Succ) ->
 %% tree - the tree of nodes, with labels as keys and node records as values
 
 -record(nodes, {
-  domtree	                   :: hipe_dominators:domTree(),
+  domtree       = none             :: 'none' | hipe_dominators:domTree(),
   labels 	= none             :: 'none' | [icode_lbl()],
   postorder 	= none             :: 'none' | [icode_lbl()],            
   start_label	= none             :: 'none' | icode_lbl(),
@@ -390,7 +390,7 @@ update_del_red_test_set(Update) ->
 %%-----------------------------------------------------------------------------
 %% Main function called from the hipe_main module
 
--spec struct_reuse(#cfg{}) -> #cfg{}.
+-spec struct_reuse(cfg()) -> cfg().
 
 struct_reuse(CFG) ->
   %% debug_init_case_count(?SR_INSTR_TYPE),
diff --git a/lib/hipe/main/hipe.erl b/lib/hipe/main/hipe.erl
index 1a4bbf179f..0e32da1d36 100644
--- a/lib/hipe/main/hipe.erl
+++ b/lib/hipe/main/hipe.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2001-2013. All Rights Reserved.
+%% Copyright Ericsson AB 2001-2015. All Rights Reserved.
 %%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -764,7 +764,8 @@ finalize(OrigList, Mod, Exports, WholeModule, Opts) ->
 finalize_fun(MfaIcodeList, Exports, Opts) ->
   case proplists:get_value(concurrent_comp, Opts) of
     FalseVal when (FalseVal =:= undefined) orelse (FalseVal =:= false) ->
-      [finalize_fun_sequential(MFAIcode, Opts, #comp_servers{})
+      NoServers = #comp_servers{pp_server = none, range = none, type = none},
+      [finalize_fun_sequential(MFAIcode, Opts, NoServers)
        || {_MFA, _Icode} = MFAIcode <- MfaIcodeList];
     TrueVal when (TrueVal =:= true) orelse (TrueVal =:= debug) ->
       finalize_fun_concurrent(MfaIcodeList, Exports, Opts)
diff --git a/lib/hipe/main/hipe.hrl.src b/lib/hipe/main/hipe.hrl.src
index ba27878a84..3be824ac34 100644
--- a/lib/hipe/main/hipe.hrl.src
+++ b/lib/hipe/main/hipe.hrl.src
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2001-2011. All Rights Reserved.
+%% Copyright Ericsson AB 2001-2015. All Rights Reserved.
 %% 
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -299,7 +299,8 @@
 %% Records defined in the hipe module used in other parts of the compiler
 %%----------------------------------------------------------------------------
 
--record(comp_servers, {pp_server :: pid(), range :: pid(), type :: pid()}).
+-type mpid() :: 'none' | pid().
+-record(comp_servers, {pp_server :: mpid(), range :: mpid(), type :: mpid()}).
 
 %%----------------------------------------------------------------------------
 %% Basic types of the 'hipe' application used in other parts of the system
diff --git a/lib/hipe/main/hipe_main.erl b/lib/hipe/main/hipe_main.erl
index 5753169961..be5050e155 100644
--- a/lib/hipe/main/hipe_main.erl
+++ b/lib/hipe/main/hipe_main.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2001-2011. All Rights Reserved.
+%% Copyright Ericsson AB 2001-2015. All Rights Reserved.
 %%
 %% Licensed under the Apache License, Version 2.0 (the "License");
 %% you may not use this file except in compliance with the License.
@@ -55,7 +55,7 @@
 %%=====================================================================
 
 %% @spec compile_icode(MFA::mfa(),
-%%                     LinearIcode::#icode{},
+%%                     LinearIcode::icode(),
 %%                     CompilerOptions::comp_options(),
 %%		       CompServers::#comp_servers()) ->
 %%          {native,Platform,{unprofiled,NativeCode}} | {rtl,RTLCode}
@@ -69,7 +69,7 @@
 %% generated). The compiler options must have already been expanded
 %% (cf. `<a href="hipe.html">hipe:expand_options</a>'). </p>
 
--spec compile_icode(mfa(), #icode{}, comp_options(), #comp_servers{}) ->
+-spec compile_icode(mfa(), icode(), comp_options(), #comp_servers{}) ->
 	 comp_icode_ret().
 
 compile_icode(MFA, LinearIcode, Options, Servers) ->
@@ -230,10 +230,12 @@ get_pp_module(icode_liveness) -> hipe_icode_liveness;
 get_pp_module(rtl_liveness) -> hipe_rtl_liveness.
   
 perform_io(no_fun, _) -> ok;
-perform_io(Fun,PPServer) when is_pid(PPServer) ->
-  PPServer ! {print,Fun};
-perform_io(Fun, undefined) ->
-  Fun().
+perform_io(Fun, PPServer) when is_pid(PPServer) ->
+  PPServer ! {print, Fun},
+  ok;
+perform_io(Fun, none) ->
+  Fun(),
+  ok.
 
 
 %%--------------------------------------------------------------------