src/jdk.jfr/share/classes/jdk/jfr/internal/tool/XMLWriter.java
author egahlin
Wed, 05 Dec 2018 16:40:12 +0100
changeset 52850 f527b24990d7
permissions -rw-r--r--
8205516: JFR tool Reviewed-by: mgronlun
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
52850
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     1
/*
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     2
 * Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     4
 *
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    10
 *
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    15
 * accompanied this code).
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    16
 *
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    20
 *
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    23
 * questions.
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    24
 */
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    25
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    26
package jdk.jfr.internal.tool;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    27
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    28
import java.io.PrintWriter;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    29
import java.util.List;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    30
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    31
import jdk.jfr.EventType;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    32
import jdk.jfr.ValueDescriptor;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    33
import jdk.jfr.consumer.RecordedEvent;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    34
import jdk.jfr.consumer.RecordedFrame;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    35
import jdk.jfr.consumer.RecordedObject;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    36
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    37
final class XMLWriter extends EventPrintWriter {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    38
    public XMLWriter(PrintWriter destination) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    39
        super(destination);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    40
    }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    41
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    42
    @Override
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    43
    protected void printBegin() {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    44
        println("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    45
        println("<recording xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    46
        indent();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    47
        printIndent();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    48
        println("<events>");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    49
        indent();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    50
    }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    51
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    52
    @Override
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    53
    protected void printEnd() {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    54
        retract();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    55
        printIndent();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    56
        println("</events>");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    57
        retract();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    58
        println("</recording>");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    59
    }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    60
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    61
    @Override
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    62
    protected void print(List<RecordedEvent> events) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    63
        for (RecordedEvent event : events) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    64
            printEvent(event);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    65
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    66
    }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    67
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    68
    private void printEvent(RecordedEvent event) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    69
        EventType type = event.getEventType();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    70
        printIndent();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    71
        print("<event");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    72
        printAttribute("type", type.getName());
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    73
        print(">");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    74
        println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    75
        indent();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    76
        for (ValueDescriptor v : event.getFields()) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    77
            printValueDescriptor(v, getValue(event, v), -1);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    78
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    79
        retract();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    80
        printIndent();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    81
        println("</event>");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    82
        println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    83
    }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    84
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    85
    private void printAttribute(String name, String value) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    86
        print(" ", name, "=\"", value, "\"");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    87
    }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    88
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    89
    public void printObject(RecordedObject struct) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    90
        println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    91
        indent();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    92
        for (ValueDescriptor v : struct.getFields()) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    93
            printValueDescriptor(v, getValue(struct, v), -1);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    94
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    95
        retract();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    96
    }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    97
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    98
    private void printArray(ValueDescriptor v, Object[] array) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
    99
        println();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   100
        indent();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   101
        int depth = 0;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   102
        for (int index = 0; index < array.length; index++) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   103
            Object arrayElement = array[index];
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   104
            if (!(arrayElement instanceof RecordedFrame) || depth < getStackDepth()) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   105
                printValueDescriptor(v, array[index], index);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   106
            }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   107
            depth++;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   108
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   109
        retract();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   110
    }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   111
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   112
    private void printValueDescriptor(ValueDescriptor vd, Object value, int index) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   113
        boolean arrayElement = index != -1;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   114
        String name = arrayElement ? null : vd.getName();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   115
        if (vd.isArray() && !arrayElement) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   116
            if (printBeginElement("array", name, value, index)) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   117
                printArray(vd, (Object[]) value);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   118
                printIndent();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   119
                printEndElement("array");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   120
            }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   121
            return;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   122
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   123
        if (!vd.getFields().isEmpty()) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   124
            if (printBeginElement("struct", name, value, index)) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   125
                printObject((RecordedObject) value);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   126
                printIndent();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   127
                printEndElement("struct");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   128
            }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   129
            return;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   130
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   131
        if (printBeginElement("value", name, value, index)) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   132
            printEscaped(String.valueOf(value));
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   133
            printEndElement("value");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   134
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   135
    }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   136
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   137
    private boolean printBeginElement(String elementName, String name, Object value, int index) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   138
        printIndent();
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   139
        print("<", elementName);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   140
        if (name != null) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   141
            printAttribute("name", name);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   142
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   143
        if (index != -1) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   144
            printAttribute("index", Integer.toString(index));
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   145
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   146
        if (value == null) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   147
            printAttribute("xsi:nil", "true");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   148
            println("/>");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   149
            return false;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   150
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   151
        if (value.getClass().isArray()) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   152
            Object[] array = (Object[]) value;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   153
            printAttribute("size", Integer.toString(array.length));
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   154
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   155
        print(">");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   156
        return true;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   157
    }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   158
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   159
    private void printEndElement(String elementName) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   160
        print("</");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   161
        print(elementName);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   162
        println(">");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   163
    }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   164
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   165
    private void printEscaped(String text) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   166
        for (int i = 0; i < text.length(); i++) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   167
            printEscaped(text.charAt(i));
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   168
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   169
    }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   170
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   171
    private void printEscaped(char c) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   172
        if (c == 34) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   173
            print("&quot;");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   174
            return;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   175
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   176
        if (c == 38) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   177
            print("&amp;");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   178
            return;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   179
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   180
        if (c == 39) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   181
            print("&apos;");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   182
            return;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   183
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   184
        if (c == 60) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   185
            print("&lt;");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   186
            return;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   187
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   188
        if (c == 62) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   189
            print("&gt;");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   190
            return;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   191
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   192
        if (c > 0x7F) {
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   193
            print("&#");
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   194
            print((int) c);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   195
            print(';');
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   196
            return;
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   197
        }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   198
        print(c);
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   199
    }
f527b24990d7 8205516: JFR tool
egahlin
parents:
diff changeset
   200
}