1 /*
   2  * Copyright (c) 2002, 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #ifndef SHARE_VM_GC_SHARED_COLLECTORCOUNTERS_HPP
  26 #define SHARE_VM_GC_SHARED_COLLECTORCOUNTERS_HPP
  27 
  28 #include "runtime/perfData.hpp"
  29 
  30 // CollectorCounters is a holder class for performance counters
  31 // that track a collector
  32 
  33 class CollectorCounters: public CHeapObj<mtGC> {
  34   friend class VMStructs;
  35 
  36   private:
  37     PerfCounter*      _invocations;
  38     PerfCounter*      _time;
  39     PerfVariable*     _last_entry_time;
  40     PerfVariable*     _last_exit_time;
  41 
  42     // Constant PerfData types don't need to retain a reference.
  43     // However, it's a good idea to document them here.
  44     // PerfStringConstant*     _name;
  45 
  46     char*             _name_space;
  47 
  48   public:
  49 
  50     CollectorCounters(const char* name, int ordinal);
  51 
  52     ~CollectorCounters() {
  53       if (_name_space != NULL) FREE_C_HEAP_ARRAY(char, _name_space);
  54     }
  55 
  56     inline PerfCounter* invocation_counter() const  { return _invocations; }
  57 
  58     inline PerfCounter* time_counter() const        { return _time; }
  59 
  60     inline PerfVariable* last_entry_counter() const { return _last_entry_time; }
  61 
  62     inline PerfVariable* last_exit_counter() const  { return _last_exit_time; }
  63 
  64     const char* name_space() const                  { return _name_space; }
  65 };
  66 
  67 class TraceCollectorStats: public PerfTraceTimedEvent {
  68 
  69   protected:
  70     CollectorCounters* _c;
  71 
  72   public:
  73     inline TraceCollectorStats(CollectorCounters* c) :
  74            PerfTraceTimedEvent(c->time_counter(), c->invocation_counter()),
  75            _c(c) {
  76 
  77       if (UsePerfData) {
  78          _c->last_entry_counter()->set_value(os::elapsed_counter());
  79       }
  80     }
  81 
  82     inline ~TraceCollectorStats() {
  83       if (UsePerfData) _c->last_exit_counter()->set_value(os::elapsed_counter());
  84     }
  85 };
  86 
  87 #endif // SHARE_VM_GC_SHARED_COLLECTORCOUNTERS_HPP