summaryrefslogtreecommitdiffstats
path: root/src/java/com/jogamp/common/nio/PointerBuffer.java
blob: c9499d786802c11b27d5f57a59b845045c67607e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
/**
 * Copyright 2010-2023 JogAmp Community. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice, this list of
 *       conditions and the following disclaimer.
 *
 *    2. Redistributions in binary form must reproduce the above copyright notice, this list
 *       of conditions and the following disclaimer in the documentation and/or other materials
 *       provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those of the
 * authors and should not be interpreted as representing official policies, either expressed
 * or implied, of JogAmp Community.
 */

/*
 * Created on Saturday, March 27 2010 11:55
 */
package com.jogamp.common.nio;

import java.nio.Buffer;
import java.nio.ByteBuffer;
import java.nio.IntBuffer;
import java.nio.LongBuffer;

import com.jogamp.common.os.Platform;
import com.jogamp.common.util.LongObjectHashMap;

/**
 * Hardware independent container holding an array of native pointer,
 * while its {@link #getDirectBufferAddress()} is-a pointer-pointer type value.
 * <p>
 * An instance maps an array of pointers of referenced Buffer objects, represented as longs.
 * </p>
 * <p>
 * The native values (NIO direct ByteBuffer) might be 32bit or 64bit wide,
 * depending of the CPU pointer width, see {@link #POINTER_SIZE}.
 * </p>
 * @author Sven Gothel
 * @author Michael Bien
 */
public class PointerBuffer extends AbstractBuffer<PointerBuffer> {
    protected LongObjectHashMap dataMap = null;

    /** no backup array, use for direct usage only */
    static PointerBuffer create(final ByteBuffer bb) {
        return Platform.is32Bit() ? new PointerBuffer( bb.asIntBuffer() ) : new PointerBuffer( bb.asLongBuffer() );
    }

    /** supports backup array */
    PointerBuffer(final IntBuffer b) {
        super(b, POINTER_SIZE, b.capacity());
    }

    /** supports backup array */
    PointerBuffer(final LongBuffer b) {
        super(b, POINTER_SIZE, b.capacity());
    }

    private final void validateDataMap() {
        if(null == dataMap) {
            dataMap = new LongObjectHashMap();
            dataMap.setKeyNotFoundValue(null);
        }
    }

    /** Returns a non direct PointerBuffer, having a backup array */
    public static PointerBuffer allocate(final int size) {
        if (Platform.is32Bit()) {
            return new PointerBuffer(IntBuffer.wrap(new int[size]));
        } else {
            return new PointerBuffer(LongBuffer.wrap(new long[size]));
        }
    }

    /** Returns a direct PointerBuffer in native order, w/o backup array */
    public static PointerBuffer allocateDirect(final int size) {
        return create(Buffers.newDirectByteBuffer(POINTER_SIZE * size));
    }

    /** Wraps given {@link ByteBuffer} {@code src} up to it {@link ByteBuffer#capacity()}/{@link #POINTER_SIZE} pointers. */
    public static PointerBuffer wrap(final ByteBuffer src) {
        return create(src);
    }
    /**
     * Wraps given {@link ByteBuffer} {@code src} @ {@code srcByteOffset} to contain {@code elemCount} pointers.
     * @param src
     * @param srcByteOffset
     * @param elemCount
     * @return
     */
    public static PointerBuffer wrap(final ByteBuffer src, final int srcByteOffset, final int elemCount) {
        final int oldPos = src.position();
        final int oldLimit = src.limit();
        src.position(srcByteOffset);
        src.limit(srcByteOffset + POINTER_SIZE*elemCount);
        final ByteBuffer ref = src.slice().order(src.order()); // slice and duplicate may change byte order
        src.position(oldPos);
        src.limit(oldLimit);
        return create(ref);
    }

