Utility.cpp

/*----------------------------------------------------------------------------*/
/* Copyright (c) FIRST 2008. All Rights Reserved.                                                         */
/* Open Source Software - may be modified and shared by FRC teams. The code   */
/* must be accompanied by the FIRST BSD license file in $(WIND_BASE)/WPILib.  */
/*----------------------------------------------------------------------------*/

#include "Utility.h"

#include "NetworkCommunication/FRCComm.h"
#include "ChipObject.h"
#include "Task.h"
#include <dbgLib.h>
#include <stdio.h>
#include <sysSymTbl.h>
#include "nivision.h"

#define DBG_DEMANGLE_PRINT_LEN 256  /* Num chars of demangled names to print */

extern "C"
{
        extern char * cplusDemangle (char *source, char *dest, INT32 n);
}

char *wpi_getLabel(UINT addr, INT32 *found)
{
        INT32 pVal;
        SYM_TYPE pType;
        char name[MAX_SYS_SYM_LEN + 1];
        static char label[DBG_DEMANGLE_PRINT_LEN + 1 + 11];
        bzero(label, DBG_DEMANGLE_PRINT_LEN + 1 + 11);

        if (symFindByValue(sysSymTbl, addr, name, &pVal, &pType) == OK)
        {
                cplusDemangle(name, label, sizeof(label) - 11);
                if ((UINT)pVal != addr)
                {
                        sprintf(&label[strlen(label)], "+0x%04x", addr-pVal);
                        if (found) *found = 2;
                }
                else
                {
                        if (found) *found = 1;
                }
        }
        else
        {
                sprintf(label, "0x%04x", addr);
                if (found) *found = 0;
        }

        return label;
}
/*
static void wpiTracePrint(INSTR *caller, INT32 func, INT32 nargs, INT32 *args, INT32 taskId, BOOL isKernelAdrs)
{
        char buf [MAX_SYS_SYM_LEN * 2];
        INT32 ix;
        INT32 len = 0;
        len += sprintf (&buf [len], "%s <%#010x>: ", wpi_getLabel((UINT)caller), (INT32)caller);
        len += sprintf (&buf [len], "%s <%#010x> (", wpi_getLabel((UINT)func), func);
        for (ix = 0; ix < nargs; ix++)
        {
                if (ix != 0)
                        len += sprintf (&buf [len], ", ");
                len += sprintf (&buf [len], "%#x", args [ix]);
        }
        len += sprintf (&buf [len], ")\n");

        printf(buf);
}
*/
static void wpiCleanTracePrint(INSTR *caller, INT32 func, INT32 nargs, INT32 *args, INT32 taskId, BOOL isKernelAdrs)
{
        char buf [MAX_SYS_SYM_LEN];
        INT32 ix;
        INT32 len = 0;
        INT32 nameFound = 0;
        INT32 params = 0;
        INT32 totalnargs = nargs;
        char *funcName = wpi_getLabel((UINT)func, &nameFound);
        // Ignore names that are not exact symbol address matches.
        if (nameFound != 1) return;

        // Ignore internal function name matches.
        if (strncmp(funcName, "wpi_assert", 10) == 0) return;
        if (strncmp(funcName, "wpi_fatal", 9) == 0) return;
        if (strncmp(funcName, "wpi_selfTrace", 13) == 0) return;
        if (strncmp(funcName, "Error::Set", 10) == 0) return;
        if (strncmp(funcName, "ErrorBase::SetError", 19) == 0) return;
        if (strncmp(funcName, "Error::Report", 13) == 0) return;

        // Find the number of arguments in the name string.
        char *start = strchr(funcName, '(');
        char *end = strrchr(funcName, ')');
        if (start + 1 != end && start != NULL)
        {
                do
                {
                        params++;
                        if(strncmp(start+1, "bool", 4) == 0 || strncmp(start+2, "bool", 4) == 0)
                        {
                                totalnargs++;
                        }
                        start = strchr(start + 1, ',');
                }
                while(start < end && start != NULL);
        }
        char *funcNameEnd = strchr(funcName, '(');
        *funcNameEnd = 0;
        len += sprintf (&buf [len], funcName);

        // If this is a member function, print out the this pointer value.
        if (totalnargs - params == 1)
        {
                len += sprintf (&buf [len], "<this=%#x>", args [0]);
        }

        // Print out the argument values.
        len += sprintf (&buf [len], "(");
        for (ix = totalnargs - params; ix < nargs; ix++)
        {
                if (ix != totalnargs - params)
                        len += sprintf (&buf [len], ", ");
                len += sprintf (&buf [len], "%#x", args [ix]);
        }
        len += sprintf (&buf [len], ")\n");

        printf(buf);
}

extern "C"
{
        extern void trcStack(REG_SET* pRegs, FUNCPTR printRtn, INT32 tid);
}

static INT32 wpiStackTask(INT32 taskId)
{
        taskDelay(1);
        //tt(taskId);

        REG_SET regs;
        taskRegsGet(taskId, &regs);
        trcStack(&regs, (FUNCPTR) wpiCleanTracePrint, taskId);
        printf("\n");

        // The task should be resumed because it had to be suspended to get the stack trace.
        taskResume(taskId);
        return 0;
}

void wpi_selfTrace()
{
        INT32 priority=100;
        taskPriorityGet(0, &priority);
        // Lower priority than the calling task.
        Task traceTask("StackTrace", (FUNCPTR)wpiStackTask, priority + 1);
        traceTask.Start(taskIdSelf());

        // Task to be traced must be suspended for the stack trace to work.
        taskSuspend(0);
}

