GH-774: Consoliate BitVectorHelper.getValidityBufferSize and BaseValueVector.getValidityBufferSizeFromCount

vector/src/main/java/org/apache/arrow/vector/BaseFixedWidthVector.java

@@ -359,7 +359,7 @@ public int getBufferSizeFor(final int count) {
     if (count == 0) {
       return 0;
     }
-    return (count * typeWidth) + getValidityBufferSizeFromCount(count);
+    return (count * typeWidth) + BitVectorHelper.getValidityBufferSizeFromCount(count);
   }
 
   /**
@@ -372,7 +372,7 @@ public int getBufferSize() {
     if (valueCount == 0) {
       return 0;
     }
-    return (valueCount * typeWidth) + getValidityBufferSizeFromCount(valueCount);
+    return (valueCount * typeWidth) + BitVectorHelper.getValidityBufferSizeFromCount(valueCount);
   }
 
   /**
@@ -536,10 +536,10 @@ private void setReaderAndWriterIndex() {
       validityBuffer.writerIndex(0);
       valueBuffer.writerIndex(0);
     } else {
-      validityBuffer.writerIndex(getValidityBufferSizeFromCount(valueCount));
+      validityBuffer.writerIndex(BitVectorHelper.getValidityBufferSizeFromCount(valueCount));
       if (typeWidth == 0) {
         /* specialized handling for BitVector */
-        valueBuffer.writerIndex(getValidityBufferSizeFromCount(valueCount));
+        valueBuffer.writerIndex(BitVectorHelper.getValidityBufferSizeFromCount(valueCount));
       } else {
         valueBuffer.writerIndex((long) valueCount * typeWidth);
       }
