output documentation to file on request
[libfirm] / scripts / ir_spec.py
index 65aa32e..489cd40 100755 (executable)
@@ -7,7 +7,9 @@ abstract(Op)
 class Unop(Op):
        """Unary nodes have exactly 1 input"""
        name     = "unop"
-       ins      = [ "op" ]
+       ins      = [
+               ("op",  "operand"),
+       ]
        op_index = 0
        pinned   = "no"
 abstract(Unop)
@@ -15,38 +17,48 @@ abstract(Unop)
 class Binop(Op):
        """Binary nodes have exactly 2 inputs"""
        name     = "binop"
-       ins      = [ "left", "right" ]
+       ins      = [
+               ( "left",   "first operand" ),
+               ( "right", "second operand" ),
+       ]
        op_index = 0
        pinned   = "no"
 abstract(Binop)
 
 class Add(Binop):
        """returns the sum of its operands"""
-       flags = ["commutative"]
+       flags = [ "commutative" ]
 
 class Alloc(Op):
        """allocates a block of memory.
        It can be specified whether the variable should be allocated to the stack
        or to the heap."""
-       ins   = [ "mem", "count" ]
+       ins   = [
+               ("mem",   "memory dependency" ),
+               ("count", "number of objects to allocate" ),
+       ]
        outs  = [
-               ("M",         "memory result",                         "pn_Generic_M"),
-               ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
-               ("X_except",  "control flow when exception occured",   "pn_Generic_X_except"),
-               ("res",       "pointer to newly allocated memory",     "pn_Generic_other"),
+               ("M",         "memory result"),
+               ("res",       "pointer to newly allocated memory"),
+               ("X_regular", "control flow when no exception occurs"),
+               ("X_except",  "control flow when exception occured"),
        ]
-       flags = [ "fragile", "uses_memory" ]
        attrs = [
                dict(
-                       name = "type",
-                       type = "ir_type*"
+                       name    = "type",
+                       type    = "ir_type*",
+                       comment = "type of the allocated variable",
                ),
                dict(
-                       name = "where",
-                       type = "ir_where_alloc"
+                       name    = "where",
+                       type    = "ir_where_alloc",
+                       comment = "whether to allocate the variable on the stack or heap",
                )
        ]
-       pinned      = "yes"
+       flags       = [ "fragile", "uses_memory" ]
+       pinned      = "exception"
+       throws_init = "false"
+       pinned_init = "op_pin_state_pinned"
        attr_struct = "alloc_attr"
 
 class Anchor(Op):
@@ -80,6 +92,43 @@ class ASM(Op):
        attr_struct      = "asm_attr"
        attrs_name       = "assem"
        customSerializer = True
+       attrs = [
+               dict(
+                       name    = "input_constraints",
+                       type    = "ir_asm_constraint*",
+                       comment = "input constraints",
+               ),
+               dict(
+                       name    = "n_output_constraints",
+                       type    = "size_t",
+                       noprop  = True,
+                       comment = "number of output constraints",
+               ),
+               dict(
+                       name    = "output_constraints",
+                       type    = "ir_asm_constraint*",
+                       comment = "output constraints",
+               ),
+               dict(
+                       name    = "n_clobbers",
+                       type    = "size_t",
+                       noprop  = True,
+                       comment = "number of clobbered registers/memory",
+               ),
+               dict(
+                       name    = "clobbers",
+                       type    = "ident**",
+                       comment = "list of clobbered registers/memory",
+               ),
+               dict(
+                       name    = "text",
+                       type    = "ident*",
+                       comment = "assembler text",
+               ),
+       ]
+       # constructor is written manually at the moment, because of the clobbers+
+       # constraints arrays needing special handling (2 arguments for 1 attribute)
+       noconstructor = True
 
 class Bad(Op):
        """Bad nodes indicate invalid input, which is values which should never be
@@ -99,12 +148,10 @@ class Bad(Op):
        they are set to Bad, and the actual removal is left to the control flow
        optimisation phase. Block, Phi, Tuple with only Bad inputs however are
        replaced by Bad right away."""
-       mode          = "mode_T"
-       flags         = [ "cfopcode", "start_block", "dump_noblock" ]
+       flags         = [ "start_block", "dump_noblock" ]
        pinned        = "yes"
        knownBlock    = True
        block         = "get_irg_start_block(irg)"
