cpython/Python/instruction_sequence.c

/*
 * This file implements a data structure representing a sequence of
 * instructions, which is used by different parts of the compilation
 * pipeline.
 */


#include <stdbool.h>

#include "Python.h"

#include "pycore_compile.h" // _PyCompile_EnsureArrayLargeEnough
#include "pycore_opcode_utils.h"
#include "pycore_opcode_metadata.h" // OPCODE_HAS_ARG, etc

instruction;
instr_sequence;
location;

#define INITIAL_INSTR_SEQUENCE_SIZE …
#define INITIAL_INSTR_SEQUENCE_LABELS_MAP_SIZE …

#include "clinic/instruction_sequence.c.h"

#undef SUCCESS
#undef ERROR
#define SUCCESS …
#define ERROR …

#define RETURN_IF_ERROR(X) …

static int
instr_sequence_next_inst(instr_sequence *seq) { … }

_PyJumpTargetLabel
_PyInstructionSequence_NewLabel(instr_sequence *seq)
{ … }

int
_PyInstructionSequence_UseLabel(instr_sequence *seq, int lbl)
{ … }

int
_PyInstructionSequence_ApplyLabelMap(instr_sequence *instrs)
{ … }

#define MAX_OPCODE …

int
_PyInstructionSequence_Addop(instr_sequence *seq, int opcode, int oparg,
                             location loc)
{ … }

int
_PyInstructionSequence_InsertInstruction(instr_sequence *seq, int pos,
                                         int opcode, int oparg, location loc)
{ … }

int
_PyInstructionSequence_AddNested(instr_sequence *seq, instr_sequence *nested)
{ … }

void
PyInstructionSequence_Fini(instr_sequence *seq) { … }

/*[clinic input]
class InstructionSequenceType "_PyInstructionSequence *" "&_PyInstructionSequence_Type"
[clinic start generated code]*/
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=589963e07480390f]*/

static _PyInstructionSequence*
inst_seq_create(void)
{ … }

PyObject*
_PyInstructionSequence_New(void)
{ … }

/*[clinic input]
@classmethod
InstructionSequenceType.__new__ as inst_seq_new

Create a new InstructionSequence object.
[clinic start generated code]*/

static PyObject *
inst_seq_new_impl(PyTypeObject *type)
/*[clinic end generated code: output=98881de92c8876f6 input=b393150146849c74]*/
{ … }

/*[clinic input]
InstructionSequenceType.use_label

  label: int

Place label at current location.
[clinic start generated code]*/

static PyObject *
InstructionSequenceType_use_label_impl(_PyInstructionSequence *self,
                                       int label)
/*[clinic end generated code: output=4c06bbacb2854755 input=da55f49bb91841f3]*/

{ … }

/*[clinic input]
InstructionSequenceType.addop

  opcode: int
  oparg: int
  lineno: int
  col_offset: int
  end_lineno: int
  end_col_offset: int

Append an instruction.
[clinic start generated code]*/

static PyObject *
InstructionSequenceType_addop_impl(_PyInstructionSequence *self, int opcode,
                                   int oparg, int lineno, int col_offset,
                                   int end_lineno, int end_col_offset)
/*[clinic end generated code: output=af0cc22c048dfbf3 input=012762ac88198713]*/
{ … }

/*[clinic input]
InstructionSequenceType.new_label -> int

Return a new label.
[clinic start generated code]*/

static int
InstructionSequenceType_new_label_impl(_PyInstructionSequence *self)
/*[clinic end generated code: output=dcb0589e4f5bf4bd input=c66040b9897bc327]*/
{ … }

/*[clinic input]
InstructionSequenceType.add_nested

  nested: object

Add a nested sequence.
[clinic start generated code]*/

static PyObject *
InstructionSequenceType_add_nested_impl(_PyInstructionSequence *self,
                                        PyObject *nested)
/*[clinic end generated code: output=14540fad459f7971 input=f2c482568b3b3c0f]*/
{ … }

/*[clinic input]
InstructionSequenceType.get_nested

Add a nested sequence.
[clinic start generated code]*/

static PyObject *
InstructionSequenceType_get_nested_impl(_PyInstructionSequence *self)
/*[clinic end generated code: output=f415112c292630cb input=e429e474c57b95b4]*/
{ … }

/*[clinic input]
InstructionSequenceType.get_instructions

Return the instructions as a list of tuples or labels.
[clinic start generated code]*/

static PyObject *
InstructionSequenceType_get_instructions_impl(_PyInstructionSequence *self)
/*[clinic end generated code: output=23f4f3f894c301b3 input=fbadb5dadb611291]*/
{ … }

static PyMethodDef inst_seq_methods[] = …;

static PyMemberDef inst_seq_memberlist[] = …;

static PyGetSetDef inst_seq_getsetters[] = …;

static void
inst_seq_dealloc(_PyInstructionSequence *seq)
{ … }

static int
inst_seq_traverse(_PyInstructionSequence *seq, visitproc visit, void *arg)
{ … }

static int
inst_seq_clear(_PyInstructionSequence *seq)
{ … }

PyTypeObject _PyInstructionSequence_Type = …;