    public static PointerBuffer derefPointer(final long aptr, final int elemCount) {
        if( 0 == aptr ) {
            throw new NullPointerException("aptr is null");
        }
        final ByteBuffer bb = Buffers.getDirectByteBuffer(aptr, elemCount * POINTER_SIZE);
        if( null == bb ) {
            throw new InternalError("Couldn't dereference aptr 0x"+Long.toHexString(aptr)+", size "+elemCount+" * "+POINTER_SIZE);
        }
        return create(bb);
    }
    public static PointerBuffer derefPointer(final ByteBuffer ptrSrc, final int ptrSrcByteOffset, final int elemCount) {
        return derefPointer(wrap(ptrSrc, ptrSrcByteOffset, 1).get(0), elemCount);
    }

    /**
     * @return new PointerBuffer sharing the same buffer data of this instance (identity),
     *         but having an independent position.
     */
    public final PointerBuffer duplicate() {
        PointerBuffer npb;
        if (Platform.is32Bit()) {
            npb = new PointerBuffer((IntBuffer)buffer);
        } else {
            npb = new PointerBuffer((LongBuffer)buffer);
        }
        if(null != dataMap) {
            npb.dataMap = (LongObjectHashMap) dataMap.clone();
        }
        npb.position = position;
        return npb;
    }

    @Override
    public final PointerBuffer put(final PointerBuffer src) {
        if (remaining() < src.remaining()) {
            throw new IndexOutOfBoundsException("remaining[this "+remaining()+" < src "+src.remaining()+"], this "+this+", src "+src);
        }
        if( null == src.dataMap && null == dataMap ) {
            // fast path no dataMap usage on both
            while (src.hasRemaining()) {
                put(src.get());
            }
        } else {
            while (src.hasRemaining()) {
                 final long addr = src.get();
                 put(addr);
                 if( null != src.dataMap) {
                     final Buffer bb = (Buffer) src.dataMap.get(addr);
                     if(null!=bb) {
                         validateDataMap();
                         dataMap.put(addr, bb);
                     } else if( null != dataMap ) {
                         dataMap.remove(addr);
                     }
                 } else if( null != dataMap ) {
                     dataMap.remove(addr);
                 }
            }
        }
        return this;
    }

    /** Absolute get method. Get the pointer value at the given index */
    public final long get(final int idx) {
        if (0 > idx || idx >= limit()) {
            throw new IndexOutOfBoundsException("idx "+idx+" not within [0.."+limit()+"), "+this);
        }
        if (Platform.is32Bit()) {
            return ((IntBuffer) buffer).get(idx)  & 0x00000000FFFFFFFFL;
        } else {
            return ((LongBuffer) buffer).get(idx);
        }
    }
    /** Relative get method. Get the pointer value at the current position and increment the position by one. */
    public final long get() {
        final long r = get(position);
        position++;
        return r;
    }

    /** Absolute get method. Get element-bytes for `elemCount` elements from this buffer at `srcElemPos` into `dest` at the given element-index `destElemPos` */
    public final PointerBuffer get(final int srcElemPos, final long[] dest, final int destElemPos, final int elemCount) {
        if (0 > srcElemPos || srcElemPos + elemCount > limit() || 0 > elemCount ||
            0 > destElemPos || destElemPos + elemCount > dest.length )
        {
            throw new IndexOutOfBoundsException("destElemPos "+destElemPos+", srcElemPos "+srcElemPos+", elemCount "+elemCount+
                                                ", srcLimit "+limit()+", destLimit "+dest.length+", "+this);
        }
        if (Platform.is32Bit()) {
            final IntBuffer src = (IntBuffer) buffer;
            for(int i=0; i<elemCount; ++i) {
                dest[destElemPos+i] = src.get(srcElemPos+i) & 0x00000000FFFFFFFFL;
            }
        } else {
            final LongBuffer src = (LongBuffer) buffer;
            final int oldSrcLim = src.limit();
            final int oldSrcPos = src.position();
            src.position( srcElemPos ).limit( srcElemPos + elemCount ); // remaining = elemCount
            src.get(dest, destElemPos, elemCount);
            src.limit(oldSrcLim).position(oldSrcPos);
        }
        return this;
    }

    /**
     * Relative bulk get method. Copy the pointer values <code> [ position .. position+elemCount [</code>
     * to the destination array <code> [ dest[destElemPos] .. dest[destElemPos+elemCount] [ </code>
     * and increment the position by <code>elemCount</code>. */
    public final PointerBuffer get(final long[] dest, final int destElemPos, final int elemCount) {
        get(position, dest, destElemPos, elemCount);
        position += elemCount;
        return this;
    }

