svga: Add the ability to log messages to vmware.log on the host.

For now this capability only exists in the SVGA driver but
can be exported later if other modules, e.g. winsys, wants
to use it for logging.

Reviewed-by: Brian Paul <[email protected]>

5 files changed, 471 insertions, 0 deletions

diff --git a/src/gallium/drivers/svga/Makefile.sources b/src/gallium/drivers/svga/Makefile.sources
index 229d2863c84..72024cf60e1 100644
--- a/src/gallium/drivers/svga/Makefile.sources
+++ b/src/gallium/drivers/svga/Makefile.sources
@@ -15,6 +15,8 @@ C_SOURCES := \
 	svga_hw_reg.h \
 	svga_link.c \
 	svga_link.h \
+	svga_msg.c \
+	svga_msg.h \
 	svga_mksstats.h \
 	svga_pipe_blend.c \
 	svga_pipe_blit.c \
diff --git a/src/gallium/drivers/svga/svga_msg.c b/src/gallium/drivers/svga/svga_msg.c
new file mode 100644
index 00000000000..9c71fefbb87
--- /dev/null
+++ b/src/gallium/drivers/svga/svga_msg.c
@@ -0,0 +1,411 @@
+/*
+ * Copyright © 2016 VMware, Inc., Palo Alto, CA., USA
+ * All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sub license, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the
+ * next paragraph) shall be included in all copies or substantial portions
+ * of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
+ * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+ * USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ */
+
+#include "util/u_math.h" /* for MAX2/MIN2 */
+#include "util/u_debug.h"
+#include "util/u_memory.h"
+#include "util/u_string.h"
+#include "pipe/p_defines.h"
+#include "svga_msg.h"
+
+
+#define MESSAGE_STATUS_SUCCESS  0x0001
+#define MESSAGE_STATUS_DORECV   0x0002
+#define MESSAGE_STATUS_CPT      0x0010
+#define MESSAGE_STATUS_HB       0x0080
+
+#define RPCI_PROTOCOL_NUM       0x49435052
+#define GUESTMSG_FLAG_COOKIE    0x80000000
+
+#define RETRIES                 3
+
+#define VMW_HYPERVISOR_MAGIC    0x564D5868
+#define VMW_HYPERVISOR_PORT     0x5658
+#define VMW_HYPERVISOR_HB_PORT  0x5659
+
+#define VMW_PORT_CMD_MSG        30
+#define VMW_PORT_CMD_HB_MSG     0
+#define VMW_PORT_CMD_OPEN_CHANNEL  (MSG_TYPE_OPEN << 16 | VMW_PORT_CMD_MSG)
+#define VMW_PORT_CMD_CLOSE_CHANNEL (MSG_TYPE_CLOSE << 16 | VMW_PORT_CMD_MSG)
+#define VMW_PORT_CMD_SENDSIZE   (MSG_TYPE_SENDSIZE << 16 | VMW_PORT_CMD_MSG)
+#define VMW_PORT_CMD_RECVSIZE   (MSG_TYPE_RECVSIZE << 16 | VMW_PORT_CMD_MSG)
+#define VMW_PORT_CMD_RECVSTATUS (MSG_TYPE_RECVSTATUS << 16 | VMW_PORT_CMD_MSG)
+
+#define HIGH_WORD(X) ((X & 0xFFFF0000) >> 16)
+
+
+/**
+ * Hypervisor-specific bi-directional communication channel.  Should never
+ * execute on bare metal hardware.  The caller must make sure to check for
+ * supported hypervisor before using these macros.
+ *
+ * The last two parameters are both input and output and must be initialized.
+ *
+ * @cmd: [IN] Message Cmd
+ * @in_bx: [IN] Message Len, through BX
+ * @in_si: [IN] Input argument through SI, set to 0 if not used
+ * @in_di: [IN] Input argument through DI, set ot 0 if not used
+ * @port_num: [IN] port number + [channel id]
+ * @magic: [IN] hypervisor magic value
+ * @ax: [OUT] value of AX register
+ * @bx: [OUT] e.g. status from an HB message status command
+ * @cx: [OUT] e.g. status from a non-HB message status command
+ * @dx: [OUT] e.g. channel id
+ * @si:  [OUT]
+ * @di:  [OUT]
+ */
+#define VMW_PORT(cmd, in_bx, in_si, in_di, \
+         port_num, magic,                  \
+         ax, bx, cx, dx, si, di)           \
+({                                         \
+   asm volatile ("inl %%dx, %%eax;" :      \
+      "=a"(ax),                            \
+      "=b"(bx),                            \
+      "=c"(cx),                            \
+      "=d"(dx),                            \
+      "=S"(si),                            \
+      "=D"(di) :                           \
+      "a"(magic),                          \
+      "b"(in_bx),                          \
+      "c"(cmd),                            \
+      "d"(port_num),                       \
+      "S"(in_si),                          \
+      "D"(in_di) :                         \
+      "memory");                           \
+})
+
+
+/**
+ * Hypervisor-specific bi-directional communication channel.  Should never
+ * execute on bare metal hardware.  The caller must make sure to check for
+ * supported hypervisor before using these macros.
+ *
+ * @cmd: [IN] Message Cmd
+ * @in_cx: [IN] Message Len, through CX
+ * @in_si: [IN] Input argument through SI, set to 0 if not used
+ * @in_di: [IN] Input argument through DI, set to 0 if not used
+ * @port_num: [IN] port number + [channel id]
+ * @magic: [IN] hypervisor magic value
+ * @bp:  [IN]
+ * @ax: [OUT] value of AX register
+ * @bx: [OUT] e.g. status from an HB message status command
+ * @cx: [OUT] e.g. status from a non-HB message status command
+ * @dx: [OUT] e.g. channel id
+ * @si:  [OUT]
+ * @di:  [OUT]
+ */
+#ifdef __x86_64__
+
+typedef uint64_t VMW_REG;
+
+#define VMW_PORT_HB_OUT(cmd, in_cx, in_si, in_di, \
+         port_num, magic, bp,                     \
+         ax, bx, cx, dx, si, di)                  \
+({                                                \
+   asm volatile ("push %%rbp;"                    \
+      "movq %12, %%rbp;"                          \
+      "rep outsb;"                                \
+      "pop %%rbp;" :                              \
+      "=a"(ax),                                   \
+      "=b"(bx),                                   \
+      "=c"(cx),                                   \
+      "=d"(dx),                                   \
+      "=S"(si),                                   \
+      "=D"(di) :                                  \
+      "a"(magic),                                 \
+      "b"(cmd),                                   \
+      "c"(in_cx),                                 \
+      "d"(port_num),                              \
+      "S"(in_si),                                 \
+      "D"(in_di),                                 \
+      "r"(bp) :                                   \
+      "memory", "cc");                            \
+})
+
+#define VMW_PORT_HB_IN(cmd, in_cx, in_si, in_di,  \
+         port_num, magic, bp,                     \
+         ax, bx, cx, dx, si, di)                  \
+({                                                \
+   asm volatile ("push %%rbp;"                    \
+      "movq %12, %%rbp;"                          \
+      "rep insb;"                                 \
+      "pop %%rbp" :                               \
+      "=a"(ax),                                   \
+      "=b"(bx),                                   \
+      "=c"(cx),                                   \
+      "=d"(dx),                                   \
+      "=S"(si),                                   \
+      "=D"(di) :                                  \
+      "a"(magic),                                 \
+      "b"(cmd),                                   \
+      "c"(in_cx),                                 \
+      "d"(port_num),                              \
+      "S"(in_si),                                 \
+      "D"(in_di),                                 \
+      "r"(bp) :                                   \
+      "memory", "cc");                            \
+})
+
+#else
+
+typedef uint32_t VMW_REG;
+
+/* In the 32-bit version of this macro, we use "m" because there is no
+ * more register left for bp
+ */
+#define VMW_PORT_HB_OUT(cmd, in_cx, in_si, in_di, \
+         port_num, magic, bp,                     \
+         ax, bx, cx, dx, si, di)                  \
+({                                                \
+   asm volatile ("push %%ebp;"                    \
+      "mov %12, %%ebp;"                           \
+      "rep outsb;"                                \
+      "pop %%ebp;" :                              \
+      "=a"(ax),                                   \
+      "=b"(bx),                                   \
+      "=c"(cx),                                   \
+      "=d"(dx),                                   \
+      "=S"(si),                                   \
+      "=D"(di) :                                  \
+      "a"(magic),                                 \
+      "b"(cmd),                                   \
+      "c"(in_cx),                                 \
+      "d"(port_num),                              \
+      "S"(in_si),                                 \
+      "D"(in_di),                                 \
+      "m"(bp) :                                   \
+      "memory", "cc");                            \
+})
+
+
+#define VMW_PORT_HB_IN(cmd, in_cx, in_si, in_di,  \
+         port_num, magic, bp,                     \
+         ax, bx, cx, dx, si, di)                  \
+({                                                \
+   asm volatile ("push %%ebp;"                    \
+      "mov %12, %%ebp;"                           \
+      "rep insb;"                                 \
+      "pop %%ebp" :                               \
+      "=a"(ax),                                   \
+      "=b"(bx),                                   \
+      "=c"(cx),                                   \
+      "=d"(dx),                                   \
+      "=S"(si),                                   \
+      "=D"(di) :                                  \
+      "a"(magic),                                 \
+      "b"(cmd),                                   \
+      "c"(in_cx),                                 \
+      "d"(port_num),                              \
+      "S"(in_si),                                 \
+      "D"(in_di),                                 \
+      "m"(bp) :                                   \
+      "memory", "cc");                            \
+})
+#endif /* #if __x86_64__ */
+
+
+enum rpc_msg_type {
+   MSG_TYPE_OPEN,
+   MSG_TYPE_SENDSIZE,
+   MSG_TYPE_SENDPAYLOAD,
+   MSG_TYPE_RECVSIZE,
+   MSG_TYPE_RECVPAYLOAD,
+   MSG_TYPE_RECVSTATUS,
+   MSG_TYPE_CLOSE,
+};
+
+struct rpc_channel {
+   uint16_t channel_id;
+   uint32_t cookie_high;
+   uint32_t cookie_low;
+};
+
+
+
+/**
+ * svga_open_channel
+ *
+ * @channel: RPC channel
+ * @protocol:
+ *
+ * Returns: PIPE_OK on success, PIPE_ERROR otherwise
+ */
+static enum pipe_error
+svga_open_channel(struct rpc_channel *channel, unsigned protocol)
+{
+   VMW_REG ax, bx, cx, dx, si = 0, di = 0;
+
+   VMW_PORT(VMW_PORT_CMD_OPEN_CHANNEL,
+      (protocol | GUESTMSG_FLAG_COOKIE), si, di,
+      VMW_HYPERVISOR_PORT,
+      VMW_HYPERVISOR_MAGIC,
+      ax, bx, cx, dx, si, di);
+
+   if ((HIGH_WORD(cx) & MESSAGE_STATUS_SUCCESS) == 0)
+      return PIPE_ERROR;
+
+   channel->channel_id = HIGH_WORD(dx);
+   channel->cookie_high = si;
+   channel->cookie_low = di;
+
+   return PIPE_OK;
+}
+
+
+
+/**
+ * svga_close_channel
+ *
+ * @channel: RPC channel
+ *
+ * Returns: PIPE_OK on success, PIPE_ERROR otherwises
+ */
+static enum pipe_error
+svga_close_channel(struct rpc_channel *channel)
+{
+   VMW_REG ax, bx, cx, dx, si, di;
+
+   /* Set up additional parameters */
+   si = channel->cookie_high;
+   di = channel->cookie_low;
+
+   VMW_PORT(VMW_PORT_CMD_CLOSE_CHANNEL,
+      0, si, di,
+      (VMW_HYPERVISOR_PORT | (channel->channel_id << 16)),
+      VMW_HYPERVISOR_MAGIC,
+      ax, bx, cx, dx, si, di);
+
+   if ((HIGH_WORD(cx) & MESSAGE_STATUS_SUCCESS) == 0)
+      return PIPE_ERROR;
+
+   return PIPE_OK;
+}
+
+
+
+/**
+ * svga_send_msg: Sends a message to the host
+ *
+ * @channel: RPC channel
+ * @logmsg: NULL terminated string
+ *
+ * Returns: PIPE_OK on success
+ */
+static enum pipe_error
+svga_send_msg(struct rpc_channel *channel, const char *msg)
+{
+   VMW_REG ax, bx, cx, dx, si, di, bp;
+   size_t msg_len = strlen(msg);
+   int retries = 0;
+
+
+   while (retries < RETRIES) {
+      retries++;
+
+      /* Set up additional parameters */
+      si = channel->cookie_high;
+      di = channel->cookie_low;
+
+      VMW_PORT(VMW_PORT_CMD_SENDSIZE,
+         msg_len, si, di,
+         VMW_HYPERVISOR_PORT | (channel->channel_id << 16),
+         VMW_HYPERVISOR_MAGIC,
+         ax, bx, cx, dx, si, di);
+
+      if ((HIGH_WORD(cx) & MESSAGE_STATUS_SUCCESS) == 0 ||
+          (HIGH_WORD(cx) & MESSAGE_STATUS_HB) == 0) {
+         /* Expected success + high-bandwidth. Give up. */
+         return PIPE_ERROR;
+      }
+
+      /* Send msg */
+      si = (uintptr_t) msg;
+      di = channel->cookie_low;
+      bp = channel->cookie_high;
+
+      VMW_PORT_HB_OUT(
+         (MESSAGE_STATUS_SUCCESS << 16) | VMW_PORT_CMD_HB_MSG,
+         msg_len, si, di,
+         VMW_HYPERVISOR_HB_PORT | (channel->channel_id << 16),
+         VMW_HYPERVISOR_MAGIC, bp,
+         ax, bx, cx, dx, si, di);
+
+      if ((HIGH_WORD(bx) & MESSAGE_STATUS_SUCCESS) != 0) {
+         return PIPE_OK;
+      } else if ((HIGH_WORD(bx) & MESSAGE_STATUS_CPT) != 0) {
+         /* A checkpoint occurred. Retry. */
+         continue;
+      } else {
+         break;
+      }
+   }
+
+   return PIPE_ERROR;
+}
+
+
+
+/**
+ * svga_host_log: Sends a log message to the host
+ *
+ * @log: NULL terminated string
+ *
+ * Returns: PIPE_OK on success
+ */
+enum pipe_error
+svga_host_log(const char *log)
+{
+   struct rpc_channel channel;
+   char *msg;
+   int msg_len;
+   enum pipe_error ret = PIPE_OK;
+
+
+   if (!log)
+      return ret;
+
+   msg_len = strlen(log) + strlen("log ") + 1;
+   msg = CALLOC(1, msg_len);
+   if (msg == NULL) {
+      debug_printf("Cannot allocate memory for log message\n");
+      return PIPE_ERROR_OUT_OF_MEMORY;
+   }
+
+   util_sprintf(msg, "log %s", log);
+
+   if (svga_open_channel(&channel, RPCI_PROTOCOL_NUM) ||
+       svga_send_msg(&channel, msg) ||
+       svga_close_channel(&channel)) {
+      debug_printf("Failed to send log\n");
+
+      ret = PIPE_ERROR;
+   }
+
+   FREE(msg);
+
+   return ret;
+}
+
diff --git a/src/gallium/drivers/svga/svga_msg.h b/src/gallium/drivers/svga/svga_msg.h
new file mode 100644
index 00000000000..9132ba7e240
--- /dev/null
+++ b/src/gallium/drivers/svga/svga_msg.h
@@ -0,0 +1,42 @@
+/*
+ * Copyright © 2016 VMware, Inc., Palo Alto, CA., USA
+ * All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sub license, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the
+ * next paragraph) shall be included in all copies or substantial portions
+ * of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
+ * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+ * USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * Based on code from vmware.c and vmmouse.c.
+ * Author:
+ *   Sinclair Yeh <[email protected]>
+ */
+#ifndef _SVGA_MSG_H
+#define _SVGA_MSG_H
+
+/**
+ * svga_host_log: Sends a log message to the host
+ *
+ * @log: NULL terminated string
+ *
+ * Returns: PIPE_OK on success
+ */
+enum pipe_error svga_host_log(const char *log);
+
+#endif
+
diff --git a/src/gallium/drivers/svga/svga_screen.c b/src/gallium/drivers/svga/svga_screen.c
index b79d9e9a767..866eef13930 100644
--- a/src/gallium/drivers/svga/svga_screen.c
+++ b/src/gallium/drivers/svga/svga_screen.c
@@ -23,6 +23,7 @@
  *
  **********************************************************/
 
