-
Notifications
You must be signed in to change notification settings - Fork 12
/
IntegerDeclaration.java
638 lines (587 loc) · 21.4 KB
/
IntegerDeclaration.java
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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
/*******************************************************************************
* Copyright (c) 2011, 2014 Ericsson, Ecole Polytechnique de Montreal and others
*
* All rights reserved. This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0 which
* accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Matthew Khouzam - Initial API and implementation
* Simon Marchi - Initial API and implementation
* Marc-Andre Laperle - Add min/maximum for validation
*******************************************************************************/
package org.eclipse.tracecompass.ctf.core.event.types;
import static java.util.Objects.requireNonNull;
import java.math.BigInteger;
import java.nio.ByteOrder;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.tracecompass.ctf.core.CTFException;
import org.eclipse.tracecompass.ctf.core.event.io.BitBuffer;
import org.eclipse.tracecompass.ctf.core.event.scope.IDefinitionScope;
/**
* A CTF integer declaration.
*
* The declaration of a integer basic data type.
*
* @version 1.0
* @author Matthew Khouzam
* @author Simon Marchi
*/
@NonNullByDefault
public final class IntegerDeclaration extends Declaration implements ISimpleDatatypeDeclaration {
// ------------------------------------------------------------------------
// Helpers
// ------------------------------------------------------------------------
private static final int SIZE_64 = 64;
private static final int SIZE_32 = 32;
private static final int SIZE_27 = 27;
private static final int SIZE_16 = 16;
private static final int SIZE_8 = 8;
private static final int SIZE_5 = 5;
private static final int BYTE_ALIGN = 8;
private static final int BASE_10 = 10;
/**
* unsigned int 32 bits big endian
*/
public static final IntegerDeclaration UINT_32B_DECL = new IntegerDeclaration(32, false, ByteOrder.BIG_ENDIAN);
/**
* unsigned int 32 bits little endian
*/
public static final IntegerDeclaration UINT_32L_DECL = new IntegerDeclaration(32, false, ByteOrder.LITTLE_ENDIAN);
/**
* signed int 32 bits big endian
*/
public static final IntegerDeclaration INT_32B_DECL = new IntegerDeclaration(32, true, ByteOrder.BIG_ENDIAN);
/**
* signed int 32 bits little endian
*/
public static final IntegerDeclaration INT_32L_DECL = new IntegerDeclaration(32, true, ByteOrder.LITTLE_ENDIAN);
/**
* unsigned int 32 bits big endian
*/
public static final IntegerDeclaration UINT_64B_DECL = new IntegerDeclaration(64, false, ByteOrder.BIG_ENDIAN);
/**
* unsigned int 64 bits little endian
*/
public static final IntegerDeclaration UINT_64L_DECL = new IntegerDeclaration(64, false, ByteOrder.LITTLE_ENDIAN);
/**
* signed int 64 bits big endian
*/
public static final IntegerDeclaration INT_64B_DECL = new IntegerDeclaration(64, true, ByteOrder.BIG_ENDIAN);
/**
* signed int 64 bits little endian
*/
public static final IntegerDeclaration INT_64L_DECL = new IntegerDeclaration(64, true, ByteOrder.LITTLE_ENDIAN);
/**
* unsigned 8 bit int endianness doesn't matter since it's 8 bits (byte)
*/
public static final IntegerDeclaration UINT_8_DECL = new IntegerDeclaration(8, false, ByteOrder.BIG_ENDIAN);
/**
* signed 8 bit int endianness doesn't matter since it's 8 bits (char)
*/
public static final IntegerDeclaration INT_8_DECL = new IntegerDeclaration(8, true, ByteOrder.BIG_ENDIAN);
/**
* Unsigned 5 bit int, used for event headers
*/
public static final IntegerDeclaration UINT_5B_DECL = new IntegerDeclaration(5, false, 10, ByteOrder.BIG_ENDIAN, Encoding.NONE, "", 1); //$NON-NLS-1$
/**
* Unsigned 5 bit int, used for event headers
*/
public static final IntegerDeclaration UINT_5L_DECL = new IntegerDeclaration(5, false, 10, ByteOrder.LITTLE_ENDIAN, Encoding.NONE, "", 1); //$NON-NLS-1$
/**
* Unsigned 5 bit int, used for event headers
*/
public static final IntegerDeclaration UINT_27B_DECL = new IntegerDeclaration(27, false, 10, ByteOrder.BIG_ENDIAN, Encoding.NONE, "", 1); //$NON-NLS-1$
/**
* Unsigned 5 bit int, used for event headers
*/
public static final IntegerDeclaration UINT_27L_DECL = new IntegerDeclaration(27, false, 10, ByteOrder.LITTLE_ENDIAN, Encoding.NONE, "", 1); //$NON-NLS-1$
/**
* Unsigned 16 bit int, used for event headers
*/
public static final IntegerDeclaration UINT_16B_DECL = new IntegerDeclaration(16, false, ByteOrder.BIG_ENDIAN);
/**
* Unsigned 16 bit int, used for event headers
*/
public static final IntegerDeclaration UINT_16L_DECL = new IntegerDeclaration(16, false, ByteOrder.LITTLE_ENDIAN);
// ------------------------------------------------------------------------
// Attributes
// ------------------------------------------------------------------------
private final int fLength;
private final boolean fSigned;
private final int fBase;
private final boolean fIsByteOrderSet;
private final ByteOrder fByteOrder;
private final Encoding fEncoding;
private final long fAlignment;
private final String fClock;
// ------------------------------------------------------------------------
// Constructors
// ------------------------------------------------------------------------
/**
* Factory, some common types cached
*
* @deprecated use
* {@link #createDeclaration(int, boolean, int, ByteOrder, Encoding, String, long, String)}
* instead
*
* @param len
* The length in bits
* @param signed
* Is the integer signed? false == unsigned
* @param base
* The base (10-16 are most common)
* @param byteOrder
* Big-endian little-endian or other
* @param encoding
* ascii, utf8 or none.
* @param clock
* The clock path, can be null
* @param alignment
* The minimum alignment. Should be >= 1
* @return the integer declaration
* @deprecated use {@link #createDeclaration(int, boolean, int, ByteOrder, Encoding, String, long, String)}
*/
@Deprecated
public static IntegerDeclaration createDeclaration(int len, boolean signed, int base,
@Nullable ByteOrder byteOrder, Encoding encoding, String clock, long alignment) {
if (encoding.equals(Encoding.NONE) && (clock.equals("")) && base == BASE_10 && byteOrder != null) { //$NON-NLS-1$
if (alignment == BYTE_ALIGN) {
switch (len) {
case SIZE_8:
return signed ? INT_8_DECL : UINT_8_DECL;
case SIZE_16:
if (!signed) {
if (isBigEndian(byteOrder)) {
return UINT_16B_DECL;
}
return UINT_16L_DECL;
}
break;
case SIZE_32:
if (signed) {
if (isBigEndian(byteOrder)) {
return INT_32B_DECL;
}
return INT_32L_DECL;
}
if (isBigEndian(byteOrder)) {
return UINT_32B_DECL;
}
return UINT_32L_DECL;
case SIZE_64:
if (signed) {
if (isBigEndian(byteOrder)) {
return INT_64B_DECL;
}
return INT_64L_DECL;
}
if (isBigEndian(byteOrder)) {
return UINT_64B_DECL;
}
return UINT_64L_DECL;
default:
}
} else if (alignment == 1) {
switch (len) {
case SIZE_5:
if (!signed) {
if (isBigEndian(byteOrder)) {
return UINT_5B_DECL;
}
return UINT_5L_DECL;
}
break;
case SIZE_27:
if (!signed) {
if (isBigEndian(byteOrder)) {
return UINT_27B_DECL;
}
return UINT_27L_DECL;
}
break;
default:
break;
}
}
}
return new IntegerDeclaration(len, signed, base, byteOrder, encoding, clock, alignment);
}
/**
* Alternate create method for CTF2 integers which have roles
*
* @param len
* The length in bits
* @param signed
* Is the integer signed? false == unsigned
* @param base
* The base (10-16 are most common)
* @param byteOrder
* Big-endian little-endian or other
* @param encoding
* ascii, utf8 or none.
* @param clock
* The clock path, can be null
* @param alignment
* The minimum alignment. Should be >= 1
* @param role
* The role of the declaration
* @return The integer declaration
* @since 4.4
*/
public static IntegerDeclaration createDeclaration(int len, boolean signed, int base,
@Nullable ByteOrder byteOrder, Encoding encoding, String clock, long alignment, @Nullable String role) {
if (encoding.equals(Encoding.NONE) && (clock.equals("")) && base == BASE_10 && byteOrder != null) { //$NON-NLS-1$
if (alignment == BYTE_ALIGN) {
switch (len) {
case SIZE_8:
return signed ? INT_8_DECL : UINT_8_DECL;
case SIZE_16:
if (!signed) {
if (isBigEndian(byteOrder)) {
return UINT_16B_DECL;
}
return UINT_16L_DECL;
}
break;
case SIZE_32:
if (signed) {
if (isBigEndian(byteOrder)) {
return INT_32B_DECL;
}
return INT_32L_DECL;
}
if (isBigEndian(byteOrder)) {
return UINT_32B_DECL;
}
return UINT_32L_DECL;
case SIZE_64:
if (signed) {
if (isBigEndian(byteOrder)) {
return INT_64B_DECL;
}
return INT_64L_DECL;
}
if (isBigEndian(byteOrder)) {
return UINT_64B_DECL;
}
return UINT_64L_DECL;
default:
}
} else if (alignment == 1) {
switch (len) {
case SIZE_5:
if (!signed) {
if (isBigEndian(byteOrder)) {
return UINT_5B_DECL;
}
return UINT_5L_DECL;
}
break;
case SIZE_27:
if (!signed) {
if (isBigEndian(byteOrder)) {
return UINT_27B_DECL;
}
return UINT_27L_DECL;
}
break;
default:
break;
}
}
}
return new IntegerDeclaration(len, signed, base, byteOrder, encoding, clock, alignment, role);
}
private static boolean isBigEndian(@Nullable ByteOrder byteOrder) {
return (byteOrder != null) && byteOrder.equals(ByteOrder.BIG_ENDIAN);
}
/**
* Constructor
*
* @param len
* The length in bits
* @param signed
* Is the integer signed? false == unsigned
* @param base
* The base (10-16 are most common)
* @param byteOrder
* Big-endian little-endian or other
* @param encoding
* ascii, utf8 or none.
* @param clock
* The clock path, can be null
* @param alignment
* The minimum alignment. Should be ≥ 1
*/
private IntegerDeclaration(int len, boolean signed, int base,
@Nullable ByteOrder byteOrder, Encoding encoding, String clock, long alignment) {
fLength = len;
fSigned = signed;
fBase = base;
fIsByteOrderSet = byteOrder != null;
fByteOrder = (byteOrder == null) ? ByteOrder.nativeOrder() : byteOrder;
fEncoding = encoding;
fClock = clock;
fAlignment = Math.max(alignment, 1);
}
/**
* Constructor
*
* @param len
* The length in bits
* @param signed
* Is the integer signed? false == unsigned
* @param base
* The base (10-16 are most common)
* @param byteOrder
* Big-endian little-endian or other
* @param encoding
* ascii, utf8 or none.
* @param clock
* The clock path, can be null
* @param alignment
* The minimum alignment. Should be ≥ 1
* @param role
* The role of the integer declaration
*/
private IntegerDeclaration(int len, boolean signed, int base,
@Nullable ByteOrder byteOrder, Encoding encoding, String clock, long alignment, @Nullable String role) {
this(len, signed, base, byteOrder, encoding, clock, alignment);
setRole(role);
}
private IntegerDeclaration(int len, boolean signed, @Nullable ByteOrder byteOrder) {
this(len, signed, BASE_10, byteOrder, Encoding.NONE, "", BYTE_ALIGN, null); //$NON-NLS-1$
}
// ------------------------------------------------------------------------
// Getters/Setters/Predicates
// ------------------------------------------------------------------------
/**
* Is the integer signed?
*
* @return the is the integer signed
*/
public boolean isSigned() {
return fSigned;
}
/**
* Get the integer base commonly decimal or hex
*
* @return the integer base
*/
public int getBase() {
return fBase;
}
/**
* @since 2.0
*/
@Override
public boolean isByteOrderSet() {
return fIsByteOrderSet;
}
@Override
public ByteOrder getByteOrder() {
return fByteOrder;
}
/**
* Get encoding, chars are 8 bit ints
*
* @return the encoding
*/
public Encoding getEncoding() {
return fEncoding;
}
/**
* Is the integer a character (8 bits and encoded?)
*
* @return is the integer a char
*/
public boolean isCharacter() {
return (fLength == SIZE_8) && (fEncoding != Encoding.NONE);
}
/**
* Is the integer an unsigned byte (8 bits and no sign)?
*
* @return is the integer an unsigned byte
*/
public boolean isUnsignedByte() {
return (fLength == SIZE_8) && (!fSigned);
}
/**
* Get the length in bits for this integer
*
* @return the length of the integer
*/
public int getLength() {
return fLength;
}
@Override
public long getAlignment() {
return fAlignment;
}
/**
* The integer's clock, since timestamps are stored in ints
*
* @return the integer's clock, can be null. (most often it is)
*/
public String getClock() {
return fClock;
}
@Override
public int getMaximumSize() {
return fLength;
}
// ------------------------------------------------------------------------
// Operations
// ------------------------------------------------------------------------
@Override
public IntegerDefinition createDefinition(@Nullable IDefinitionScope definitionScope,
String fieldName, BitBuffer input) throws CTFException {
ByteOrder byteOrder = input.getByteOrder();
input.setByteOrder(fByteOrder);
long value = read(input);
input.setByteOrder(byteOrder);
return new IntegerDefinition(this, definitionScope, fieldName, value);
}
@Override
public String toString() {
return "[declaration] integer[length:" + fLength + (fSigned ? " " : " un") + "signed" + " base:" + fBase + " byteOrder:" + fByteOrder + " encoding:" + fEncoding + " alignment:" + fAlignment + " clock:" + fClock + "]"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$ //$NON-NLS-8$ //$NON-NLS-9$ //$NON-NLS-10$
}
/**
* Get the maximum value for this integer declaration.
*
* @return The maximum value for this integer declaration
*/
public BigInteger getMaxValue() {
/*
* Compute the number of bits able to represent an unsigned number,
* ignoring sign bit.
*/
int significantBits = fLength - (fSigned ? 1 : 0);
/*
* For a given N significant bits, compute the maximal value which is (1
* << N) - 1.
*/
return requireNonNull(BigInteger.ONE.shiftLeft(significantBits).subtract(BigInteger.ONE));
}
/**
* Get the minimum value for this integer declaration.
*
* @return The minimum value for this integer declaration
*/
public BigInteger getMinValue() {
if (!fSigned) {
return requireNonNull(BigInteger.ZERO);
}
/*
* Compute the number of bits able to represent an unsigned number,
* without the sign bit.
*/
int significantBits = fLength - 1;
/*
* For a given N significant bits, compute the minimal value which is -
* (1 << N).
*/
return requireNonNull(BigInteger.ONE.shiftLeft(significantBits).negate());
}
private long read(BitBuffer input) throws CTFException {
/* Offset the buffer position wrt the current alignment */
alignRead(input);
boolean signed = isSigned();
int length = getLength();
long bits = 0;
/*
* Is the endianness of this field the same as the endianness of the
* input buffer? If not, then temporarily set the buffer's endianness to
* this field's just to read the data
*/
ByteOrder previousByteOrder = input.getByteOrder();
if ((getByteOrder() != input.getByteOrder())) {
input.setByteOrder(getByteOrder());
}
if (length > SIZE_64) {
throw new CTFException("Cannot read an integer with over 64 bits. Length given: " + length); //$NON-NLS-1$
}
bits = input.get(length, signed);
/*
* Put the input buffer's endianness back to original if it was changed
*/
if (previousByteOrder != input.getByteOrder()) {
input.setByteOrder(previousByteOrder);
}
return bits;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + (int) (fAlignment ^ (fAlignment >>> 32));
result = prime * result + fBase;
result = prime * result + fByteOrder.toString().hashCode();
result = prime * result + fClock.hashCode();
result = prime * result + fEncoding.hashCode();
result = prime * result + fLength;
result = prime * result + (fSigned ? 1231 : 1237);
return result;
}
@Override
public boolean equals(@Nullable Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
IntegerDeclaration other = (IntegerDeclaration) obj;
if (!isBinaryEquivalent(other)) {
return false;
}
if (!fByteOrder.equals(other.fByteOrder)) {
return false;
}
if (!fClock.equals(other.fClock)) {
return false;
}
if (fEncoding != other.fEncoding) {
return false;
}
return (fBase == other.fBase);
}
@Override
public boolean isBinaryEquivalent(@Nullable IDeclaration obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
IntegerDeclaration other = (IntegerDeclaration) obj;
return isBinaryEquivalent(other);
}
private boolean isBinaryEquivalent(IntegerDeclaration other) {
if (fAlignment != other.fAlignment) {
return false;
}
if (fLength != other.fLength) {
return false;
}
if (fSigned != other.fSigned) {
return false;
}
// no need for base
// no need for encoding
// no need for clock
// byte inversion is ok on byte order if the element is one byte long
return !((fLength != BYTE_ALIGN) && !fByteOrder.equals(other.fByteOrder));
}
}