Update backward incompatible planned changes in 5.5 (#2279)

* Update backward incompatible planned changes

* add planned changes to changelog

* update rocm-docs-core to v0.18.3

---------

Co-authored-by: Sam Wu <sam.wu2@amd.com>

CHANGELOG.md

@@ -80,6 +80,29 @@ The following hipcc changes are implemented in this release:
   - `hipCommander` at <https://github.com/ROCm-Developer-Tools/hip-tests/tree/develop/samples/1_Utils/hipCommander>
 
   Note that the samples will continue to be available in previous release branches.
+- Removal of gcnarch from hipDeviceProp_t structure
+- Addition of new fields in hipDeviceProp_t structure
+  - maxTexture1D
+  - maxTexture2D
+  - maxTexture1DLayered
+  - maxTexture2DLayered
+  - sharedMemPerMultiprocessor
+  - deviceOverlap
+  - asyncEngineCount
+  - surfaceAlignment
+  - unifiedAddressing
+  - computePreemptionSupported
+  - hostRegisterSupported
+  - uuid
+- Removal of deprecated code
+  - hip-hcc codes from hip code tree
+- Correct hipArray usage in HIP APIs such as hipMemcpyAtoH and hipMemcpyHtoA
+- HIPMEMCPY_3D fields correction to avoid truncation of "size_t" to "unsigned int" inside hipMemcpy3D()
+- Renaming of 'memoryType' in hipPointerAttribute_t structure to 'type'
+- Correct hipGetLastError to return the last error instead of last API call's return code
+- Update hipExternalSemaphoreHandleDesc to add "unsigned int reserved[16]"
+- Correct handling of flag values in hipIpcOpenMemHandle for hipIpcMemLazyEnablePeerAccess
+- Remove hiparray* and make it opaque with hipArray_t
 
 ##### New HIP APIs in This Release
 

docs/reference/ai_tools.md

@@ -10,10 +10,10 @@ AMD's library for high performance machine learning primitives.
 
 :::
 
-:::{grid-item-card} {doc}`Composable Kernel <composable-kernel:index>`
+:::{grid-item-card} {doc}`Composable Kernel <composable_kernel:index>`
 Composable Kernel: Performance Portable Programming Model for Machine Learning Tensor Operators
 
-- {doc}`Documentation <composable-kernel:index>`
+- {doc}`Documentation <composable_kernel:index>`
 
 :::
 

docs/reference/all.md

@@ -42,7 +42,7 @@ Inter and intra-node communication is supported by the following projects:
 Libraries related to AI.
 
 - {doc}`MIOpen <miopen:index>`
-- {doc}`Composable Kernel <composable-kernel:index>`
+- {doc}`Composable Kernel <composable_kernel:index>`
 - {doc}`MIGraphX <migraphx:index>`
 
 :::
@@ -80,7 +80,7 @@ Computer vision related projects.
 
 :::{grid-item-card} [Validation Tools](validation_tools)
 
-- {doc}`ROCm Validation Suite <rocm-validation-suite:index>`
+- {doc}`ROCm Validation Suite <rocmvalidationsuite:index>`
 - {doc}`TransferBench <transferbench:index>`
 
 :::

docs/reference/validation_tools.md

@@ -3,10 +3,10 @@
 :::::{grid} 1 1 2 2
 :gutter: 1
 
-:::{grid-item-card} {doc}`RVS <rocm-validation-suite:index>`
+:::{grid-item-card} {doc}`RVS <rocmvalidationsuite:index>`
 The ROCm Validation Suite is a system administrator’s and cluster manager's tool for detecting and troubleshooting common problems affecting AMD GPU(s) running in a high-performance computing environment, enabled using the ROCm software stack on a compatible platform.
 
-- {doc}`Documentation <rocm-validation-suite:index>`
+- {doc}`Documentation <rocmvalidationsuite:index>`
 
 :::
 

docs/sphinx/_toc.yml.in

@@ -148,9 +148,9 @@ subtrees:
           - title: MIOpen - Machine Intelligence
             url: ${project:miopen}
           - title: Composable Kernel
-            url: ${project:composable-kernel}
+            url: ${project:composable_kernel}
           - title: MIGraphX - Graph Optimization
-            url: ${project:migraphx}
+            url: ${project:amdmigraphx}
     - file: reference/computer_vision
       subtrees:
         - entries:
@@ -173,7 +173,7 @@ subtrees:
       title: Validation Tools
       subtrees:
         - entries:
-          - url: ${project:rocm-validation-suite}
+          - url: ${project:rocmvalidationsuite}
             title: RVS
           - url: ${project:transferbench}
             title: TransferBench

docs/sphinx/requirements.in

@@ -1 +1 @@
-rocm-docs-core==0.18.2
+rocm-docs-core==0.18.3

docs/sphinx/requirements.txt

@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.8
 # by the following command:
 #
-#    pip-compile sphinx/requirements.in
+#    pip-compile --resolver=backtracking requirements.in
 #
 accessible-pygments==0.0.3
     # via pydata-sphinx-theme
@@ -46,6 +46,10 @@ idna==3.4
     # via requests
 imagesize==1.4.1
     # via sphinx
+importlib-metadata==6.7.0
+    # via sphinx
+importlib-resources==5.12.0
+    # via rocm-docs-core
 jinja2==3.1.2
     # via
     #   myst-parser
@@ -96,7 +100,7 @@ requests==2.31.0
     # via
     #   pygithub
     #   sphinx
-rocm-docs-core==0.18.2
+rocm-docs-core==0.18.3
     # via -r requirements.in
 smmap==5.0.0
     # via gitdb
@@ -145,3 +149,7 @@ urllib3==1.26.13
     # via requests
 wrapt==1.14.1
     # via deprecated
+zipp==3.15.0
+    # via
+    #   importlib-metadata
+    #   importlib-resources

tools/autotag/templates/rocm_changes/5.5.0.md

@@ -26,6 +26,29 @@ The following hipcc changes are implemented in this release:
   - `hipCommander` at <https://github.com/ROCm-Developer-Tools/hip-tests/tree/develop/samples/1_Utils/hipCommander>
 
   Note that the samples will continue to be available in previous release branches.
+- Removal of gcnarch from hipDeviceProp_t structure
+- Addition of new fields in hipDeviceProp_t structure
+  - maxTexture1D
+  - maxTexture2D
+  - maxTexture1DLayered
+  - maxTexture2DLayered
+  - sharedMemPerMultiprocessor
+  - deviceOverlap
+  - asyncEngineCount
+  - surfaceAlignment
+  - unifiedAddressing
+  - computePreemptionSupported
+  - hostRegisterSupported
+  - uuid
+- Removal of deprecated code
+  - hip-hcc codes from hip code tree
+- Correct hipArray usage in HIP APIs such as hipMemcpyAtoH and hipMemcpyHtoA
+- HIPMEMCPY_3D fields correction to avoid truncation of "size_t" to "unsigned int" inside hipMemcpy3D()
+- Renaming of 'memoryType' in hipPointerAttribute_t structure to 'type'
+- Correct hipGetLastError to return the last error instead of last API call's return code
+- Update hipExternalSemaphoreHandleDesc to add "unsigned int reserved[16]"
+- Correct handling of flag values in hipIpcOpenMemHandle for hipIpcMemLazyEnablePeerAccess
+- Remove hiparray* and make it opaque with hipArray_t
 
 ##### New HIP APIs in This Release