path: root/src/usr/cxxtest/cxxtestexec.C

/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/cxxtest/cxxtestexec.C $                               */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2011,2019                        */
/* [+] International Business Machines Corp.                              */
/*                                                                        */
/*                                                                        */
/* Licensed under the Apache License, Version 2.0 (the "License");        */
/* you may not use this file except in compliance with the License.       */
/* You may obtain a copy of the License at                                */
/*                                                                        */
/*     http://www.apache.org/licenses/LICENSE-2.0                         */
/*                                                                        */
/* Unless required by applicable law or agreed to in writing, software    */
/* distributed under the License is distributed on an "AS IS" BASIS,      */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or        */
/* implied. See the License for the specific language governing           */
/* permissions and limitations under the License.                         */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */

#include <vfs/vfs.H>
#include <sys/task.h>
#include <string.h>
#include <stdio.h>
#include <kernel/console.H>
#include <sys/time.h>
#include <sys/sync.h>
#include <errl/errlentry.H>
#include <errl/errlmanager.H>
#include <initservice/taskargs.H>
#include <cxxtest/TestSuite.H>

namespace CxxTest
{
    extern uint64_t    g_ModulesStarted;
    extern uint64_t    g_ModulesCompleted;

}   //  namespace

// prototype
void    cxxinit( errlHndl_t    &io_taskRetErrl );

trace_desc_t *g_trac_cxxtest = NULL;
TRAC_INIT(&g_trac_cxxtest, CXXTEST_COMP_NAME, KILOBYTE );


/**
 * _start entry point for this task.
 */
TASK_ENTRY_MACRO( cxxinit );


/**
 *  @brief init() for CxxTest
 *  Iterate through all modules in the VFS named "libtest*" and create
 *  children tasks to execute them.
 *
 * * @parms[in,out]   - pointer to any args
 *
 */