@@ -664,7 +664,7 @@ private void splitAndTransferValidityBuffer(
       int startIndex, int length, BaseFixedWidthVector target) {
     int firstByteSource = BitVectorHelper.byteIndex(startIndex);
     int lastByteSource = BitVectorHelper.byteIndex(valueCount - 1);
-    int byteSizeTarget = getValidityBufferSizeFromCount(length);
+    int byteSizeTarget = BitVectorHelper.getValidityBufferSizeFromCount(length);
     int offset = startIndex % 8;
 
     if (length > 0) {

vector/src/main/java/org/apache/arrow/vector/BaseLargeVariableWidthVector.java

@@ -379,7 +379,7 @@ private void setReaderAndWriterIndex() {
       valueBuffer.writerIndex(0);
     } else {
       final long lastDataOffset = getStartOffset(valueCount);
-      validityBuffer.writerIndex(getValidityBufferSizeFromCount(valueCount));
+      validityBuffer.writerIndex(BitVectorHelper.getValidityBufferSizeFromCount(valueCount));
       offsetBuffer.writerIndex((long) (valueCount + 1) * OFFSET_WIDTH);
       valueBuffer.writerIndex(lastDataOffset);
     }
@@ -633,7 +633,7 @@ public int getBufferSizeFor(final int valueCount) {
       return 0;
     }
 
-    final long validityBufferSize = getValidityBufferSizeFromCount(valueCount);
+    final long validityBufferSize = BitVectorHelper.getValidityBufferSizeFromCount(valueCount);
     final long offsetBufferSize = (long) (valueCount + 1) * OFFSET_WIDTH;
     /* get the end offset for this valueCount */
     final long dataBufferSize = getStartOffset(valueCount);
@@ -816,7 +816,7 @@ private void splitAndTransferValidityBuffer(
       int startIndex, int length, BaseLargeVariableWidthVector target) {
     int firstByteSource = BitVectorHelper.byteIndex(startIndex);
     int lastByteSource = BitVectorHelper.byteIndex(valueCount - 1);
-    int byteSizeTarget = getValidityBufferSizeFromCount(length);
+    int byteSizeTarget = BitVectorHelper.getValidityBufferSizeFromCount(length);
     int offset = startIndex % 8;
 
     if (length > 0) {

vector/src/main/java/org/apache/arrow/vector/BaseValueVector.java

@@ -110,7 +110,14 @@ protected ArrowBuf releaseBuffer(ArrowBuf buffer) {
     return buffer;
   }
 
-  /* number of bytes for the validity buffer for the given valueCount */
+  /**
+   * Compute the size of validity buffer required to manage a given number of elements in a vector.
+   *
+   * @param valueCount number of elements in the vector
+   * @return buffer size
+   * @deprecated -- use {@link BitVectorHelper#getValidityBufferSizeFromCount} instead.
+   */
+  @Deprecated(forRemoval = true, since = "18.4.0")
   protected static int getValidityBufferSizeFromCount(final int valueCount) {
     return DataSizeRoundingUtil.divideBy8Ceil(valueCount);
   }

vector/src/main/java/org/apache/arrow/vector/BaseVariableWidthVector.java

@@ -395,7 +395,7 @@ private void setReaderAndWriterIndex() {
       valueBuffer.writerIndex(0);
     } else {
       final int lastDataOffset = getStartOffset(valueCount);
-      validityBuffer.writerIndex(getValidityBufferSizeFromCount(valueCount));
+      validityBuffer.writerIndex(BitVectorHelper.getValidityBufferSizeFromCount(valueCount));
       offsetBuffer.writerIndex((long) (valueCount + 1) * OFFSET_WIDTH);
       valueBuffer.writerIndex(lastDataOffset);
     }
@@ -673,7 +673,7 @@ public int getBufferSizeFor(final int valueCount) {
       return 0;
     }
 
-    final int validityBufferSize = getValidityBufferSizeFromCount(valueCount);
+    final int validityBufferSize = BitVectorHelper.getValidityBufferSizeFromCount(valueCount);
     final int offsetBufferSize = (valueCount + 1) * OFFSET_WIDTH;
     /* get the end offset for this valueCount */
     final int dataBufferSize = offsetBuffer.getInt((long) valueCount * OFFSET_WIDTH);
@@ -867,7 +867,7 @@ private void splitAndTransferValidityBuffer(
 
     final int firstByteSource = BitVectorHelper.byteIndex(startIndex);
     final int lastByteSource = BitVectorHelper.byteIndex(valueCount - 1);
-    final int byteSizeTarget = getValidityBufferSizeFromCount(length);
+    final int byteSizeTarget = BitVectorHelper.getValidityBufferSizeFromCount(length);
     final int offset = startIndex % 8;
 
     if (offset == 0) {

vector/src/main/java/org/apache/arrow/vector/BaseVariableWidthViewVector.java

@@ -400,7 +400,7 @@ private void setReaderAndWriterIndex() {
       validityBuffer.writerIndex(0);
       viewBuffer.writerIndex(0);
     } else {
-      validityBuffer.writerIndex(getValidityBufferSizeFromCount(valueCount));
+      validityBuffer.writerIndex(BitVectorHelper.getValidityBufferSizeFromCount(valueCount));
       viewBuffer.writerIndex(valueCount * ELEMENT_SIZE);
     }
   }
@@ -683,7 +683,7 @@ public int getBufferSizeFor(final int valueCount) {
       return 0;
     }
 
-    final int validityBufferSize = getValidityBufferSizeFromCount(valueCount);
+    final int validityBufferSize = BitVectorHelper.getValidityBufferSizeFromCount(valueCount);
     final int viewBufferSize = valueCount * ELEMENT_SIZE;
     final int dataBufferSize = getDataBufferSize();
     return validityBufferSize + viewBufferSize + dataBufferSize;
@@ -872,7 +872,7 @@ private void splitAndTransferValidityBuffer(
 
     final int firstByteSource = BitVectorHelper.byteIndex(startIndex);
     final int lastByteSource = BitVectorHelper.byteIndex(valueCount - 1);
-    final int byteSizeTarget = getValidityBufferSizeFromCount(length);
+    final int byteSizeTarget = BitVectorHelper.getValidityBufferSizeFromCount(length);
     final int offset = startIndex % 8;
 
     if (offset == 0) {

vector/src/main/java/org/apache/arrow/vector/BitVector.java

@@ -98,7 +98,7 @@ public MinorType getMinorType() {
    */
   @Override
   public void setInitialCapacity(int valueCount) {
-    final int size = getValidityBufferSizeFromCount(valueCount);
+    final int size = BitVectorHelper.getValidityBufferSizeFromCount(valueCount);
     if (size * 2L > MAX_ALLOCATION_SIZE) {
       throw new OversizedAllocationException("Requested amount of memory is more than max allowed");
     }
@@ -121,7 +121,7 @@ public int getBufferSizeFor(final int count) {
     if (count == 0) {
       return 0;
     }
-    return 2 * getValidityBufferSizeFromCount(count);
+    return 2 * BitVectorHelper.getValidityBufferSizeFromCount(count);
   }
 
   /**
@@ -165,7 +165,7 @@ private ArrowBuf splitAndTransferBuffer(
       int startIndex, int length, ArrowBuf sourceBuffer, ArrowBuf destBuffer) {
     int firstByteSource = BitVectorHelper.byteIndex(startIndex);
     int lastByteSource = BitVectorHelper.byteIndex(valueCount - 1);
-    int byteSizeTarget = getValidityBufferSizeFromCount(length);
+    int byteSizeTarget = BitVectorHelper.getValidityBufferSizeFromCount(length);
     int offset = startIndex % 8;
 
     if (length > 0) {

vector/src/main/java/org/apache/arrow/vector/BitVectorHelper.java

@@ -135,11 +135,11 @@ public static void setValidityBit(ArrowBuf validityBuffer, int index, int value)
   public static ArrowBuf setValidityBit(
       ArrowBuf validityBuffer, BufferAllocator allocator, int valueCount, int index, int value) {
     if (validityBuffer == null) {
-      validityBuffer = allocator.buffer(getValidityBufferSize(valueCount));
+      validityBuffer = allocator.buffer(getValidityBufferSizeFromCount(valueCount));
     }
     setValidityBit(validityBuffer, index, value);
     if (index == (valueCount - 1)) {
-      validityBuffer.writerIndex(getValidityBufferSize(valueCount));
+      validityBuffer.writerIndex(getValidityBufferSizeFromCount(valueCount));
     }
 
     return validityBuffer;
@@ -165,7 +165,7 @@ public static int get(final ArrowBuf buffer, int index) {
    * @param valueCount number of elements in the vector
    * @return buffer size
    */
-  public static int getValidityBufferSize(int valueCount) {
+  public static int getValidityBufferSizeFromCount(int valueCount) {
     return DataSizeRoundingUtil.divideBy8Ceil(valueCount);
   }
 
@@ -182,7 +182,7 @@ public static int getNullCount(final ArrowBuf validityBuffer, final int valueCou
       return 0;
     }
     int count = 0;
-    final int sizeInBytes = getValidityBufferSize(valueCount);
+    final int sizeInBytes = getValidityBufferSizeFromCount(valueCount);
     // If value count is not a multiple of 8, then calculate number of used bits in the last byte
     final int remainder = valueCount % 8;
     final int fullBytesCount = remainder == 0 ? sizeInBytes : sizeInBytes - 1;
@@ -233,7 +233,7 @@ public static boolean checkAllBitsEqualTo(
     if (valueCount == 0) {
       return true;
     }
-    final int sizeInBytes = getValidityBufferSize(valueCount);
+    final int sizeInBytes = getValidityBufferSizeFromCount(valueCount);
 
     // boundary check
     validityBuffer.checkBytes(0, sizeInBytes);
@@ -325,7 +325,7 @@ public static ArrowBuf loadValidityBuffer(
         sourceValidityBuffer == null || sourceValidityBuffer.capacity() == 0;
     if (isValidityBufferNull
         && (fieldNode.getNullCount() == 0 || fieldNode.getNullCount() == valueCount)) {
-      newBuffer = allocator.buffer(getValidityBufferSize(valueCount));
+      newBuffer = allocator.buffer(getValidityBufferSizeFromCount(valueCount));
       newBuffer.setZero(0, newBuffer.capacity());
       if (fieldNode.getNullCount() != 0) {
         /* all NULLs */

vector/src/main/java/org/apache/arrow/vector/complex/FixedSizeListVector.java

@@ -110,7 +110,8 @@ public FixedSizeListVector(
     this.listSize = ((ArrowType.FixedSizeList) field.getFieldType().getType()).getListSize();
     Preconditions.checkArgument(listSize >= 0, "list size must be non-negative");
     this.valueCount = 0;
-    this.validityAllocationSizeInBytes = getValidityBufferSizeFromCount(INITIAL_VALUE_ALLOCATION);
+    this.validityAllocationSizeInBytes =
+        BitVectorHelper.getValidityBufferSizeFromCount(INITIAL_VALUE_ALLOCATION);
   }
 
   @Override
@@ -189,7 +190,7 @@ public List<ArrowBuf> getFieldBuffers() {
 
   private void setReaderAndWriterIndex() {
     validityBuffer.readerIndex(0);
-    validityBuffer.writerIndex(getValidityBufferSizeFromCount(valueCount));
+    validityBuffer.writerIndex(BitVectorHelper.getValidityBufferSizeFromCount(valueCount));
   }
 
   /**
@@ -268,7 +269,8 @@ private void reallocValidityBuffer() {
       if (validityAllocationSizeInBytes > 0) {
         newAllocationSize = validityAllocationSizeInBytes;
       } else {
-        newAllocationSize = getValidityBufferSizeFromCount(INITIAL_VALUE_ALLOCATION) * 2L;
+        newAllocationSize =
+            BitVectorHelper.getValidityBufferSizeFromCount(INITIAL_VALUE_ALLOCATION) * 2L;
       }
     }
 
@@ -311,7 +313,7 @@ public UnionFixedSizeListWriter getWriter() {
 
   @Override
   public void setInitialCapacity(int numRecords) {
-    validityAllocationSizeInBytes = getValidityBufferSizeFromCount(numRecords);
+    validityAllocationSizeInBytes = BitVectorHelper.getValidityBufferSizeFromCount(numRecords);
     vector.setInitialCapacity(numRecords * listSize);
   }
 
@@ -328,15 +330,15 @@ public int getBufferSize() {
     if (getValueCount() == 0) {
       return 0;
     }
-    return getValidityBufferSizeFromCount(valueCount) + vector.getBufferSize();
+    return BitVectorHelper.getValidityBufferSizeFromCount(valueCount) + vector.getBufferSize();
   }
 
   @Override
   public int getBufferSizeFor(int valueCount) {
     if (valueCount == 0) {
       return 0;
     }
-    return getValidityBufferSizeFromCount(valueCount)
+    return BitVectorHelper.getValidityBufferSizeFromCount(valueCount)
         + vector.getBufferSizeFor(valueCount * listSize);
   }
 
@@ -654,7 +656,7 @@ private void splitAndTransferValidityBuffer(
         int startIndex, int length, FixedSizeListVector target) {
       int firstByteSource = BitVectorHelper.byteIndex(startIndex);
       int lastByteSource = BitVectorHelper.byteIndex(valueCount - 1);
-      int byteSizeTarget = getValidityBufferSizeFromCount(length);
+      int byteSizeTarget = BitVectorHelper.getValidityBufferSizeFromCount(length);
       int offset = startIndex % 8;
 
       if (length > 0) {

vector/src/main/java/org/apache/arrow/vector/complex/LargeListVector.java

@@ -131,7 +131,8 @@ public LargeListVector(Field field, BufferAllocator allocator, CallBack callBack
     this.field = field;
     this.validityBuffer = allocator.getEmpty();
     this.callBack = callBack;
-    this.validityAllocationSizeInBytes = getValidityBufferSizeFromCount(INITIAL_VALUE_ALLOCATION);
+    this.validityAllocationSizeInBytes =
+        BitVectorHelper.getValidityBufferSizeFromCount(INITIAL_VALUE_ALLOCATION);
     this.lastSet = -1;
     this.offsetBuffer = allocator.getEmpty();
     this.vector = vector == null ? DEFAULT_DATA_VECTOR : vector;
@@ -156,7 +157,7 @@ public void initializeChildrenFromFields(List<Field> children) {
 
   @Override
   public void setInitialCapacity(int numRecords) {
-    validityAllocationSizeInBytes = getValidityBufferSizeFromCount(numRecords);
+    validityAllocationSizeInBytes = BitVectorHelper.getValidityBufferSizeFromCount(numRecords);
     offsetAllocationSizeInBytes = (long) (numRecords + 1) * OFFSET_WIDTH;
     if (vector instanceof BaseFixedWidthVector || vector instanceof BaseVariableWidthVector) {
       vector.setInitialCapacity(numRecords * RepeatedValueVector.DEFAULT_REPEAT_PER_RECORD);
@@ -184,7 +185,7 @@ public void setInitialCapacity(int numRecords) {
    */
   @Override
   public void setInitialCapacity(int numRecords, double density) {
-    validityAllocationSizeInBytes = getValidityBufferSizeFromCount(numRecords);
+    validityAllocationSizeInBytes = BitVectorHelper.getValidityBufferSizeFromCount(numRecords);
     if ((numRecords * density) >= Integer.MAX_VALUE) {
       throw new OversizedAllocationException("Requested amount of memory is more than max allowed");
     }
@@ -311,7 +312,7 @@ private void setReaderAndWriterIndex() {
       validityBuffer.writerIndex(0);
       offsetBuffer.writerIndex(0);
     } else {
-      validityBuffer.writerIndex(getValidityBufferSizeFromCount(valueCount));
+      validityBuffer.writerIndex(BitVectorHelper.getValidityBufferSizeFromCount(valueCount));
       offsetBuffer.writerIndex((valueCount + 1) * OFFSET_WIDTH);
     }
   }
@@ -442,7 +443,8 @@ private void reallocValidityBuffer() {
       if (validityAllocationSizeInBytes > 0) {
         newAllocationSize = validityAllocationSizeInBytes;
       } else {
-        newAllocationSize = getValidityBufferSizeFromCount(INITIAL_VALUE_ALLOCATION) * 2L;
+        newAllocationSize =
+            BitVectorHelper.getValidityBufferSizeFromCount(INITIAL_VALUE_ALLOCATION) * 2L;
       }
     }
     newAllocationSize = CommonUtil.nextPowerOfTwo(newAllocationSize);
@@ -699,7 +701,7 @@ private void splitAndTransferValidityBuffer(
         int startIndex, int length, LargeListVector target) {
       int firstByteSource = BitVectorHelper.byteIndex(startIndex);
       int lastByteSource = BitVectorHelper.byteIndex(valueCount - 1);
-      int byteSizeTarget = getValidityBufferSizeFromCount(length);
+      int byteSizeTarget = BitVectorHelper.getValidityBufferSizeFromCount(length);
       int offset = startIndex % 8;
 
       if (length > 0) {
@@ -821,7 +823,7 @@ public int getBufferSize() {
       return 0;
     }
     final int offsetBufferSize = (valueCount + 1) * OFFSET_WIDTH;
-    final int validityBufferSize = getValidityBufferSizeFromCount(valueCount);
+    final int validityBufferSize = BitVectorHelper.getValidityBufferSizeFromCount(valueCount);
     return offsetBufferSize + validityBufferSize + vector.getBufferSize();
   }
 
@@ -830,7 +832,7 @@ public int getBufferSizeFor(int valueCount) {
     if (valueCount == 0) {
       return 0;
     }
-    final int validityBufferSize = getValidityBufferSizeFromCount(valueCount);
+    final int validityBufferSize = BitVectorHelper.getValidityBufferSizeFromCount(valueCount);
     long innerVectorValueCount = offsetBuffer.getLong((long) valueCount * OFFSET_WIDTH);
 
     return ((valueCount + 1) * OFFSET_WIDTH)