-       singleton     = True
        attr_struct   = "bad_attr"
        init = '''
        res->attr.bad.irg.irg = irg;
@@ -117,7 +164,7 @@ class Deleted(Op):
        flags            = [ ]
        pinned           = "yes"
        noconstructor    = True
-       customSerializer = True
+       customSerializer = True # this has no serializer
 
 class Block(Op):
        """A basic block"""
@@ -128,6 +175,14 @@ class Block(Op):
        arity            = "variable"
        flags            = [ "labeled" ]
        attr_struct      = "block_attr"
+       attrs            = [
+               dict(
+                       name    = "entity",
+                       type    = "ir_entity*",
+                       comment = "entity representing this block",
+                       init    = "NULL",
+               ),
+       ]
        customSerializer = True
 
        init = '''
@@ -149,36 +204,45 @@ class Borrow(Binop):
 class Bound(Op):
        """Performs a bounds-check: if lower <= index < upper then return index,
        otherwise throw an exception."""
-       ins    = [ "mem", "index", "lower", "upper" ]
+       ins    = [
+               ("mem",    "memory dependency"),
+               ("index",  "value to test"),
+               ("lower",  "lower bound (inclusive)"),
+               ("upper",  "upper bound (exclusive)"),
+       ]
        outs  = [
-               ("M",         "memory result",                         "pn_Generic_M"),
-               ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
-               ("X_except",  "control flow when exception occured",   "pn_Generic_X_except"),
-               ("res",       "the checked index",                     "pn_Generic_other"),
+               ("M",         "memory result"),
+               ("res",       "the checked index"),
+               ("X_regular", "control flow when no exception occurs"),
+               ("X_except",  "control flow when exception occured"),
        ]
        flags  = [ "fragile", "highlevel" ]
        pinned = "exception"
        pinned_init = "op_pin_state_pinned"
+       throws_init = "false"
        attr_struct = "bound_attr"
-       attrs_name  = "bound"
 
 class Builtin(Op):
        """performs a backend-specific builtin."""
-       ins      = [ "mem" ]
+       ins      = [
+               ("mem", "memory dependency"),
+       ]
        arity    = "variable"
        outs     = [
-               ("M",        "memory result", "pn_Generic_M"),
-               ("1_result", "first result",  "pn_Generic_other"),
+               ("M", "memory result"),
+               # results follow here
        ]
        flags    = [ "uses_memory" ]
        attrs    = [
                dict(
-                       type = "ir_builtin_kind",
-                       name = "kind"
+                       type    = "ir_builtin_kind",
+                       name    = "kind",
+                       comment = "kind of builtin",
                ),
                dict(
-                       type = "ir_type*",
-                       name = "type"
+                       type    = "ir_type*",
+                       name    = "type",
+                       comment = "method type for the builtin call",
                )
        ]
        pinned      = "memory"
