mirror of
https://bitbucket.org/librepilot/librepilot.git
synced 2024-12-10 18:24:11 +01:00
267 lines
7.3 KiB
C
267 lines
7.3 KiB
C
/*
|
|
# This file is Copyright 2006, 2007, 2009, 2010 Dean Hall.
|
|
#
|
|
# This file is part of the PyMite VM.
|
|
# The PyMite VM is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU GENERAL PUBLIC LICENSE Version 2.
|
|
#
|
|
# The PyMite VM is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
# A copy of the GNU GENERAL PUBLIC LICENSE Version 2
|
|
# is seen in the file COPYING in this directory.
|
|
*/
|
|
|
|
|
|
#ifndef __PM_H__
|
|
#define __PM_H__
|
|
|
|
|
|
/**
|
|
* \file
|
|
* \brief PyMite Header
|
|
*
|
|
* Include things that are needed by nearly everything.
|
|
*/
|
|
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <stdint.h>
|
|
#include <stdio.h>
|
|
|
|
|
|
/**
|
|
* Value indicating the release of PyMite
|
|
*
|
|
* This value should be incremented for every public release.
|
|
* It helps locate a defect when used in conjunction with a fileID
|
|
* and line number.
|
|
*/
|
|
#define PM_RELEASE 8
|
|
|
|
|
|
/** null for C code */
|
|
#define C_NULL 0
|
|
|
|
/** false for C code */
|
|
#define C_FALSE 0
|
|
|
|
/** true for C code */
|
|
#define C_TRUE 1
|
|
|
|
/** Comparison result is that items are the same */
|
|
#define C_SAME (int8_t)0
|
|
|
|
/** Comparison result is that items differ */
|
|
#define C_DIFFER (int8_t)-1
|
|
|
|
/** PORT inline for C code */
|
|
#define INLINE __inline__
|
|
|
|
|
|
/**
|
|
* Returns an exception error code and stores debug data
|
|
*
|
|
* This macro must be used as an rval statement. That is, it must
|
|
* be used after an assignment such as "retval = " or a return statement
|
|
*/
|
|
#if __DEBUG__
|
|
#define PM_RAISE(retexn, exn) \
|
|
do \
|
|
{ \
|
|
retexn = (exn); \
|
|
gVmGlobal.errFileId = __FILE_ID__; \
|
|
gVmGlobal.errLineNum = (uint16_t)__LINE__; \
|
|
} while (0)
|
|
#else
|
|
#define PM_RAISE(retexn, exn) \
|
|
retexn = (exn)
|
|
#endif
|
|
|
|
/** if retval is not OK, break from the block */
|
|
#define PM_BREAK_IF_ERROR(retval) if ((retval) != PM_RET_OK) break
|
|
|
|
/** return an error code if it is not PM_RET_OK */
|
|
#define PM_RETURN_IF_ERROR(retval) if ((retval) != PM_RET_OK) return (retval)
|
|
|
|
/** print an error message if argument is not PM_RET_OK */
|
|
#define PM_REPORT_IF_ERROR(retval) if ((retval) != PM_RET_OK) \
|
|
plat_reportError(retval)
|
|
|
|
/** Jumps to a label if argument is not PM_RET_OK */
|
|
#define PM_GOTO_IF_ERROR(retval, target) if ((retval) != PM_RET_OK) \
|
|
goto target
|
|
|
|
//Dirty hack to resolve conflicts with winnt.h on Windows
|
|
#if defined(C_ASSERT)
|
|
#undef C_ASSERT
|
|
#endif
|
|
|
|
#if __DEBUG__
|
|
/** If the boolean expression fails, return the ASSERT error code */
|
|
#define C_ASSERT(boolexpr) \
|
|
do \
|
|
{ \
|
|
if (!((boolexpr))) \
|
|
{ \
|
|
gVmGlobal.errFileId = __FILE_ID__; \
|
|
gVmGlobal.errLineNum = (uint16_t)__LINE__; \
|
|
return PM_RET_ASSERT_FAIL; \
|
|
} \
|
|
} \
|
|
while (0)
|
|
|
|
#else
|
|
/** Assert statements are removed from production code */
|
|
#define C_ASSERT(boolexpr)
|
|
#endif
|
|
|
|
/** Use as the first argument to C_DEBUG_PRINT for low volume messages */
|
|
#define VERBOSITY_LOW 1
|
|
|
|
/** Use as the first argument to C_DEBUG_PRINT for medium volume messages */
|
|
#define VERBOSITY_MEDIUM 2
|
|
|
|
/** Use as the first argument to C_DEBUG_PRINT for high volume messages */
|
|
#define VERBOSITY_HIGH 3
|
|
|
|
#if __DEBUG__
|
|
|
|
/** To be used to set DEBUG_PRINT_VERBOSITY to a value so no prints occur */
|
|
#define VERBOSITY_OFF 0
|
|
|
|
/** Sets the level of verbosity to allow in debug prints */
|
|
#define DEBUG_PRINT_VERBOSITY VERBOSITY_OFF
|
|
|
|
/** Prints a debug message when the verbosity is within the set value */
|
|
#define C_DEBUG_PRINT(v, f, ...) \
|
|
do \
|
|
{ \
|
|
if (DEBUG_PRINT_VERBOSITY >= (v)) \
|
|
{ \
|
|
printf("PM_DEBUG: " f, ## __VA_ARGS__); \
|
|
} \
|
|
} \
|
|
while (0)
|
|
|
|
#else
|
|
#define C_DEBUG_PRINT(...)
|
|
#endif
|
|
|
|
|
|
/**
|
|
* Return values for system functions
|
|
* to report status, errors, exceptions, etc.
|
|
* Normally, functions which use these values
|
|
* should propagate the same return value
|
|
* up the call tree to the interpreter.
|
|
*/
|
|
typedef enum PmReturn_e
|
|
{
|
|
/* general status return values */
|
|
PM_RET_OK = 0, /**< Everything is ok */
|
|
PM_RET_NO = 0xFF, /**< General "no result" */
|
|
PM_RET_ERR = 0xFE, /**< General failure */
|
|
PM_RET_STUB = 0xFD, /**< Return val for stub fxn */
|
|
PM_RET_ASSERT_FAIL = 0xFC, /**< Assertion failure */
|
|
PM_RET_FRAME_SWITCH = 0xFB, /**< Frame pointer was modified */
|
|
|
|
/* return vals that indicate an exception occured */
|
|
PM_RET_EX = 0xE0, /**< General exception */
|
|
PM_RET_EX_EXIT = 0xE1, /**< System exit */
|
|
PM_RET_EX_IO = 0xE2, /**< Input/output error */
|
|
PM_RET_EX_ZDIV = 0xE3, /**< Zero division error */
|
|
PM_RET_EX_ASSRT = 0xE4, /**< Assertion error */
|
|
PM_RET_EX_ATTR = 0xE5, /**< Attribute error */
|
|
PM_RET_EX_IMPRT = 0xE6, /**< Import error */
|
|
PM_RET_EX_INDX = 0xE7, /**< Index error */
|
|
PM_RET_EX_KEY = 0xE8, /**< Key error */
|
|
PM_RET_EX_MEM = 0xE9, /**< Memory error */
|
|
PM_RET_EX_NAME = 0xEA, /**< Name error */
|
|
PM_RET_EX_SYNTAX = 0xEB, /**< Syntax error */
|
|
PM_RET_EX_SYS = 0xEC, /**< System error */
|
|
PM_RET_EX_TYPE = 0xED, /**< Type error */
|
|
PM_RET_EX_VAL = 0xEE, /**< Value error */
|
|
PM_RET_EX_STOP = 0xEF, /**< Stop iteration */
|
|
PM_RET_EX_WARN = 0xF0, /**< Warning */
|
|
} PmReturn_t;
|
|
|
|
|
|
extern volatile uint32_t pm_timerMsTicks;
|
|
|
|
|
|
/* WARNING: The order of the following includes is critical */
|
|
#include "plat.h"
|
|
#include "pmfeatures.h"
|
|
#include "pmEmptyPlatformDefs.h"
|
|
#include "sli.h"
|
|
#include "mem.h"
|
|
#include "obj.h"
|
|
#include "seq.h"
|
|
#include "tuple.h"
|
|
#include "strobj.h"
|
|
#include "heap.h"
|
|
#include "int.h"
|
|
#include "seglist.h"
|
|
#include "lst.h"
|
|
#include "dict.h"
|
|
#include "codeobj.h"
|
|
#include "func.h"
|
|
#include "module.h"
|
|
#include "frame.h"
|
|
#include "interp.h"
|
|
#include "img.h"
|
|
#include "global.h"
|
|
#include "class.h"
|
|
#include "thread.h"
|
|
#include "float.h"
|
|
#include "plat_interface.h"
|
|
#include "bytearray.h"
|
|
|
|
|
|
/** Pointer to a native function used for lookup tables in interp.c */
|
|
typedef PmReturn_t (* pPmNativeFxn_t)(pPmFrame_t *);
|
|
extern pPmNativeFxn_t const std_nat_fxn_table[];
|
|
extern pPmNativeFxn_t const usr_nat_fxn_table[];
|
|
|
|
|
|
/**
|
|
* Initializes the PyMite virtual machine and indexes the user's application
|
|
* image. The VM heap and globals are reset. The argument, pusrimg, may be
|
|
* null for interactive sessions.
|
|
*
|
|
* @param memspace Memory space in which the user image is located
|
|
* @param pusrimg Address of the user image in the memory space
|
|
* @return Return status
|
|
*/
|
|
PmReturn_t pm_init(PmMemSpace_t memspace, uint8_t const * const pusrimg);
|
|
|
|
/**
|
|
* Executes the named module
|
|
*
|
|
* @param modstr Name of module to run
|
|
* @return Return status
|
|
*/
|
|
PmReturn_t pm_run(uint8_t const *modstr);
|
|
|
|
/**
|
|
* Needs to be called periodically by the host program.
|
|
* For the desktop target, it is periodically called using a signal.
|
|
* For embedded targets, it needs to be called periodically. It should
|
|
* be called from a timer interrupt.
|
|
*
|
|
* @param usecsSinceLastCall Microseconds (not less than those) that passed
|
|
* since last call. This must be <64535.
|
|
* @return Return status
|
|
*/
|
|
PmReturn_t pm_vmPeriodic(uint16_t usecsSinceLastCall);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __PM_H__ */
|