irnode.h 61.1 KB
Newer Older
Christian Würdig's avatar
Christian Würdig committed
1
/*
2
 * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
Christian Würdig's avatar
Christian Würdig committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 *
 * This file is part of libFirm.
 *
 * This file may be distributed and/or modified under the terms of the
 * GNU General Public License version 2 as published by the Free Software
 * Foundation and appearing in the file LICENSE.GPL included in the
 * packaging of this file.
 *
 * Licensees holding valid libFirm Professional Edition licenses may use
 * this file in accordance with the libFirm Commercial License.
 * Agreement provided with the Software.
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */

Matthias Braun's avatar
Matthias Braun committed
20
21
22
23
24
/**
 * @file
 * @brief   Representation of an intermediate operation.
 * @author  Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Michael Beck
 * @version $Id$
Michael Beck's avatar
Michael Beck committed
25
 */
Matthias Braun's avatar
Matthias Braun committed
26
27
#ifndef FIRM_IR_IRNODE_H
#define FIRM_IR_IRNODE_H
Christian Schäfer's avatar
Christian Schäfer committed
28

29
30
#include <stddef.h>

Michael Beck's avatar
Michael Beck committed
31
#include "firm_common.h"
32
#include "typerep.h"
Michael Beck's avatar
Michael Beck committed
33
34
#include "irop.h"
#include "irmode.h"
Christian Schäfer's avatar
Christian Schäfer committed
35

Michael Beck's avatar
Michael Beck committed
36
37
/**
 * @file irnode.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
38
 *
Michael Beck's avatar
Michael Beck committed
39
 * @author Martin Trapp, Christian Schaefer
Götz Lindenmaier's avatar
Götz Lindenmaier committed
40
 *
Michael Beck's avatar
Michael Beck committed
41
42
43
44
45
46
 * Declarations of an ir node.
 */

/**
 * @defgroup ir_node Declarations of an ir node.
 *
47
 * The type definition of ir_node is also in irgraph.h to resolve
Michael Beck's avatar
Michael Beck committed
48
 *  recursion between irnode.h and irgraph.h
Götz Lindenmaier's avatar
Götz Lindenmaier committed
49
 *
Michael Beck's avatar
Michael Beck committed
50
 * ir_node - a datatype representing a Firm node
Götz Lindenmaier's avatar
Götz Lindenmaier committed
51
 *
Michael Beck's avatar
Michael Beck committed
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 *  The common fields are:
 *
 *  - firm_kind - A firm_kind tag containing k_type.  This is useful
 *                for dynamically checking whether a node is a ir_node.
 *  - arity     - The number of predecessors in the Firm graph.
 *  - in        - A list with the predecessors in the Firm graph.  There are
 *                routines to access individual elements and to obtain the
 *                array.  The method returning the array should not be used.
 *  - mode      - The mode of the node.  There are routines to get the mode
 *                but also to access the mode's fields directly.
 *  - opcode    - The opcode of the node. There are routines to get the opcode
 *                but also to access the opcode's fields directly.
 *  - node_nr   - A unique number for the node.  Available only if debugging
 *                is turned on.
 * @{
Götz Lindenmaier's avatar
Götz Lindenmaier committed
67
 */
Michael Beck's avatar
Michael Beck committed
68

Sebastian Felis's avatar
Sebastian Felis committed
69
/**
70
 * Some projection numbers must be always equal to support automatic phi construction
Michael Beck's avatar
Michael Beck committed
71
 */
72
73
74
75
76
77
enum pn_generic {
	pn_Generic_M_regular = 0,  /**< The memory result. */
	pn_Generic_X_regular = 1,  /**< Execution result if no exception occurred. */
	pn_Generic_X_except  = 2,  /**< The control flow result branching to the exception handler */
	pn_Generic_other     = 3   /**< First free projection number */
};
Christian Schäfer's avatar
Christian Schäfer committed
78

Sebastian Felis's avatar
Sebastian Felis committed
79
80
81
/**
 *   Checks whether a pointer points to a ir node.
 *
82
83
 *   @param thing   an arbitrary pointer
 *   @return        non-zero if the thing is a ir mode, else zero
Sebastian Felis's avatar
Sebastian Felis committed
84
 */
85
int is_ir_node (const void *thing);
Sebastian Felis's avatar
Sebastian Felis committed
86

87
88
89
90
91
/**
 * Returns the number of predecessors without the block predecessor.
 *
 * @param node   the IR-node
 */
