python: add nvme.i consistency check and fix violations

Add tools/check-nvme-i-consistency.py, a static analysis script that
verifies nvme.i stays consistent with the accessor annotations in
private.h and private-fabrics.h. It enforces several rules:

  Rule 1 (error):   !accessors:readonly fields exposed in nvme.i must
                    be declared %immutable.
  Rule 2 (error):   fields with auto-generated or bridged accessors
                    must be in %extend{} so SWIG invokes the getter
                    instead of accessing the struct member directly.
  Rule 3 (error):   fields in %extend{} must have a getter bridge
                    whose target is declared in a public header.
  Check 4 (error):  bridge target not found in any public header.
  Check 5 (error):  %immutable declaration for a field that does not
                    exist in the corresponding C struct.
  Check 6 (warning): field has an accessor but is not exposed in nvme.i.
  Check 7 (warning): field type in nvme.i differs from private header.

The check is registered as a meson test in libnvme/libnvme/meson.build
inside the 'if want_python' block. It performs pure static analysis and
does not depend on the built SWIG module.

Fix all Rule 2 violations found by the new check by moving the
offending fields into %extend{} blocks (using existing blocks where
possible, creating one for libnvme_ns). Remove stale comments on
cntrltype, dctype, and discovered that incorrectly claimed no getter
method was available.

Signed-off-by: Martin Belanger <[email protected]>
Assisted-by: Claude Sonnet 4.6 <[email protected]>

Author: Martin Belanger

.gitignore

@@ -13,7 +13,7 @@ subprojects/*
 cscope.*
 compile_commands.json
 
-tests/__pycache__
+__pycache__/
 tests/nvmetests
 tests/*.pyc
 

libnvme/libnvme/meson.build

@@ -77,6 +77,32 @@ if want_python
     test_env.set('PYTHONMALLOC', 'malloc')
 
     # Test section
+    _priv_hdr_args = [
+        '--private-header',
+        meson.current_source_dir() / '..' / 'src' / 'nvme' / 'private.h',
+        '--private-header',
+        meson.current_source_dir() / '..' / 'src' / 'nvme' / 'private-fabrics.h',
+    ]
+    _swig_pub_hdr_args = []
+    foreach hdr : headers
+        _swig_pub_hdr_args += [
+            '--public-header',
+            meson.current_source_dir() / '..' / 'src' / hdr,
+        ]
+    endforeach
+    test(
+        'libnvme - check-nvme-i-consistency',
+        python3,
+        args: [
+            files('../tools/check-nvme-i-consistency.py'),
+        ] + _priv_hdr_args + _swig_pub_hdr_args + [
+            '--swig-interface',
+            meson.current_source_dir() / 'nvme.i',
+            '--swig-accessors',
+            meson.current_source_dir() / 'nvme-swig-accessors.i',
+        ],
+    )
+
     test('libnvme - python-import-libnvme', python3, args: ['-c', 'from libnvme import nvme'], env: test_env, depends: pynvme_clib)
 
     py_tests = [

libnvme/libnvme/nvme.i

@@ -582,10 +582,10 @@ struct libnvme_host {
 	%immutable hostnqn;
 	%immutable hostid;
 	%immutable hostsymname;
-	char *hostnqn;
-	char *hostid;
-	char *hostsymname;
 	%extend {
+		char *hostnqn;
+		char *hostid;
+		char *hostsymname;
 		char *dhchap_host_key;
 	}
 };
@@ -598,13 +598,13 @@ struct libnvme_subsystem {
 	%immutable firmware;
 	%immutable subsystype;
 	%immutable iopolicy;
-	char *subsysnqn;
-	char *model;
-	char *serial;
-	char *firmware;
-	char *subsystype;
 
 	%extend {
+		char *subsysnqn;
+		char *model;
+		char *serial;
+		char *firmware;
+		char *subsystype;
 		const char *sysfs_dir;
 		const char *application;
 		const char *iopolicy;
@@ -633,10 +633,6 @@ struct libnvme_ctrl {
 	%immutable phy_slot;
 	%immutable discovered;
 
-	const char *cntrltype;  // Do not put in %extend because there's no getter method in libnvme.map
-	const char *dctype;     // Do not put in %extend because there's no getter method in libnvme.map
-	const bool discovered;  // Do not put in %extend because there's no getter method in libnvme.map
-
 	%extend {
 		/**
 		 * By putting these attributes in an %extend block, we're
@@ -665,10 +661,13 @@ struct libnvme_ctrl {
 		const char *trsvcid;
 		const char *cntlid;
 		const char *phy_slot;
+		const char *cntrltype;
+		const char *dctype;
 
 		bool unique_discovery_ctrl;
 		bool discovery_ctrl;
 		bool persistent;
+		bool discovered;
 
 		char *keyring;
 		char *tls_key_identity;
@@ -695,7 +694,9 @@ struct libnvme_ns {
 	%immutable eui64;
 	%immutable nguid;
 	%immutable uuid;
-	unsigned int nsid;
+	%extend {
+		unsigned int nsid;
+	}
 	uint8_t eui64[8];
 	uint8_t nguid[16];
 	uint8_t uuid[16];