Fix: foreach_get/set does not work on multidimensional arrays #116457

Thomas Barlow · 2023-12-22T02:11:08+01:00

Thomas Barlow commented

2023-12-22 02:11:08 +01:00

The foreach_get/foreach_set methods of bpy_prop_array get/set the entire
contents of the array, but they were checking that the length of the
input sequence was equal to the length of the current array dimension
rather than the total length of all dimensions of the array.

This would read/write memory after the end of the passed in sequence
when the property was a multidimensional array. Performing
foreach_get with a Python list with length matching the length of the
current dimension of a multidimensional array would crash a debug build
due to the trailing pad bytes of the temporarily allocated array being
overwritten.

This patch fixes pyprop_array_foreach_getset by changing the function
used to get the expected sequence size, to the RNA function that gets
the total length of the array across all its dimensions.

The tests have be updated to additionally test multidimensional array
properties.

To crash on a debug build, select an Object as active and then run in the Python Console:

C.object.matrix_world.owner.foreach_get([1] * 4)

The foreach_get/foreach_set methods of bpy_prop_array get/set the entire contents of the array, but they were checking that the length of the input sequence was equal to the length of the current array dimension rather than the total length of all dimensions of the array. This would read/write memory after the end of the passed in sequence when the property was a multidimensional array. Performing `foreach_get` with a Python list with length matching the length of the current dimension of a multidimensional array would crash a debug build due to the trailing pad bytes of the temporarily allocated array being overwritten. This patch fixes `pyprop_array_foreach_getset` by changing the function used to get the expected sequence size, to the RNA function that gets the total length of the array across all its dimensions. The tests have be updated to additionally test multidimensional array properties. --- To crash on a debug build, select an Object as active and then run in the Python Console: ```py C.object.matrix_world.owner.foreach_get([1] * 4) ```

❤️ 1

Thomas Barlow added 4 commits 2023-12-22 02:11:19 +01:00

beea6dab6a Fix: foreach_get/set does not work on multidimensional arrays

The foreach_get/foreach_set methods of bpy_prop_array get/set the entire
contents of the array, but they were checking that the length of the
input sequence was equal to the length of the current array dimension
rather than the total length of all dimensions of the array.

This would read/write memory after the end of the passed in sequence
when the property was a multidimensional array. Performing
`foreach_get` with a Python list with length matching the length of the
current dimension of a multidimensional array would crash a debug build
due to the trailing pad bytes of the temporarily allocated array being
overwritten.

This patch fixes pyprop_array_foreach_getset by changing the function
used to get the expected sequence size, to the RNA function that gets
the total length of the array across all its dimensions.

36a6ec3596 Fix: wrong arrays tested in bl_pyapi_prop_array.py#TestPropArray

33ffa9dff8 Deduplicate TestPropArray

18a0ca87ef Add tests for multidimensional arrays

Thomas Barlow added 1 commit 2023-12-22 03:35:21 +01:00

buildbot/vexp-code-patch-darwin-x86_64 Build done. Details

buildbot/vexp-code-patch-darwin-arm64 Build done. Details

buildbot/vexp-code-patch-linux-x86_64 Build done. Details

buildbot/vexp-code-patch-lint Build done. Details

buildbot/vexp-code-patch-windows-amd64 Build done. Details

buildbot/vexp-code-patch-coordinator Build done. Details

bdb0b2efd5 Test all dimensions of multidimensional arrays

Thomas Barlow changed title from ~~WIP: Fix: foreach_get/set does not work on multidimensional arrays~~ to Fix: foreach_get/set does not work on multidimensional arrays

2023-12-22 03:56:17 +01:00

Thomas Barlow commented

2024-01-11 10:27:04 +01:00

Hi @ideasman42, can you check this one-line fix for the Python API? I also updated the tests, but can separate them into a different PR if preferred.

Iliya Katushenock added this to the Python API project 2024-01-11 10:34:48 +01:00

Brecht Van Lommel commented

2024-01-12 15:44:47 +01:00

@blender-bot build

Brecht Van Lommel requested review from Campbell Barton 2024-01-12 15:48:30 +01:00

Thomas Barlow added 1 commit 2024-01-12 17:23:00 +01:00

19c956e544 Fix string formatting typo in bl_pyapi_prop_array test

Thomas Barlow added 1 commit 2024-01-12 17:25:19 +01:00