opcode_core.h File Reference

#include "opcode_gen_core.h"

Include dependency graph for opcode_core.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	opcode_core_INCLUDED   "opcode_core.h"

Macro Definition Documentation

#define opcode_core_INCLUDED   "opcode_core.h"

    Opcodes, Opcode Types, and Opcode Flags
    ---------------------------------------

Description:

This interface describes all the opcode names, operators,
types associated with opcodes, and properties associated with opcodes.
The files opcode_gen_core.h and opcode_gen_core.c are generated by
running './opcodegen', which uses perl prodecure calls to encode
all legal opcodes and types in a tabular form.

This code require absolutely no #includes to use, and is thus useful
for programs other than the compiler proper.

Reserved Prefixes:

OPC         for OPCODE members only.
OPR         for OPERATOR members only.
OPCODE              for other opcode information, e.g. external
            function names.
OPERATOR    for the operator, i.e. untyped operation

Exported types:

OPCODE

    An enumerated type.  The members are generated automatically.
    All OPCODEs are prefixed with OPC.

    OPCODE has the following fields:

    const OPERATOR operator

    The operator for this opcode.
    E.g. OPCODE_operator(OPC_F8ADD) is OPR_ADD.

    const TYPE_ID rtype

    The 'return type' of this opcode.
    E.g. OPCODE_rtype(OPC_F8ADD) is MTYPE_F8.

    const TYPE_ID desc

    The 'descriptor type' of this opcode.
    E.g. OPCODE_desc(OPC_F8ADD) is MTYPE_V.

    An opcode is fully and uniquely defined by these three components.

OPERATOR

    An enumerated type representing the operator.
    These are all prefixed with OPR.

OPCODE_MAPCAT

    The annotation category for opcodes, one of

      OPCODE_MAPCAT_HDR
      OPCODE_MAPCAT_SCF
      OPCODE_MAPCAT_LDST
      OPCODE_MAPCAT_PRAGMA
      OPCODE_MAPCAT_OSTMT
      OPCODE_MAPCAT_OEXP
      OPCODE_MAPCAT_ARRAY
      OPCODE_MAPCAT_CALL

    These are an enumerated type, the first value of which is 0.
    There are WN_MAP_CATEGORIES values, 0 through WN_MAP_CATEGORIES-1.

Exported data:

Commonly, these data structures would be used by opcode.h and opcode.c
to look up interesting information.  However, they are provided
separately because there is demand for them.

struct OPCODE_gop_info_struct {
  char name[16];
  OPCODE first;
  OPCODE last;
} OPCODE_gop_info[];

    Used to look up information about a OPERATOR: what the first
    opcode and last opcode are for that operator, and the ascii
    representation of the operator.

extern struct OPCODE_info_struct {
  char          _name[20];
  mUINT16       _operator;
  mUINT8        _rtype;
  mUINT8        _desc;
  mINT8         nkids;
  mUINT16   wnfields;
  mUINT16       _flags;
} OPCODE_info[];

    Used to look up information about an OPCODE: the ascii name,
    the "operator", the "return type" and "descriptor type" of
    the opcode, the number of kids (-1 if unknown) and the flags
    that define the boolean properties, currently

    OPCODE_PROPERTY_scf                     structured control flow
    OPCODE_PROPERTY_stmt            statement
    OPCODE_PROPERTY_expression              expression
    OPCODE_PROPERTY_leaf            nkids is zero
    OPCODE_PROPERTY_store           is a store
    OPCODE_PROPERTY_load            is a load
    OPCODE_PROPERTY_call            is a call
    OPCODE_PROPERTY_compare         is a comparison
    OPCODE_PROPERTY_non_scf         control flow, but not scf
    OPCODE_PROPERTY_boolean         boolean returns, e.g. GE

Definition at line 151 of file opcode_core.h.