void    cxxinit( errlHndl_t    &io_taskRetErrl )
{
    struct cxxtask_t
    {
        tid_t tid;
        const char * module;
    } cxxtask;
    errlHndl_t  l_errl  =   NULL;
    std::vector<const char *> module_list;
    std::vector<const char *> parallel_module_list;
    std::vector<const char *> serial_module_list;
    std::vector<cxxtask_t> tasks;
    tid_t       tidrc           =   0;

    for (uint64_t i = 0; i < CxxTest::CXXTEST_FAIL_LIST_SIZE; i++)
    {
        memset(CxxTest::g_FailedTestList[i].failTestFile,
               0x00,
               CxxTest::CXXTEST_FILENAME_SIZE);
        CxxTest::g_FailedTestList[i].failTestData = 0;
    };

    // output a blank line so that it's easier to find the beginning of
    //  CxxTest
    TRACDCOMP( g_trac_cxxtest, " ");
    TRACDCOMP( g_trac_cxxtest, " ");

    // count up the number of viable modules ahead of time
    TRACDCOMP( g_trac_cxxtest, "Counting CxxTestExec modules:" );

    //Get all modules, then sort into parallel and serial lists
    VFS::find_test_modules(module_list);

    CxxTest::sortTests(module_list, serial_module_list, parallel_module_list);

    //  start executing the CxxTest modules
    TRACFCOMP( g_trac_cxxtest, ENTER_MRK "Execute CxxTestExec, totalparallelmodules=%d, totalserialmodules=%d (overall total:%d)",
            parallel_module_list.size(),
            serial_module_list.size(),
            parallel_module_list.size()+serial_module_list.size());
    printkd( "\n Begin CxxTest...\n");

    __sync_add_and_fetch(&CxxTest::g_ModulesStarted, 1);

    // Before we launch, ensure there aren't any residual error logs from
    // the IPL.
    if (ERRORLOG::ErrlManager::errlCommittedThisBoot())
    {
        TS_FAIL("Error logs committed previously during IPL.");
    }

    for(std::vector<const char *>::const_iterator i = serial_module_list.begin();
        i != serial_module_list.end(); ++i)
    {
        __sync_add_and_fetch(&CxxTest::g_ModulesStarted, 1);

        TRACFCOMP( g_trac_cxxtest,
                   "Now executing Serial Test Cases!");

        // load module and call _init()
        l_errl = VFS::module_load( *i );
        if ( l_errl )
        {
            // vfs could not load a module and returned an errorlog.
            //  commit the errorlog, mark the test failed, and
            //  move on.
            TS_FAIL( "ERROR: Task %s could not be loaded, committing errorlog",
                    *i );
            errlCommit( l_errl, CXXTEST_COMP_ID );
            continue;
        }

        //First run all serial testcases
        tidrc = task_exec( *i, NULL );
        TRACFCOMP( g_trac_cxxtest, "Launched serial task: %s tidrc=%d",
                   *i, tidrc );
        int status = 0;
        task_wait_tid(tidrc, &status, NULL);

        if (status != TASK_STATUS_EXITED_CLEAN)
        {
            TRACFCOMP( g_trac_cxxtest, "Task %d crashed with status %d.",
                       tidrc, status );
            if(CxxTest::g_FailedTests < CxxTest::CXXTEST_FAIL_LIST_SIZE)
            {
                CxxTest::CxxTestFailedEntry *l_failedEntry =
                    &CxxTest::g_FailedTestList[CxxTest::g_FailedTests];
                sprintf(l_failedEntry->failTestFile,
                        "%s crashed",
                        *i);
                l_failedEntry->failTestData = tidrc;
            }
            __sync_add_and_fetch(&CxxTest::g_FailedTests, 1);
        }
        else
        {
            TRACFCOMP( g_trac_cxxtest, "Task %d finished.", tidrc );
        }
    }

    //Then run all parallel testcases
    for(std::vector<const char *>::const_iterator i = parallel_module_list.begin();
        i != parallel_module_list.end(); ++i)
    {
        __sync_add_and_fetch(&CxxTest::g_ModulesStarted, 1);

        TRACDCOMP( g_trac_cxxtest,
                   "ModulesStarted=%d",
                   CxxTest::g_ModulesStarted );

        // load module and call _init()
        l_errl = VFS::module_load( *i );
        if ( l_errl )
        {
            // vfs could not load a module and returned an errorlog.
            //  commit the errorlog, mark the test failed, and
            //  move on.
            TS_FAIL( "ERROR: Task %s could not be loaded, committing errorlog",
                    *i );
            errlCommit( l_errl, CXXTEST_COMP_ID );
            continue;
        }

        tidrc = task_exec( *i, NULL );
        TRACFCOMP( g_trac_cxxtest, "Launched task: %s tidrc=%d",
                   *i, tidrc );
        cxxtask.tid = tidrc;
        cxxtask.module = *i;
        tasks.push_back(cxxtask);
    }

    TRACFCOMP( g_trac_cxxtest,  "Waiting for all (%d) tasks to finish....",
               CxxTest::g_ModulesStarted );

    //  wait for all the launched tasks to finish
    for (std::vector<cxxtask_t>::iterator t = tasks.begin();
         t != tasks.end();
         ++t)
    {
        int status = 0;
        task_wait_tid(t->tid, &status, NULL);

        if (status != TASK_STATUS_EXITED_CLEAN)
        {
            TRACFCOMP( g_trac_cxxtest, "Task %d crashed with status %d.",
                       t->tid, status );
            if(CxxTest::g_FailedTests < CxxTest::CXXTEST_FAIL_LIST_SIZE)
            {
                CxxTest::CxxTestFailedEntry *l_failedEntry =
                    &CxxTest::g_FailedTestList[CxxTest::g_FailedTests];
                sprintf(l_failedEntry->failTestFile,
                        "%s crashed",
                        t->module);
                l_failedEntry->failTestData = t->tid;
            }
            __sync_add_and_fetch(&CxxTest::g_FailedTests, 1);
        }
        else
        {
            TRACFCOMP( g_trac_cxxtest, "Task %d finished.", t->tid );
        }
    }

    __sync_add_and_fetch(&CxxTest::g_ModulesCompleted, 1);
    TRACFCOMP( g_trac_cxxtest, " ModulesCompleted=%d",
            CxxTest::g_ModulesCompleted );

    TRACFCOMP( g_trac_cxxtest, EXIT_MRK "Finished CxxTestExec: ");
    TRACFCOMP( g_trac_cxxtest, "    total tests:   %d",
            CxxTest::g_TotalTests  );
    TRACFCOMP( g_trac_cxxtest, "    failed tests:  %d",
            CxxTest::g_FailedTests );
    TRACFCOMP( g_trac_cxxtest, "    warnings:      %d",
            CxxTest::g_Warnings    );
    TRACFCOMP( g_trac_cxxtest, "    trace calls:   %d",
            CxxTest::g_TraceCalls  );
    for (uint64_t i = 0;
         (i < CxxTest::g_FailedTests) && (i < CxxTest::CXXTEST_FAIL_LIST_SIZE);
         i++ )
    {
        TRACFCOMP( g_trac_cxxtest, "    failed test[%d]: %s (%d)",
                   i,
                   CxxTest::g_FailedTestList[i].failTestFile,
                   CxxTest::g_FailedTestList[i].failTestData);
    }

    //  @todo dump out an informational errorlog??

    // should always return NULL
    io_taskRetErrl  = l_errl;
}