Validate setImmediates API in different encoder types

This PR adding validation tests to cover setImmediates API in  different
encoder types (compute pass, render pass, render bundle) by covering:
*Interpretation:
  - Passing a TypedArray the data offset and size is not given in elements.
* Alignment:
  - rangeOffset is not a multiple of 4 bytes.
  - content size, converted to bytes, is not a multiple of 4 bytes.
* Arithmetic overflow
  - rangeOffset + contentSize is overflow
* Bounds:
  - dataOffset + size (in bytes) exceeds the content data size.
  - rangeOffset + size (in bytes) exceeds the maxImmdiateSize.

Author: shaoboyan091

package-lock.json

@@ -50,7 +50,7 @@
     "@types/w3c-image-capture": "^1.0.10",
     "@typescript-eslint/eslint-plugin": "^6.9.1",
     "@typescript-eslint/parser": "^6.9.1",
-    "@webgpu/types": "^0.1.66",
+    "@webgpu/types": "^0.1.67",
     "ansi-colors": "4.1.3",
     "babel-plugin-add-header-comment": "^1.0.3",
     "babel-plugin-const-enum": "^1.2.0",

package.json

@@ -0,0 +1,196 @@
+export const description = `
+setImmediates validation tests.
+
+Test different encoder types (compute pass, render pass, render bundle):
+*Interpretation:
+  - Passing a TypedArray the data offset and size is not given in elements.
+* Alignment:
+  - rangeOffset is not a multiple of 4 bytes.
+  - content size, converted to bytes, is not a multiple of 4 bytes.
+* Arithmetic overflow
+  - rangeOffset + contentSize is overflow
+* Bounds:
+  - dataOffset + size (in bytes) exceeds the content data size.
+  - rangeOffset + size (in bytes) exceeds the maxImmdiateSize.
+`;
+
+import { makeTestGroup } from '../../../../../common/framework/test_group.js';
+import {
+  kTypedArrayBufferViewConstructors,
+  TypedArrayBufferViewConstructor,
+} from '../../../../../common/util/util.js';
+import { Float16Array } from '../../../../../external/petamoriken/float16/float16.js';
+import { AllFeaturesMaxLimitsGPUTest } from '../../../../gpu_test.js';
+import { kProgrammableEncoderTypes } from '../../../../util/command_buffer_maker.js';
+import { kMaxSafeMultipleOf8 } from '../../../../util/math.js';
+
+export const g = makeTestGroup(AllFeaturesMaxLimitsGPUTest);
+
+g.test('interpretation')
+  .desc('Tests that contentSize interpreted to element size with TypedArray.')
+  .paramsSubcasesOnly(u =>
+    u //
+      .combine('encoderType', kProgrammableEncoderTypes)
+      .combine('_success', [true, false])
+  )
+  .fn(t => {
+    const { encoderType, _success } = t.params;
+
+    function runTest(arrayBufferType: TypedArrayBufferViewConstructor) {
+      const kMinAlignmentBytes = 4;
+      const elementSize = arrayBufferType.BYTES_PER_ELEMENT;
+      const maxImmediateSize = t.device.limits.maxImmediateSize; // using this limit for tests
+      const validDataSize = _success
+        ? Math.floor((maxImmediateSize - kMinAlignmentBytes) / elementSize)
+        : maxImmediateSize - kMinAlignmentBytes;
+      const validOffset = _success
+        ? Math.ceil(kMinAlignmentBytes / elementSize)
+        : kMinAlignmentBytes;
+
+      const { encoder, validateFinish } = t.createEncoder(encoderType);
+      const data = new arrayBufferType(maxImmediateSize);
+
+      encoder.setImmediates(/* rangeOffset */ 0, data, /* dataOffset */ validOffset, validDataSize);
+
+      validateFinish(_success || elementSize === 1);
+    }
+
+    for (const arrayType of kTypedArrayBufferViewConstructors) {
+      if (arrayType === Float16Array) {
+        // Skip Float16Array since it is supplied by an external module, so there isn't an overload for it.
+        continue;
+      }
+      runTest(arrayType);
+    }
+  });
+
+g.test('alignment')
+  .desc('Tests that rangeOffset and contentSize aligned must align to 4 bytes.')
+  .paramsSubcasesOnly(u =>
+    u //
+      .combine('encoderType', kProgrammableEncoderTypes)
+      .combineWithParams([
+        // control case
+        { offset: 4, contentByteSize: 4, _offsetValid: true, _contentValid: true },
+        // offset is not align to 4 bytes
+        { offset: 1, contentByteSize: 4, _offsetValid: false, _contentValid: true },
+        // contentSize is not align to 4 bytes
+        { offset: 4, contentByteSize: 5, _offsetValid: true, _contentValid: false },
+      ] as const)
+  )
+  .fn(t => {
+    const { encoderType, offset, contentByteSize, _offsetValid, _contentValid } = t.params;
+    const data = new Uint8Array(contentByteSize);
+
+    const { encoder, validateFinish } = t.createEncoder(encoderType);
+
+    const doSetImmediates = () => {
+      encoder.setImmediates(offset, data, 0, contentByteSize);
+    };
+
+    if (_contentValid) {
+      doSetImmediates();
+    } else {
+      t.shouldThrow('RangeError', doSetImmediates);
+    }
+
+    validateFinish(_offsetValid);
+  });
+
+g.test('overflow')
+  .desc('Tests that rangeOffset + contentSize exceed MAX_INTEGER.')
+  .paramsSubcasesOnly(u =>
+    u //
+      .combine('encoderType', kProgrammableEncoderTypes)
+      .combineWithParams([
+        // control case
+        { offset: 4, contentByteSize: 4, _rangeValid: true, _contentValid: true },
+        // rangeOffset + contentSize is overflow
+        {
+          offset: 4,
+          contentByteSize: kMaxSafeMultipleOf8,
+          _rangeValid: true,
+          _contentValid: false,
+        },
+      ] as const)
+  )
+  .fn(t => {
+    const { encoderType, offset, contentByteSize, _rangeValid, _contentValid } = t.params;
+    const data = new Uint8Array(t.device.limits.maxImmediateSize);
+
+    const { encoder, validateFinish } = t.createEncoder(encoderType);
+
+    const doSetImmediates = () => {
+      encoder.setImmediates(offset, data, 0, contentByteSize);
+    };
+
+    if (_contentValid) {
+      doSetImmediates();
+    } else {
+      t.shouldThrow('RangeError', doSetImmediates);
+    }
+
+    validateFinish(_rangeValid);
+  });
+
+g.test('out_of_bounds')
+  .desc(
+    'Tests that rangeOffset + contentSize is greater than maxImmediateSize and contentSize is larger than data size.'
+  )
+  .paramsSubcasesOnly(u =>
+    u //
+      .combine('encoderType', kProgrammableEncoderTypes)
+      .combineWithParams([
+        // control case
+        {
+          rangeRemainSpace: 4,
+          dataByteSize: 32,
+          immediateContentByteSize: 4,
+          _rangeValid: true,
+          _contentValid: true,
+        },
+        // offset + contentByteSize large than maxImmediateSize
+        {
+          rangeRemainSpace: 0,
+          dataByteSize: 32,
+          immediateContentByteSize: 4,
+          _rangeValid: false,
+          _contentValid: true,
+        },
+        // contentSize is larger than data size
+        {
+          rangeRemainSpace: 8,
+          dataByteSize: 4,
+          immediateContentByteSize: 8,
+          _rangeValid: true,
+          _contentValid: false,
+        },
+      ] as const)
+  )
+  .fn(t => {
+    const {
+      encoderType,
+      rangeRemainSpace,
+      dataByteSize,
+      immediateContentByteSize,
+      _rangeValid,
+      _contentValid,
+    } = t.params;
+    const maxImmediates = t.device.limits.maxImmediateSize;
+    const rangeOffset = maxImmediates - rangeRemainSpace;
+    const data = new Uint8Array(dataByteSize);
+
+    const { encoder, validateFinish } = t.createEncoder(encoderType);
+
+    const doSetImmediates = () => {
+      encoder.setImmediates(rangeOffset, data, 0, immediateContentByteSize);
+    };
+
+    if (_contentValid) {
+      doSetImmediates();
+    } else {
+      t.shouldThrow('RangeError', doSetImmediates);
+    }
+
+    validateFinish(_rangeValid);
+  });