ovm_env.svh

Go to the documentation of this file.

// $Id: ovm_env.svh 1 2008-03-05 02:42:30Z seanoboyle $
//----------------------------------------------------------------------
//   Copyright 2007-2008 Mentor Graphics Corporation
//   Copyright 2007-2008 Cadence Design Systems, Inc.
//   All Rights Reserved Worldwide
//
//   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.
//----------------------------------------------------------------------

`ifndef OVM_ENV_SVH
`define OVM_ENV_SVH

//----------------------------------------------------------------------
// CLASS env
//----------------------------------------------------------------------

// Subclasses of the avm_env class hold all the classes in
// that together constitute the testbench. These subclasses
// must define their own run method, and may also define their own 
// connect, configure and report methods

virtual class ovm_env extends ovm_threaded_component;

  extern function new( string name = "env", ovm_component parent = null );

  // Implicit $finish when run_test is done. Do disable the implicit
  // finish, set to 0.
  static bit finish_on_completion = 1;

  // Phase all top level components. Uses test_name is provided via input
  // arg or command line +OVM_TESTNAME, the test is instantiated prior to
  // phasing.
  extern static task run_test (string test_name="");

  // Manually execute phases. If ph_name is empty, then this will run through
  // to the last phase.
  extern static task run_global_phase  (string ph_name="");      

  // Deprecated phasing. Executes global phasing. 
  extern virtual task do_test();
  extern virtual task run();
 

  // Add special semantics for the run phase for an env 
  extern protected virtual task  m_do_task_phase     (ovm_phase phase);

  // Internal 
  extern static local task               m_do_global_phase   (string ph_name);

endclass

//-----------------------------------------------------------------------------
//
// TASK: run_test, ovm_print_topology
//
// wrappers for calling ovm_env::run_test,print_units
//-----------------------------------------------------------------------------


task run_test (string test_name="");
  ovm_env::run_test(test_name);
endtask

function void ovm_print_topology (ovm_printer printer=null);
  ovm_report_info("OVMTOP", "OVM testbench topology:", 500);
  ovm_component::print_units(printer);
endfunction

`endif // OVM_ENV_SVH