Show Linux driver information in flutter doctor (#163980)

I have attempted to cherry pick some useful information from eglinfo
which is often requested when resolving issues with rendering.

This information is not required to compile an Flutter application, so
it is a little different to the other displayed information.

Author: robert-ancell

packages/flutter_tools/lib/src/base/user_messages.dart

@@ -275,6 +275,9 @@ class UserMessages {
   String get gtkLibrariesMissing =>
       'GTK 3.0 development libraries are required for Linux development.\n'
       'They are likely available from your distribution (e.g.: apt install libgtk-3-dev)';
+  String get eglinfoMissing =>
+      "Unable to access driver information using 'eglinfo'.\n"
+      'It is likely available from your distribution (e.g.: apt install mesa-utils)';
 
   // Messages used in FlutterCommand
   String flutterElapsedTime(String name, String elapsedTime) =>

packages/flutter_tools/lib/src/linux/linux_doctor.dart

@@ -7,6 +7,7 @@ import 'package:process/process.dart';
 import '../base/io.dart';
 import '../base/user_messages.dart';
 import '../base/version.dart';
+import '../convert.dart';
 import '../doctor_validator.dart';
 
 /// A combination of version description and parsed version number.
@@ -29,6 +30,87 @@ class _VersionInfo {
   Version? number;
 }
 
+/// Information about graphics drivers.
+class _DriverInformation {
+  _DriverInformation({required ProcessManager processManager}) : _processManager = processManager;
+
+  final ProcessManager _processManager;
+  List<List<String>> _sections = <List<String>>[];
+
+  Future<bool> load() async {
+    ProcessResult? result;
+    try {
+      result = await _processManager.run(<String>['eglinfo'], stdoutEncoding: utf8);
+    } on ArgumentError {
+      // ignore error.
+    }
+    if (result == null || result.exitCode != 0) {
+      return false;
+    }
+
+    // Break into sections separated by an empty line.
+    final List<String> lines = (result.stdout as String).split('\n');
+    final List<List<String>> sections = <List<String>>[<String>[]];
+    for (final String line in lines) {
+      if (line == '') {
+        if (sections.last.isNotEmpty) {
+          sections.add(<String>[]);
+        }
+      } else {
+        sections.last.add(line);
+      }
+    }
+    if (sections.last.isEmpty) {
+      sections.removeLast();
+    }
+    _sections = sections;
+
+    return true;
+  }
+
+  List<String>? _getSection(String sectionName) {
+    for (final List<String> lines in _sections) {
+      if (lines[0] == '$sectionName:') {
+        return lines;
+      }
+    }
+
+    return null;
+  }
+
+  // Extracts a variable from eglinfo output.
+  String? getVariable(String sectionName, String name) {
+    final List<String>? lines = _getSection(sectionName);
+    if (lines == null) {
+      return null;
+    }
+
+    final String prefix = '$name:';
+    for (int i = 0; i < lines.length; i++) {
+      if (lines[i].startsWith(prefix)) {
+        String value = lines[i].substring(prefix.length).trim();
+        // Combine multi-line indented values.
+        if (value == '') {
+          for (int j = i + 1; j < lines.length && lines[j].startsWith('    '); j++) {
+            if (value == '') {
+              value += ' ';
+            }
+            value += lines[j].trim();
+          }
+        }
+        return value;
+      }
+    }
+
+    return null;
+  }
+
+  // Extracts a comma separated list variable.
+  List<String>? getListVariable(String sectionName, String name) {
+    return getVariable(sectionName, name)?.split(',').map((String s) => s.trim()).toList();
+  }
+}
+
 /// A validator that checks for Clang and Make build dependencies.
 class LinuxDoctorValidator extends DoctorValidator {
   LinuxDoctorValidator({required ProcessManager processManager, required UserMessages userMessages})
@@ -160,6 +242,94 @@ class LinuxDoctorValidator extends DoctorValidator {
       }
     }
 
+    // Messages for drivers.
+    {
+      final _DriverInformation driverInfo = _DriverInformation(processManager: _processManager);
+      if (!await driverInfo.load()) {
+        messages.add(ValidationMessage.hint(_userMessages.eglinfoMissing));
+      } else {
+        const String kWaylandPlatform = 'Wayland platform';
+        const String kX11Platform = 'X11 platform';
+        const String kOpenGLCoreProfileRenderer = 'OpenGL core profile renderer';
+        const String kOpenGLCoreProfileShadingLanguageVersion =
+            'OpenGL core profile shading language version';
+        const String kOpenGLCoreProfileVersion = 'OpenGL core profile version';
+        const String kOpenGLCoreProfileExtensions = 'OpenGL core profile extensions';
+        const String kOpenGLESProfileRenderer = 'OpenGL ES profile renderer';
+        const String kOpenGLESProfileVersion = 'OpenGL ES profile version';
+        const String kOpenGLESProfileShadingLanguageVersion =
+            'OpenGL ES profile shading language version';
+        const String kOpenGLESProfileExtensions = 'OpenGL ES profile extensions';
+
+        // Check both Wayland and X11 platforms for value.
+        String? getPlatformVariable(String name) {
+          final String? waylandValue = driverInfo.getVariable(kWaylandPlatform, name);
+          final String? x11Value = driverInfo.getVariable(kX11Platform, name);
+          if (waylandValue == null && x11Value == null) {
+            return null;
+          }
+
+          if (waylandValue == null) {
+            return '$x11Value (X11)';
+          } else if (x11Value == null) {
+            return '$waylandValue (Wayland)';
+          } else if (waylandValue == x11Value) {
+            return waylandValue;
+          } else {
+            return '$waylandValue (Wayland) $x11Value (X11)';
+          }
+        }
+
+        // Check if has specified OpenGL extension.
+        ValidationMessage extensionStatus(String variableName, String extensionName) {
+          final List<String> waylandExtensions =
+              driverInfo.getListVariable(kWaylandPlatform, variableName) ?? <String>[];
+          final List<String> x11Extensions =
+              driverInfo.getListVariable(kX11Platform, variableName) ?? <String>[];
+
+          final bool hasWayland = waylandExtensions.contains(extensionName);
+          final bool hasX11 = x11Extensions.contains(extensionName);
+          String status;
+          if (!hasWayland && !hasX11) {
+            status = 'no';
+          } else if (!hasWayland) {
+            status = 'yes (X11)';
+          } else if (!hasX11) {
+            status = 'yes (Wayland)';
+          } else {
+            status = 'yes';
+          }
+
+          return ValidationMessage('$extensionName: $status');
+        }
+
+        final String? renderer = getPlatformVariable(kOpenGLCoreProfileRenderer);
+        if (renderer != null) {
+          messages.add(ValidationMessage('OpenGL core renderer: $renderer'));
+          final String version = getPlatformVariable(kOpenGLCoreProfileVersion) ?? 'unknown';
+          messages.add(ValidationMessage('OpenGL core version: $version'));
+          final String shadingLanguageVersion =
+              getPlatformVariable(kOpenGLCoreProfileShadingLanguageVersion) ?? 'unknown';
+          messages.add(
+            ValidationMessage('OpenGL core shading language version: $shadingLanguageVersion'),
+          );
+        }
+        final String? esRenderer = getPlatformVariable(kOpenGLESProfileRenderer);
+        if (esRenderer != null) {
+          messages.add(ValidationMessage('OpenGL ES renderer: $esRenderer'));
+          final String version = getPlatformVariable(kOpenGLESProfileVersion) ?? 'unknown';
+          messages.add(ValidationMessage('OpenGL ES version: $version'));
+          final String shadingLanguageVersion =
+              getPlatformVariable(kOpenGLESProfileShadingLanguageVersion) ?? 'unknown';
+          messages.add(
+            ValidationMessage('OpenGL ES shading language version: $shadingLanguageVersion'),
+          );
+        }
+        messages.add(extensionStatus(kOpenGLCoreProfileExtensions, 'GL_EXT_framebuffer_blit'));
+        messages.add(extensionStatus(kOpenGLESProfileExtensions, 'GL_EXT_texture_format_BGRA8888'));
+      }
+    }
+
     return ValidationResult(validationType, messages);
   }