Fix GOSI server-side implementation (#1222)

aravind-70 · web-flow · commit c719796bb07d · 2025-11-06T15:06:25.000+05:30
What does this Pull Request accomplish?
This pull request updates the NI-DMM GetOpenSessionsInformation API metadata and nidmm_restricted_service.custom.cpp to fix the Null Pointer Exception for NI-407x series devices.

Why should this Pull Request be merged?
This is a temporary workaround required for an internal release, and we will revert this change once the Exception is actually fixed in the Driver layer.

What testing has been done?
Relying on pipeline.
diff --git a/generated/nidmm/nidmm.proto b/generated/nidmm/nidmm.proto
@@ -1,6 +1,6 @@
 
 //---------------------------------------------------------------------
-// This file is generated from NI-DMM API metadata version 26.0.0d64
+// This file is generated from NI-DMM API metadata version 26.0.0d90
 //---------------------------------------------------------------------
 // Proto file for the NI-DMM Metadata
 //---------------------------------------------------------------------
diff --git a/generated/nidmm_restricted/nidmm_restricted.proto b/generated/nidmm_restricted/nidmm_restricted.proto
@@ -1,6 +1,6 @@
 
 //---------------------------------------------------------------------
-// This file is generated from NI-DMM-RESTRICTED API metadata version 26.0.0d64
+// This file is generated from NI-DMM-RESTRICTED API metadata version 26.0.0d90
 //---------------------------------------------------------------------
 // Proto file for the NI-DMM-RESTRICTED Metadata
 //---------------------------------------------------------------------
diff --git a/generated/nidmm_restricted/nidmm_restricted_service.cpp b/generated/nidmm_restricted/nidmm_restricted_service.cpp
@@ -22,9 +22,6 @@ namespace nidmm_restricted_grpc {
   using nidevice_grpc::converters::convert_to_grpc;
   using nidevice_grpc::converters::MatchState;
 
-  const auto kErrorReadBufferTooSmall = -200229;
-  const auto kWarningCAPIStringTruncatedToFitBuffer = 200026;
-
   NiDmmRestrictedService::NiDmmRestrictedService(
       LibrarySharedPtr library,
       ResourceRepositorySharedPtr resource_repository,
@@ -126,49 +123,6 @@ namespace nidmm_restricted_grpc {
     }
   }
 
-  //---------------------------------------------------------------------
-  //---------------------------------------------------------------------
-  ::grpc::Status NiDmmRestrictedService::GetOpenSessionsInformation(::grpc::ServerContext* context, const GetOpenSessionsInformationRequest* request, GetOpenSessionsInformationResponse* response)
-  {
-    if (context->IsCancelled()) {
-      return ::grpc::Status::CANCELLED;
-    }
-    try {
-      auto resource_name_mbcs = convert_from_grpc<std::string>(request->resource_name());
-      ViRsrc resource_name = (ViRsrc)resource_name_mbcs.c_str();
-      ViUInt64 buffer_size_needed_in_bytes {};
-      while (true) {
-        auto status = library_->GetOpenSessionsInformation(resource_name, nullptr, 0, &buffer_size_needed_in_bytes);
-        if (!status_ok(status)) {
-          return ConvertApiErrorStatusForViSession(context, status, 0);
-        }
-        std::string info_json;
-        if (buffer_size_needed_in_bytes > 0) {
-            info_json.resize(buffer_size_needed_in_bytes - 1);
-        }
-        auto buffer_size = buffer_size_needed_in_bytes;
-        status = library_->GetOpenSessionsInformation(resource_name, (ViChar*)info_json.data(), buffer_size, &buffer_size_needed_in_bytes);
-        if (status == kErrorReadBufferTooSmall || status == kWarningCAPIStringTruncatedToFitBuffer) {
-          // buffer is now too small, try again
-          continue;
-        }
-        if (!status_ok(status)) {
-          return ConvertApiErrorStatusForViSession(context, status, 0);
-        }
-        response->set_status(status);
-        std::string info_json_utf8;
-        convert_to_grpc(info_json, &info_json_utf8);
-        response->set_info_json(info_json_utf8);
-        nidevice_grpc::converters::trim_trailing_nulls(*(response->mutable_info_json()));
-        response->set_buffer_size_needed_in_bytes(buffer_size_needed_in_bytes);
-        return ::grpc::Status::OK;
-      }
-    }
-    catch (nidevice_grpc::NonDriverException& ex) {
-      return ex.GetStatus();
-    }
-  }
-
   //---------------------------------------------------------------------
   //---------------------------------------------------------------------
   ::grpc::Status NiDmmRestrictedService::RequestPrivilege(::grpc::ServerContext* context, const RequestPrivilegeRequest* request, RequestPrivilegeResponse* response)
diff --git a/source/codegen/metadata/nidmm/attributes.py b/source/codegen/metadata/nidmm/attributes.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-DMM API metadata version 26.0.0d64
+# This file is generated from NI-DMM API metadata version 26.0.0d90
 attributes = {
     1050002: {
         'codegen_method': 'public',
diff --git a/source/codegen/metadata/nidmm/config.py b/source/codegen/metadata/nidmm/config.py
@@ -1,12 +1,12 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-DMM API metadata version 26.0.0d64
+# This file is generated from NI-DMM API metadata version 26.0.0d90
 config = {
     'additional_headers': {
         'custom/ivi_errors.h': [
             'service.cpp'
         ]
     },
-    'api_version': '26.0.0d64',
+    'api_version': '26.0.0d90',
     'c_function_prefix': 'niDMM_',
     'c_header': 'nidmm.h',
     'close_function': 'Close',
diff --git a/source/codegen/metadata/nidmm/enums.py b/source/codegen/metadata/nidmm/enums.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-DMM API metadata version 26.0.0d64
+# This file is generated from NI-DMM API metadata version 26.0.0d90
 enums = {
     'AcquisitionStatus': {
         'codegen_method': 'public',
diff --git a/source/codegen/metadata/nidmm/functions.py b/source/codegen/metadata/nidmm/functions.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-DMM API metadata version 26.0.0d64
+# This file is generated from NI-DMM API metadata version 26.0.0d90
 functions = {
     'Abort': {
         'codegen_method': 'public',
diff --git a/source/codegen/metadata/nidmm/nidmm.proto b/source/codegen/metadata/nidmm/nidmm.proto
@@ -1,6 +1,6 @@
 
 //---------------------------------------------------------------------
-// This file is generated from NI-DMM API metadata version 26.0.0d64
+// This file is generated from NI-DMM API metadata version 26.0.0d90
 //---------------------------------------------------------------------
 // Proto file for the NI-DMM Metadata
 //---------------------------------------------------------------------
diff --git a/source/codegen/metadata/nidmm_restricted/attributes.py b/source/codegen/metadata/nidmm_restricted/attributes.py
@@ -1,4 +1,4 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-DMM API metadata version 26.0.0d64
+# This file is generated from NI-DMM API metadata version 26.0.0d90
 attributes = {
 }
diff --git a/source/codegen/metadata/nidmm_restricted/config.py b/source/codegen/metadata/nidmm_restricted/config.py
@@ -1,12 +1,12 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-DMM API metadata version 26.0.0d64
+# This file is generated from NI-DMM API metadata version 26.0.0d90
 config = {
     'additional_headers': {
         'custom/ivi_errors.h': [
             'service.cpp'
         ]
     },
-    'api_version': '26.0.0d64',
+    'api_version': '26.0.0d90',
     'c_function_prefix': 'niDMM_',
     'c_header': 'nidmm.h',
     'close_function': None,
diff --git a/source/codegen/metadata/nidmm_restricted/enums.py b/source/codegen/metadata/nidmm_restricted/enums.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-DMM API metadata version 26.0.0d64
+# This file is generated from NI-DMM API metadata version 26.0.0d90
 enums = {
     'AcquisitionStatus': {
         'codegen_method': 'public',
diff --git a/source/codegen/metadata/nidmm_restricted/functions.py b/source/codegen/metadata/nidmm_restricted/functions.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# This file is generated from NI-DMM API metadata version 26.0.0d64
+# This file is generated from NI-DMM API metadata version 26.0.0d90
 functions = {
     'AttributeWasSetByUser': {
         'codegen_method': 'public',
@@ -191,7 +191,7 @@
         'returns': 'ViStatus'
     },
     'GetOpenSessionsInformation': {
-        'codegen_method': 'public',
+        'codegen_method': 'CustomCode',
         'parameters': [
             {
                 'cppName': 'resourceName',
diff --git a/source/custom/nidmm_restricted_service.custom.cpp b/source/custom/nidmm_restricted_service.custom.cpp
@@ -1,8 +1,23 @@
 #include <nidmm_restricted/nidmm_restricted_service.h>
+#include <server/converters.h>
+#include "custom/ivi_errors.h"
+
+#include <string>
+#include <vector>
 
 namespace nidmm_restricted_grpc {
 
-::grpc::Status NiDmmRestrictedService::ConvertApiErrorStatusForViSession(::grpc::ServerContextBase* context, int32_t status, ViSession vi)
+using nidevice_grpc::converters::convert_from_grpc;
+using nidevice_grpc::converters::convert_to_grpc;
+using nidevice_grpc::converters::trim_trailing_nulls;
+
+//---------------------------------------------------------------------
+// ConvertApiErrorStatusForViSession
+//---------------------------------------------------------------------
+::grpc::Status NiDmmRestrictedService::ConvertApiErrorStatusForViSession(
+    ::grpc::ServerContextBase* context,
+    int32_t status,
+    ViSession vi)
 {
   ViStatus error_code{};
   std::string description(nidevice_grpc::kMaxGrpcErrorDescriptionSize, '\0');
@@ -16,4 +31,66 @@ ::grpc::Status NiDmmRestrictedService::ConvertApiErrorStatusForViSession(::grpc:
   return nidevice_grpc::ApiErrorAndDescriptionToStatus(context, status, description);
 }
 
+//---------------------------------------------------------------------
+// GetOpenSessionsInformation
+//---------------------------------------------------------------------
+::grpc::Status NiDmmRestrictedService::GetOpenSessionsInformation(
+    ::grpc::ServerContext* context,
+    const GetOpenSessionsInformationRequest* request,
+    GetOpenSessionsInformationResponse* response)
+{
+  if (context->IsCancelled()) {
+    return ::grpc::Status::CANCELLED;
+  }
+
+  try {
+    // Convert resource name from gRPC string to native char pointer
+    auto resource_name_mbcs = convert_from_grpc<std::string>(request->resource_name());
+    ViRsrc resource_name = (ViRsrc)resource_name_mbcs.c_str();
+    ViUInt64 buffer_size_needed_in_bytes{};
+
+    // Local constants for NI error/warning codes
+    const auto kErrorReadBufferTooSmall = -200229;
+    const auto kWarningCAPIStringTruncatedToFitBuffer = 200026;
+
+    while (true) {
+      // First call to determine required buffer size with Empty string.
+      // Avoid Null pointer since exception will be thrown for PAL devices.
+      auto status = library_->GetOpenSessionsInformation(resource_name, (ViChar*)"", 0, &buffer_size_needed_in_bytes);
+      if (status < 0) {
+        return ConvertApiErrorStatusForViSession(context, status, 0);
+      }
+
+      std::string info_json;
+      if (buffer_size_needed_in_bytes > 0) {
+        info_json.resize(buffer_size_needed_in_bytes - 1);
+      }
+
+      auto buffer_size = buffer_size_needed_in_bytes;
+      status = library_->GetOpenSessionsInformation(
+          resource_name, (ViChar*)info_json.data(), buffer_size, &buffer_size_needed_in_bytes);
+
+      if (status == kErrorReadBufferTooSmall || status == kWarningCAPIStringTruncatedToFitBuffer) {
+        // Buffer was too small, try again with new size
+        continue;
+      }
+
+      if (status < 0) {
+        return ConvertApiErrorStatusForViSession(context, status, 0);
+      }
+
+      response->set_status(status);
+      std::string info_json_utf8;
+      convert_to_grpc(info_json, &info_json_utf8);
+      response->set_info_json(info_json_utf8);
+      trim_trailing_nulls(*(response->mutable_info_json()));
+      response->set_buffer_size_needed_in_bytes(buffer_size_needed_in_bytes);
+      return ::grpc::Status::OK;
+    }
+  }
+  catch (nidevice_grpc::NonDriverException& ex) {
+    return ex.GetStatus();
+  }
+}
+
 }  // namespace nidmm_restricted_grpc

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`# -- coding: utf-8 --`
`2`		`-# This file is generated from NI-DMM API metadata version 26.0.0d64`
	`2`	`+# This file is generated from NI-DMM API metadata version 26.0.0d90`
`3`	`3`	`attributes = {`
`4`	`4`	`}`