Update nvidia_driver_differ to also check ioctl numbers.

Updated the tooling to fetch the ioctl number used in the driver source code
and compare it to the one used in nvproxy. It is possible that ioctl numbers
change across driver versions (under our foot). It is imperative that we mimic
these changes in nvproxy. For example, in 575.57.08 driver release,
NV2080_CTRL_CMD_FB_QUERY_DRAM_ENCRYPTION_INFOROM_SUPPORT changed from
0x20801358 to 0x20801357.

To achieve this effect, the AST parser has been updated in the previous change
to be able to parse numerical constants. However, it is unable to parse macros
that evaluate to constants (trust me, I tried). So as a workaround, the
nvidia_driver_differ declares "const uint64_t" variables in the source file
which is created with all relevant includes (see parser.WriteIncludeFile()).
These variables are defined with name "GVISOR_{IOCTL_MACRO} = IOCTL_MACRO" so
they should not conflict with anything in the driver. Then we use the AST
parser to evaluate the value of the const variable and return that.

PiperOrigin-RevId: 793350829

Author: ayushr2

pkg/sentry/devices/nvproxy/nvproxy_driver_parity_test.go

@@ -54,16 +54,16 @@ func createParserRunner(t *testing.T) *parser.Runner {
 	return runner
 }
 
