[Mesa-dev] [PATCH v3] util: Add Mesa ARB_get_program_binary helper functions
Timothy Arceri
tarceri at itsqueeze.com
Tue Nov 28 00:08:20 UTC 2017
From: Jordan Justen <jordan.l.justen at intel.com>
V2 (Timothy Arceri):
- add extra code comment
- stop passing around void *binary and just pass
program_binary_header *hdr instead.
- move to src/mesa/main rather than src/util
Signed-off-by: Jordan Justen <jordan.l.justen at intel.com>
Reviewed-by: Timothy Arceri <tarceri at itsqueeze.com>
---
src/mesa/Makefile.sources | 2 +
src/mesa/main/program_binary.c | 149 +++++++++++++++++++++++++++++++++++++++++
src/mesa/main/program_binary.h | 70 +++++++++++++++++++
src/mesa/meson.build | 2 +
4 files changed, 223 insertions(+)
create mode 100644 src/mesa/main/program_binary.c
create mode 100644 src/mesa/main/program_binary.h
diff --git a/src/mesa/Makefile.sources b/src/mesa/Makefile.sources
index 6da1e3fef9d..d8b1eb1f995 100644
--- a/src/mesa/Makefile.sources
+++ b/src/mesa/Makefile.sources
@@ -166,20 +166,22 @@ MAIN_FILES = \
main/pixel.c \
main/pixel.h \
main/pixelstore.c \
main/pixelstore.h \
main/pixeltransfer.c \
main/pixeltransfer.h \
main/points.c \
main/points.h \
main/polygon.c \
main/polygon.h \
+ main/program_binary.c \
+ main/program_binary.h \
main/program_resource.c \
main/program_resource.h \
main/querymatrix.c \
main/querymatrix.h \
main/queryobj.c \
main/queryobj.h \
main/rastpos.c \
main/rastpos.h \
main/readpix.c \
main/readpix.h \
diff --git a/src/mesa/main/program_binary.c b/src/mesa/main/program_binary.c
new file mode 100644
index 00000000000..c5fd71bc922
--- /dev/null
+++ b/src/mesa/main/program_binary.c
@@ -0,0 +1,149 @@
+/*
+ * Mesa 3-D graphics library
+ *
+ * Copyright (c) 2017 Intel Corporation
+ *
+ * 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, sublicense,
+ * 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 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 NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS 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.
+ */
+
+/**
+ * \file program_binary.c
+ *
+ * Helper functions for serializing a binary program.
+ */
+
+
+#include "main/mtypes.h"
+#include "util/crc32.h"
+#include "program_binary.h"
+
+/**
+ * Mesa supports one binary format, but it must differentiate between formats
+ * produced by different drivers and different Mesa versions.
+ *
+ * Mesa uses a uint32_t value to specify an internal format. The only format
+ * defined has one uint32_t value of 0, followed by 20 bytes specifying a sha1
+ * that uniquely identifies the Mesa driver type and version.
+ */
+
+struct program_binary_header {
+ /* If internal_format is 0, it must be followed by the 20 byte sha1 that
+ * identifies the Mesa driver and version supported. If we want to support
+ * something besides a sha1, then a new internal_format value can be added.
+ */
+ uint32_t internal_format;
+ uint8_t sha1[20];
+ /* Fields following sha1 can be changed since the sha1 will guarantee that
+ * the binary only works with the same Mesa version.
+ */
+ uint32_t size;
+ uint32_t crc32;
+};
+
+unsigned
+get_program_binary_header_size(void)
+{
+ return sizeof(struct program_binary_header);
+}
+
+bool
+write_program_binary(const void *payload, unsigned payload_size,
+ const void *sha1, void *binary, unsigned binary_size,
+ GLenum *binary_format)
+{
+ struct program_binary_header *hdr = binary;
+
+ if (binary_size < sizeof(*hdr))
+ return false;
+
+ /* binary_size is the size of the buffer provided by the application.
+ * Make sure our program (payload) will fit in the buffer.
+ */
+ if (payload_size > binary_size - sizeof(*hdr))
+ return false;
+
+ hdr->internal_format = 0;
+ memcpy(hdr->sha1, sha1, sizeof(hdr->sha1));
+ memcpy(hdr + 1, payload, payload_size);
+ hdr->size = payload_size;
+
+ hdr->crc32 = util_hash_crc32(hdr + 1, payload_size);
+ *binary_format = GL_PROGRAM_BINARY_FORMAT_MESA;
+
+ return true;
+}
+
+static bool
+simple_header_checks(const struct program_binary_header *hdr, unsigned length)
+{
+ if (hdr == NULL || length < sizeof(*hdr))
+ return false;
+
+ if (hdr->internal_format != 0)
+ return false;
+
+ return true;
+}
+
+static bool
+check_crc32(const struct program_binary_header *hdr, unsigned length)
+{
+ uint32_t crc32;
+ unsigned crc32_len;
+
+ crc32_len = hdr->size;
+ if (crc32_len > length - sizeof(*hdr))
+ return false;
+
+ crc32 = util_hash_crc32(hdr + 1, crc32_len);
+ if (hdr->crc32 != crc32)
+ return false;
+
+ return true;
+}
+
+static bool
+is_program_binary_valid(GLenum binary_format, const void *sha1,
+ const struct program_binary_header *hdr,
+ unsigned length)
+{
+ if (binary_format != GL_PROGRAM_BINARY_FORMAT_MESA)
+ return false;
+
+ if (!simple_header_checks(hdr, length))
+ return false;
+
+ if (memcmp(hdr->sha1, sha1, sizeof(hdr->sha1)) != 0)
+ return false;
+
+ if (!check_crc32(hdr, length))
+ return false;
+
+ return true;
+}
+
+const void*
+get_program_binary_payload(GLenum binary_format, const void *sha1,
+ const void *binary, unsigned length)
+{
+ const struct program_binary_header *hdr = binary;
+ if (!is_program_binary_valid(binary_format, sha1, hdr, length))
+ return NULL;
+ return (const uint8_t*)binary + sizeof(*hdr);
+}
diff --git a/src/mesa/main/program_binary.h b/src/mesa/main/program_binary.h
new file mode 100644
index 00000000000..64f9ef767b7
--- /dev/null
+++ b/src/mesa/main/program_binary.h
@@ -0,0 +1,70 @@
+/*
+ * Mesa 3-D graphics library
+ *
+ * Copyright (C) 2004-2007 Brian Paul All Rights Reserved.
+ * Copyright (C) 2010 VMware, Inc. 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, sublicense,
+ * 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 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 NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS 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.
+ */
+
+
+#ifndef PROGRAM_BINARY_H
+#define PROGRAM_BINARY_H
+
+#include <stdbool.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * Returns the header size needed for a binary
+ */
+extern unsigned
+get_program_binary_header_size(void);
+
+/**
+ * Returns the program binary for a given payload.
+ *
+ * This binary can be used as a return for the glGetProgramBinary call.
+ */
+extern bool
+write_program_binary(const void *payload, unsigned payload_size,
+ const void *sha1, void *binary, unsigned binary_size,
+ GLenum *binary_format);
+
+/**
+ * Returns the payload within the binary.
+ *
+ * If NULL is returned, then the binary not supported. If non-NULL is
+ * returned, it will be a pointer contained within the specified `binary`
+ * buffer.
+ *
+ * This can be used to access the payload of `binary` during the
+ * glProgramBinary call.
+ */
+extern const void*
+get_program_binary_payload(GLenum binary_format, const void *sha1,
+ const void *binary, unsigned length);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* PROGRAM_BINARY_H */
diff --git a/src/mesa/meson.build b/src/mesa/meson.build
index 05a3a9ac55d..670c3d22d24 100644
--- a/src/mesa/meson.build
+++ b/src/mesa/meson.build
@@ -208,20 +208,22 @@ files_libmesa_common = files(
'main/pixel.c',
'main/pixel.h',
'main/pixelstore.c',
'main/pixelstore.h',
'main/pixeltransfer.c',
'main/pixeltransfer.h',
'main/points.c',
'main/points.h',
'main/polygon.c',
'main/polygon.h',
+ 'main/program_binary.c',
+ 'main/program_binary.h',
'main/program_resource.c',
'main/program_resource.h',
'main/querymatrix.c',
'main/querymatrix.h',
'main/queryobj.c',
'main/queryobj.h',
'main/rastpos.c',
'main/rastpos.h',
'main/readpix.c',
'main/readpix.h',
--
2.14.3
More information about the mesa-dev
mailing list