LinuxKernelSymbols.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 *

#ifndef __LINUXKERNELSYMBOLS_HPP__
#define __LINUXKERNELSYMBOLS_HPP__

//******************************************************************************
// local includes
//******************************************************************************

#include "SimpleSymbols.hpp"



//******************************************************************************
// type declarations
//******************************************************************************

class LinuxKernelSymbols : public SimpleSymbols {
public:
  LinuxKernelSymbols();
  bool parse(const std::set<std::string> &directorySet, const char *pathname);
};

enum init_status_e {UNINITIALIZED, INITIALIZED};

class LinuxKernelSymbolsFactory : public SimpleSymbolsFactory {
public:
  LinuxKernelSymbolsFactory():m_kernelSymbol(NULL), m_id(0), m_fileId(0),
    m_id_status(UNINITIALIZED), m_fileId_status(UNINITIALIZED)
  {}
  ~LinuxKernelSymbolsFactory() {
    if (m_kernelSymbol) {
      delete m_kernelSymbol;
    }
  }

  const char *unified_name();

  bool match(const char *pathname);
  SimpleSymbols *create();

  void id(uint _id);
  uint id();

  void fileId(uint _id);
  uint fileId();

private:
  LinuxKernelSymbols *m_kernelSymbol;
  uint m_id;
  uint m_fileId;

  enum init_status_e m_id_status;
  enum init_status_e m_fileId_status;
};
     
#endif