    /** Absolute put method. Put the pointer value at the given index */
    public final PointerBuffer put(final int idx, final long v) {
        if (0 > idx || idx >= limit()) {
            throw new IndexOutOfBoundsException("idx "+idx+" not within [0.."+limit()+"), "+this);
        }
        if (Platform.is32Bit()) {
            ((IntBuffer) buffer).put(idx, (int) v);
        } else {
            ((LongBuffer) buffer).put(idx, v);
        }
        return this;
    }
    /** Relative put method. Put the pointer value at the current position and increment the position by one. */
    public final PointerBuffer put(final long value) {
        put(position, value);
        position++;
        return this;
    }

    /** Absolute put method. Put element-bytes for `elemCount` elements from `src` at `srcElemPos` into this buffer at the given element-index `destElemPos` */
    public final PointerBuffer put(final long[] src, final int srcElemPos, final int destElemPos, final int elemCount) {
        if (0 > destElemPos || destElemPos + elemCount > limit() || 0 > elemCount ||
            0 > srcElemPos || srcElemPos + elemCount > src.length )
        {
            throw new IndexOutOfBoundsException("srcElemPos "+srcElemPos+", destElemPos "+destElemPos+", elemCount "+elemCount+
                                                ", destLimit "+limit()+", srcLimit "+src.length+", "+this);
        }
        if (Platform.is32Bit()) {
            final IntBuffer dest = (IntBuffer) buffer;
            for(int i=0; i<elemCount; ++i) {
                dest.put(destElemPos+i, (int) src[srcElemPos+i]);
            }
        } else {
            final LongBuffer dest = (LongBuffer) buffer;
            final int oldDestLim = dest.limit();
            final int oldDestPos = dest.position();
            dest.position( destElemPos ).limit( destElemPos + elemCount ); // remaining = elemCount
            dest.put(src, srcElemPos, elemCount); // remaining = elemCount
            dest.limit(oldDestLim).position(oldDestPos);
        }
        return this;
    }
    /**
     * Relative bulk put method. Put the pointer values <code> [ src[srcElemPos] .. src[srcElemPos+elemCount] [</code>
     * at the current position and increment the position by <code>elemCount</code>. */
    public final PointerBuffer put(final long[] src, final int srcElemPos, final int elemCount) {
        put(src, srcElemPos, position, elemCount);
        position += elemCount;
        return this;
    }

    /** Put the address of the given direct Buffer at the given position
        of this pointer array.
        Adding a reference of the given direct Buffer to this object.

        @throws IllegalArgumentException if bb is null or not a direct buffer
     */
    public final PointerBuffer referenceBuffer(final int index, final Buffer bb) {
        if(null==bb) {
            throw new IllegalArgumentException("Buffer is null");
        }
        if(!Buffers.isDirect(bb)) {
            throw new IllegalArgumentException("Buffer is not direct");
        }
        final long mask = Platform.is32Bit() ?  0x00000000FFFFFFFFL : 0xFFFFFFFFFFFFFFFFL ;
        final long bbAddr = Buffers.getDirectBufferAddressImpl(bb) & mask;
        if(0==bbAddr) {
            throw new RuntimeException("Couldn't determine native address of given Buffer: "+bb);
        }
        validateDataMap();
        put(index, bbAddr);
        dataMap.put(bbAddr, bb);
        return this;
    }

    /** Put the address of the given direct Buffer at the end
        of this pointer array.
        Adding a reference of the given direct Buffer to this object. */
    public final PointerBuffer referenceBuffer(final Buffer bb) {
        referenceBuffer(position, bb);
        position++;
        return this;
    }

    public final Buffer getReferencedBuffer(final int index) {
        if(null != dataMap) {
            final long addr = get(index);
            return (Buffer) dataMap.get(addr);
        }
        return null;
    }

    public final Buffer getReferencedBuffer() {
        final Buffer bb = getReferencedBuffer(position);
        position++;
        return bb;
    }

    @Override
    public String toString() {
        return "PointerBuffer"+toSubString();
    }
}