PCProfileFilter.hpp

Go to the documentation of this file.

// -*-Mode: C++;-*-

// * BeginRiceCopyright *****************************************************
//
// $HeadURL$
// $Id$
//
// --------------------------------------------------------------------------
// Part of HPCToolkit (hpctoolkit.org)
//
// Information about sources of support for research and development of
// HPCToolkit is at 'hpctoolkit.org' and in 'README.Acknowledgments'.
// --------------------------------------------------------------------------
//
// Copyright ((c)) 2002-2019, Rice University
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
//   notice, this list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright
//   notice, this list of conditions and the following disclaimer in the
//   documentation and/or other materials provided with the distribution.
//
// * Neither the name of Rice University (RICE) nor the names of its
//   contributors may be used to endorse or promote products derived from
//   this software without specific prior written permission.
//
// This software is provided by RICE and contributors "as is" and any
// express or implied warranties, including, but not limited to, the
// implied warranties of merchantability and fitness for a particular
// purpose are disclaimed. In no event shall RICE or contributors be
// liable for any direct, indirect, incidental, special, exemplary, or
// consequential damages (including, but not limited to, procurement of
// substitute goods or services; loss of use, data, or profits; or
// business interruption) however caused and on any theory of liability,
// whether in contract, strict liability, or tort (including negligence
// or otherwise) arising in any way out of the use of this software, even
// if advised of the possibility of such damage.
//
// ******************************************************* EndRiceCopyright *

//***************************************************************************
//
// File:
//    PCProfileFilter.h
//
// Purpose:
//    [The purpose of this file]
//
// Description:
//    See, in particular, the comments associated with 'PCProfile'.
//
//***************************************************************************

#ifndef PCProfileFilter_H 
#define PCProfileFilter_H

//************************* System Include Files ****************************

#include <vector>
#include <list>
#include <string>

//*************************** User Include Files ****************************

#include <include/uint.h>

#include <lib/isa/ISA.hpp>

#include <lib/binutils/LM.hpp>

//*************************** Forward Declarations ***************************

class PCProfileFilter;
class MetricFilter;
class PCFilter;

// Some useful containers
class PCProfileFilterList : public std::list<PCProfileFilter*> {
public:
  typedef std::list<PCProfileFilter*> Base;

public:
  PCProfileFilterList() { }
  virtual ~PCProfileFilterList() { clear(); }
  virtual void clear() { Base::clear(); } // does not delte contents
  void destroyContents();  // deletes contents
};


class PCProfileMetric;

//****************************************************************************
// PCProfileFilter
//****************************************************************************

// 'PCProfileFilter' is a filter that implicitly defines a derived
// metric (e.g. 'ProfileMetric') by specifing some combination of raw
// metrics and pcs from a 'PCProfile'.
// Currently, filters are strictly divided between metric and pc filters.
class PCProfileFilter
{
public:
  // PCProfileFilter: assumes ownership of the MetricFilter and PCFilter.
  PCProfileFilter(MetricFilter* x = NULL, PCFilter* y = NULL)
    : mfilt(x), pcfilt(y) { }
  virtual ~PCProfileFilter();

  // Name, Description: The name and a description of what this filter
  // computes.
  const std::string& GetName()        const { return name; }
  const std::string& GetDescription() const { return description; }

  void SetName(const char* s)          { name = (s) ? s : ""; }
  void SetDescription(const char* s)   { description = (s) ? s : ""; }

  // Access to the various sub-filters.  (These intentionally return
  // non-const pointers!)
  MetricFilter* GetMetricFilter() const { return mfilt; }
  PCFilter* GetPCFilter() const { return pcfilt; }
  
  void Dump(std::ostream& o = std::cerr);
  void DDump(); 
  
private:
  // Should not be used 
  PCProfileFilter(const PCProfileFilter& p) { }
  PCProfileFilter& operator=(const PCProfileFilter& p) { return *this; }
  
protected:
private:
  std::string name;
  std::string description;

  MetricFilter* mfilt;
  PCFilter* pcfilt;
};


//****************************************************************************
// MetricFilter
//****************************************************************************

// MetricFilter: An abstract base class providing an interface for
// standard and user-defined metric filters.  A MetricFilter divides
// metrics into two sets sets, 'in' and 'out'. 
class MetricFilter {
public:
  MetricFilter() { }
  virtual ~MetricFilter() { }
  
