Merge pull request #52 from GPUOpen-LibrariesAndSDKs/next-release-12

Update to 3.1.0.cb09c56
Co-authored-by: Daniel Meister <daniel.meister@amd.com>

Author: RichardGe

.github/workflows/format.yaml

@@ -0,0 +1,47 @@
+name: Format and Update Hash
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  format-and-update:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout PR branch
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+
+      # Step 1: Run clang-format linter (in place)
+      - name: Run clang-format
+        uses: DoozyX/clang-format-lint-action@v0.20
+        with:
+          source: './hiprt ./test'
+          exclude: './contrib ./tools ./scripts'
+          extensions: 'h,cpp,c'
+          clangFormatVersion: 15
+          inplace: 'True'
+
+      # Step 2: Update commit hash in version.txt (line 4)
+      - name: Update version.txt with latest commit hash
+        run: |
+          FILE="version.txt"
+          HASH=$(git rev-parse --short HEAD)
+          if [ -f "$FILE" ]; then
+            echo "Updating $FILE with hash $HASH"
+            sed -i "4s~.*~$HASH~" "$FILE"
+          else
+            echo "File $FILE not found!"
+            exit 1
+          fi
+
+      # Step 3: Commit and push all changes (format + hash)
+      - name: Commit and push changes
+        uses: EndBug/add-and-commit@v9.1.1
+        with:
+          author_name: rprbuild
+          author_email: a1rpr@amd.com
+          message: 'Automatic: clang-format + hash update'

.github/workflows/format_and_update_hash.yaml

@@ -361,7 +361,7 @@ add_library(${HIPRT_NAME} SHARED)
 target_compile_definitions(${HIPRT_NAME} PRIVATE HIPRT_EXPORTS)
 
 
-if( ${CMAKE_BUILD_TYPE} STREQUAL "Debug" )
+if( CMAKE_BUILD_TYPE STREQUAL "Debug" )
 	set_target_properties(${HIPRT_NAME} PROPERTIES OUTPUT_NAME "${HIPRT_NAME}64D")
 else()
 	set_target_properties(${HIPRT_NAME} PROPERTIES OUTPUT_NAME "${HIPRT_NAME}64")
@@ -650,7 +650,7 @@ if(NOT NO_UNITTEST)
 		target_link_libraries(unittest PRIVATE version)
 	endif()
 
-	if( ${CMAKE_BUILD_TYPE} STREQUAL "Debug" )
+	if( CMAKE_BUILD_TYPE STREQUAL "Debug" )
 		set_target_properties(unittest PROPERTIES OUTPUT_NAME "unittest64D")
 	else()
 		set_target_properties(unittest PROPERTIES OUTPUT_NAME "unittest64")

CMakeLists.txt

@@ -80,6 +80,7 @@ Example: `..\dist\bin\Release\unittest64.exe --width=512 --height=512 --referenc
 - Use references instead of pointers if possible.
 - Use bit-fields instead of explicit bit masking if possible.
 - Use `nullptr` instead of `NULL` or zero.
+- Use `using` instead of `typedef`.
 - Use C++-style casts (e.g., `static_cast`) instead of C-style cast.
 - Add `const` for references and pointers if they are not being changed.
 - Add `constexpr` for variables and functions if they can be constant in compile time (do not use `#define` if possible).

README.md

@@ -0,0 +1 @@
+.

_codeql_detected_source_root

@@ -506,46 +506,14 @@ class hiprtSceneTraversalAnyHitCustomStack
 		m_impl;
 };
 
-/** \brief Returns the object to world transformation for a given instance and time in the form of the SRT frame.
- *
- * \param scene A scene.
- * \param instanceID Instance ID.
- * \param time The time.
- */
-HIPRT_DEVICE hiprtFrameSRT hiprtGetObjectToWorldFrameSRT( hiprtScene scene, uint32_t instanceID, float time = 0.0f );
-
-/** \brief Returns the world to object transformation for a given instance and time in the form of the SRT frame.
- *
- * \param scene A scene.
- * \param instanceID Instance ID.
- * \param time The time.
- */
-HIPRT_DEVICE hiprtFrameSRT hiprtGetWorldToObjectFrameSRT( hiprtScene scene, uint32_t instanceID, float time = 0.0f );
-
-/** \brief Returns the object to world transformation for a given instance and time in the form of the matrix.
- *
- * \param scene A scene.
- * \param instanceID Instance ID.
- * \param time The time.
- */
-HIPRT_DEVICE hiprtFrameMatrix hiprtGetObjectToWorldFrameMatrix( hiprtScene scene, uint32_t instanceID, float time = 0.0f );
-
-/** \brief Returns the world to object transformation for a given instance and time in the form of the matrix.
- *
- * \param scene A scene.
- * \param instanceID Instance ID.
- * \param time The time.
- */
-HIPRT_DEVICE hiprtFrameMatrix hiprtGetWorldToObjectFrameMatrix( hiprtScene scene, uint32_t instanceID, float time = 0.0f );
-
 /** \brief Transforms a point from the object space to the world space.
  *
  * \param point A point in the object space.
  * \param scene A scene.
  * \param instanceID Instance ID.
  * \param time The time.
  */
