001/*
002 * Copyright (c) 2015, 2015, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.
008 *
009 * This code is distributed in the hope that it will be useful, but WITHOUT
010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
011 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
012 * version 2 for more details (a copy is included in the LICENSE file that
013 * accompanied this code).
014 *
015 * You should have received a copy of the GNU General Public License version
016 * 2 along with this work; if not, write to the Free Software Foundation,
017 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
018 *
019 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
020 * or visit www.oracle.com if you need additional information or have any
021 * questions.
022 */
023package com.oracle.graal.lir.debug;
024
025import com.oracle.graal.debug.*;
026import jdk.internal.jvmci.meta.*;
027
028import com.oracle.graal.lir.*;
029
030/**
031 * Provides information about {@link LIR} generation for debugging purposes.
032 */
033public interface LIRGenerationDebugContext {
034
035    /**
036     * Gets an object that represents the source of an {@link LIR} {@link Value operand} in a higher
037     * representation.
038     */
039    Object getSourceForOperand(Value value);
040
041    static LIRGenerationDebugContext getFromDebugContext() {
042        if (Debug.isEnabled()) {
043            LIRGenerationDebugContext lirGen = Debug.contextLookup(LIRGenerationDebugContext.class);
044            assert lirGen != null;
045            return lirGen;
046        }
047        return null;
048    }
049
050    static Object getSourceForOperandFromDebugContext(Value value) {
051        LIRGenerationDebugContext gen = getFromDebugContext();
052        if (gen != null) {
053            return gen.getSourceForOperand(value);
054        }
055        return null;
056    }
057
058}