annotate src/share/vm/utilities/histogram.hpp @ 1972:f95d63e2154a

6989984: Use standard include model for Hospot Summary: Replaced MakeDeps and the includeDB files with more standardized solutions. Reviewed-by: coleenp, kvn, kamg
author stefank
date Tue, 23 Nov 2010 13:22:55 -0800
parents c18cbe5936b8
children f08d439fab8c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a61af66fc99e Initial load
duke
parents:
diff changeset
1 /*
1972
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
2 * Copyright (c) 1998, 2010, Oracle and/or its affiliates. All rights reserved.
0
a61af66fc99e Initial load
duke
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
a61af66fc99e Initial load
duke
parents:
diff changeset
4 *
a61af66fc99e Initial load
duke
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
a61af66fc99e Initial load
duke
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
a61af66fc99e Initial load
duke
parents:
diff changeset
7 * published by the Free Software Foundation.
a61af66fc99e Initial load
duke
parents:
diff changeset
8 *
a61af66fc99e Initial load
duke
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
a61af66fc99e Initial load
duke
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
a61af66fc99e Initial load
duke
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
a61af66fc99e Initial load
duke
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
a61af66fc99e Initial load
duke
parents:
diff changeset
13 * accompanied this code).
a61af66fc99e Initial load
duke
parents:
diff changeset
14 *
a61af66fc99e Initial load
duke
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
a61af66fc99e Initial load
duke
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
a61af66fc99e Initial load
duke
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
a61af66fc99e Initial load
duke
parents:
diff changeset
18 *
1552
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 0
diff changeset
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 0
diff changeset
20 * or visit www.oracle.com if you need additional information or have any
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 0
diff changeset
21 * questions.
0
a61af66fc99e Initial load
duke
parents:
diff changeset
22 *
a61af66fc99e Initial load
duke
parents:
diff changeset
23 */
a61af66fc99e Initial load
duke
parents:
diff changeset
24
1972
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
25 #ifndef SHARE_VM_UTILITIES_HISTOGRAM_HPP
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
26 #define SHARE_VM_UTILITIES_HISTOGRAM_HPP
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
27
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
28 #include "memory/allocation.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
29 #include "runtime/os.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
30 #include "utilities/growableArray.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
31 #ifdef TARGET_OS_FAMILY_linux
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
32 # include "os_linux.inline.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
33 #endif
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
34 #ifdef TARGET_OS_FAMILY_solaris
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
35 # include "os_solaris.inline.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
36 #endif
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
37 #ifdef TARGET_OS_FAMILY_windows
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
38 # include "os_windows.inline.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
39 #endif
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
40
0
a61af66fc99e Initial load
duke
parents:
diff changeset
41 // This class provides a framework for collecting various statistics.
a61af66fc99e Initial load
duke
parents:
diff changeset
42 // The current implementation is oriented towards counting invocations
a61af66fc99e Initial load
duke
parents:
diff changeset
43 // of various types, but that can be easily changed.
a61af66fc99e Initial load
duke
parents:
diff changeset
44 //
a61af66fc99e Initial load
duke
parents:
diff changeset
45 // To use it, you need to declare a Histogram*, and a subtype of
a61af66fc99e Initial load
duke
parents:
diff changeset
46 // HistogramElement:
a61af66fc99e Initial load
duke
parents:
diff changeset
47 //
a61af66fc99e Initial load
duke
parents:
diff changeset
48 // HistogramElement* MyHistogram;
a61af66fc99e Initial load
duke
parents:
diff changeset
49 //
a61af66fc99e Initial load
duke
parents:
diff changeset
50 // class MyHistogramElement : public HistogramElement {
a61af66fc99e Initial load
duke
parents:
diff changeset
51 // public:
a61af66fc99e Initial load
duke
parents:
diff changeset
52 // MyHistogramElement(char* name);
a61af66fc99e Initial load
duke
parents:
diff changeset
53 // };
a61af66fc99e Initial load
duke
parents:
diff changeset
54 //
a61af66fc99e Initial load
duke
parents:
diff changeset
55 // MyHistogramElement::MyHistogramElement(char* elementName) {
a61af66fc99e Initial load
duke
parents:
diff changeset
56 // _name = elementName;
a61af66fc99e Initial load
duke
parents:
diff changeset
57 //
a61af66fc99e Initial load
duke
parents:
diff changeset
58 // if(MyHistogram == NULL)
a61af66fc99e Initial load
duke
parents:
diff changeset
59 // MyHistogram = new Histogram("My Call Counts",100);
a61af66fc99e Initial load
duke
parents:
diff changeset
60 //
a61af66fc99e Initial load
duke
parents:
diff changeset
61 // MyHistogram->add_element(this);
a61af66fc99e Initial load
duke
parents:
diff changeset
62 // }
a61af66fc99e Initial load
duke
parents:
diff changeset
63 //
a61af66fc99e Initial load
duke
parents:
diff changeset
64 // #define MyCountWrapper(arg) static MyHistogramElement* e = new MyHistogramElement(arg); e->increment_count()
a61af66fc99e Initial load
duke
parents:
diff changeset
65 //
a61af66fc99e Initial load
duke
parents:
diff changeset
66 // This gives you a simple way to count invocations of specfic functions:
a61af66fc99e Initial load
duke
parents:
diff changeset
67 //
a61af66fc99e Initial load
duke
parents:
diff changeset
68 // void a_function_that_is_being_counted() {
a61af66fc99e Initial load
duke
parents:
diff changeset
69 // MyCountWrapper("FunctionName");
a61af66fc99e Initial load
duke
parents:
diff changeset
70 // ...
a61af66fc99e Initial load
duke
parents:
diff changeset
71 // }
a61af66fc99e Initial load
duke
parents:
diff changeset
72 //
a61af66fc99e Initial load
duke
parents:
diff changeset
73 // To print the results, invoke print() on your Histogram*.
a61af66fc99e Initial load
duke
parents:
diff changeset
74
a61af66fc99e Initial load
duke
parents:
diff changeset
75 #ifdef ASSERT
a61af66fc99e Initial load
duke
parents:
diff changeset
76
a61af66fc99e Initial load
duke
parents:
diff changeset
77 class HistogramElement : public CHeapObj {
a61af66fc99e Initial load
duke
parents:
diff changeset
78 protected:
a61af66fc99e Initial load
duke
parents:
diff changeset
79 jint _count;
a61af66fc99e Initial load
duke
parents:
diff changeset
80 const char* _name;
a61af66fc99e Initial load
duke
parents:
diff changeset
81
a61af66fc99e Initial load
duke
parents:
diff changeset
82 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
83 HistogramElement();
a61af66fc99e Initial load
duke
parents:
diff changeset
84 virtual int count();
a61af66fc99e Initial load
duke
parents:
diff changeset
85 virtual const char* name();
a61af66fc99e Initial load
duke
parents:
diff changeset
86 virtual void increment_count();
a61af66fc99e Initial load
duke
parents:
diff changeset
87 void print_on(outputStream* st) const;
a61af66fc99e Initial load
duke
parents:
diff changeset
88 virtual int compare(HistogramElement* e1,HistogramElement* e2);
a61af66fc99e Initial load
duke
parents:
diff changeset
89 };
a61af66fc99e Initial load
duke
parents:
diff changeset
90
a61af66fc99e Initial load
duke
parents:
diff changeset
91 class Histogram : public CHeapObj {
a61af66fc99e Initial load
duke
parents:
diff changeset
92 protected:
a61af66fc99e Initial load
duke
parents:
diff changeset
93 GrowableArray<HistogramElement*>* _elements;
a61af66fc99e Initial load
duke
parents:
diff changeset
94 GrowableArray<HistogramElement*>* elements() { return _elements; }
a61af66fc99e Initial load
duke
parents:
diff changeset
95 const char* _title;
a61af66fc99e Initial load
duke
parents:
diff changeset
96 const char* title() { return _title; }
a61af66fc99e Initial load
duke
parents:
diff changeset
97 static int sort_helper(HistogramElement** e1,HistogramElement** e2);
a61af66fc99e Initial load
duke
parents:
diff changeset
98 virtual void print_header(outputStream* st);
a61af66fc99e Initial load
duke
parents:
diff changeset
99 virtual void print_elements(outputStream* st);
a61af66fc99e Initial load
duke
parents:
diff changeset
100
a61af66fc99e Initial load
duke
parents:
diff changeset
101 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
102 Histogram(const char* title,int estimatedSize);
a61af66fc99e Initial load
duke
parents:
diff changeset
103 virtual void add_element(HistogramElement* element);
a61af66fc99e Initial load
duke
parents:
diff changeset
104 void print_on(outputStream* st) const;
a61af66fc99e Initial load
duke
parents:
diff changeset
105 };
a61af66fc99e Initial load
duke
parents:
diff changeset
106
a61af66fc99e Initial load
duke
parents:
diff changeset
107 #endif
1972
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
108
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1552
diff changeset
109 #endif // SHARE_VM_UTILITIES_HISTOGRAM_HPP