-HIPRT_DEVICE float3 hiprtPointObjectToWorld( float3 point, hiprtScene scene, uint32_t instanceID, float time = 0.0f );
+HIPRT_DEVICE float3 hiprtPointObjectToWorld( const float3& point, hiprtScene scene, uint32_t instanceID, float time = 0.0f );
 
 /** \brief Transforms a point from the world space to the object space.
  *
@@ -554,7 +522,7 @@ HIPRT_DEVICE float3 hiprtPointObjectToWorld( float3 point, hiprtScene scene, uin
  * \param instanceID Instance ID.
  * \param time The time.
  */
-HIPRT_DEVICE float3 hiprtPointWorldToObject( float3 point, hiprtScene scene, uint32_t instanceID, float time = 0.0f );
+HIPRT_DEVICE float3 hiprtPointWorldToObject( const float3& point, hiprtScene scene, uint32_t instanceID, float time = 0.0f );
 
 /** \brief Transforms a vector from the object space to the world space.
  *
@@ -563,7 +531,7 @@ HIPRT_DEVICE float3 hiprtPointWorldToObject( float3 point, hiprtScene scene, uin
  * \param instanceID Instance ID.
  * \param time The time.
  */
-HIPRT_DEVICE float3 hiprtVectorObjectToWorld( float3 vector, hiprtScene scene, uint32_t instanceID, float time = 0.0f );
+HIPRT_DEVICE float3 hiprtVectorObjectToWorld( const float3& vector, hiprtScene scene, uint32_t instanceID, float time = 0.0f );
 
 /** \brief Transforms a vector from the world space to the object space.
  *
@@ -572,43 +540,7 @@ HIPRT_DEVICE float3 hiprtVectorObjectToWorld( float3 vector, hiprtScene scene, u
  * \param instanceID Instance ID.
  * \param time The time.
  */
