/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* $Source: src/usr/diag/attn/ipl/test/attntestsvc.H $                    */
/*                                                                        */
/* OpenPOWER HostBoot Project                                             */
/*                                                                        */
/* Contributors Listed Below - COPYRIGHT 2014,2016                        */
/* [+] 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                                                     */
#ifndef __TEST_ATTNTESTSVC_H
#define __TEST_ATTNTESTSVC_H

/**
 * @file attntestsvc.H
 *
 * @brief Unit test for the attnsvc module.
 */

#include "../attnsvc.H"
#include "attnfakesys.H"
#include "attntest.H"
#include <cxxtest/TestSuite.H>
#include "../../common/attntrace.H"
#include "attnfakepresenter.H"
#include "attnfakegfir.H"
#include <prdf/common/prdfMain_common.H>
#include "attnfakegp1.H"
#include "attnfakemcs.H"
#include "attnfakeipoll.H"
#include "attnvalidate.H"
#include "attnfaketarget.H"
#include "attnrandsource.H"
#include "attnfakeprd.H"
#include "../../common/attnproc.H"
#include <sys/time.h>



using namespace ATTN;
using namespace std;

/**
 * @brief AttnSvcTest Unit test for the attnsvc module.
 */
class AttnSvcTest: public CxxTest::TestSuite
{
    public:

        /**
         * @brief testAttentions Unit test for the attnsvc module.
         */
        void testAttentions()
        {
            ATTN_SLOW(ENTER_MRK "AttnSvcTest:testAttentions");

            static const uint64_t targetPoolSize = 8;
            static const uint64_t iterations = 5;
            static const uint64_t maxAttnsPerIteration = 5;

            errlHndl_t err = 0;

            Service svc;

            FakePresenter presenter;
            FakeSystem system;

            FakeGfir xstpGfir(PRDF::CHECK_STOP),
                   spclGfir(PRDF::SPECIAL),
                   recGfir(PRDF::RECOVERABLE),
                   hostAttnGfir(PRDF::HOST_ATTN),
                   unitCsGfir(PRDF::UNIT_CS);


            xstpGfir.install(system);
            spclGfir.install(system);
            recGfir.install(system);
            hostAttnGfir.install(system);
            unitCsGfir.install(system);

            // @TODO RTC: 164827
            // When we get CENTAURS, we may need to add host/unit cs
            // here and install them right below.
            FakeMcs rec(PRDF::RECOVERABLE),
                    xstp(PRDF::CHECK_STOP),
                    special(PRDF::SPECIAL);

            xstp.install(system);
            special.install(system);
            rec.install(system);

            FakeIpoll xstpIpoll(PRDF::CHECK_STOP,  presenter),
                      spclIpoll(PRDF::SPECIAL,     presenter),
                      recIpoll (PRDF::RECOVERABLE, presenter),
                      unitIpoll(PRDF::UNIT_CS,     presenter),
                      hostIpoll(PRDF::HOST_ATTN,   presenter);

            xstpIpoll.install(system);
            spclIpoll.install(system);
            recIpoll.install(system);
            hostIpoll.install(system);
            unitIpoll.install(system);

            Validator v;

            v.install(system);

            system.installScomImpl();

            FakeMemTargetService targetSvc(targetPoolSize);

            TARGETING::TargetHandleList membufs, procs;

            targetSvc.getAllChips(procs,   TARGETING::TYPE_PROC);
            targetSvc.getAllChips(membufs, TARGETING::TYPE_MEMBUF);

            ATTN::RandSource procSource(iterations,
                    maxAttnsPerIteration,
                    system,
                    &procs[0],
                    &procs[0] + procs.size());

            // @TODO RTC: 164827
            // We don't have Centaurs yet
            /* ATTN::RandSource memSource(
                    iterations,
                    maxAttnsPerIteration,
                    system,
                    &membufs[0],
                    &membufs[0] + membufs.size());
            */

            targetSvc.installTargetService();

            ATTN::FakePrd prd(system);

            prd.installPrd();

            ATTN::getProcOps().enable();

            do
            {
                err = svc.start();

                if(err)
                {
                    TS_FAIL("unexpected error starting service");
                    break;
                }

                if(!presenter.start(svc.iv_intrTaskQ))
                {
                    TS_FAIL("unexpected error starting fake presenter");
                    break;
                }

                // @TODO RTC: 164827
                // We don't have Centaurs yet
                /* if(!memSource.start())
                   {
                       TS_FAIL("unexpected error starting source");
                       break;
                   }
                */

                if(!procSource.start())
                {
                    TS_FAIL("unexpected error starting source");
                    break;
                }

                // wait for the testcase to finish injecting attentions

                // @TODO RTC: 164827
                // We don't have Centaurs yet on NIMBUS P9
                /* if(!memSource.wait())
                   {
                       TS_FAIL("unexpected error waiting for source");
                        break;
                   }
                */

                if(!procSource.wait())
                {
                    TS_FAIL("unexpected error waiting for source");
                    break;
                }

                // wait for the the service to handle all the attentions
                TS_TRACE("Waiting for attentions to be cleared.");

                if(!system.wait(TEN_CTX_SWITCHES_NS * iterations * 100))
                {
                    TS_FAIL("Attentions still present on system.");

                    system.dump();
                    break;
                }

            } while(0);

            err = svc.stop();

            if(err)
            {
                TS_FAIL("unexpected error stopping service");
                delete err;
            }

            presenter.stop();

            if(!v.empty())
            {
                TS_FAIL("unexpected result after injecting attentions");

                v.dump();
            }

            ATTN_SLOW(EXIT_MRK "AttnSvcTest:testAttentions");
        }
};
#endif