92
93
94
int get_irn_arity      (const ir_node *node);
int get_irn_intra_arity(const ir_node *node);
int get_irn_inter_arity(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
95
96

/** Replaces the old in array by a new one that will contain the ins given in
97
   the parameters.  Conserves the block predecessor.  It copies the array passed.
98
   This function is necessary to adjust in arrays of blocks, calls and phis.
99
   Assumes that current_ir_graph is set to the graph containing "node".
100
101
   "in" must contain all predecessors except the block that are required for
   the nodes opcode. */
102
void set_irn_in(ir_node *node, int arity, ir_node *in[]);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
103

Christian Schäfer's avatar
Christian Schäfer committed
104
105
106
/* to iterate through the predecessors without touching the array. No
   order of predecessors guaranteed.
   To iterate over the operands iterate from 0 to i < get_irn_arity(),
Götz Lindenmaier's avatar
Götz Lindenmaier committed
107
   to iterate including the Block predecessor iterate from i = -1 to
Christian Schäfer's avatar
Christian Schäfer committed
108
   i < get_irn_arity. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
109
/* Access predecessor n */
110
111
112
113

/**
 * Get the n-th predecessor of a node.
 * This function removes Id predecessors.
Michael Beck's avatar
Michael Beck committed
114
 * This function automatically handles intra- and interprocedural views.
115
 */
116
ir_node *get_irn_n(const ir_node *node, int n);
Michael Beck's avatar
Michael Beck committed
117

Sebastian Hack's avatar
Sebastian Hack committed
118
119
120
/**
* Add a artificial dependency to the node.
* The dependency is only inserted if it is not there already.
121
122
* This is only allowed in phase_backend!
*
Sebastian Hack's avatar
Sebastian Hack committed
123
124
* @param node The node.
* @param dep  The dependency target.
125
*
Sebastian Hack's avatar
Sebastian Hack committed
126
127
128
129
130
131
* @return The index in the array (get_irn_dep() with that index returns @p dep).
*/
int add_irn_dep(ir_node *node, ir_node *dep);

/**
 * Copy all dependencies from a node to another.
132
133
 * This is only allowed in phase_backend!
 *
134
 * @param tgt The node which should be enriched.
Sebastian Hack's avatar
Sebastian Hack committed
135
136
137
138
139
 * @param src The node whose dependencies shall be copied.
 */
void add_irn_deps(ir_node *tgt, ir_node *src);

/**
Michael Beck's avatar
Michael Beck committed
140
141
142
143
 * Get the length of the dependency array.
 * @param node The node.
 * @return The length of the dependency array or 0 if it has not yet been allocated.
 */
Sebastian Hack's avatar
Sebastian Hack committed
144
145
146
int get_irn_deps(const ir_node *node);

/**
Michael Beck's avatar
Michael Beck committed
147
148
149
150
151
 * Get an entry of the dependency array.
 * @param node The node.
 * @param pos  The position.
 * @return The node at that position.
 */
Sebastian Hack's avatar
Sebastian Hack committed
152
153
154
ir_node *get_irn_dep(const ir_node *node, int pos);

/**
Michael Beck's avatar
Michael Beck committed
155
156
157
158
159
 * Set an entry of the dependency array.
 * @param node The node.
 * @param pos  The position.
 * @param dep  The dependency target.
 */
Sebastian Hack's avatar
Sebastian Hack committed
160
161
162
void set_irn_dep(ir_node *node, int pos, ir_node *dep);


Michael Beck's avatar
Michael Beck committed
163
164
165
166
/**
 * Get the n-th predecessor of a node in intraprocedural view.
 * Can be used always if it's know that node is not a split one.
 */
167
ir_node *get_irn_intra_n(const ir_node *node, int n);
Michael Beck's avatar
Michael Beck committed
168
169
170
171

/**
 * Get the n-th predecessor of a node in interprocedural view.
 */
172
ir_node *get_irn_inter_n(const ir_node *node, int n);
173
174

/** Replace the n-th predecessor of a node with a new one. */
175
void set_irn_n(ir_node *node, int n, ir_node *in);
176
177
178
179
180
181
/**
 * Appends a new predecessor to a node. This only works for nodes with
 * variable arity!
 * @returns   the number of the new input
 */
int add_irn_n(ir_node *node, ir_node *in);
Christoph Mallon's avatar
Christoph Mallon committed
182
183
/* Remove predecessor i from Sync n */
void del_Sync_n(ir_node *n, int i);
184
/* Sets the mode struct of node.  */
185
void set_irn_mode(ir_node *node, ir_mode *mode);
186
/** Gets the mode struct of a node.  */
187
ir_mode *get_irn_mode(const ir_node *node);
188
189
/** Gets the mode-enum ir_modecode. */
ir_modecode get_irn_modecode(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
190
/** Gets the ident for a string representation of the mode .*/
191
ident *get_irn_modeident(const ir_node *node);
192
/** Gets the string representation of the mode .*/
193
const char *get_irn_modename(const ir_node *node);
194
/** Gets the opcode struct of the node. */
195
ir_op *get_irn_op(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
196
/** Sets the opcode struct of the node. */
197
void set_irn_op(ir_node *node, ir_op *op);
Michael Beck's avatar
Michael Beck committed
198
/** Gets the opcode-enum of the node. */
Matthias Braun's avatar
Matthias Braun committed
199
unsigned get_irn_opcode(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
200
/** Get the string representation of the opcode. */
201
const char *get_irn_opname(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
202
/** Get the ident for a string representation of the opcode. */
203
ident *get_irn_opident(const ir_node *node);
204
/** If arg is an argument of the node, returns it's position, -1 otherwise */
205
int get_irn_pred_pos(ir_node *node, ir_node *arg);
206
/** Gets the visited counter of a node. */
207
ir_visited_t get_irn_visited(const ir_node *node);
208
/** Sets the visited counter of a node. */
209
void set_irn_visited(ir_node *node, ir_visited_t visited);
Michael Beck's avatar
Michael Beck committed
210
/** Sets visited to get_irg_visited(current_ir_graph). */
211
void mark_irn_visited(ir_node *node);
212
/** Returns 1 if visited >= get_irg_visited(current_ir_graph). */
213
int irn_visited(const ir_node *node);
214
215
216
217
218

/**
 * Sets the link of a node.
 * Only allowed if the graph is NOT in phase_building.
 */
219
void set_irn_link(ir_node *node, void *link);
220
221

/** Returns the link of a node.  */
222
void *get_irn_link(const ir_node *node);
223

224
/** Returns the ir_graph this node belongs to. */
225
ir_graph *get_irn_irg(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
226

227
/** Outputs a unique number for this node if libFIRM is compiled for
228
229
   debugging, (configure with --enable-debug) else returns address
   of node cast to long. */
230
long get_irn_node_nr(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
231

232
233
234
235
236
237
238
/** Returns the pinned state of a node.
 *
 *  Returns whether the node _always_ must be pinned.
 *  I.e., the node is not floating after global cse.
 *
 * @returns Either state op_pin_state_pinned or op_pin_state_floats.
 */
239
op_pin_state get_irn_pinned(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
240
241
242

/** Set pin state for nodes with op pin state op_pin_state_exc_pinned */
void set_irn_pinned(ir_node *node, op_pin_state state);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
243

244
245
246
247
248
249
/** Returns whether the node is currently pinned.
 *
 * If get_irn_pinned returns op_pin_state_floats and the graph the
 * node belongs to is in state op_poin_state_floats then this function
 * returns 'floats', else 'pinned'.
 */
250
op_pin_state is_irn_pinned_in_irg(const ir_node *node);
251

Michael Beck's avatar
Michael Beck committed
252
/**
253
254
255
256
 * IR node constructor.
 * Create a new IR node in irg, with an op, mode, arity and
 * some incoming IR nodes.
 * This constructor is used in every specific IR node constructor.
257
258
259
 *
 * @param db    Debug info.
 * @param irg   IR-graph on with this new node should be constructed.
Michael Beck's avatar
Michael Beck committed
260
 * @param block The block the new node belongs to
261
262
 * @param op    The opcode of the new node.
 * @param mode  The mode of the new node.
263
 * @param arity The arity of the new node, <0 if can be changed dynamically.
264
 * @param in    An array of arity predecessor nodes.
Michael Beck's avatar
Michael Beck committed
265
 */
266
ir_node *
267
new_ir_node(dbg_info *db,
Florian Liekweg's avatar
Florian Liekweg committed
268
269
270
271
272
273
         ir_graph *irg,
         ir_node *block,
         ir_op *op,
         ir_mode *mode,
         int arity,
         ir_node *in[]);
Christian Schäfer's avatar
Christian Schäfer committed
274

275
276
277
278
279
/**
 * Return the block the node belongs to.  This is only
 * possible for pinned nodes or if the graph is in pinned state.
 * Otherwise the block may be incorrect.  This condition is
 * now checked by an assertion.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
280
281
282
283
284
 *
 * This works for all except Block.  It can return Blocks or the Bad node.
 *
 * To express the difference to access routines that work for all
 * nodes we use infix "nodes" and do not name this function
285
 * get_irn_block(). */
Sebastian Hack's avatar
Sebastian Hack committed
286
ir_node  *get_nodes_block (const ir_node *node);
Michael Beck's avatar
Michael Beck committed
287
288

/** Sets the Block of a node. */
289
void      set_nodes_block (ir_node *node, ir_node *block);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
290

Michael Beck's avatar
Michael Beck committed
291
292
293
294
295
296
297
298
299
300
301
302
303
/**
 * Return the MacroBlock the node belongs to.  This is only
 * possible for pinned nodes or if the graph is in pinned state.
 * Otherwise the MacroBlock may be incorrect.  This condition is
 * now checked by an assertion.
 *
 * This works for all except Block.  It can return Blocks or the Bad node.
 *
 * To express the difference to access routines that work for all
 * nodes we use infix "nodes" and do not name this function
 * get_irn_MacroBlock(). */
ir_node  *get_nodes_MacroBlock(const ir_node *node);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
304
/**
Michael Beck's avatar
Michael Beck committed
305
 * @function get_irn_block()
306
 * @see get_nodes_block()
Götz Lindenmaier's avatar
Götz Lindenmaier committed
307
 */
308

309
310
311
312
/**
 * Projection numbers for result of Start node: use for Proj nodes!
 */
typedef enum {
Michael Beck's avatar
Michael Beck committed
313
314
315
316
317
318
319
320
321
	pn_Start_X_initial_exec,   /**< Projection on the initial control flow. */
	pn_Start_M,                /**< Projection on the initial memory. */
	pn_Start_P_frame_base,     /**< Projection on the frame base pointer. */
	pn_Start_P_tls,            /**< Projection on the pointer to the thread local store
	                                segment containing _all_thread local variables. */
	pn_Start_T_args,           /**< Projection on all arguments. */
	pn_Start_P_value_arg_base, /**< Pointer to region of compound value arguments as defined by
	                                type of this method. */
	pn_Start_max               /**< number of projections from a Start */
322
323
} pn_Start; /* Projection numbers for Start. */

324
325
326
327
/** Test whether arbitrary node is frame pointer.
 *
 * Test whether arbitrary node is frame pointer, i.e. Proj(pn_Start_P_frame_base)
 * from Start.  If so returns frame type, else Null. */
328
ir_type *is_frame_pointer(const ir_node *n);
329

330
/** Test whether arbitrary node is the thread local storage (tls) pointer.
331
332
333
 *
 * Test whether arbitrary node is tls pointer, i.e. Proj(pn_Start_P_tls)
 * from Start.  If so returns tls type, else Null. */
334
ir_type *is_tls_pointer(const ir_node *n);
335

336
337
338
339
/** Test whether arbitrary node is value arg base.
 *
 * Test whether arbitrary node is value arg base, i.e. Proj(pn_Start_P_value_arg_base)
 * from Start.   If so returns 1, else 0. */
340
int is_value_arg_pointer(const ir_node *n);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
341

342
/* @@@ no more supported  */
343
344
ir_node **get_Block_cfgpred_arr(ir_node *node);
int       get_Block_n_cfgpreds(const ir_node *node);
345
ir_node  *get_Block_cfgpred(const ir_node *node, int pos);
346
void      set_Block_cfgpred(ir_node *node, int pos, ir_node *pred);
347
348
/** Get the predecessor block.
 *
349
 *  Returns the block corresponding to the predecessor pos of block.
350
351
352
353
354
355
356
357
 *
 *  There are several ambiguities we resolve with this function:
 *  - The direct predecessor can be a Proj, which is not pinned.
 *    We walk from the predecessor to the next pinned node
 *    (skip_Proj) and return the block that node is in.
 *  - If we encounter the Bad node, this function does not return
 *    Start, but the Bad node.
 */
358
359
ir_node  *get_Block_cfgpred_block(const ir_node *node, int pos);
int       get_Block_matured(const ir_node *node);
360
void      set_Block_matured(ir_node *node, int matured);
Götz Lindenmaier's avatar
Götz Lindenmaier committed
361
362
363

/** A visited flag only for block nodes.
 *  @see also: get_irn_visited() inc_irg_visited() inc_irg_block_visited()*/
364
365
ir_visited_t get_Block_block_visited(const ir_node *node);
void         set_Block_block_visited(ir_node *node, ir_visited_t visit);
366
367
368
369
370

/**
 * Marks a block as dead but do not replace it with a Bad node.
 * Dead blocks are removed in the con
 */
371
372
373
ir_node  *set_Block_dead(ir_node *block);
int       is_Block_dead(const ir_node *block);

Götz Lindenmaier's avatar
Götz Lindenmaier committed
374
/* For this current_ir_graph must be set. */
375
void      mark_Block_block_visited(ir_node *node);
Matthias Braun's avatar
Matthias Braun committed
376
int       Block_block_visited(const ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
377

378
#ifdef INTERPROCEDURAL_VIEW
379
380
/* Set and remove interprocedural predecessors. If the interprocedural
 * predecessors are removed, the node has the same predecessors in
381
382
 * both views.
 * @@@ Maybe better:  arity is zero if no cg preds. */
Michael Beck's avatar
Michael Beck committed
383
void      set_Block_cg_cfgpred_arr(ir_node *node, int arity, ir_node *in[]);
384
void      set_Block_cg_cfgpred(ir_node *node, int pos, ir_node *pred);
385
/* @@@ not supported */
386
ir_node **get_Block_cg_cfgpred_arr(ir_node *node);
Michael Beck's avatar
Michael Beck committed
387
/** Returns the number of interprocedural predecessors.  0 if none. */
388
int       get_Block_cg_n_cfgpreds(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
389
/** Return the interprocedural predecessor at position pos. */
390
ir_node  *get_Block_cg_cfgpred(const ir_node *node, int pos);
391
392
/** Frees the memory allocated for interprocedural predecessors. */
void      remove_Block_cg_cfgpred_arr(ir_node *node);
393
394
#endif

395
/** Returns the extended basic block a block belongs to. */
396
ir_extblk *get_Block_extbb(const ir_node *block);
397
/** Sets the extended basic block a block belongs to. */
398
void set_Block_extbb(ir_node *block, ir_extblk *extblk);
Michael Beck's avatar
Michael Beck committed
399
400
/** Get the Macro Block header of a (sub-) block. */
ir_node *get_Block_MacroBlock(const ir_node *block);
Michael Beck's avatar
Michael Beck committed
401
402
/** Set the Macro Block header of a (sub-) block. */
void set_Block_MacroBlock(ir_node *block, ir_node *mbh);
Michael Beck's avatar
Michael Beck committed
403
404
/** Get the Macro Block header of a node. */
ir_node *get_irn_MacroBlock(const ir_node *n);
405
406
/** Returns the ir_graph this Block belongs to. */
ir_graph *get_Block_irg(const ir_node *block);
Michael Beck's avatar
Michael Beck committed
407
408
409
410
411
412
/** Returns non-zero if the block has an assigned label. */
int has_Block_label(const ir_node *block);
/** Returns the label of a Block. */
ir_label_t get_Block_label(const ir_node *block);
/** Sets a label to a block. */
void set_Block_label(ir_node *block, ir_label_t label);
413
414
415
416
/** Gets the head of the Phi list for this block. */
ir_node *get_Block_phis(const ir_node *block);
/** Sets the head of the Phi list for this block. */
void set_Block_phis(ir_node *block, ir_node *phi);
Michael Beck's avatar
Michael Beck committed
417
418
/** Add a Phi node to the list of Block Phi's. */
void add_Block_phi(ir_node *block, ir_node *phi);
Michael Beck's avatar
Michael Beck committed
419
420
421
422
/** Get the Block mark (single bit). */
unsigned get_Block_mark(const ir_node *block);
/** Set the Block mark (single bit). */
void set_Block_mark(ir_node *block, unsigned mark);
Michael Beck's avatar
Michael Beck committed
423

Michael Beck's avatar
Michael Beck committed
424
/** Return the number of Keep alive node. */
425
int  get_End_n_keepalives(const ir_node *end);
Michael Beck's avatar
Michael Beck committed
426
/** Return the Keep alive node a position pos. */
427
ir_node *get_End_keepalive(const ir_node *end, int pos);
Michael Beck's avatar
Michael Beck committed
428
/** Keep alive dedicated nodes.  These must be either PhiM or Block nodes. */
429
void add_End_keepalive(ir_node *end, ir_node *ka);
Michael Beck's avatar
Michael Beck committed
430
/** Set the Keep alive node at position pos. */
431
void set_End_keepalive(ir_node *end, int pos, ir_node *ka);
432
433
434
435
436
437

/**
 * Set new keep-alives.
 * Beware: This might be an expensive operation if dynamic edges are enabled,
 * so avoid it in the backend.
 */
438
void set_End_keepalives(ir_node *end, int n, ir_node *in[]);
439
440

/** Remove irn from the keep-alive set. */
441
442
void remove_End_keepalive(ir_node *end, ir_node *irn);

Michael Beck's avatar
Michael Beck committed
443
/** Some parts of the End node are allocated separately -- their memory
444
   is not recovered by dead_node_elimination if a End node is dead.
Michael Beck's avatar
Michael Beck committed
445
   free_End() frees these data structures. */
446
void free_End(ir_node *end);
447

448
/** Return the target address of an IJmp */
449
ir_node *get_IJmp_target(const ir_node *ijmp);
450
451
/** Sets the target address of an IJmp */
void set_IJmp_target(ir_node *ijmp, ir_node *tgt);
452

453
454
455
456
457
458
459
460
/* We distinguish three kinds of Cond nodes.  These can be distinguished
   by the mode of the selector operand and an internal flag of type cond_kind.
   First we distinguish binary Conds and switch Conds.
   A binary Cond has as selector a boolean value.  Proj(0) projects the control
   flow for case "False", Proj(1) the control flow for "True".  A binary Cond
   is recognized by the boolean selector.
   The switch Cond has as selector an unsigned integer.  It produces as result
   an n+1 Tuple (cf0, ... , cfn) of control flows.
461
   We differ two flavors of this Cond.  The first, the dense Cond, passes
462
463
   control along output i if the selector value is i, 0 <= i <= n.  If the
   selector value is >n it passes control along output n.
464
   The second Cond flavor differences in the treatment of cases not specified in
465
466
467
468
469
   the source program.  It magically knows about the existence of Proj nodes.
   It only passes control along output i, 0 <= i <= n, if a node Proj(Cond, i)
   exists.  Else it passes control along output n (even if this Proj does not
   exist.)  This Cond we call "fragmentary".  There is a special constructor
   new_defaultProj that automatically sets the flavor.
470
471
   The two switch flavors are distinguished by a flag of type cond_kind.
   Default flavor is "dense"
472
473
*/
typedef enum {
Michael Beck's avatar
Michael Beck committed
474
475
476
	dense,        /**< Default. Missing Proj nodes are dead control flow. */
	fragmentary   /**< Special. No control flow optimizations allowed.  Missing
	                   Proj nodes mean default control flow, i.e., Proj(n). */
477
478
} cond_kind;

479
ir_node  *get_Cond_selector(const ir_node *node);
480
void      set_Cond_selector(ir_node *node, ir_node *selector);
481
cond_kind get_Cond_kind(const ir_node *node);
482
void      set_Cond_kind(ir_node *node, cond_kind kind);
483
long      get_Cond_defaultProj(const ir_node *node);
Christian Schäfer's avatar
Christian Schäfer committed
484

485
486
487
/**
 * Projection numbers for conditions.
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
488
typedef enum {
Michael Beck's avatar
Michael Beck committed
489
490
491
	pn_Cond_false,    /**< Control flow if operand is "false". */
	pn_Cond_true,     /**< Control flow if operand is "true".  */
	pn_Cond_max       /**< number of projections from a Cond */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
492
493
} pn_Cond;  /* Projection numbers for Cond. */

494
ir_node  *get_Return_mem(const ir_node *node);
495
496
void      set_Return_mem(ir_node *node, ir_node *mem);
ir_node **get_Return_res_arr(ir_node *node);
497
498
int       get_Return_n_ress(const ir_node *node);
ir_node  *get_Return_res(const ir_node *node, int pos);
499
void      set_Return_res(ir_node *node, int pos, ir_node *res);
Christian Schäfer's avatar
Christian Schäfer committed
500

Christoph Mallon's avatar
Christoph Mallon committed
501
tarval  *get_Const_tarval(const ir_node *node);
502
void     set_Const_tarval(ir_node *node, tarval *con);
Michael Beck's avatar
Michael Beck committed
503

Michael Beck's avatar
Michael Beck committed
504
/** Return non-zero if the given Const node represents the 0 constant. */
505
506
int is_Const_null(const ir_node *node);

Michael Beck's avatar
Michael Beck committed
507
/** Return non-zero if the given Const node represents the 1 constant. */
508
509
int is_Const_one(const ir_node *node);

Michael Beck's avatar
Michael Beck committed
510
/** Return non-zero if the given Const node represents the constant with all bits set. */
511
int is_Const_all_one(const ir_node *node);
Sebastian Hack's avatar
Sebastian Hack committed
512

Michael Beck's avatar
Michael Beck committed
513
514
515
/** Returns the source language type of a Const node.
 * Must be an atomic type.  Mode of type must be mode of node.
 */
516
ir_type  *get_Const_type(ir_node *node);
Michael Beck's avatar
Michael Beck committed
517
518

/** Sets the source language type of a Const node. */
519
void     set_Const_type(ir_node *node, ir_type *tp);
Christian Schäfer's avatar
Christian Schäfer committed
520

Michael Beck's avatar
Michael Beck committed
521
/**  This enum names the three different kinds of symbolic Constants
Götz Lindenmaier's avatar
Götz Lindenmaier committed
522
523
524
525
     represented by SymConst.  The content of the attribute type_or_id
     depends on this tag.  Use the proper access routine after testing
     this flag. */
typedef enum {
Michael Beck's avatar
Michael Beck committed
526
527
528
529
530
531
532
533
534
535
536
537
538
539
	symconst_type_tag,    /**< The SymConst is a type tag for the given type.
	                           symconst_symbol is type *. */
	symconst_type_size,   /**< The SymConst is the size of the given type.
	                           symconst_symbol is type *. */
	symconst_type_align,  /**< The SymConst is the alignment of the given type.
	                           symconst_symbol is type *. */
	symconst_addr_name,   /**< The SymConst is a symbolic pointer to be filled in
	                           by the linker.  The pointer is represented by a string.
	                           symconst_symbol is ident *. */
	symconst_addr_ent,    /**< The SymConst is a symbolic pointer to be filled in
	                           by the linker.  The pointer is represented by an entity.
	                           symconst_symbol is entity *. */
	symconst_ofs_ent,     /**< The SymConst is the offset of its entity in the entities
	                           owner type. */
Michael Beck's avatar
Michael Beck committed
540
	symconst_enum_const,  /**< The SymConst is a enumeration constant of an
Michael Beck's avatar
Michael Beck committed
541
	                           enumeration type. */
Michael Beck's avatar
Michael Beck committed
542
	symconst_label        /**< The SymConst is a label address. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
543
} symconst_kind;
544

545
546
547
548
549
550
551
/** Returns non-zero if s symconst kind has a type attribute */
#define SYMCONST_HAS_TYPE(kind) ((kind) <= symconst_type_align)

/** Returns non-zero if s symconst kind has an ident attribute */
#define SYMCONST_HAS_ID(kind) ((kind) == symconst_addr_name)

/** Returns non-zero if s symconst kind has an entity attribute */
552
#define SYMCONST_HAS_ENT(kind) ((kind) == symconst_addr_ent || (kind) == symconst_ofs_ent)
553

554
555
556
/** Returns non-zero if s symconst kind has an enum_const attribute */
#define SYMCONST_HAS_ENUM(kind) ((kind) == symconst_enum_const)

Michael Beck's avatar
Michael Beck committed
557
558
559
/** Returns non-zero if s symconst kind has a label attribute */
#define SYMCONST_HAS_LABEL(kind) ((kind) == symconst_label)

Götz Lindenmaier's avatar
Götz Lindenmaier committed
560
561
/** SymConst attribute.
 *
562
563
 *  This union contains the symbolic information represented by the node.
 */
564
typedef union symconst_symbol {
Michael Beck's avatar
Michael Beck committed
565
566
567
568
569
	ir_type       *type_p;    /**< The type of a SymConst. */
	ident         *ident_p;   /**< The ident of a SymConst. */
	ir_entity     *entity_p;  /**< The entity of a SymConst. */
	ir_enum_const *enum_p;    /**< The enumeration constant of a SymConst. */
	ir_label_t    label;      /**< The label of a SymConst. */
570
} symconst_symbol;
571

Michael Beck's avatar
Michael Beck committed
572
/** Get the kind of the SymConst. */
573
symconst_kind get_SymConst_kind(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
574
/** Set the kind of the SymConst. */
575
void          set_SymConst_kind(ir_node *node, symconst_kind num);
Beyhan's avatar
Beyhan committed
576
577

/** Only to access SymConst of kind type_tag or size.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
578
ir_type  *get_SymConst_type(const ir_node *node);
579
void     set_SymConst_type(ir_node *node, ir_type *tp);
Beyhan's avatar
Beyhan committed
580
581

/** Only to access SymConst of kind addr_name.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
582
ident   *get_SymConst_name(const ir_node *node);
583
void     set_SymConst_name(ir_node *node, ident *name);
Beyhan's avatar
Beyhan committed
584
585

/** Only to access SymConst of kind addr_ent.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
586
ir_entity *get_SymConst_entity(const ir_node *node);
587
void       set_SymConst_entity(ir_node *node, ir_entity *ent);
Beyhan's avatar
Beyhan committed
588

589
/** Only to access SymConst of kind symconst_enum_const.  Else assertion: */
Michael Beck's avatar
Michael Beck committed
590
ir_enum_const *get_SymConst_enum(const ir_node *node);
591
void           set_SymConst_enum(ir_node *node, ir_enum_const *ec);
592

Beyhan's avatar
Beyhan committed
593
594
/** Sets both: type and ptrinfo.  Needed to treat the node independent of
   its semantics.  Does a memcpy for the memory sym points to. */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
595
/* write 'union': firmjni then does not create a method... */
Michael Beck's avatar
Michael Beck committed
596
union symconst_symbol get_SymConst_symbol(const ir_node *node);
597
598
void                  set_SymConst_symbol(ir_node *node,
                                          union symconst_symbol sym);
599

Michael Beck's avatar
Michael Beck committed
600
601
602
603
604
/** Only to access SymConst of kind symconst_label.  Else assertion: */
ir_label_t get_SymConst_label(const ir_node *node);
void       set_SymConst_label(ir_node *node, ir_label_t label);


Götz Lindenmaier's avatar
Götz Lindenmaier committed
605
606
607
/** Access the type of the value represented by the SymConst.
 *
 *  Example: primitive type int for SymConst size. */
608
609
610
ir_type *get_SymConst_value_type(ir_node *node);
void    set_SymConst_value_type(ir_node *node, ir_type *tp);

611
ir_node   *get_Sel_mem(const ir_node *node);
612
void       set_Sel_mem(ir_node *node, ir_node *mem);
613
ir_node   *get_Sel_ptr(const ir_node *node);  /* ptr to the object to select from */
614
615
void       set_Sel_ptr(ir_node *node, ir_node *ptr);
ir_node   **get_Sel_index_arr(ir_node *node);
616
617
int        get_Sel_n_indexs(const ir_node *node);
ir_node   *get_Sel_index(const ir_node *node, int pos);
618
void       set_Sel_index(ir_node *node, int pos, ir_node *index);
619
ir_entity *get_Sel_entity(const ir_node *node); /* entity to select */
620
void       set_Sel_entity (ir_node *node, ir_entity *ent);
Christian Schäfer's avatar
Christian Schäfer committed
621

622
623
624
/**
 * Projection numbers for result of Call node: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
625
typedef enum {
626
627
628
629
630
631
632
633
634
	pn_Call_M_regular = pn_Generic_M_regular, /**< The memory result. */
	pn_Call_X_regular = pn_Generic_X_regular, /**< The control flow result when no exception occurs. */
	pn_Call_X_except  = pn_Generic_X_except,  /**< The control flow result branching to the exception handler. */
	pn_Call_T_result  = pn_Generic_other,     /**< The tuple containing all (0, 1, 2, ...) results. */
	pn_Call_M_except,                         /**< The memory result in case the called method terminated with
	                                               an exception. */
	pn_Call_P_value_res_base,                 /**< A pointer to the memory region containing copied results
	                                               passed by value (for compound result types). */
	pn_Call_max                               /**< number of projections from a Call */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
635
} pn_Call;   /* Projection numbers for Call. */
636
#define pn_Call_M pn_Call_M_regular
Götz Lindenmaier's avatar
Götz Lindenmaier committed
637

638
ir_node *get_Call_mem(const ir_node *node);
639
void     set_Call_mem(ir_node *node, ir_node *mem);
640
ir_node *get_Call_ptr(const ir_node *node);
641
642
void     set_Call_ptr(ir_node *node, ir_node *ptr);
ir_node **get_Call_param_arr(ir_node *node);
Michael Beck's avatar
Michael Beck committed
643
/** Gets the number of parameters of a call. */
644
int      get_Call_n_params(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
645
/** Gets the call parameter at position pos. */
646
ir_node *get_Call_param(const ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
647
/** Sets the call parameter at position pos. */
648
void     set_Call_param(ir_node *node, int pos, ir_node *param);
Michael Beck's avatar
Michael Beck committed
649
/** Gets the type of a call. */
650
ir_type *get_Call_type(ir_node *node);
Michael Beck's avatar
Michael Beck committed
651
/** Sets the type of a call. */
652
void     set_Call_type(ir_node *node, ir_type *tp);
Michael Beck's avatar
Michael Beck committed
653
/** Gets the arity of a call. Identical to get_Call_n_params(). */
654
int      get_Call_arity(const ir_node *node);
Michael Beck's avatar
Michael Beck committed
655
656
657
658
659
660

/**
 * Returns non-zero if a Call is surely a self-recursive Call.
 * Beware: if this functions returns 0, the call might be self-recursive!
 */
int is_self_recursive_Call(const ir_node *call);
661

662
663
664
665
/** Set, get and remove the callee information for a Call node.
 *
 *  The callee information lists all method entities that can be called
 *  from this node.  If the address expression can not be analyzed fully,
Götz Lindenmaier's avatar
Götz Lindenmaier committed
666
667
668
669
 *  e.g., as entities can be called that are not in the compilation unit,
 *  the array contains the unknown_entity.  The array contains only entities
 *  with peculiarity_existent, but with all kinds of visibility.  The entities
 *  not necessarily contain an irg.
670
671
672
673
674
675
676
677
678
 *
 *  The array is only accessible if callee information is valid.  See flag
 *  in graph.
 *
 *  The memory allocated for the array is managed automatically, i.e., it must
 *  not be freed if the Call node is removed from the graph.
 *
 *  @param node A Call node.
 */
679
680
681
int        Call_has_callees(const ir_node *node);
int        get_Call_n_callees(const ir_node *node);
ir_entity *get_Call_callee(const ir_node *node, int pos);
Michael Beck's avatar
Michael Beck committed
682

683
684
685
/** Set the full callee array.
 *
 *  The passed array is copied. Assumes current_ir_graph set properly! */
686
void    set_Call_callee_arr(ir_node *node, const int n, ir_entity **arr);
687
void    remove_Call_callee_arr(ir_node *node);
688

689
ir_node  *get_CallBegin_ptr(const ir_node *node);
690
void      set_CallBegin_ptr(ir_node *node, ir_node *ptr);
691
ir_node  *get_CallBegin_call(const ir_node *node);
692
void      set_CallBegin_call(ir_node *node, ir_node *call);
693

Christian Schäfer's avatar
Christian Schäfer committed
694
695
696
/* For unary and binary arithmetic operations the access to the
   operands can be factored out.  Left is the first, right the
   second arithmetic value  as listed in tech report 1999-44.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
697
   unops are: Minus, Abs, Not, Conv, Cast
Christian Schäfer's avatar
Christian Schäfer committed
698
   binops are: Add, Sub, Mul, Quot, DivMod, Div, Mod, And, Or, Eor, Shl,
699
   Shr, Shrs, Rotl, Cmp */
700
int      is_unop(const ir_node *node);
701
ir_node *get_unop_op(const ir_node *node);
702
703
void     set_unop_op(ir_node *node, ir_node *op);
int      is_binop(const ir_node *node);
704
ir_node *get_binop_left(const ir_node *node);
705
void     set_binop_left(ir_node *node, ir_node *left);
706
ir_node *get_binop_right(const ir_node *node);
707
708
void     set_binop_right(ir_node *node, ir_node *right);

709
ir_node *get_Add_left(const ir_node *node);
710
void     set_Add_left(ir_node *node, ir_node *left);
711
ir_node *get_Add_right(const ir_node *node);
712
713
void     set_Add_right(ir_node *node, ir_node *right);

714
715
716
717
718
ir_node *get_Carry_left(const ir_node *node);
void     set_Carry_left(ir_node *node, ir_node *left);
ir_node *get_Carry_right(const ir_node *node);
void     set_Carry_right(ir_node *node, ir_node *right);

719
ir_node *get_Sub_left(const ir_node *node);
720
void     set_Sub_left(ir_node *node, ir_node *left);
721
ir_node *get_Sub_right(const ir_node *node);
722
723
void     set_Sub_right(ir_node *node, ir_node *right);

724
ir_node *get_Minus_op(const ir_node *node);
725
726
void     set_Minus_op(ir_node *node, ir_node *op);

727
ir_node *get_Mul_left(const ir_node *node);
728
void     set_Mul_left(ir_node *node, ir_node *left);
729
ir_node *get_Mul_right(const ir_node *node);
730
731
void     set_Mul_right(ir_node *node, ir_node *right);

Michael Beck's avatar
Michael Beck committed
732
733
734
735
736
ir_node *get_Mulh_left(const ir_node *node);
void     set_Mulh_left(ir_node *node, ir_node *left);
ir_node *get_Mulh_right(const ir_node *node);
void     set_Mulh_right(ir_node *node, ir_node *right);

737
ir_node *get_Quot_left(const ir_node *node);
738
void     set_Quot_left(ir_node *node, ir_node *left);
739
ir_node *get_Quot_right(const ir_node *node);
740
void     set_Quot_right(ir_node *node, ir_node *right);
741
ir_node *get_Quot_mem(const ir_node *node);
742
void     set_Quot_mem(ir_node *node, ir_node *mem);
743
744
ir_mode *get_Quot_resmode(const ir_node *node);
void     set_Quot_resmode(ir_node *node, ir_mode *mode);
745

746
747
748
/**
 * Projection numbers for Quot: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
749
typedef enum {
750
751
752
753
754
	pn_Quot_M         = pn_Generic_M_regular, /**< Memory result. */
	pn_Quot_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
	pn_Quot_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
	pn_Quot_res       = pn_Generic_other,     /**< Result of computation. */
	pn_Quot_max                               /**< number of projections from a Quot */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
755
756
} pn_Quot;  /* Projection numbers for Quot. */

757
ir_node *get_DivMod_left(const ir_node *node);
758
void     set_DivMod_left(ir_node *node, ir_node *left);
759
ir_node *get_DivMod_right(const ir_node *node);
760
void     set_DivMod_right(ir_node *node, ir_node *right);
761
ir_node *get_DivMod_mem(const ir_node *node);
762
void     set_DivMod_mem(ir_node *node, ir_node *mem);
763
764
ir_mode *get_DivMod_resmode(const ir_node *node);
void     set_DivMod_resmode(ir_node *node, ir_mode *mode);
765

766
767
768
/**
 * Projection numbers for DivMod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
769
typedef enum {
770
771
772
773
774
775
	pn_DivMod_M         = pn_Generic_M_regular, /**< Memory result. */
	pn_DivMod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
	pn_DivMod_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
	pn_DivMod_res_div   = pn_Generic_other,     /**< Result of computation a / b. */
	pn_DivMod_res_mod,                          /**< Result of computation a % b. */
	pn_DivMod_max                               /**< number of projections from a DivMod */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
776
777
} pn_DivMod;  /* Projection numbers for DivMod. */

778
ir_node *get_Div_left(const ir_node *node);
779
void     set_Div_left(ir_node *node, ir_node *left);
780
ir_node *get_Div_right(const ir_node *node);
781
void     set_Div_right(ir_node *node, ir_node *right);
782
ir_node *get_Div_mem(const ir_node *node);
783
void     set_Div_mem(ir_node *node, ir_node *mem);
784
785
ir_mode *get_Div_resmode(const ir_node *node);
void     set_Div_resmode(ir_node *node, ir_mode *mode);
786
int      is_Div_remainderless(const ir_node *node);
787

788
789
790
/**
 * Projection numbers for Div: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
791
typedef enum {
792
793
794
795
796
	pn_Div_M         = pn_Generic_M_regular, /**< Memory result. */
	pn_Div_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
	pn_Div_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
	pn_Div_res       = pn_Generic_other,     /**< Result of computation. */
	pn_Div_max                               /**< number of projections from a Div */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
797
798
} pn_Div;  /* Projection numbers for Div. */

799
ir_node *get_Mod_left(const ir_node *node);
800
void     set_Mod_left(ir_node *node, ir_node *left);
801
ir_node *get_Mod_right(const ir_node *node);
802
void     set_Mod_right(ir_node *node, ir_node *right);
803
ir_node *get_Mod_mem(const ir_node *node);
804
void     set_Mod_mem(ir_node *node, ir_node *mem);
805
806
ir_mode *get_Mod_resmode(const ir_node *node);
void     set_Mod_resmode(ir_node *node, ir_mode *mode);
807

808
809
810
/**
 * Projection numbers for Mod: use for Proj nodes!
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
811
typedef enum {
812
813
814
815
816
	pn_Mod_M         = pn_Generic_M_regular, /**< Memory result.    */
	pn_Mod_X_regular = pn_Generic_X_regular, /**< Execution result if no exception occurred. */
	pn_Mod_X_except  = pn_Generic_X_except,  /**< Execution result if exception occurred. */
	pn_Mod_res       = pn_Generic_other,     /**< Result of computation. */
	pn_Mod_max                               /**< number of projections from a Mod */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
817
818
} pn_Mod;  /* Projection numbers for Mod. */

819
ir_node *get_Abs_op(const ir_node *node);
820
void     set_Abs_op(ir_node *node, ir_node *op);
821

822
ir_node *get_And_left(const ir_node *node);
823
void     set_And_left(ir_node *node, ir_node *left);
824
ir_node *get_And_right(const ir_node *node);
825
void     set_And_right(ir_node *node, ir_node *right);
826

827
ir_node *get_Or_left(const ir_node *node);
828
void     set_Or_left(ir_node *node, ir_node *left);
829
ir_node *get_Or_right(const ir_node *node);
830
void     set_Or_right(ir_node *node, ir_node *right);
831

832
ir_node *get_Eor_left(const ir_node *node);
833
void     set_Eor_left(ir_node *node, ir_node *left);
834
ir_node *get_Eor_right(const ir_node *node);
835
void     set_Eor_right(ir_node *node, ir_node *right);
836

837
ir_node *get_Not_op(const ir_node *node);
838
void     set_Not_op(ir_node *node, ir_node *op);
Christian Schäfer's avatar
Christian Schäfer committed
839

840
841
/**
 * Projection numbers for Cmp are defined several times.
842
 * The bit patterns are used for various tests, so don't change.
843
844
 * The "unordered" values are possible results of comparing
 * floating point numbers.
Michael Beck's avatar
Michael Beck committed
845
 * Note that the encoding is imported, so do NOT change the order.
846
 */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
847
typedef enum {
Michael Beck's avatar
Michael Beck committed
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
	pn_Cmp_False = 0,                             /**< false */
	pn_Cmp_Eq    = 1,                             /**< equal */
	pn_Cmp_Lt    = 2,                             /**< less */
	pn_Cmp_Le    = pn_Cmp_Eq|pn_Cmp_Lt,           /**< less or equal */
	pn_Cmp_Gt    = 4,                             /**< greater */
	pn_Cmp_Ge    = pn_Cmp_Eq|pn_Cmp_Gt,           /**< greater or equal */
	pn_Cmp_Lg    = pn_Cmp_Lt|pn_Cmp_Gt,           /**< less or greater */
	pn_Cmp_Leg   = pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt, /**< less, equal or greater = ordered */
	pn_Cmp_Uo    = 8,                             /**< unordered */
	pn_Cmp_Ue    = pn_Cmp_Uo|pn_Cmp_Eq,           /**< unordered or equal */
	pn_Cmp_Ul    = pn_Cmp_Uo|pn_Cmp_Lt,           /**< unordered or less */
	pn_Cmp_Ule   = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Lt, /**< unordered, less or equal */
	pn_Cmp_Ug    = pn_Cmp_Uo|pn_Cmp_Gt,           /**< unordered or greater */
	pn_Cmp_Uge   = pn_Cmp_Uo|pn_Cmp_Eq|pn_Cmp_Gt, /**< unordered, greater or equal */
	pn_Cmp_Ne    = pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt, /**< unordered, less or greater = not equal */
	pn_Cmp_True  = 15                             /**< true */
	/* not_mask = Leg*/   /* bits to flip to negate comparison * @@ hack for JNI interface */
Götz Lindenmaier's avatar
Götz Lindenmaier committed
865
} pn_Cmp;   /* Projection numbers for Cmp */
866
/* #define not_mask pn_Cmp_Leg */
867