@@ -193,31 +257,29 @@ class Call(Op):
        operands are passed to the called code. Called code usually performs a
        return operation. The operands of this return operation are the result
        of the Call node."""
-       ins      = [ "mem", "ptr" ]
+       ins      = [
+               ("mem",   "memory dependency"),
+               ("ptr",   "pointer to called code"),
+       ]
        arity    = "variable"
        outs     = [
-               ("M",                "memory result",                         "pn_Generic_M"),
-               ("X_regular",        "control flow when no exception occurs", "pn_Generic_X_regular"),
-               ("X_except",         "control flow when exception occured",   "pn_Generic_X_except"),
-               ("T_result",         "tuple containing all results",          "pn_Generic_other"),
-               ("P_value_res_base", "pointer to memory register containing copied results passed by value"),
+               ("M",                "memory result"),
+               ("T_result",         "tuple containing all results"),
+               ("X_regular",        "control flow when no exception occurs"),
+               ("X_except",         "control flow when exception occured"),
        ]
        flags    = [ "fragile", "uses_memory" ]
        attrs    = [
                dict(
-                       type = "ir_type*",
-                       name = "type"
+                       type    = "ir_type*",
+                       name    = "type",
+                       comment = "type of the call (usually type of the called procedure)",
                ),
-               dict(
-                       type = "unsigned",
-                       name = "tail_call",
-                       # the tail call attribute can only be set by analysis
-                       init = "0"
-               )
        ]
        attr_struct = "call_attr"
        pinned      = "memory"
        pinned_init = "op_pin_state_pinned"
+       throws_init = "false"
        init = '''
        assert((get_unknown_type() == type) || is_Method_type(type));
        '''
@@ -233,50 +295,33 @@ class Cast(Unop):
        flags    = [ "highlevel" ]
        attrs    = [
                dict(
-                       type = "ir_type*",
-                       name = "type"
+                       type    = "ir_type*",
+                       name    = "type",
+                       comment = "target type of the case",
                )
        ]
        attr_struct = "cast_attr"
        init     = "assert(is_atomic_type(type));"
 
 class Cmp(Binop):
-       """Returns the relation of 2 operands"""
-       outs  = [
-               ("False", "always false",                            "0"),
-               ("Eq",    "equal",                                   "1"),
-               ("Lt",    "less",                                    "2"),
-               ("Le",    "less or equal",                           "pn_Cmp_Eq|pn_Cmp_Lt"),
-               ("Gt",    "greater",                                 "4"),
-               ("Ge",    "greater or equal",                        "pn_Cmp_Eq|pn_Cmp_Gt"),
-               ("Lg",    "less or greater ('not equal' for integer numbers)", "pn_Cmp_Lt|pn_Cmp_Gt"),
-               ("Leg",   "less, equal or greater ('not unordered')", "pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt"),
-               ("Uo",    "unordered",                               "8"),
-               ("Ue",    "unordered or equal",                      "pn_Cmp_Uo|pn_Cmp_Eq"),
-               ("Ul",    "unordered or less",                       "pn_Cmp_Uo|pn_Cmp_Lt"),
-               ("Ule",   "unordered, less or equal",                "pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Eq"),
-               ("Ug",    "unordered or greater",                    "pn_Cmp_Uo|pn_Cmp_Gt"),
-               ("Uge",   "onordered, greater or equal",             "pn_Cmp_Uo|pn_Cmp_Gt|pn_Cmp_Eq"),
-               ("Ne",    "unordered, less or greater ('not equal' for floatingpoint numbers)", "pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt"),
-               ("True",  "always true",                             "15"),
-       ]
+       """Compares its two operands and checks whether a specified
+          relation (like less or equal) is fulfilled."""
        flags = []
+       mode  = "mode_b"
+       attrs = [
+               dict(
+                       type    = "ir_relation",
+                       name    = "relation",
+                       comment = "Comparison relation"
+               )
+       ]
+       attr_struct = "cmp_attr"
 
 class Cond(Op):
-       """Conditionally change control flow. There are two versions of this node:
-
-       Boolean Cond:
-       Input:  A value of mode_b
-       Output: A tuple of two control flows. The first is taken if the input is
-               false, the second if it is true.
-
-       Switch Cond:
-       Input:  A value of mode_Iu
-       Output: A tuple of n control flows. If the Cond's input is i, control flow
-       will proceed along output i. If the input is >= n control flow proceeds
-       along output def_proj.
-       """
-       ins      = [ "selector" ]
+       """Conditionally change control flow."""
+       ins      = [
+               ("selector",  "condition parameter"),
+       ]
        outs     = [
                ("false", "control flow if operand is \"false\""),
                ("true",  "control flow if operand is \"true\""),
@@ -285,18 +330,41 @@ class Cond(Op):
        pinned   = "yes"
        attrs    = [
                dict(
-                       name = "default_proj",
-                       type = "long",
-                       init = "0"
+                       name    = "jmp_pred",
+                       type    = "cond_jmp_predicate",
+                       init    = "COND_JMP_PRED_NONE",
+                       comment = "can indicate the most likely jump",
                ),
-               dict(
-                       name = "jmp_pred",
-                       type = "cond_jmp_predicate",
-                       init = "COND_JMP_PRED_NONE"
-               )
        ]
        attr_struct = "cond_attr"
 
+class Switch(Op):
+       """Change control flow. The destination is choosen based on an integer input value which is looked up in a table.
+
+       Backends can implement this efficiently using a jump table."""
+       ins    = [
+               ("selector", "input selector"),
+       ]
+       outs   = [
+               ("default", "control flow if no other case matches"),
+       ]
+       flags  = [ "cfopcode", "forking" ]
+       pinned = "yes"
+       attrs  = [
+               dict(
+                       name    = "n_outs",
+                       type    = "unsigned",
+                       comment = "number of outputs (including pn_Switch_default)",
+               ),
+               dict(
+                       name    = "table",
+                       type    = "ir_switch_table*",
+                       comment = "table describing mapping from input values to Proj numbers",
+               ),
+       ]
+       attr_struct = "switch_attr"
+       attrs_name  = "switcha"
+
 class Confirm(Op):
        """Specifies constraints for a value. This allows explicit representation
        of path-sensitive properties. (Example: This value is always >= 0 on 1
@@ -307,82 +375,96 @@ class Confirm(Op):
        value is always returned.
        Note that this node does NOT check or assert the constraint, it merely
        specifies it."""
-       ins      = [ "value", "bound" ]
+       ins      = [
+               ("value",  "value to express a constraint for"),
+               ("bound",  "value to compare against"),
+       ]
        mode     = "get_irn_mode(irn_value)"
        flags    = [ "highlevel" ]
        pinned   = "yes"
        attrs    = [
                dict(
-                       name = "cmp",
-                       type = "pn_Cmp"
+                       name    = "relation",
+                       type    = "ir_relation",
+                       comment = "relation of value to bound",
                ),
        ]
        attr_struct = "confirm_attr"
-       attrs_name  = "confirm"
 
 class Const(Op):
        """Returns a constant value."""
-       mode       = ""
        flags      = [ "constlike", "start_block" ]
+       block      = "get_irg_start_block(irg)"
+       mode       = "get_tarval_mode(tarval)"
        knownBlock = True
        pinned     = "no"
-       attrs_name = "con"
        attrs      = [
                dict(
-                       type = "ir_tarval*",
-                       name = "tarval",
+                       type    = "ir_tarval*",
+                       name    = "tarval",
+                       comment = "constant value (a tarval object)",
                )
        ]
        attr_struct = "const_attr"
+       attrs_name  = "con"
 
 class Conv(Unop):
        """Converts values between modes"""
        flags = []
        attrs = [
                dict(
-                       name = "strict",
-                       type = "int",
-                       init = "0",
+                       name    = "strict",
+                       type    = "int",
+                       init    = "0",
+                       comment = "force floating point to restrict precision even if backend computes in higher precision (deprecated)",
                )
        ]
        attr_struct = "conv_attr"
-       attrs_name  = "conv"
 
 class CopyB(Op):
        """Copies a block of memory"""
-       ins   = [ "mem", "dst", "src" ]
+       ins   = [
+               ("mem",  "memory dependency"),
+               ("dst",  "destination address"),
+               ("src",  "source address"),
+       ]
        outs  = [
-               ("M",         "memory result",                         "pn_Generic_M"),
-               ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
-               ("X_except",  "control flow when exception occured",   "pn_Generic_X_except"),
+               ("M",         "memory result"),
+               ("X_regular", "control flow when no exception occurs"),
+               ("X_except",  "control flow when exception occured"),
        ]
        flags = [ "fragile", "uses_memory" ]
        attrs = [
                dict(
-                       name = "type",
-                       type = "ir_type*"
+                       name    = "type",
+                       type    = "ir_type*",
+                       comment = "type of copied data",
                )
        ]
        attr_struct = "copyb_attr"
-       attrs_name  = "copyb"
        pinned      = "memory"
        pinned_init = "op_pin_state_pinned"
+       throws_init = "false"
 
 class Div(Op):
-       """returns the quotient of its 2 operands, integer version"""
-       ins   = [ "mem", "left", "right" ]
+       """returns the quotient of its 2 operands"""
+       ins   = [
+               ("mem",   "memory dependency"),
+               ("left",  "first operand"),
+               ("right", "second operand"),
+       ]
        outs  = [
-               ("M",         "memory result",                         "pn_Generic_M"),
-               ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
-               ("X_except",  "control flow when exception occured",   "pn_Generic_X_except"),
-               ("res",       "result of computation",                 "pn_Generic_other"),
+               ("M",         "memory result"),
+               ("res",       "result of computation"),
+               ("X_regular", "control flow when no exception occurs"),
+               ("X_except",  "control flow when exception occured"),
        ]
        flags = [ "fragile", "uses_memory" ]
-       attrs_name = "divmod"
        attrs = [
                dict(
-                       type = "ir_mode*",
-                       name = "resmode"
+                       type    = "ir_mode*",
+                       name    = "resmode",
+                       comment = "mode of the result value",
                ),
                dict(
                        name = "no_remainder",
@@ -390,31 +472,9 @@ class Div(Op):
                        init = "0",
                )
        ]
-       attr_struct = "divmod_attr"
-       pinned      = "exception"
-       op_index    = 1
-       arity_override = "oparity_binary"
-
-class DivMod(Op):
-       """divides its 2 operands and computes the remainder of the division"""
-       ins   = [ "mem", "left", "right" ]
-       outs  = [
-               ("M",         "memory result",                         "pn_Generic_M"),
-               ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
-               ("X_except",  "control flow when exception occured",   "pn_Generic_X_except"),
-               ("res_div",   "result of computation a/b",             "pn_Generic_other"),
-               ("res_mod",   "result of computation a%b"),
-       ]
-       flags = [ "fragile", "uses_memory" ]
-       attrs_name = "divmod"
-       attrs = [
-               dict(
-                       type = "ir_mode*",
-                       name = "resmode"
-               ),
-       ]
-       attr_struct = "divmod_attr"
+       attr_struct = "div_attr"
        pinned      = "exception"
+       throws_init = "false"
        op_index    = 1
        arity_override = "oparity_binary"
 
@@ -438,7 +498,6 @@ class End(Op):
        knownBlock       = True
        block            = "get_irg_end_block(irg)"
        singleton        = True
-       customSerializer = True
 
 class Eor(Binop):
        """returns the result of a bitwise exclusive or operation of its operands"""
@@ -446,25 +505,33 @@ class Eor(Binop):
 
 class Free(Op):
        """Frees a block of memory previously allocated by an Alloc node"""
-       ins    = [ "mem", "ptr", "size" ]
+       ins    = [
+               ("mem",   "memory dependency" ),
+               ("ptr",   "pointer to the object to free"),
+               ("count", "number of objects to allocate" ),
+       ]
        mode   = "mode_M"
        flags  = [ "uses_memory" ]
        pinned = "yes"
        attrs  = [
                dict(
-                       name = "type",
-                       type = "ir_type*"
+                       name    = "type",
+                       type    = "ir_type*",
+                       comment = "type of the allocated variable",
                ),
                dict(
-                       name = "where",
-                       type = "ir_where_alloc"
+                       name    = "where",
+                       type    = "ir_where_alloc",
+                       comment = "whether allocation was on the stack or heap",
                )
        ]
        attr_struct = "free_attr"
 
 class Id(Op):
        """Returns its operand unchanged."""
-       ins    = [ "pred" ]
+       ins    = [
+          ("pred", "the value which is returned unchanged")
+       ]
        pinned = "no"
        flags  = []
 
@@ -474,23 +541,29 @@ class IJmp(Op):
        by the tuple results"""
        mode     = "mode_X"
        pinned   = "yes"
-       ins      = [ "target" ]
-       flags    = [ "cfopcode", "forking", "keep" ]
+       ins      = [
+          ("target", "target address of the jump"),
+       ]
+       flags    = [ "cfopcode", "forking", "keep", "unknown_jump" ]
 
 class InstOf(Op):
-       """Tests wether an object is an instance of a class-type"""
-       ins   = [ "store", "obj" ]
+       """Tests whether an object is an instance of a class-type"""
+       ins   = [
+          ("store", "memory dependency"),
+          ("obj",   "pointer to object being queried")
+       ]
        outs  = [
-               ("M",         "memory result",                         "pn_Generic_M"),
-               ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
-               ("X_except",  "control flow when exception occured",   "pn_Generic_X_except"),
-               ("res",       "checked object pointer",                "pn_Generic_other"),
+               ("M",         "memory result"),
+               ("res",       "checked object pointer"),
+               ("X_regular", "control flow when no exception occurs"),
+               ("X_except",  "control flow when exception occured"),
        ]
        flags = [ "highlevel" ]
        attrs = [
                dict(
-                       name = "type",
-                       type = "ir_type*"
+                       name    = "type",
+                       type    = "ir_type*",
+                       comment = "type to check ptr for",
                )
        ]
        attr_struct = "io_attr"
@@ -506,30 +579,49 @@ class Jmp(Op):
 
 class Load(Op):
        """Loads a value from memory (heap or stack)."""
-       ins      = [ "mem", "ptr" ]
+       ins   = [
+               ("mem", "memory dependency"),
+               ("ptr",  "address to load from"),
+       ]
        outs  = [
-               ("M",         "memory result",                         "pn_Generic_M"),
-               ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
-               ("X_except",  "control flow when exception occured",   "pn_Generic_X_except"),
-               ("res",       "result of load operation",              "pn_Generic_other"),
+               ("M",         "memory result"),
+               ("res",       "result of load operation"),
+               ("X_regular", "control flow when no exception occurs"),
+               ("X_except",  "control flow when exception occured"),
        ]
        flags    = [ "fragile", "uses_memory" ]
        pinned   = "exception"
-       pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
        attrs    = [
                dict(
-                       type = "ir_mode*",
-                       name = "mode",
-                       java_name = "load_mode"
+                       type      = "ir_mode*",
+                       name      = "mode",
+                       comment   = "mode of the value to be loaded",
+               ),
+               dict(
+                       type      = "ir_volatility",
+                       name      = "volatility",
+                       comment   = "volatile loads are a visible side-effect and may not be optimized",
+                       init      = "flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
+                       to_flags  = "%s == volatility_is_volatile ? cons_volatile : 0"
+               ),
+               dict(
+                       type      = "ir_align",
+                       name      = "unaligned",
+                       comment   = "pointers to unaligned loads don't need to respect the load-mode/type alignments",
+                       init      = "flags & cons_unaligned ? align_non_aligned : align_is_aligned",
+                       to_flags  = "%s == align_non_aligned ? cons_unaligned : 0"
                ),
        ]
        attr_struct = "load_attr"
        constructor_args = [
                dict(
-                       type = "ir_cons_flags",
-                       name = "flags",
+                       type    = "ir_cons_flags",
+                       name    = "flags",
+                       comment = "specifies alignment, volatility and pin state",
                ),
        ]
+       pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
+       throws_init = "(flags & cons_throws_exception) != 0"
 
 class Minus(Unop):
        """returns the difference between its operands"""
@@ -539,28 +631,34 @@ class Mod(Op):
        """returns the remainder of its operands from an implied division.
 
        Examples:
+
        * mod(5,3)   produces 2
        * mod(5,-3)  produces 2
        * mod(-5,3)  produces -2
        * mod(-5,-3) produces -2
        """
-       ins   = [ "mem", "left", "right" ]
+       ins   = [
+               ("mem",   "memory dependency"),
+               ("left",  "first operand"),
+               ("right", "second operand"),
+       ]
        outs  = [
-               ("M",         "memory result",                         "pn_Generic_M"),
-               ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
-               ("X_except",  "control flow when exception occured",   "pn_Generic_X_except"),
-               ("res",       "result of computation",                 "pn_Generic_other"),
+               ("M",         "memory result"),
+               ("res",       "result of computation"),
+               ("X_regular", "control flow when no exception occurs"),
+               ("X_except",  "control flow when exception occured"),
        ]
        flags = [ "fragile", "uses_memory" ]
-       attrs_name = "divmod"
        attrs = [
                dict(
-                       type = "ir_mode*",
-                       name = "resmode"
+                       type    = "ir_mode*",
+                       name    = "resmode",
+                       comment = "mode of the result",
                ),
        ]
-       attr_struct = "divmod_attr"
+       attr_struct = "mod_attr"
        pinned      = "exception"
+       throws_init = "false"
        op_index    = 1
        arity_override = "oparity_binary"
 
@@ -576,7 +674,11 @@ class Mulh(Binop):
 class Mux(Op):
        """returns the false or true operand depending on the value of the sel
        operand"""
-       ins    = [ "sel", "false", "true" ]
+       ins    = [
+          ("sel",   "value making the output selection"),
+          ("false", "selected if sel input is false"),
+          ("true",  "selected if sel input is true"),
+       ]
        flags  = []
        pinned = "no"
 
@@ -607,70 +709,57 @@ class Phi(Op):
        arity         = "variable"
        flags         = []
        attr_struct   = "phi_attr"
-       init = '''
+       init          = '''
+       res->attr.phi.u.backedge = new_backedge_arr(irg->obst, arity);'''
+       init_after_opt = '''
        /* Memory Phis in endless loops must be kept alive.
           As we can't distinguish these easily we keep all of them alive. */
-       if (is_Phi(res) && mode == mode_M)
-               add_End_keepalive(get_irg_end(irg), res);
-       '''
+       if (is_Phi(res) && mode == mode_M)
+               add_End_keepalive(get_irg_end(irg), res);'''
+       customSerializer = True
 
 class Pin(Op):
        """Pin the value of the node node in the current block. No users of the Pin
        node can float above the Block of the Pin. The node cannot float behind
        this block. Often used to Pin the NoMem node."""
-       ins      = [ "op" ]
+       ins      = [
+               ("op", "value which is pinned"),
+       ]
        mode     = "get_irn_mode(irn_op)"
        flags    = [ "highlevel" ]
        pinned   = "yes"
 
 class Proj(Op):
        """returns an entry of a tuple value"""
-       ins              = [ "pred" ]
+       ins              = [
+               ("pred", "the tuple value from which a part is extracted"),
+       ]
        flags            = []
        pinned           = "no"
        knownBlock       = True
        knownGraph       = True
        block            = "get_nodes_block(irn_pred)"
        graph            = "get_irn_irg(irn_pred)"
-       customSerializer = True
        attrs      = [
                dict(
-                       type = "long",
-                       name = "proj",
-               )
-       ]
-       attr_struct = "proj_attr"
-
-class Quot(Op):
-       """returns the quotient of its 2 operands, floatingpoint version"""
-       ins   = [ "mem", "left", "right" ]
-       outs  = [
-               ("M",         "memory result",                         "pn_Generic_M"),
-               ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
-               ("X_except",  "control flow when exception occured",   "pn_Generic_X_except"),
-               ("res",       "result of computation",                 "pn_Generic_other"),
-       ]
-       flags = [ "fragile", "uses_memory" ]
-       attrs_name = "divmod"
-       attrs = [
-               dict(
-                       type = "ir_mode*",
-                       name = "resmode"
+                       type    = "long",
+                       name    = "proj",
+                       comment = "number of tuple component to be extracted",
                ),
        ]
-       attr_struct = "divmod_attr"
-       pinned      = "exception"
-       op_index    = 1
-       arity_override = "oparity_binary"
+       attr_struct = "proj_attr"
 
 class Raise(Op):
        """Raises an exception. Unconditional change of control flow. Writes an
        explicit Except variable to memory to pass it to the exception handler.
        Must be lowered to a Call to a runtime check function."""
-       ins    = [ "mem", "exo_ptr" ]
+       ins    = [
+               ("mem",     "memory dependency"),
+               ("exo_ptr", "pointer to exception object to be thrown"),
+       ]
        outs  = [
-               ("M", "memory result",                     "pn_Generic_M"),
-               ("X", "control flow to exception handler", "pn_Generic_X_regular"),
+               ("M", "memory result"),
+               ("X", "control flow to exception handler"),
        ]
        flags  = [ "highlevel", "cfopcode" ]
        pinned = "yes"
@@ -678,7 +767,9 @@ class Raise(Op):
 class Return(Op):
        """Returns from the current function. Takes memory and return values as
        operands."""
-       ins      = [ "mem" ]
+       ins      = [
+               ("mem", "memory dependency"),
+       ]
        arity    = "variable"
        mode     = "mode_X"
        flags    = [ "cfopcode" ]
@@ -691,16 +782,23 @@ class Rotl(Binop):
 
 class Sel(Op):
        """Computes the address of a entity of a compound type given the base
-       address of an instance of the compound type."""
-       ins    = [ "mem", "ptr" ]
+       address of an instance of the compound type.
+
+       Optimisations assume that a Sel node can only produce a NULL pointer if the
+       ptr input was NULL."""
+       ins    = [
+               ("mem", "memory dependency"),
+               ("ptr", "pointer to object to select from"),
+       ]
        arity  = "variable"
        flags  = []
        mode   = "is_Method_type(get_entity_type(entity)) ? mode_P_code : mode_P_data"
        pinned = "no"
        attrs  = [
                dict(
-                       type = "ir_entity*",
-                       name = "entity"
+                       type    = "ir_entity*",
+                       name    = "entity",
+                       comment = "entity which is selected",
                )
        ]
        attr_struct = "sel_attr"
@@ -727,7 +825,6 @@ class Start(Op):
                ("X_initial_exec", "control flow"),
                ("M",              "initial memory"),
                ("P_frame_base",   "frame base pointer"),
-               ("P_tls",          "pointer to thread local storage segment"),
                ("T_args",         "function arguments")
        ]
        mode             = "mode_T"
@@ -735,25 +832,46 @@ class Start(Op):
        flags            = [ "cfopcode" ]
        singleton        = True
        knownBlock       = True
-       customSerializer = True
        block            = "get_irg_start_block(irg)"
 
 class Store(Op):
        """Stores a value into memory (heap or stack)."""
-       ins      = [ "mem", "ptr", "value" ]
+       ins   = [
+          ("mem",   "memory dependency"),
+          ("ptr",   "address to store to"),
+          ("value", "value to store"),
+       ]
        outs  = [
-               ("M",         "memory result",                         "pn_Generic_M"),
-               ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
-               ("X_except",  "control flow when exception occured",   "pn_Generic_X_except"),
+               ("M",         "memory result"),
+               ("X_regular", "control flow when no exception occurs"),
+               ("X_except",  "control flow when exception occured"),
        ]
        flags    = [ "fragile", "uses_memory" ]
        pinned   = "exception"
        attr_struct = "store_attr"
        pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
+       throws_init = "(flags & cons_throws_exception) != 0"
+       attrs = [
+               dict(
+                       type      = "ir_volatility",
+                       name      = "volatility",
+                       comment   = "volatile stores are a visible side-effect and may not be optimized",
+                       init      = "flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
+                       to_flags  = "%s == volatility_is_volatile ? cons_volatile : 0"
+               ),
+               dict(
+                       type      = "ir_align",
+                       name      = "unaligned",
+                       comment   = "pointers to unaligned stores don't need to respect the load-mode/type alignments",
+                       init      = "flags & cons_unaligned ? align_non_aligned : align_is_aligned",
+                       to_flags  = "%s == align_non_aligned ? cons_unaligned : 0"
+               ),
+       ]
        constructor_args = [
                dict(
-                       type = "ir_cons_flags",
-                       name = "flags",
+                       type    = "ir_cons_flags",
+                       name    = "flags",
+                       comment = "specifies alignment, volatility and pin state",
                ),
        ]
 
@@ -764,34 +882,36 @@ class Sub(Binop):
 class SymConst(Op):
        """A symbolic constant.
 
-        - symconst_type_tag   The symbolic constant represents a type tag.  The
-                              type the tag stands for is given explicitly.
-        - symconst_type_size  The symbolic constant represents the size of a type.
-                              The type of which the constant represents the size
-                              is given explicitly.
-        - symconst_type_align The symbolic constant represents the alignment of a
-                              type.  The type of which the constant represents the
-                              size is given explicitly.
-        - symconst_addr_ent   The symbolic constant represents the address of an
-                              entity (variable or method).  The variable is given
-                              explicitly by a firm entity.
-        - symconst_ofs_ent    The symbolic constant represents the offset of an
-                              entity in its owner type.
-        - symconst_enum_const The symbolic constant is a enumeration constant of
-                              an enumeration type."""
+        - *symconst_type_size* The symbolic constant represents the size of a type.
+                               The type of which the constant represents the size
+                               is given explicitly.
+        - *symconst_type_align* The symbolic constant represents the alignment of a
+                               type.  The type of which the constant represents the
+                               size is given explicitly.
+        - *symconst_addr_ent*  The symbolic constant represents the address of an
+                               entity (variable or method).  The variable is given
+                               explicitly by a firm entity.
+        - *symconst_ofs_ent*   The symbolic constant represents the offset of an
+                               entity in its owner type.
+        - *symconst_enum_const* The symbolic constant is a enumeration constant of
+                               an enumeration type."""
        mode       = "mode_P"
        flags      = [ "constlike", "start_block" ]
        knownBlock = True
        pinned     = "no"
        attrs      = [
                dict(
-                       type = "ir_entity*",
-                       name = "entity",
-                       noprop = True
+                       type    = "ir_entity*",
+                       name    = "entity",
+                       noprop  = True,
+                       comment = "entity whose address is returned",
                )
        ]
        attr_struct = "symconst_attr"
        customSerializer = True
+       # constructor is written manually at the moment, because of the strange
+       # union argument
+       noconstructor = True
 
 class Sync(Op):
        """The Sync operation unifies several partial memory blocks. These blocks
@@ -812,7 +932,7 @@ class Tuple(Op):
        following Proj nodes have not to be changed. (They are hard to find due to
        the implementation with pointers in only one direction.) The Tuple node is
        smaller than any other node, so that a node can be changed into a Tuple by
-       just changing it's opcode and giving it a new in array."""
+       just changing its opcode and giving it a new in array."""
        arity  = "variable"
        mode   = "mode_T"
        pinned = "no"
@@ -824,7 +944,7 @@ class Unknown(Op):
        knownBlock = True
        pinned     = "yes"
        block      = "get_irg_start_block(irg)"
-       flags      = [ "cfopcode", "start_block", "constlike", "dump_noblock" ]
+       flags      = [ "start_block", "constlike", "dump_noblock" ]
 
 # Prepare node list