GPU: Platform Support Level

Adds a check when starting blender if your platform is supported. We use a blacklist
as drivers are updated more regular then blender (stable releases).

The mechanism detects if the support level changed or has been validated by the user previously.
Changes can happen due to users updating their drivers, but also when we change the support
level in our code base.

When the user has seen the limited support level message it is saved in the user config.
It would be better to have a system specific config section, but currently not clear
what could benefit from that.

When the platform is unsupported or has limited support a dialog box will appear including a link
to our user manual describing what to do.

**Windows**
Windows uses the MessageBox that is provided by the windows kernel.

**X11**
We use a very lowlevel messagebox for X11. It is very limited in use and can be fine tuned when needed.

**SDL/APPLE**
There is no implementation for SDL or APPLE at this moment as the platform support feature targets mostly Windows users.

Reviewed By: brecht

Differential Revision: https://developer.blender.org/D5955

1 files changed, 216 insertions, 0 deletions

diff --git a/source/blender/windowmanager/intern/wm_platform_support.c b/source/blender/windowmanager/intern/wm_platform_support.c
new file mode 100644
index 00000000000..9ed6f9f4299
--- /dev/null
+++ b/source/blender/windowmanager/intern/wm_platform_support.c
@@ -0,0 +1,216 @@
+/*
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * The Original Code is Copyright (C) 2019 Blender Foundation.
+ * All rights reserved.
+ */
+
+/** \file
+ * \ingroup wm
+ */
+#include "wm_platform_support.h"
+#include "wm_window_private.h"
+
+#include <string.h>
+
+#include "BLI_sys_types.h"
+#include "BLI_dynstr.h"
+#include "BLI_path_util.h"
+#include "BLI_fileops.h"
+#include "BLI_string.h"
+#include "BLI_linklist.h"
+
+#include "BLT_translation.h"
+
+#include "BKE_appdir.h"
+#include "BKE_global.h"
+
+#include "GPU_platform.h"
+
+#include "GHOST_C-api.h"
+
+#define WM_PLATFORM_SUPPORT_TEXT_SIZE 1024
+
+/* Check if user has already approved the given platform_support_key. */
+static bool wm_platform_support_check_approval(const char *platform_support_key, bool update)
+{
+  const char *const cfgdir = BKE_appdir_folder_id(BLENDER_USER_CONFIG, NULL);
+  bool result = false;
+
+  if (G.factory_startup) {
+    return result;
+  }
+
+  if (cfgdir) {
+    char filepath[FILE_MAX];
+    BLI_make_file_string("/", filepath, cfgdir, BLENDER_PLATFORM_SUPPORT_FILE);
+    LinkNode *lines = BLI_file_read_as_lines(filepath);
+    for (LinkNode *line_node = lines; line_node; line_node = line_node->next) {
+      char *line = line_node->link;
+      if (STREQ(line, platform_support_key)) {
+        result = true;
+        break;
+      }
+    }
+
+    if (!result && update) {
+      FILE *fp = BLI_fopen(filepath, "a");
+      if (fp) {
+        fprintf(fp, "%s\n", platform_support_key);
+        fclose(fp);
+      }
+    }
+
+    BLI_file_free_lines(lines);
+  }
+  return result;
+}
+
+static void wm_platform_support_create_link(char *link)
+{
+  DynStr *ds = BLI_dynstr_new();
+
+  BLI_dynstr_append(ds, "https://docs.blender.org/manual/en/dev/troubleshooting/gpu/");
+#if defined(_WIN32)
+  BLI_dynstr_append(ds, "windows/");
+#elif defined(__APPLE__)
+  BLI_dynstr_append(ds, "apple/");
+#else /* UNIX */
+  BLI_dynstr_append(ds, "linux/");
+#endif
+
+  if (GPU_type_matches(GPU_DEVICE_INTEL, GPU_OS_ANY, GPU_DRIVER_ANY)) {
+    BLI_dynstr_append(ds, "intel.html");
+  }
+  else if (GPU_type_matches(GPU_DEVICE_NVIDIA, GPU_OS_ANY, GPU_DRIVER_ANY)) {
+    BLI_dynstr_append(ds, "nvidia.html");
+  }
+  else if (GPU_type_matches(GPU_DEVICE_ATI, GPU_OS_ANY, GPU_DRIVER_ANY)) {
+    BLI_dynstr_append(ds, "amd.html");
+  }
+  else {
+    BLI_dynstr_append(ds, "unknown.html");
+  }
+
+  BLI_assert(BLI_dynstr_get_len(ds) < WM_PLATFORM_SUPPORT_TEXT_SIZE);
+  BLI_dynstr_get_cstring_ex(ds, link);
+  BLI_dynstr_free(ds);
+}
+
+bool WM_platform_support_perform_checks()
+{
+  char title[WM_PLATFORM_SUPPORT_TEXT_SIZE];
+  char message[WM_PLATFORM_SUPPORT_TEXT_SIZE];
+  char link[WM_PLATFORM_SUPPORT_TEXT_SIZE];
+
+  bool result = true;
+
+  eGPUSupportLevel support_level = GPU_platform_support_level();
+  const char *platform_key = GPU_platform_support_level_key();
+
+  /* check if previous check matches the current check. Don't update the approval when running in
+   * `background`. this could have been triggered by installing addons via installers.  */
+  if (support_level != GPU_SUPPORT_LEVEL_UNSUPPORTED && !G.factory_startup &&
+      wm_platform_support_check_approval(platform_key, !G.background)) {
+    /* if it matches the user has confirmed and whishes to use it */
+    return result;
+  }
+
+  /* update the message and link based on the found support level */
+  GHOST_DialogOptions dialog_options = 0;
+
+  switch (support_level) {
+    default:
+    case GPU_SUPPORT_LEVEL_SUPPORTED:
+      break;
+
+    case GPU_SUPPORT_LEVEL_LIMITED: {
+      size_t slen = 0;
+      STR_CONCAT(title, slen, "Blender - ");
+      STR_CONCAT(
+          title, slen, CTX_IFACE_(BLT_I18NCONTEXT_ID_WINDOWMANAGER, "Limited Platform Support"));
+      slen = 0;
+      STR_CONCAT(
+          message,
+          slen,
+          CTX_IFACE_(BLT_I18NCONTEXT_ID_WINDOWMANAGER,
+                     "Your graphics card or driver has limited support. It may work, but with "
+                     "issues."));
+
+      /* TODO: Extra space is needed for the split function in GHOST_SystemX11. We should change
+       * the behavior in GHOST_SystemX11. */
+      STR_CONCAT(message, slen, "\n \n");
+      STR_CONCAT(message,
+                 slen,
+                 CTX_IFACE_(BLT_I18NCONTEXT_ID_WINDOWMANAGER,
+                            "Press help to see if the support can be improved."));
+      STR_CONCAT(message, slen, "\n \n");
+      STR_CONCAT(message, slen, CTX_IFACE_(BLT_I18NCONTEXT_ID_WINDOWMANAGER, "Graphics card:\n"));
+      STR_CONCAT(message, slen, GPU_platform_gpu_name());
+
+      dialog_options = GHOST_DialogWarning;
+      break;
+    }
+
+    case GPU_SUPPORT_LEVEL_UNSUPPORTED: {
+      size_t slen = 0;
+      STR_CONCAT(title, slen, "Blender - ");
+      STR_CONCAT(
+          title, slen, CTX_IFACE_(BLT_I18NCONTEXT_ID_WINDOWMANAGER, "Platform Unsupported"));
+      slen = 0;
+      STR_CONCAT(message,
+                 slen,
+                 CTX_IFACE_(BLT_I18NCONTEXT_ID_WINDOWMANAGER,
+                            "Your graphics card or driver is not supported."));
+
+      STR_CONCAT(message, slen, "\n \n");
+      STR_CONCAT(message,
+                 slen,
+                 CTX_IFACE_(BLT_I18NCONTEXT_ID_WINDOWMANAGER,
+                            "Press help to see if the support can be improved."));
+
+      STR_CONCAT(message, slen, "\n \n");
+      STR_CONCAT(message, slen, CTX_IFACE_(BLT_I18NCONTEXT_ID_WINDOWMANAGER, "Graphics card:\n"));
+      STR_CONCAT(message, slen, GPU_platform_gpu_name());
+      STR_CONCAT(message, slen, "\n \n");
+
+      STR_CONCAT(message,
+                 slen,
+                 CTX_IFACE_(BLT_I18NCONTEXT_ID_WINDOWMANAGER, "The program will now close."));
+      dialog_options = GHOST_DialogError;
+      result = false;
+      break;
+    }
+  }
+  wm_platform_support_create_link(link);
+
+  bool show_message = ELEM(
+      support_level, GPU_SUPPORT_LEVEL_LIMITED, GPU_SUPPORT_LEVEL_UNSUPPORTED);
+
+  /* We are running in the background print the message in the console. */
+  if ((G.background || G.debug & G_DEBUG) && show_message) {
+    printf("%s\n\n%s\n%s\n", title, message, link);
+  }
+  if (G.background) {
+    /* don't show the messagebox when running in background mode. Printing to
+     * console is enough. */
+    result = true;
+  }
+  else if (show_message) {
+    WM_ghost_show_message_box(title, message, link, dialog_options);
+  }
+
+  return result;
+}
\ No newline at end of file