static bool stackTraceEnabled = false;
static bool suspendOnAssertEnabled = false;

void wpi_stackTraceOnAssertEnable(bool enabled)
{
        stackTraceEnabled = enabled;
}

void wpi_suspendOnAssertEnabled(bool enabled)
{
        suspendOnAssertEnabled = enabled;
}

static void wpi_handleTracing()
{
        if (stackTraceEnabled)
        {
                printf("\n-----------<Stack Trace>----------------\n");
                wpi_selfTrace();
        }
        printf("\n");
}

bool wpi_assert_impl(bool conditionValue, 
                                         const char *conditionText,
                                         const char *message,
                                         const char *fileName,
                                         UINT32 lineNumber, 
                                         const char *funcName)
{
        if (!conditionValue)
        {   
                // Error string buffer
                char error[256];
                                
                // If an error message was specified, include it
                // Build error string
                if(message != NULL) {
                        sprintf(error, "Assertion failed: \"%s\", \"%s\" failed in %s() in %s at line %d\n", 
                                                         message, conditionText, funcName, fileName, lineNumber);
                } else {
                        sprintf(error, "Assertion failed: \"%s\" in %s() in %s at line %d\n", 
                                                         conditionText, funcName, fileName, lineNumber);
                }
                
                // Print to console and send to remote dashboard
                printf("\n\n>>>>%s", error);
                setErrorData(error, strlen(error), 100);
                
                wpi_handleTracing();
                if (suspendOnAssertEnabled) taskSuspend(0);
        }
        return conditionValue;
}

void wpi_assertEqual_common_impl(int valueA,
                                                         int valueB,
                                                         const char *equalityType,
                                                         const char *message,
                                                         const char *fileName,
                                                         UINT32 lineNumber, 
                                                         const char *funcName)
{
        // Error string buffer
        char error[256];
                        
        // If an error message was specified, include it
        // Build error string
        if(message != NULL) {
                sprintf(error, "Assertion failed: \"%s\", \"%d\" %s \"%d\" in %s() in %s at line %d\n", 
                                                 message, valueA, equalityType, valueB, funcName, fileName, lineNumber);
        } else {
                sprintf(error, "Assertion failed: \"%d\" %s \"%d\" in %s() in %s at line %d\n", 
                                                 valueA, equalityType, valueB, funcName, fileName, lineNumber);
        }
        
        // Print to console and send to remote dashboard
        printf("\n\n>>>>%s", error);
        setErrorData(error, strlen(error), 100);
        
        wpi_handleTracing();
        if (suspendOnAssertEnabled) taskSuspend(0);
}

bool wpi_assertEqual_impl(int valueA,
                                                  int valueB,
                                                  const char *message,
                                                  const char *fileName,
                                                  UINT32 lineNumber, 
                                                  const char *funcName)
{
        if(!(valueA == valueB))
        {
                wpi_assertEqual_common_impl(valueA, valueB, "!=", message, fileName, lineNumber, funcName);
        }
        return valueA == valueB;
}

bool wpi_assertNotEqual_impl(int valueA,
                                                     int valueB,
                                                     const char *message,
                                                     const char *fileName,
                                                     UINT32 lineNumber, 
                                                     const char *funcName)
{
        if(!(valueA != valueB))
        {
                wpi_assertEqual_common_impl(valueA, valueB, "==", message, fileName, lineNumber, funcName);
        }
        return valueA != valueB;
}


UINT16 GetFPGAVersion()
{
        tRioStatusCode status = 0;
        tGlobal *global = tGlobal::create(&status);
        UINT16 version = global->readVersion(&status);
        delete global;
        wpi_setGlobalError(status);
        return version;
}

UINT32 GetFPGARevision()
{
        tRioStatusCode status = 0;
        tGlobal *global = tGlobal::create(&status);
        UINT32 revision = global->readRevision(&status);
        delete global;
        wpi_setGlobalError(status);
        return revision;
}

UINT32 GetFPGATime()
{
        tRioStatusCode status = 0;
        tGlobal *global = tGlobal::create(&status);
        UINT32 time = global->readLocalTime(&status);
        delete global;
        wpi_setGlobalError(status);
        return time;
}

// RT hardware access functions exported from ni_emb.out
extern "C"
{
        INT32 UserSwitchInput(INT32 nSwitch);
        INT32 LedInput(INT32 led);
        INT32 LedOutput(INT32 led, INT32 value);
}

INT32 GetRIOUserSwitch()
{
        INT32 switchValue = UserSwitchInput(0);
        wpi_assert(switchValue >= 0);
        return switchValue > 0;
}

void SetRIOUserLED(UINT32 state)
{
        LedOutput(0, state > 0);
}

INT32 GetRIOUserLED()
{
        return LedInput(0);
}

INT32 ToggleRIOUserLED()
{
        INT32 ledState = !GetRIOUserLED();
        SetRIOUserLED(ledState);
        return ledState;
}

void SetRIO_FPGA_LED(UINT32 state)
{
        tRioStatusCode status = 0;
        tGlobal *global = tGlobal::create(&status);
        global->writeFPGA_LED(state, &status);
        wpi_setGlobalError(status);
        delete global;
}

INT32 GetRIO_FPGA_LED()
{
        tRioStatusCode status = 0;
        tGlobal *global = tGlobal::create(&status);
        bool ledValue = global->readFPGA_LED(&status);
        wpi_setGlobalError(status);
        delete global;
        return ledValue;
}

INT32 ToggleRIO_FPGA_LED()
{
        INT32 ledState = !GetRIO_FPGA_LED();
        SetRIO_FPGA_LED(ledState);
        return ledState;
}