Mercurial > hg > graal-jvmci-8
comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/frame/VirtualFrame.java @ 7267:a4b84ba6dc2e
Introduction of the Truffle API for efficient implementation of dynamic languages on top of the Graal VM. New projects com.oracle.truffle.api for the API definition and com.oracle.truffle.api.test for API tests and documentation.
author | Thomas Wuerthinger <thomas.wuerthinger@oracle.com> |
---|---|
date | Tue, 18 Dec 2012 15:33:55 +0100 |
parents | |
children | 5e3d1a68664e |
comparison
equal
deleted
inserted
replaced
7259:494d99e07614 | 7267:a4b84ba6dc2e |
---|---|
1 /* | |
2 * Copyright (c) 2012, 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 package com.oracle.truffle.api.frame; | |
24 | |
25 import com.oracle.truffle.api.*; | |
26 | |
27 /** | |
28 * Represents a frame containing values of local variables of the guest language. Instances of this type must not be | |
29 * stored in a field or cast to {@link java.lang.Object}. If this is necessary, the frame must be explicitly converted | |
30 * into a materialized frame using the {@link VirtualFrame#materialize()} method. Whenever fast access to the local | |
31 * variables of a frame is no longer necessary, a virtual frame should be converted into a packed frame using the | |
32 * {@link VirtualFrame#pack()} method. | |
33 */ | |
34 public interface VirtualFrame extends Frame { | |
35 | |
36 /** | |
37 * Converts this virtual frame into a packed frame that has no longer direct access to the local variables. This | |
38 * packing is an important hint to the Truffle optimizer and therefore passing around a {@link PackedFrame} should | |
39 * be preferred over passing around a {@link VirtualFrame} when the probability that an unpacking will occur is low. | |
40 * | |
41 * @return the packed frame | |
42 */ | |
43 PackedFrame pack(); | |
44 | |
45 /** | |
46 * Accesses the caller frame passed in via {@link CallTarget#call}. To get full access, it must be first unpacked | |
47 * using {@link PackedFrame#unpack()}. | |
48 * | |
49 * @return the caller frame or null if this was a root method call | |
50 */ | |
51 PackedFrame getCaller(); | |
52 | |
53 /** | |
54 * Materializes this frame, which allows it to be stored in a field or cast to {@link java.lang.Object}. The frame | |
55 * however looses the ability to be packed or to access the caller frame. | |
56 * | |
57 * @return the new materialized frame | |
58 */ | |
59 MaterializedFrame materialize(); | |
60 } |