1 /*
   2  * Copyright (c) 2011, 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_G1_G1HRPRINTER_HPP
  26 #define SHARE_VM_GC_G1_G1HRPRINTER_HPP
  27 
  28 #include "gc/g1/heapRegion.hpp"
  29 #include "logging/log.hpp"
  30 #include "memory/allocation.hpp"
  31 
  32 #define SKIP_RETIRED_FULL_REGIONS 1
  33 
  34 class G1HRPrinter VALUE_OBJ_CLASS_SPEC {
  35 public:
  36   typedef enum {
  37     Alloc,
  38     AllocForce,
  39     Retire,
  40     Reuse,
  41     CSet,
  42     EvacFailure,
  43     Cleanup,
  44     PostCompaction,
  45     Commit,
  46     Uncommit
  47   } ActionType;
  48 
  49   typedef enum {
  50     Unset,
  51     Eden,
  52     Survivor,
  53     Old,
  54     SingleHumongous,
  55     StartsHumongous,
  56     ContinuesHumongous,
  57     Archive
  58   } RegionType;
  59 
  60 private:
  61   static const char* action_name(ActionType action);
  62   static const char* region_type_name(RegionType type);
  63 
  64   // Print an action event. This version is used in most scenarios and
  65   // only prints the region's bottom. The parameters type and top are
  66   // optional (the "not set" values are Unset and NULL).
  67   static void print(ActionType action, RegionType type,
  68                     HeapRegion* hr, HeapWord* top);
  69 
  70   // Print an action event. This version prints both the region's
  71   // bottom and end. Used for Commit / Uncommit events.
  72   static void print(ActionType action, HeapWord* bottom, HeapWord* end);
  73 
  74 public:
  75   // In some places we iterate over a list in order to generate output
  76   // for the list's elements. By exposing this we can avoid this
  77   // iteration if the printer is not active.
  78   const bool is_active() { return log_is_enabled(Trace, gc, region); }
  79 
  80   // The methods below are convenient wrappers for the print() methods.
  81 
  82   void alloc(HeapRegion* hr, RegionType type, bool force = false) {
  83     if (is_active()) {
  84       print((!force) ? Alloc : AllocForce, type, hr, NULL);
  85     }
  86   }
  87 
  88   void alloc(RegionType type, HeapRegion* hr, HeapWord* top) {
  89     if (is_active()) {
  90       print(Alloc, type, hr, top);
  91     }
  92   }
  93 
  94   void retire(HeapRegion* hr) {
  95     if (is_active()) {
  96       if (!SKIP_RETIRED_FULL_REGIONS || hr->top() < hr->end()) {
  97         print(Retire, Unset, hr, hr->top());
  98       }
  99     }
 100   }
 101 
 102   void reuse(HeapRegion* hr) {
 103     if (is_active()) {
 104       print(Reuse, Unset, hr, NULL);
 105     }
 106   }
 107 
 108   void cset(HeapRegion* hr) {
 109     if (is_active()) {
 110       print(CSet, Unset, hr, NULL);
 111     }
 112   }
 113 
 114   void evac_failure(HeapRegion* hr) {
 115     if (is_active()) {
 116       print(EvacFailure, Unset, hr, NULL);
 117     }
 118   }
 119 
 120   void cleanup(HeapRegion* hr) {
 121     if (is_active()) {
 122       print(Cleanup, Unset, hr, NULL);
 123     }
 124   }
 125 
 126   void post_compaction(HeapRegion* hr, RegionType type) {
 127     if (is_active()) {
 128       print(PostCompaction, type, hr, hr->top());
 129     }
 130   }
 131 
 132   void commit(HeapWord* bottom, HeapWord* end) {
 133     if (is_active()) {
 134       print(Commit, bottom, end);
 135     }
 136   }
 137 
 138   void uncommit(HeapWord* bottom, HeapWord* end) {
 139     if (is_active()) {
 140       print(Uncommit, bottom, end);
 141     }
 142   }
 143 };
 144 
 145 #endif // SHARE_VM_GC_G1_G1HRPRINTER_HPP