BitSetNode (Apache HBase 2.2.3 API)

java.lang.Object
- org.apache.hadoop.hbase.procedure2.store.BitSetNode

```
@InterfaceAudience.Private
class BitSetNode
extends Object
```
A bitmap which can grow/merge with other BitSetNode (if certain conditions are met). Boundaries of bitmap are aligned to multiples of BITS_PER_WORD. So the range of a BitSetNode is from [x * K, y * K) where x and y are integers, y > x and K is BITS_PER_WORD.
We have two main bit sets to describe the state of procedures, the meanings are:
```
  ----------------------
 | modified | deleted |  meaning
 |     0    |   0     |  proc exists, but hasn't been updated since last resetUpdates().
 |     1    |   0     |  proc was updated (but not deleted).
 |     1    |   1     |  proc was deleted.
 |     0    |   1     |  proc doesn't exist (maybe never created, maybe deleted in past).
 ----------------------
 
```
The meaning of modified is that, we have modified the state of the procedure, no matter insert, update, or delete. And if it is an insert or update, we will set the deleted to 0, if not we will set the delete to 1.
For a non-partial BitSetNode, the initial modified value is 0 and deleted value is 1. For the partial one, the initial modified value is 0 and the initial deleted value is also 0. In unsetPartialFlag() we will reset the deleted to 1 if it is not modified.

Field Summary

Fields
Modifier and Type	Field and Description
`private static int`	`ADDRESS_BITS_PER_WORD`
`private static int`	`BITS_PER_WORD`
`private long[]`	`deleted` Keeps track of procedure ids which belong to this bitmap's range and have been deleted.
`private static int`	`MAX_NODE_SIZE`
`private long[]`	`modified` Set of procedures which have been modified since last `resetModified()`.
`private boolean`	`partial` Mimics `ProcedureStoreTracker.partial`.
`private long`	`start` Offset of bitmap i.e.
`private static long`	`WORD_MASK`

Constructor Summary

Constructors
Constructor and Description
`BitSetNode(BitSetNode other, boolean resetDelete)`
`BitSetNode(long procId, boolean partial)`
`BitSetNode(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureStoreTracker.TrackerNode data)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private static long`	`alignDown(long x)`
`private static long`	`alignUp(long x)`
`boolean`	`canGrow(long procId)`
`boolean`	`canMerge(BitSetNode rightNode)`
`boolean`	`contains(long procId)`
`org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureStoreTracker.TrackerNode`	`convert()` Convert to org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureStoreTracker.TrackerNode protobuf.
`void`	`delete(long procId)`
`void`	`dump()`
`long`	`getActiveMaxProcId()`
`long`	`getActiveMinProcId()`
`long[]`	`getActiveProcIds()`
`private int`	`getBitmapIndex(long procId)`
`long`	`getEnd()` Inclusive.
`long`	`getStart()`
`void`	`grow(long procId)`
`void`	`insertOrUpdate(long procId)`
`boolean`	`isAllModified()`
`ProcedureStoreTracker.DeleteState`	`isDeleted(long procId)`
`boolean`	`isEmpty()`
`boolean`	`isModified(long procId)`
`void`	`merge(BitSetNode rightNode)`
`void`	`resetModified()`
`String`	`toString()`
`void`	`unsetPartialFlag()`
`(package private) void`	`updateState(long procId, boolean isDeleted)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- WORD_MASK
```
private static final long WORD_MASK
```
  See Also:
  
  Constant Field Values
- ADDRESS_BITS_PER_WORD
```
private static final int ADDRESS_BITS_PER_WORD
```
  See Also:
  
  Constant Field Values
- BITS_PER_WORD
```
private static final int BITS_PER_WORD
```
  See Also:
  
  Constant Field Values
- MAX_NODE_SIZE
```
private static final int MAX_NODE_SIZE
```
  See Also:
  
  Constant Field Values
- partial
```
private boolean partial
```
  Mimics ProcedureStoreTracker.partial. It will effect how we fill the new deleted bits when growing.
- modified
```
private long[] modified
```
  Set of procedures which have been modified since last resetModified(). Useful to track procedures which have been modified since last WAL write.
- deleted
```
private long[] deleted
```
  Keeps track of procedure ids which belong to this bitmap's range and have been deleted. This represents global state since it's not reset on WAL rolls.
- start
```
private long start
```
  Offset of bitmap i.e. procedure id corresponding to first bit.

Constructor Detail

BitSetNode

public BitSetNode(long procId,
                  boolean partial)

BitSetNode

public BitSetNode(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureStoreTracker.TrackerNode data)

BitSetNode

public BitSetNode(BitSetNode other,
                  boolean resetDelete)

Method Detail

dump
```
public void dump()
```

insertOrUpdate

public void insertOrUpdate(long procId)

delete
```
public void delete(long procId)
```

getStart
```
public long getStart()
```

getEnd
```
public long getEnd()
```
Inclusive.

contains
```
public boolean contains(long procId)
```

isDeleted

public ProcedureStoreTracker.DeleteState isDeleted(long procId)

isModified

public boolean isModified(long procId)

isAllModified
```
public boolean isAllModified()
```
Returns:

true, if all the procedures has been modified.

getActiveProcIds
```
public long[] getActiveProcIds()
```
Returns:

all the active procedure ids in this bit set.

isEmpty
```
public boolean isEmpty()
```
Returns:

true, if there are no active procedures in this BitSetNode, else false.

resetModified
```
public void resetModified()
```

unsetPartialFlag
```
public void unsetPartialFlag()
```

convert
```
public org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureStoreTracker.TrackerNode convert()
```
Convert to org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureStoreTracker.TrackerNode protobuf.

canGrow
```
public boolean canGrow(long procId)
```

canMerge

public boolean canMerge(BitSetNode rightNode)

grow
```
public void grow(long procId)
```

merge

public void merge(BitSetNode rightNode)

toString
```
public String toString()
```
Overrides:

toString in class Object

getActiveMinProcId
```
public long getActiveMinProcId()
```

getActiveMaxProcId
```
public long getActiveMaxProcId()
```

getBitmapIndex

private int getBitmapIndex(long procId)

updateState

void updateState(long procId,
                 boolean isDeleted)

alignUp
```
private static long alignUp(long x)
```
Returns:

upper boundary (aligned to multiple of BITS_PER_WORD) of bitmap range x belongs to.

alignDown
```
private static long alignDown(long x)
```
Returns:

lower boundary (aligned to multiple of BITS_PER_WORD) of bitmap range x belongs to.

Class BitSetNode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WORD_MASK

ADDRESS_BITS_PER_WORD

BITS_PER_WORD

MAX_NODE_SIZE

partial

modified

deleted

start

Constructor Detail

BitSetNode

BitSetNode

BitSetNode

Method Detail

dump

insertOrUpdate

delete

getStart

getEnd

contains

isDeleted

isModified

isAllModified

getActiveProcIds

isEmpty

resetModified

unsetPartialFlag

convert

canGrow

canMerge

grow

merge

toString

getActiveMinProcId

getActiveMaxProcId

getBitmapIndex

updateState

alignUp

alignDown