xref: /gem5/src/systemc/tests/systemc/kernel/process_control/suspend_resume/test2/test2.cpp

/*****************************************************************************

  Licensed to Accellera Systems Initiative Inc. (Accellera) under one or
  more contributor license agreements.  See the NOTICE file distributed
  with this work for additional information regarding copyright ownership.
  Accellera licenses this file to you 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.

 *****************************************************************************/

//*****************************************************************************
//
//  test02.cpp -- test that suspended processes with static sensitivity
//                wake up when resumed.
//
//  Original Author: Andy Goodrich, Forte Design Systems, Inc.
//
//  CVS MODIFICATION LOG - modifiers, enter your name, affiliation, date and
//  changes you are making here.
//
// $Log: test2.cpp,v $
// Revision 1.5  2011/04/02 00:08:19  acg
//  Andy Goodrich: turn off corner case error checking.
//
// Revision 1.4  2011/03/07 19:32:09  acg
//  Andy Goodrich: addition to set sc_core::sc_allow_process_control_corners
//  to true so that this test avoids corner case error messages.
//
// Revision 1.3  2011/02/20 13:43:49  acg
//  Andy Goodrich: updates for IEEE 1666 2011.
//
// Revision 1.2  2011/02/04 15:26:52  acg
//  Andy Goodrich: changes for process control semantics.
//
// Revision 1.1  2009/07/28 18:43:55  acg
//  Andy Goodrich: new standard test bench version of this test.
//
//*****************************************************************************

#define SC_INCLUDE_DYNAMIC_PROCESSES
#include "systemc.h"

enum my_process_states {
    ST_SUSPENDD,
    ST_NORMAL,
    ST_SUSPENDED
};

inline ostream& time_stamp( ostream& os )
{
    os << dec << sc_time_stamp() << "[" << sc_delta_count() << "]: ";
    return os;
}

SC_MODULE(top) {
    // constructor:

    SC_CTOR(top)
    {
        m_state_cthread0 = ST_NORMAL;
	m_state_method0 = ST_NORMAL;
        m_state_thread0 = ST_NORMAL;

        SC_THREAD(stimulator0);

        SC_CTHREAD( target_cthread0, m_clk.pos() );
        m_target_cthread0 = sc_get_current_process_handle();

        SC_METHOD(target_method0);
	sensitive << m_clk.pos();
        m_target_method0 = sc_get_current_process_handle();

        SC_THREAD(target_thread0);
	sensitive << m_clk.neg();
        m_target_thread0 = sc_get_current_process_handle();
    }

    // processes:

    void stimulator0();
    void target_cthread0();
    void target_method0();
    void target_thread0();

    // Storage:

    sc_in<bool>       m_clk;
    int               m_state_cthread0;
    int               m_state_method0;
    int               m_state_thread0;
    sc_process_handle m_target_cthread0;
    sc_process_handle m_target_method0;
    sc_process_handle m_target_thread0;
};

#define SUSPEND(TARGET) \
    cout << endl; \
    time_stamp(cout) << name << ": suspending target_" << #TARGET << endl; \
    m_state_##TARGET = ST_SUSPENDD; \
    m_target_##TARGET.suspend(); \
    cout << endl;

#define RESUME(TARGET) \
    cout << endl; \
    time_stamp(cout) << name << ": resuming target_" << #TARGET << endl; \
    m_state_##TARGET = ST_NORMAL; \
    m_target_##TARGET.resume(); \
    cout << endl;

void top::stimulator0()
{
    const char* name = "stimulator";

    wait(2, SC_NS);

    SUSPEND(cthread0)
    wait(3, SC_NS);
    SUSPEND(method0)
    wait(3, SC_NS);
    SUSPEND(thread0)
    wait(3, SC_NS);

    RESUME(cthread0)
    wait(3, SC_NS);
    RESUME(method0)
    wait(3, SC_NS);
    RESUME(thread0)
    wait(3, SC_NS);

    SUSPEND(cthread0)
    wait(3, SC_NS);
    SUSPEND(method0)
    wait(3, SC_NS);
    SUSPEND(thread0)
    wait(3, SC_NS);

    RESUME(cthread0)
    wait(3, SC_NS);
    RESUME(method0)
    wait(3, SC_NS);
    RESUME(thread0)
    wait(3, SC_NS);

    ::sc_core::wait(1000, SC_NS);
    cout << endl;
    time_stamp(cout) << name << ": terminating" << endl;
    sc_stop();
}

void top::target_cthread0()
{
    const char* name = "target_cthread0";

    time_stamp(cout) << name  << ": starting" << endl;
    for (int i = 0; i < 12; i++)
    {
	wait();
	if ( m_state_cthread0 == ST_SUSPENDD )
	{
	    time_stamp(cout) << name  << ": ERROR should not see this" << endl;
	}
	else
	{
	    time_stamp(cout) << name  << ": active" << endl;
	}
    }
    time_stamp(cout) << name  << ": terminating" << endl;
}

void top::target_method0()
{
    const char* name = "target_method0";
    static int  state = 0;
    switch( state )
    {
      case 0:
        time_stamp(cout) << name  << ": starting" << endl;
        break;
      default:
	if ( m_state_method0 == ST_SUSPENDD )
	{
	    time_stamp(cout) << name  << ": ERROR should not see this" << endl;
	}
	else if ( state < 20 )
	{
	    time_stamp(cout) << name  << ": active" << endl;
	}
        break;
      case 21:
        time_stamp(cout) << name  << ": terminating" << endl;
        break;
    }
    state++;
}

void top::target_thread0()
{
    const char* name = "target_thread0";

    time_stamp(cout) << name  << ": starting" << endl;
    for (int i = 0; i < 12; i++)
    {
	wait();
	if ( m_state_thread0 == ST_SUSPENDD )
	{
	    time_stamp(cout) << name  << ": ERROR should not see this" << endl;
	}
	else
	{
	    time_stamp(cout) << name  << ": active" << endl;
	}
    }
    time_stamp(cout) << name  << ": terminating" << endl;
}

int sc_main (int argc, char *argv[])
{
    sc_core::sc_allow_process_control_corners = true;
    sc_clock clock( "clock", 2.0, SC_NS );

    top* top_p = new top("top");
    top_p->m_clk(clock);

    sc_core::sc_allow_process_control_corners = true;
    sc_start();
    return 0;
}