release/src/router/mysql/storage/ndb/include/debugger/DebuggerNames.hpp

   1 /* Copyright (c) 2003, 2005 MySQL AB
   2
   3    This program is free software; you can redistribute it and/or modify
   4    it under the terms of the GNU General Public License as published by
   5    the Free Software Foundation; version 2 of the License.
   6
   7    This program is distributed in the hope that it will be useful,
   8    but WITHOUT ANY WARRANTY; without even the implied warranty of
   9    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10    GNU General Public License for more details.
  11
  12    You should have received a copy of the GNU General Public License
  13    along with this program; if not, write to the Free Software
  14    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA */
  15
  16 #ifndef DEBUGGER_NAMES
  17 #define DEBUGGER_NAMES
  18
  19 #include <kernel_types.h>
  20 #include <signaldata/SignalDataPrint.hpp>
  21
  22 /**
  23  * getSignalName
  24  *
  25  * NOTES: Very quick
  26  *
  27  * RETURNS: Signal name or 0 if none found
  28  */
  29 const char *
  30 getSignalName(GlobalSignalNumber gsn, const char * defualtValue = "Unknown");
  31
  32 /**
  33  * getGsn
  34  *
  35  * NOTES: Very slow
  36  *
  37  * RETURNS: Gsn or 0 if none found
  38  */
  39 GlobalSignalNumber
  40 getGsn(const char * signalName);
  41
  42 /**
  43  * getBlockName
  44  *
  45  * NOTES: Very quick
  46  *
  47  * RETURNS: Block name or
  48  *          defValue if not a valid block number
  49  */
  50 const char *
  51 getBlockName(BlockNumber blockNo, const char * defValue = 0);
  52
  53 /**
  54  * getBlockNo
  55  *
  56  * NOTES: Very slow
  57  *
  58  * RETURNS: BlockNo or 0 if none found
  59  */
  60 BlockNumber
  61 getBlockNo(const char * blockName);
  62
  63 /**
  64  * Find a print function for a signal
  65  *
  66  * RETURNS: 0 if none found
  67  */
  68 SignalDataPrintFunction findPrintFunction(GlobalSignalNumber);
  69
  70 #endif