-func getDriverDefs(t *testing.T, runner *parser.Runner, version nvconf.DriverVersion) ([]nvproxy.DriverStruct, *parser.OutputJSON) {
+func getDriverDefs(t *testing.T, runner *parser.Runner, version nvconf.DriverVersion) (*nvproxy.DriverABIInfo, *parser.OutputJSON) {
 	t.Helper()
 
-	structs, ok := nvproxy.SupportedStructTypes(version)
+	info, ok := nvproxy.SupportedIoctls(version)
 	if !ok {
 		t.Fatalf("failed to get struct names for driver %q", version.String())
 	}
 
 	// Create structs file for parser
-	if err := runner.CreateStructsFile(structs); err != nil {
+	if err := runner.CreateInputFile(info); err != nil {
 		t.Fatalf("failed to create temporary structs list: %v", err)
 	}
 
@@ -73,7 +73,7 @@ func getDriverDefs(t *testing.T, runner *parser.Runner, version nvconf.DriverVer
 		t.Fatalf("failed to run driver_ast_parser: %v", err)
 	}
 
-	return structs, defs
+	return info, defs
 }
 
 // TestStructDefinitionParity tests that the struct definitions in nvproxy are the same as the
@@ -86,43 +86,68 @@ func TestStructDefinitionParity(t *testing.T) {
 			t.Parallel()
 			runner := createParserRunner(t)
 
-			nvproxyDefs, defs := getDriverDefs(t, runner, version)
+			nvproxyIoctls, defs := getDriverDefs(t, runner, version)
 
-			for _, nvproxyDef := range nvproxyDefs {
-				// Check if the nvproxy definition has disallowed types.
-				if nvproxyDef.Type != nil {
-					fields := flattenNvproxyStruct(t, nvproxyDef.Type)
-					for _, field := range fields {
-						if _, ok := typeAllowlist[field.Type.Kind()]; !ok {
-							t.Errorf("struct %q has disallowed type %q in nvproxy", nvproxyDef.Name, field.Type.Name())
+			checkIoctl := func(ioctlNum uint32, nvproxyIoctl nvproxy.IoctlInfo) {
+				if nvproxyIoctl.Name == "" {
+					return
+				}
+				// Check if the ioctl number has changed.
+				if driverIoctlNum, ok := defs.Constants[nvproxyIoctl.Name]; !ok {
+					t.Errorf("ioctl %q not found in driver source code", nvproxyIoctl.Name)
+				} else if driverIoctlNum != uint64(ioctlNum) {
+					t.Errorf("ioctl %q has changed numbers between nvproxy (%#x) and driver (%#x)",
+						nvproxyIoctl.Name, ioctlNum, defs.Constants[nvproxyIoctl.Name])
+				}
+
+				for _, nvproxyDef := range nvproxyIoctl.Structs {
+					// Check if the nvproxy definition has disallowed types.
+					if nvproxyDef.Type != nil {
+						fields := flattenNvproxyStruct(t, nvproxyDef.Type)
+						for _, field := range fields {
+							if _, ok := typeAllowlist[field.Type.Kind()]; !ok {
+								t.Errorf("struct %q has disallowed type %q in nvproxy", nvproxyDef.Name, field.Type.Name())
+							}
 						}
 					}
-				}
 
-				// Compare the nvproxy definition to the parser output.
-				name := nvproxyDef.Name
-				_, isRecord := defs.Records[name]
-				aliasDef, isAlias := defs.Aliases[name]
-				if !isRecord && !isAlias {
-					t.Errorf("struct %q not found in parser output for version %q", name, version.String())
-					continue
-				}
+					// Compare the nvproxy definition to the parser output.
+					name := nvproxyDef.Name
+					_, isRecord := defs.Records[name]
+					aliasDef, isAlias := defs.Aliases[name]
+					if !isRecord && !isAlias {
+						t.Errorf("struct %q not found in parser output for version %q", name, version.String())
+						continue
+					}
 
-				switch {
-				case isRecord && nvproxyDef.Type == nil:
-					checkSimpleRecord(t, name, defs)
-				case isRecord && nvproxyDef.Type != nil:
-					if err := compareStructs(t, nvproxyDef.Type, name, defs); err != nil {
-						t.Errorf("struct %q has different definitions between nvproxy and driver: %v", name, err)
+					switch {
+					case isRecord && nvproxyDef.Type == nil:
+						checkSimpleRecord(t, name, defs)
+					case isRecord && nvproxyDef.Type != nil:
+						if err := compareStructs(t, nvproxyDef.Type, name, defs); err != nil {
+							t.Errorf("struct %q has different definitions between nvproxy and driver: %v", name, err)
+						}
+					case isAlias && nvproxyDef.Type == nil:
+						// For now, there is no good way to check if an alias is still simple.
+						// Regardless, none of the current ioctls fall into this category.
+						t.Errorf("struct %q is a simple alias, which is not supported yet", name)
+					case isAlias && nvproxyDef.Type != nil:
+						checkComplexAlias(t, nvproxyDef, aliasDef)
 					}
-				case isAlias && nvproxyDef.Type == nil:
-					// For now, there is no good way to check if an alias is still simple.
-					// Regardless, none of the current ioctls fall into this category.
-					t.Errorf("struct %q is a simple alias, which is not supported yet", name)
-				case isAlias && nvproxyDef.Type != nil:
-					checkComplexAlias(t, nvproxyDef, aliasDef)
 				}
 			}
+			for num, info := range nvproxyIoctls.FrontendInfos {
+				checkIoctl(num, info)
+			}
+			for num, info := range nvproxyIoctls.ControlInfos {
+				checkIoctl(num, info)
+			}
+			for num, info := range nvproxyIoctls.AllocationInfos {
+				checkIoctl(uint32(num), info)
+			}
+			for num, info := range nvproxyIoctls.UvmInfos {
+				checkIoctl(num, info)
+			}
 		})
 	})
 }

pkg/sentry/devices/nvproxy/nvproxy_test.go

@@ -54,25 +54,37 @@ func TestABIStructNamesInSync(t *testing.T) {
 			info := abi.getInfo()
 
 			for ioctl := range abi.frontendIoctl {
-				if _, ok := info.frontendInfos[ioctl]; !ok {
-					t.Errorf("Frontend ioctl %#x not found in struct names for version %v", ioctl, version.String())
+				if _, ok := info.FrontendInfos[ioctl]; !ok {
+					t.Errorf("Frontend ioctl %#x not found in struct names for version %s", ioctl, version)
 				}
 			}
+			if len(abi.frontendIoctl) != len(info.FrontendInfos) {
+				t.Errorf("Frontend ioctl count mismatch for version %s: %d != %d", version, len(abi.frontendIoctl), len(info.FrontendInfos))
+			}
 			for ioctl := range abi.uvmIoctl {
-				if _, ok := info.uvmInfos[ioctl]; !ok {
-					t.Errorf("UVM ioctl %#x not found in struct names for version %v", ioctl, version.String())
+				if _, ok := info.UvmInfos[ioctl]; !ok {
+					t.Errorf("UVM ioctl %#x not found in struct names for version %s", ioctl, version)
 				}
 			}
+			if len(abi.uvmIoctl) != len(info.UvmInfos) {
+				t.Errorf("UVM ioctl count mismatch for version %s: %d != %d", version, len(abi.uvmIoctl), len(info.UvmInfos))
+			}
 			for ioctl := range abi.controlCmd {
-				if _, ok := info.controlInfos[ioctl]; !ok {
-					t.Errorf("Control command %#x not found in struct names for version %v", ioctl, version.String())
+				if _, ok := info.ControlInfos[ioctl]; !ok {
+					t.Errorf("Control command %#x not found in struct names for version %s", ioctl, version)
 				}
 			}
+			if len(abi.controlCmd) != len(info.ControlInfos) {
+				t.Errorf("Control command count mismatch for version %s: %d != %d", version, len(abi.controlCmd), len(info.ControlInfos))
+			}
 			for ioctl := range abi.allocationClass {
-				if _, ok := info.allocationInfos[ioctl]; !ok {
-					t.Errorf("Alloc class %#x not found in struct names for version %v", ioctl, version.String())
+				if _, ok := info.AllocationInfos[ioctl]; !ok {
+					t.Errorf("Alloc class %#x not found in struct names for version %s", ioctl, version)
 				}
 			}
+			if len(abi.allocationClass) != len(info.AllocationInfos) {
+				t.Errorf("Alloc class count mismatch for version %s: %d != %d", version, len(abi.allocationClass), len(info.AllocationInfos))
+			}
 		})
 	}
 }