1 //******************************************************************************
2 //
3 // File: ByteArrayBuf.java
4 // Package: edu.rit.mp.buf
5 // Unit: Class edu.rit.mp.buf.ByteArrayBuf
6 //
7 // This Java source file is copyright (C) 2007 by Alan Kaminsky. All rights
8 // reserved. For further information, contact the author, Alan Kaminsky, at
9 // ark@cs.rit.edu.
10 //
11 // This Java source file is part of the Parallel Java Library ("PJ"). PJ is free
12 // software; you can redistribute it and/or modify it under the terms of the GNU
13 // General Public License as published by the Free Software Foundation; either
14 // version 3 of the License, or (at your option) any later version.
15 //
16 // PJ is distributed in the hope that it will be useful, but WITHOUT ANY
17 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
18 // A PARTICULAR PURPOSE. See the GNU General Public License for more details.
19 //
20 // Linking this library statically or dynamically with other modules is making a
21 // combined work based on this library. Thus, the terms and conditions of the GNU
22 // General Public License cover the whole combination.
23 //
24 // As a special exception, the copyright holders of this library give you
25 // permission to link this library with independent modules to produce an
26 // executable, regardless of the license terms of these independent modules, and
27 // to copy and distribute the resulting executable under terms of your choice,
28 // provided that you also meet, for each linked independent module, the terms
29 // and conditions of the license of that module. An independent module is a module
30 // which is not derived from or based on this library. If you modify this library,
31 // you may extend this exception to your version of the library, but you are not
32 // obligated to do so. If you do not wish to do so, delete this exception
33 // statement from your version.
34 //
35 // A copy of the GNU General Public License is provided in the file gpl.txt. You
36 // may also obtain a copy of the GNU General Public License on the World Wide
37 // Web at http://www.gnu.org/licenses/gpl.html.
38 //
39 //******************************************************************************
40 package edu.rit.mp.buf;
41
42 import java.nio.ByteBuffer;
43
44 import edu.rit.mp.Buf;
45 import edu.rit.mp.ByteBuf;
46 import edu.rit.pj.reduction.ByteOp;
47 import edu.rit.pj.reduction.Op;
48 import edu.rit.util.Arrays;
49 import edu.rit.util.Range;
50
51 /**
52 * Class ByteArrayBuf provides a buffer for an array of byte items sent or
53 * received using the Message Protocol (MP). The array element stride may be 1
54 * or greater than 1. While an instance of class ByteArrayBuf may be constructed
55 * directly, normally you will use a factory method in class
56 * {@linkplain edu.rit.mp.ByteBuf ByteBuf}. See that class for further
57 * information.
58 *
59 * @author Alan Kaminsky
60 * @version 25-Oct-2007
61 */
62 public class ByteArrayBuf
63 extends ByteBuf {
64
65 // Hidden data members.
66 byte[] myArray;
67 Range myRange;
68 int myArrayOffset;
69 int myStride;
70
71 // Exported constructors.
72 /**
73 * Construct a new byte array buffer.
74 *
75 * @param theArray Array.
76 * @param theRange Range of array elements to include in the buffer.
77 */
78 public ByteArrayBuf(byte[] theArray,
79 Range theRange) {
80 super(theRange.length());
81 myArray = theArray;
82 myRange = theRange;
83 myArrayOffset = theRange.lb();
84 myStride = theRange.stride();
85 }
86
87 // Exported operations.
88 /**
89 * {@inheritDoc}
90 *
91 * Obtain the given item from this buffer.
92 * <P>
93 * The <code>get()</code> method must not block the calling thread; if it does,
94 * all message I/O in MP will be blocked.
95 */
96 public byte get(int i) {
97 return myArray[myArrayOffset + i * myStride];
98 }
99
100 /**
101 * {@inheritDoc}
102 *
103 * Store the given item in this buffer.
104 * <P>
105 * The <code>put()</code> method must not block the calling thread; if it does,
106 * all message I/O in MP will be blocked.
107 */
108 public void put(int i,
109 byte item) {
110 myArray[myArrayOffset + i * myStride] = item;
111 }
112
113 /**
114 * {@inheritDoc}
115 *
116 * Copy items from the given buffer to this buffer. The number of items
117 * copied is this buffer's length or <code>theSrc</code>'s length, whichever is
118 * smaller. If <code>theSrc</code> is this buffer, the <code>copy()</code> method
119 * does nothing.
120 * @exception ClassCastException (unchecked exception) Thrown if
121 * <code>theSrc</code>'s item data type is not the same as this buffer's item
122 * data type.
123 */
124 public void copy(Buf theSrc) {
125 if (theSrc == this) {
126 } else if (theSrc instanceof ByteArrayBuf) {
127 ByteArrayBuf src = (ByteArrayBuf) theSrc;
128 Arrays.copy(src.myArray, src.myRange, this.myArray, this.myRange);
129 } else {
130 ByteBuf.defaultCopy((ByteBuf) theSrc, this);
131 }
132 }
133
134 /**
135 * {@inheritDoc}
136 *
137 * Create a buffer for performing parallel reduction using the given binary
138 * operation. The results of the reduction are placed into this buffer.
139 * @exception ClassCastException (unchecked exception) Thrown if this
140 * buffer's element data type and the given binary operation's argument data
141 * type are not the same.
142 */
143 public Buf getReductionBuf(Op op) {
144 return new ByteArrayReductionBuf(myArray, myRange, (ByteOp) op);
145 }
146
147 // Hidden operations.
148 /**
149 * {@inheritDoc}
150 *
151 * Send as many items as possible from this buffer to the given byte buffer.
152 * <P>
153 * The <code>sendItems()</code> method must not block the calling thread; if it
154 * does, all message I/O in MP will be blocked.
155 */
156 protected int sendItems(int i,
157 ByteBuffer buffer) {
158 int index = i;
159 int off = myArrayOffset + i * myStride;
160 while (index < myLength && buffer.remaining() >= 1) {
161 buffer.put(myArray[off]);
162 ++index;
163 off += myStride;
164 }
165 return index - i;
166 }
167
168 /**
169 * {@inheritDoc}
170 *
171 * Receive as many items as possible from the given byte buffer to this
172 * buffer.
173 * <P>
174 * The <code>receiveItems()</code> method must not block the calling thread; if
175 * it does, all message I/O in MP will be blocked.
176 */
177 protected int receiveItems(int i,
178 int num,
179 ByteBuffer buffer) {
180 int index = i;
181 int off = myArrayOffset + i * myStride;
182 int max = Math.min(i + num, myLength);
183 while (index < max && buffer.remaining() >= 1) {
184 myArray[off] = buffer.get();
185 ++index;
186 off += myStride;
187 }
188 return index - i;
189 }
190
191 }