  // Returns true if 'm' is within the 'in' set; false otherwise.
  virtual bool operator()(const PCProfileMetric* m) = 0;

private:
};


//****************************************************************************
// PCFilter
//****************************************************************************

// PCFilter: An abstract base class providing an interface for
// standard and user-defined PC filters.  A PCFilter divides
// PC into two sets sets, 'in' and 'out'. 
class PCFilter {
public:
  PCFilter() { }
  virtual ~PCFilter() { }
  
  // Returns true if the operation at 'pc' and 'opIndex' is within the
  // 'in' set; false otherwise.
  virtual bool operator()(VMA pc, ushort opIndex) = 0;

private:
};


//****************************************************************************
// InsnClassExpr
//****************************************************************************


#define INSN_CLASS_ALL      0x00000001 /* cannot be part of disjunction! */
#define INSN_CLASS_FLOP     0x00000002
#define INSN_CLASS_INTOP    0x00000004
#define INSN_CLASS_MEMOP    0x00000008
#define INSN_CLASS_OTHER    0x00000010

// InsnClassExpr: A common 'PCFilter' will be an instruction class
// filter (cf. 'InsnFilter').  This represent a disjunctive expression
// of instruction classes that can be used with an 'InsnFilter'.

class InsnClassExpr {
public:
  typedef uint32_t bitvec_t;
    
public:
  // A 'InsnClassExpr' can be created using the bit definitions above.
  InsnClassExpr(bitvec_t bv = 0) : bits(bv) { }
  virtual ~InsnClassExpr() { }
  
  InsnClassExpr(const InsnClassExpr& x) { *this = x; }
  InsnClassExpr& operator=(const InsnClassExpr& x) { 
    bits = x.bits; 
    return *this;
  }

  // IsSatisfied: Test to see if this query expression is satisfied by
  // the given instruction class description within 'bv'.  (Only on
  // bit (= class) in 'bv' is set.)
  bool IsSatisfied(const bitvec_t bv) {
    if (IsSet(INSN_CLASS_ALL)) {
      return true;
    } else {
      return IsSet(bv); // only one bit (= class) in 'bv' is set
    }
  }

  // IsValid: If no bits are set, this must be an invalid expression
  bool IsValid() const { return bits != 0; }
  
  // IsSet: Tests to see if all the specified bits are set
  bool IsSet(const bitvec_t bv) const {
    return (bits & bv) == bv;
  }
  bool IsSet(const InsnClassExpr& m) const {
    return (bits & m.bits) == m.bits; 
  }
  // IsSetAny: Tests to see if *any* of the specified bits are set
  bool IsSetAny(const bitvec_t bv) const {
    return (bits & bv) != 0;
  }
  bool IsSetAny(const InsnClassExpr& m) const {
    return (bits & m.bits) != 0; 
  }
  // Set: Set all the specified bits
  void Set(const bitvec_t bv) {
    bits = bits | bv;
  }
  void Set(const InsnClassExpr& m) {
    bits = bits | m.bits;
  }
  // Unset: Clears all the specified bits
  void Unset(const bitvec_t bv) {
    bits = bits & ~bv;
  }
  void Unset(const InsnClassExpr& m) {
    bits = bits & ~(m.bits);
  }
  
  void Dump(std::ostream& o = std::cerr);
  void DDump();
  
private:
  
protected:
private:  
  bitvec_t bits;
};


// ConvertInsnDesc: Converts an InsnDesc to one of the above classes
InsnClassExpr::bitvec_t 
ConvertToInsnClass(ISA::InsnDesc d);


//****************************************************************************
// InsnFilter
//****************************************************************************

// InsnFilter: Divides PCs into two sets by Alpha instruction class.
class InsnFilter : public PCFilter {
public:
  InsnFilter(InsnClassExpr expr_, binutils::LM* lm_);
  virtual ~InsnFilter();
  
  // Returns true if the operation at 'pc' and 'opIndex' satisfies
  // 'expr'; false otherwise.
  virtual bool operator()(VMA pc, ushort opIndex);
  
private:
  InsnClassExpr expr;
  binutils::LM* lm; // we do not own
};


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

#endif