• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/vm/opto/idealKit.hpp@98cb887364d3 (annotated)

src/share/vm/opto/idealKit.hpp

Fri, 27 Feb 2009 13:27:09 -0800

author

twisti

date

Fri, 27 Feb 2009 13:27:09 -0800

changeset 1040

98cb887364d3

parent 435

a61af66fc99e

child 1286

fc4be448891f

permissions

-rw-r--r--

6810672: Comment typos
Summary: I have collected some typos I have found while looking at the code.
Reviewed-by: kvn, never

duke@435	1	/*
duke@435	2	* Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
duke@435	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435	4	*
duke@435	5	* This code is free software; you can redistribute it and/or modify it
duke@435	6	* under the terms of the GNU General Public License version 2 only, as
duke@435	7	* published by the Free Software Foundation.
duke@435	8	*
duke@435	9	* This code is distributed in the hope that it will be useful, but WITHOUT
duke@435	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@435	12	* version 2 for more details (a copy is included in the LICENSE file that
duke@435	13	* accompanied this code).
duke@435	14	*
duke@435	15	* You should have received a copy of the GNU General Public License version
duke@435	16	* 2 along with this work; if not, write to the Free Software Foundation,
duke@435	17	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435	18	*
duke@435	19	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@435	20	* CA 95054 USA or visit www.sun.com if you need additional information or
duke@435	21	* have any questions.
duke@435	22	*
duke@435	23	*/
duke@435	24
duke@435	25	//-----------------------------------------------------------------------------
duke@435	26	//----------------------------IdealKit-----------------------------------------
duke@435	27	// Set of utilities for creating control flow and scalar SSA data flow.
duke@435	28	// Control:
duke@435	29	// if_then(left, relop, right)
duke@435	30	// else_ (optional)
duke@435	31	// end_if
duke@435	32	// loop(iv variable, initial, relop, limit)
duke@435	33	// - sets iv to initial for first trip
duke@435	34	// - exits when relation on limit is true
duke@435	35	// - the values of initial and limit should be loop invariant
duke@435	36	// - no increment, must be explicitly coded
duke@435	37	// - final value of iv is available after end_loop (until dead())
duke@435	38	// end_loop
duke@435	39	// make_label(number of gotos)
duke@435	40	// goto_(label)
duke@435	41	// bind(label)
duke@435	42	// Data:
duke@435	43	// ConI(integer constant) - create an integer constant
duke@435	44	// set(variable, value) - assignment
duke@435	45	// value(variable) - reference value
duke@435	46	// dead(variable) - variable's value is no longer live
duke@435	47	// increment(variable, value) - increment variable by value
duke@435	48	// simple operations: AddI, SubI, AndI, LShiftI, etc.
duke@435	49	// Example:
duke@435	50	// Node* limit = ??
duke@435	51	// IdealVariable i(kit), j(kit);
duke@435	52	// declares_done();
duke@435	53	// Node* exit = make_label(1); // 1 goto
duke@435	54	// set(j, ConI(0));
duke@435	55	// loop(i, ConI(0), BoolTest::lt, limit); {
duke@435	56	// if_then(value(i), BoolTest::gt, ConI(5)) {
duke@435	57	// set(j, ConI(1));
duke@435	58	// goto_(exit); dead(i);
duke@435	59	// } end_if();
duke@435	60	// increment(i, ConI(1));
duke@435	61	// } end_loop(); dead(i);
duke@435	62	// bind(exit);
duke@435	63	//
duke@435	64	// See string_indexOf for a more complete example.
duke@435	65
duke@435	66	class IdealKit;
duke@435	67
duke@435	68	// Variable definition for IdealKit
duke@435	69	class IdealVariable: public StackObj {
duke@435	70	friend class IdealKit;
duke@435	71	private:
duke@435	72	int _id;
duke@435	73	void set_id(int id) { _id = id; }
duke@435	74	public:
duke@435	75	IdealVariable(IdealKit &k);
duke@435	76	int id() { assert(has_id(),"uninitialized id"); return _id; }
duke@435	77	bool has_id() { return _id >= 0; }
duke@435	78	};
duke@435	79
duke@435	80	class IdealKit: public StackObj {
duke@435	81	friend class IdealVariable;
duke@435	82	// The main state (called a cvstate for Control and Variables)
duke@435	83	// contains both the current values of the variables and the
duke@435	84	// current set of predecessor control edges. The variable values
duke@435	85	// are managed via a Node [in(1)..in(_var_ct)], and the predecessor
duke@435	86	// control edges managed via a RegionNode. The in(0) of the Node
duke@435	87	// for variables points to the RegionNode for the control edges.
duke@435	88	protected:
duke@435	89	Compile * const C;
duke@435	90	PhaseGVN &_gvn;
duke@435	91	GrowableArray<Node*>* _pending_cvstates; // stack of cvstates
duke@435	92	GrowableArray<Node*>* _delay_transform; // delay invoking gvn.transform until drain
duke@435	93	Node* _cvstate; // current cvstate (control, memory and variables)
duke@435	94	uint _var_ct; // number of variables
duke@435	95	bool _delay_all_transforms; // flag forcing all transforms to be delayed
duke@435	96	Node* _initial_ctrl; // saves initial control until variables declared
duke@435	97	Node* _initial_memory; // saves initial memory until variables declared
duke@435	98
duke@435	99	PhaseGVN& gvn() const { return _gvn; }
duke@435	100	// Create a new cvstate filled with nulls
duke@435	101	Node* new_cvstate(); // Create a new cvstate
duke@435	102	Node* cvstate() { return _cvstate; } // current cvstate
duke@435	103	Node* copy_cvstate(); // copy current cvstate
duke@435	104	void set_ctrl(Node* ctrl) { _cvstate->set_req(TypeFunc::Control, ctrl); }
duke@435	105
duke@435	106	// Should this assert this is a MergeMem???
duke@435	107	void set_all_memory(Node* mem){ _cvstate->set_req(TypeFunc::Memory, mem); }
duke@435	108	void set_memory(Node* mem, uint alias_idx );
duke@435	109	void do_memory_merge(Node* merging, Node* join);
duke@435	110	void clear(Node* m); // clear a cvstate
duke@435	111	void stop() { clear(_cvstate); } // clear current cvstate
duke@435	112	Node* delay_transform(Node* n);
duke@435	113	Node* transform(Node* n); // gvn.transform or push node on delay list
duke@435	114	Node* promote_to_phi(Node* n, Node* reg);// Promote "n" to a phi on region "reg"
duke@435	115	bool was_promoted_to_phi(Node* n, Node* reg) {
duke@435	116	return (n->is_Phi() && n->in(0) == reg);
duke@435	117	}
duke@435	118	void declare(IdealVariable* v) { v->set_id(_var_ct++); }
duke@435	119	// This declares the position where vars are kept in the cvstate
duke@435	120	// For some degree of consistency we use the TypeFunc enum to
duke@435	121	// soak up spots in the inputs even though we only use early Control
duke@435	122	// and Memory slots. (So far.)
duke@435	123	static const uint first_var; // = TypeFunc::Parms + 1;
duke@435	124
duke@435	125	#ifdef ASSERT
duke@435	126	enum State { NullS=0, BlockS=1, LoopS=2, IfThenS=4, ElseS=8, EndifS= 16 };
duke@435	127	GrowableArray<int>* _state;
duke@435	128	State state() { return (State)(_state->top()); }
duke@435	129	#endif
duke@435	130
duke@435	131	// Users should not care about slices only MergedMem so no access for them.
duke@435	132	Node* memory(uint alias_idx);
duke@435	133
duke@435	134	public:
duke@435	135	IdealKit(PhaseGVN &gvn, Node* control, Node* memory, bool delay_all_transforms = false);
duke@435	136	~IdealKit() {
duke@435	137	stop();
duke@435	138	drain_delay_transform();
duke@435	139	}
duke@435	140	// Control
duke@435	141	Node* ctrl() { return _cvstate->in(TypeFunc::Control); }
duke@435	142	Node* top() { return C->top(); }
duke@435	143	MergeMemNode* merged_memory() { return _cvstate->in(TypeFunc::Memory)->as_MergeMem(); }
duke@435	144	void set(IdealVariable& v, Node* rhs) { _cvstate->set_req(first_var + v.id(), rhs); }
duke@435	145	Node* value(IdealVariable& v) { return _cvstate->in(first_var + v.id()); }
duke@435	146	void dead(IdealVariable& v) { set(v, (Node*)NULL); }
duke@435	147	void if_then(Node* left, BoolTest::mask relop, Node* right,
duke@435	148	float prob = PROB_FAIR, float cnt = COUNT_UNKNOWN,
duke@435	149	bool push_new_state = true);
duke@435	150	void else_();
duke@435	151	void end_if();
duke@435	152	void loop(IdealVariable& iv, Node* init, BoolTest::mask cmp, Node* limit,
duke@435	153	float prob = PROB_LIKELY(0.9), float cnt = COUNT_UNKNOWN);
duke@435	154	void end_loop();
duke@435	155	Node* make_label(int goto_ct);
duke@435	156	void bind(Node* lab);
duke@435	157	void goto_(Node* lab, bool bind = false);
duke@435	158	void declares_done();
duke@435	159	void drain_delay_transform();
duke@435	160
duke@435	161	Node* IfTrue(IfNode* iff) { return transform(new (C,1) IfTrueNode(iff)); }
duke@435	162	Node* IfFalse(IfNode* iff) { return transform(new (C,1) IfFalseNode(iff)); }
duke@435	163
duke@435	164	// Data
duke@435	165	Node* ConI(jint k) { return (Node*)gvn().intcon(k); }
duke@435	166	Node* makecon(const Type *t) const { return _gvn.makecon(t); }
duke@435	167
duke@435	168	Node* AddI(Node* l, Node* r) { return transform(new (C,3) AddINode(l, r)); }
duke@435	169	Node* SubI(Node* l, Node* r) { return transform(new (C,3) SubINode(l, r)); }
duke@435	170	Node* AndI(Node* l, Node* r) { return transform(new (C,3) AndINode(l, r)); }
duke@435	171	Node* MaxI(Node* l, Node* r) { return transform(new (C,3) MaxINode(l, r)); }
duke@435	172	Node* LShiftI(Node* l, Node* r) { return transform(new (C,3) LShiftINode(l, r)); }
duke@435	173	Node* CmpI(Node* l, Node* r) { return transform(new (C,3) CmpINode(l, r)); }
duke@435	174	Node* Bool(Node* cmp, BoolTest::mask relop) { return transform(new (C,2) BoolNode(cmp, relop)); }
duke@435	175	void increment(IdealVariable& v, Node* j) { set(v, AddI(value(v), j)); }
duke@435	176	void decrement(IdealVariable& v, Node* j) { set(v, SubI(value(v), j)); }
duke@435	177
duke@435	178	Node* CmpL(Node* l, Node* r) { return transform(new (C,3) CmpLNode(l, r)); }
duke@435	179
duke@435	180	// TLS
duke@435	181	Node* thread() { return gvn().transform(new (C, 1) ThreadLocalNode()); }
duke@435	182
duke@435	183	// Pointers
duke@435	184	Node* AddP(Node *base, Node *ptr, Node *off) { return transform(new (C,4) AddPNode(base, ptr, off)); }
duke@435	185	Node* CmpP(Node* l, Node* r) { return transform(new (C,3) CmpPNode(l, r)); }
duke@435	186	#ifdef _LP64
duke@435	187	Node* XorX(Node* l, Node* r) { return transform(new (C,3) XorLNode(l, r)); }
duke@435	188	#else // _LP64
duke@435	189	Node* XorX(Node* l, Node* r) { return transform(new (C,3) XorINode(l, r)); }
duke@435	190	#endif // _LP64
duke@435	191	Node* URShiftX(Node* l, Node* r) { return transform(new (C,3) URShiftXNode(l, r)); }
duke@435	192	Node* ConX(jint k) { return (Node*)gvn().MakeConX(k); }
duke@435	193	Node* CastPX(Node* ctl, Node* p) { return transform(new (C,2) CastP2XNode(ctl, p)); }
duke@435	194	// Add a fixed offset to a pointer
duke@435	195	Node* basic_plus_adr(Node* base, Node* ptr, intptr_t offset);
duke@435	196
duke@435	197	// Memory operations
duke@435	198
duke@435	199	// This is the base version which is given an alias index.
duke@435	200	Node* load(Node* ctl,
duke@435	201	Node* adr,
duke@435	202	const Type* t,
duke@435	203	BasicType bt,
duke@435	204	int adr_idx,
duke@435	205	bool require_atomic_access = false);
duke@435	206
duke@435	207	// Return the new StoreXNode
duke@435	208	Node* store(Node* ctl,
duke@435	209	Node* adr,
duke@435	210	Node* val,
duke@435	211	BasicType bt,
duke@435	212	int adr_idx,
duke@435	213	bool require_atomic_access = false);
duke@435	214
duke@435	215	// Store a card mark ordered after store_oop
duke@435	216	Node* storeCM(Node* ctl,
duke@435	217	Node* adr,
duke@435	218	Node* val,
duke@435	219	Node* oop_store,
duke@435	220	BasicType bt,
duke@435	221	int adr_idx);
duke@435	222
duke@435	223	// Trivial call
duke@435	224	void make_leaf_call(const TypeFunc *slow_call_type,
duke@435	225	address slow_call,
duke@435	226	const char *leaf_name,
duke@435	227	Node* parm0,
duke@435	228	Node* parm1 = NULL,
duke@435	229	Node* parm2 = NULL);
duke@435	230	};