-HIPRT_DEVICE float3 hiprtVectorWorldToObject( float3 vector, hiprtScene scene, uint32_t instanceID, float time = 0.0f );
-
-/** \brief Returns the object to world transformation for a given instance and time in the form of the SRT frame.
- *
- * \param scene A scene.
- * \param instanceIDs Instance IDs (multi-level instancing).
- * \param time The time.
- */
-HIPRT_DEVICE hiprtFrameSRT
-hiprtGetObjectToWorldFrameSRT( hiprtScene scene, const uint32_t ( &instanceIDs )[hiprtMaxInstanceLevels], float time = 0.0f );
-
-/** \brief Returns the world to object transformation for a given instance and time in the form of the SRT frame.
- *
- * \param scene A scene.
- * \param instanceIDs Instance IDs (multi-level instancing).
- * \param time The time.
- */
-HIPRT_DEVICE hiprtFrameSRT
-hiprtGetWorldToObjectFrameSRT( hiprtScene scene, const uint32_t ( &instanceIDs )[hiprtMaxInstanceLevels], float time = 0.0f );
-
-/** \brief Returns the object to world transformation for a given instance and time in the form of the matrix.
- *
- * \param scene A scene.
- * \param instanceIDs Instance IDs (multi-level instancing).
- * \param time The time.
- */
-HIPRT_DEVICE hiprtFrameMatrix hiprtGetObjectToWorldFrameMatrix(
-	hiprtScene scene, const uint32_t ( &instanceIDs )[hiprtMaxInstanceLevels], float time = 0.0f );
-
-/** \brief Returns the world to object transformation for a given instance and time in the form of the matrix.
- *
- * \param scene A scene.
- * \param instanceIDs Instance IDs (multi-level instancing).
- * \param time The time.
- */
-HIPRT_DEVICE hiprtFrameMatrix hiprtGetWorldToObjectFrameMatrix(
-	hiprtScene scene, const uint32_t ( &instanceIDs )[hiprtMaxInstanceLevels], float time = 0.0f );
+HIPRT_DEVICE float3 hiprtVectorWorldToObject( const float3& vector, hiprtScene scene, uint32_t instanceID, float time = 0.0f );
 
 /** \brief Transforms a point from the object space to the world space.
  *
@@ -618,7 +550,7 @@ HIPRT_DEVICE hiprtFrameMatrix hiprtGetWorldToObjectFrameMatrix(
  * \param time The time.
  */
 HIPRT_DEVICE float3 hiprtPointObjectToWorld(
-	float3 point, hiprtScene scene, const uint32_t ( &instanceIDs )[hiprtMaxInstanceLevels], float time = 0.0f );
+	const float3& point, hiprtScene scene, const uint32_t ( &instanceIDs )[hiprtMaxInstanceLevels], float time = 0.0f );
 
 /** \brief Transforms a point from the world space to the object space.
  *
@@ -628,7 +560,7 @@ HIPRT_DEVICE float3 hiprtPointObjectToWorld(
  * \param time The time.
  */
 HIPRT_DEVICE float3 hiprtPointWorldToObject(
-	float3 point, hiprtScene scene, const uint32_t ( &instanceIDs )[hiprtMaxInstanceLevels], float time = 0.0f );
+	const float3& point, hiprtScene scene, const uint32_t ( &instanceIDs )[hiprtMaxInstanceLevels], float time = 0.0f );
 
 /** \brief Transforms a vector from the object space to the world space.
  *
@@ -638,7 +570,7 @@ HIPRT_DEVICE float3 hiprtPointWorldToObject(
  * \param time The time.
  */
 HIPRT_DEVICE float3 hiprtVectorObjectToWorld(
-	float3 vector, hiprtScene scene, const uint32_t ( &instanceIDs )[hiprtMaxInstanceLevels], float time = 0.0f );
+	const float3& vector, hiprtScene scene, const uint32_t ( &instanceIDs )[hiprtMaxInstanceLevels], float time = 0.0f );
 
 /** \brief Transforms a vector from the world space to the object space.
  *
@@ -648,4 +580,4 @@ HIPRT_DEVICE float3 hiprtVectorObjectToWorld(
  * \param time The time.
  */
 HIPRT_DEVICE float3 hiprtVectorWorldToObject(
-	float3 vector, hiprtScene scene, const uint32_t ( &instanceIDs )[hiprtMaxInstanceLevels], float time = 0.0f );
+	const float3& vector, hiprtScene scene, const uint32_t ( &instanceIDs )[hiprtMaxInstanceLevels], float time = 0.0f );

hiprt/hiprt_device.h

@@ -35,12 +35,12 @@ const char* g_hip_paths[] = {
 	"amdhip64_7.dll",
 	"amdhip64_6.dll",
 	"amdhip64.dll", // <- hip '5.x' DLL.
-	NULL };
+	nullptr };
 
 const char* g_hiprtc_paths[] = { "hiprtc0707.dll", "hiprtc0706.dll", "hiprtc0705.dll", "hiprtc0704.dll", "hiprtc0703.dll",
 								 "hiprtc0702.dll", "hiprtc0701.dll", "hiprtc0700.dll", "hiprtc0605.dll", "hiprtc0604.dll",
 								 "hiprtc0603.dll", "hiprtc0602.dll", "hiprtc0601.dll", "hiprtc0600.dll", "hiprtc0507.dll",
-								 "hiprtc0506.dll", "hiprtc0505.dll", "hiprtc0504.dll", "hiprtc0503.dll", NULL };
+								 "hiprtc0506.dll", "hiprtc0505.dll", "hiprtc0504.dll", "hiprtc0503.dll", nullptr };
 #elif defined( __APPLE__ )
 
 const char** g_hip_paths	= nullptr;
@@ -67,7 +67,7 @@ const char* g_hip_paths[] = {
 	"/opt/rocm/lib/libamdhip64.so.5",
 	"/opt/rocm/hip/lib/libamdhip64.so.5",
 
-	NULL };
+	nullptr };
 
 const char* g_hiprtc_paths[] = {
 
@@ -89,5 +89,5 @@ const char* g_hiprtc_paths[] = {
 	"/opt/rocm/lib/libhiprtc.so.5",
 	"libhiprtc.so.5",
 
-	NULL };
+	nullptr };
 #endif

hiprt/hiprt_libpath.h

@@ -1580,6 +1580,15 @@ HIPRT_HOST_DEVICE HIPRT_INLINE float differenceOfProducts( const float a, const
 	return fmaf( a, b, -cd ) - fmaf( c, d, -cd );
 }
 
