1 /*
2 * Copyright (c) 2012, 2018, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * The Universal Permissive License (UPL), Version 1.0
6 *
7 * Subject to the condition set forth below, permission is hereby granted to any
8 * person obtaining a copy of this software, associated documentation and/or
9 * data (collectively the "Software"), free of charge and under any and all
10 * copyright rights in the Software, and any and all patent rights owned or
11 * freely licensable by each licensor hereunder covering either (i) the
12 * unmodified Software as contributed to or provided by such licensor, or (ii)
13 * the Larger Works (as defined below), to deal in both
14 *
15 * (a) the Software, and
16 *
17 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
18 * one is included with the Software each a "Larger Work" to which the Software
19 * is contributed by such licensors),
20 *
21 * without restriction, including without limitation the rights to copy, create
22 * derivative works of, display, perform, and distribute the Software and make,
23 * use, sell, offer for sale, import, export, have made, and have sold the
24 * Software and the Larger Work(s), and to sublicense the foregoing rights on
25 * either these or other terms.
26 *
27 * This license is subject to the following condition:
28 *
29 * The above copyright notice and either this complete permission notice or at a
30 * minimum a reference to the UPL must be included in all copies or substantial
31 * portions of the Software.
32 *
33 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
34 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
35 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
36 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
37 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
38 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
39 * SOFTWARE.
40 */
41 package jdk.internal.vm.compiler.word;
42
43 import jdk.internal.vm.compiler.word.impl.WordBoxFactory;
44 import jdk.internal.vm.compiler.word.impl.WordFactoryOpcode;
45 import jdk.internal.vm.compiler.word.impl.WordFactoryOperation;
46
47 /**
48 * Provides factory method to create machine-word-sized values.
49 *
50 * @since 1.0
51 */
52 public final class WordFactory {
53
54 private WordFactory() {
55 }
56
57 /**
58 * The constant 0, i.e., the word with no bits set. There is no difference between a signed and
59 * unsigned zero.
60 *
61 * @return the constant 0.
62 *
63 * @since 1.0
64 */
65 @WordFactoryOperation(opcode = WordFactoryOpcode.ZERO)
66 public static <T extends WordBase> T zero() {
67 return WordBoxFactory.box(0L);
68 }
69
70 /**
71 * The null pointer, i.e., the pointer with no bits set. There is no difference to a signed or
72 * unsigned {@link #zero}.
73 *
74 * @return the null pointer.
75 *
76 * @since 1.0
77 */
78 @WordFactoryOperation(opcode = WordFactoryOpcode.ZERO)
79 public static <T extends PointerBase> T nullPointer() {
80 return WordBoxFactory.box(0L);
81 }
82
83 /**
84 * Unsafe conversion from a Java long value to a Word. The parameter is treated as an unsigned
85 * 64-bit value (in contrast to the semantics of a Java long).
86 *
87 * @param val a 64 bit unsigned value
88 * @return the value cast to Word
89 *
90 * @since 1.0
91 */
92 @WordFactoryOperation(opcode = WordFactoryOpcode.FROM_UNSIGNED)
93 public static <T extends UnsignedWord> T unsigned(long val) {
94 return WordBoxFactory.box(val);
95 }
96
97 /**
98 * Unsafe conversion from a Java long value to a {@link PointerBase pointer}. The parameter is
99 * treated as an unsigned 64-bit value (in contrast to the semantics of a Java long).
100 *
101 * @param val a 64 bit unsigned value
102 * @return the value cast to PointerBase
103 *
104 * @since 1.0
105 */
106 @WordFactoryOperation(opcode = WordFactoryOpcode.FROM_UNSIGNED)
107 public static <T extends PointerBase> T pointer(long val) {
108 return WordBoxFactory.box(val);
109 }
110
111 /**
112 * Unsafe conversion from a Java int value to a Word. The parameter is treated as an unsigned
113 * 32-bit value (in contrast to the semantics of a Java int).
114 *
115 * @param val a 32 bit unsigned value
116 * @return the value cast to Word
117 *
118 * @since 1.0
119 */
120 @WordFactoryOperation(opcode = WordFactoryOpcode.FROM_UNSIGNED)
121 public static <T extends UnsignedWord> T unsigned(int val) {
122 return WordBoxFactory.box(val & 0xffffffffL);
123 }
124
125 /**
126 * Unsafe conversion from a Java long value to a Word. The parameter is treated as a signed
127 * 64-bit value (unchanged semantics of a Java long).
128 *
129 * @param val a 64 bit signed value
130 * @return the value cast to Word
131 *
132 * @since 1.0
133 */
134 @WordFactoryOperation(opcode = WordFactoryOpcode.FROM_SIGNED)
135 public static <T extends SignedWord> T signed(long val) {
136 return WordBoxFactory.box(val);
137 }
138
139 /**
140 * Unsafe conversion from a Java int value to a Word. The parameter is treated as a signed
141 * 32-bit value (unchanged semantics of a Java int).
142 *
143 * @param val a 32 bit signed value
144 * @return the value cast to Word
145 *
146 * @since 1.0
147 */
148 @WordFactoryOperation(opcode = WordFactoryOpcode.FROM_SIGNED)
149 public static <T extends SignedWord> T signed(int val) {
150 return WordBoxFactory.box(val);
151 }
152 }