+#include "git_sha1.h" /* For MESA_GIT_SHA1 */
 #include "util/u_format.h"
 #include "util/u_memory.h"
 #include "util/u_inlines.h"
@@ -45,6 +46,10 @@
 /* NOTE: this constant may get moved into a svga3d*.h header file */
 #define SVGA3D_DX_MAX_RESOURCE_SIZE (128 * 1024 * 1024)
 
+#ifndef MESA_GIT_SHA1
+#define MESA_GIT_SHA1 "(unknown git revision)"
+#endif
+
 #ifdef DEBUG
 int SVGA_DEBUG = 0;
 
@@ -1124,6 +1129,15 @@ svga_screen_create(struct svga_winsys_screen *sws)
 
    svga_screen_cache_init(svgascreen);
 
+   /* Log Version to Host */
+   util_snprintf(host_log, sizeof(host_log) - strlen(HOST_LOG_PREFIX),
+                 "%s%s", HOST_LOG_PREFIX, svga_get_name(screen));
+   svga_host_log(host_log);
+
+   util_snprintf(host_log, sizeof(host_log) - strlen(HOST_LOG_PREFIX),
+                 "%s%s (%s)", HOST_LOG_PREFIX, PACKAGE_VERSION, MESA_GIT_SHA1);
+   svga_host_log(host_log);
+
    return screen;
 error2:
    FREE(svgascreen);
diff --git a/src/gallium/drivers/svga/svga_screen.h b/src/gallium/drivers/svga/svga_screen.h
index 68834a69e2e..8e8620a1c98 100644
--- a/src/gallium/drivers/svga/svga_screen.h
+++ b/src/gallium/drivers/svga/svga_screen.h
@@ -33,6 +33,8 @@
 #include "svga_screen_cache.h"
 
 
+#define HOST_LOG_PREFIX  "Mesa: "
+
 struct svga_winsys_screen;
 struct svga_winsys_context;
 struct SVGACmdMemory;