/*
 * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.max.graal.compiler.debug;

import java.io.*;

import com.oracle.max.graal.compiler.*;
import com.oracle.max.graal.compiler.observer.*;
import com.sun.cri.ri.*;

/**
 * Observes compilation events and uses {@link CFGPrinter} to produce a control flow graph for the <a
 * href="https://c1visualizer.dev.java.net/">C1 Visualizer</a>.
 *
 * @author Peter Hofer
 */
public class CFGPrinterObserver implements CompilationObserver {

    private C1XCompilation currentCompilation;
    private CFGPrinter cfgPrinter;
    private ByteArrayOutputStream buffer = null;
    private final OutputStream stream;

    public CFGPrinterObserver() {
        this(CFGPrinter.cfgFileStream());
    }

    public CFGPrinterObserver(OutputStream stream) {
        this.stream = stream;
    }

    @Override
    public void compilationStarted(CompilationEvent event) {
        // Supports only one compilation at the same time
        assert currentCompilation == null;

        currentCompilation = event.getCompilation();
        if (buffer == null) {
            buffer = new ByteArrayOutputStream();
        }
        cfgPrinter = new CFGPrinter(buffer, currentCompilation.target);
        cfgPrinter.printCompilation(currentCompilation.method);
    }

    @Override
    public void compilationEvent(CompilationEvent event) {
        assert currentCompilation == event.getCompilation();

        String label = event.getLabel();

        if (event.getAllocator() != null && event.getIntervals() != null) {
            cfgPrinter.printIntervals(event.getAllocator(), event.getIntervals(), label);
        }

        boolean cfgprinted = false;

        if (event.getBlockMap() != null && event.getCodeSize() >= 0) {
            cfgPrinter.printCFG(event.getMethod(), event.getBlockMap(), event.getCodeSize(), label, event.isHIRValid(), event.isLIRValid());
            cfgprinted = true;
        }

        // TODO fix that when schedule is here (startBlock : Instruction->Block)
        /*if (event.getStartBlock() != null) {
            cfgPrinter.printCFG((BlockBegin) event.getStartBlock(), label, event.isHIRValid(), event.isLIRValid());
            cfgprinted = true;
        }*/

        if (event.getTargetMethod() != null) {
            if (cfgprinted) {
                // Avoid duplicate "cfg" section
                label = null;
            }

            RiRuntime runtime = event.getCompilation().runtime;
            cfgPrinter.printMachineCode(runtime.disassemble(event.getTargetMethod()), label);
        }
    }

    @Override
    public void compilationFinished(CompilationEvent event) {
        assert currentCompilation == event.getCompilation();

        cfgPrinter.flush();

        if (stream != null) {
            synchronized (stream) {
                try {
                    stream.write(buffer.toByteArray());
                    stream.flush();
                } catch (IOException e) {
                    TTY.println("WARNING: Error writing CFGPrinter output for %s: %s", event.getMethod(), e);
                }
            }
        }

        buffer.reset();
        cfgPrinter = null;
        currentCompilation = null;
    }
}