+HIPRT_HOST_DEVICE HIPRT_INLINE float hypot( const float3& a )
+{
+	float x = fabsf( a.x );
+	float y = fabsf( a.y );
+	float z = fabsf( a.z );
+	float d = x < y ? y < z ? z : y : x < z ? z : x;
+	return d != 0.0f ? ( d * sqrtf( ( x / d ) * ( x / d ) + ( y / d ) * ( y / d ) + ( z / d ) * ( z / d ) ) ) : 0.0f;
+}
+
 HIPRT_HOST_DEVICE HIPRT_INLINE float3 cross( const float3& a, const float3& b )
 {
 	return {
@@ -1593,7 +1602,7 @@ HIPRT_HOST_DEVICE HIPRT_INLINE float dot( const float3& a, const float3& b )
 	return fmaf( a.x, b.x, sumOfProducts( a.y, b.y, a.z, b.z ) );
 }
 
-HIPRT_HOST_DEVICE HIPRT_INLINE float3 normalize( const float3& a ) { return a / sqrtf( dot( a, a ) ); }
+HIPRT_HOST_DEVICE HIPRT_INLINE float3 normalize( const float3& a ) { return a / hypot( a ); }
 
 template <typename V>
 HIPRT_HOST_DEVICE HIPRT_INLINE auto* ptr( V& a )

hiprt/hiprt_math.h

@@ -31,20 +31,20 @@ struct _hiprtScene;
 struct _hiprtContext;
 struct _hiprtFuncTable;
 
-typedef void*			 hiprtDevicePtr;
-typedef _hiprtGeometry*	 hiprtGeometry;
-typedef _hiprtScene*	 hiprtScene;
-typedef _hiprtContext*	 hiprtContext;
-typedef _hiprtFuncTable* hiprtFuncTable;
-typedef uint32_t		 hiprtLogLevel;
-typedef uint32_t		 hiprtBuildFlags;
-typedef uint32_t		 hiprtRayMask;
-
-typedef int	  hiprtApiDevice;	// hipDevice, cuDevice
-typedef void* hiprtApiCtx;		// hipCtx, cuCtx
-typedef void* hiprtApiStream;	// hipStream, cuStream
-typedef void* hiprtApiFunction; // hipFunction, cuFunction
-typedef void* hiprtApiModule;	// hipModule, cuModule
+using hiprtDevicePtr  = void*;
+using hiprtGeometry	  = _hiprtGeometry*;
+using hiprtScene	  = _hiprtScene*;
+using hiprtContext	  = _hiprtContext*;
+using hiprtFuncTable  = _hiprtFuncTable*;
+using hiprtLogLevel	  = uint32_t;
+using hiprtBuildFlags = uint32_t;
+using hiprtRayMask	  = uint32_t;
+
+using hiprtApiDevice   = int;	// hipDevice, cuDevice
+using hiprtApiCtx	   = void*; // hipCtx, cuCtx
+using hiprtApiStream   = void*; // hipStream, cuStream
+using hiprtApiFunction = void*; // hipFunction, cuFunction
+using hiprtApiModule   = void*; // hipModule, cuModule
 
 /** \brief Ray traversal type.
  *
@@ -490,19 +490,19 @@ HIPRT_STATIC_ASSERT( sizeof( hiprtInstance ) == 16 );
  * are evaluated with the primitive of corresponding instance if the result is
  * 0. The transformation header defines the offset and the number of consecutive
  * transformation frames in the frame array for each instance. More than one frame
- * is interpreted as motion blur. If the transformation headers is NULL, it
+ * is interpreted as motion blur. If the transformation headers is nullptr, it
  * assumes one frame per instance. Optionally, it is possible to import a custom
  * BVH by setting nodes and the corresponding build flag.
  */
 struct alignas( 16 ) hiprtSceneBuildInput
 {
 	/*!< Array of instanceCount pointers to instances */
 	hiprtDevicePtr instances;
-	/*!< Array of instanceCount transform headers (optional: per object frame assumed if NULL) */
+	/*!< Array of instanceCount transform headers (optional: per object frame assumed if nullptr) */
 	hiprtDevicePtr instanceTransformHeaders;
 	/*!< Array of frameCount frames (supposed to be ordered according to time) */
 	hiprtDevicePtr instanceFrames;
-	/*!< Per object bit masks for instance masking (optional: if NULL masks treated as hiprtFullRayMask) */
+	/*!< Per object bit masks for instance masking (optional: if nullptr masks treated as hiprtFullRayMask) */
 	hiprtDevicePtr instanceMasks;
 	/*!< Custom Bvh nodes (optional) */
 	hiprtBvhNodeList nodeList;