gallivm: add coroutine support files to gallivm.

These wrap the coroutine intrinsics and also add some higher
level wrappers around coroutine begin, end and suspend procedures

Reviewed-by: Roland Scheidegger <sroland@vmware.com>

src/gallium/auxiliary/Makefile.sources

@@ -412,6 +412,8 @@ GALLIVM_SOURCES := \
 	gallivm/lp_bld_const.h \
 	gallivm/lp_bld_conv.c \
 	gallivm/lp_bld_conv.h \
+	gallivm/lp_bld_coro.c \
+	gallivm/lp_bld_coro.h \
 	gallivm/lp_bld_debug.cpp \
 	gallivm/lp_bld_debug.h \
 	gallivm/lp_bld_flow.c \

src/gallium/auxiliary/gallivm/lp_bld_coro.c

@@ -0,0 +1,200 @@
+/**************************************************************************
+ *
+ * Copyright 2019 Red Hat.
+ * 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.
+ *
+ **************************************************************************/
+
+#include <stdint.h>
+#include "lp_bld_coro.h"
+#include "util/os_memory.h"
+#include "lp_bld_init.h"
+#include "lp_bld_const.h"
+#include "lp_bld_intr.h"
+#include "lp_bld_flow.h"
+
+#if HAVE_LLVM < 0x0600
+/* not a wrapper, just lets it compile */
+static LLVMTypeRef LLVMTokenTypeInContext(LLVMContextRef C)
+{
+   assert(0);
+   return LLVMVoidTypeInContext(C);
+}
+#endif
+
+LLVMValueRef lp_build_coro_id(struct gallivm_state *gallivm)
+{
+   LLVMValueRef coro_id_args[4];
+   coro_id_args[0] = lp_build_const_int32(gallivm, 0);
+   coro_id_args[1] = LLVMConstPointerNull(LLVMPointerType(LLVMInt8TypeInContext(gallivm->context), 0));
+   coro_id_args[2] = coro_id_args[1];
+   coro_id_args[3] = coro_id_args[1];
+   LLVMValueRef coro_id = lp_build_intrinsic(gallivm->builder,
+                                             "llvm.coro.id",
+                                             LLVMTokenTypeInContext(gallivm->context),
+                                             coro_id_args, 4, 0);
+   return coro_id;
+}
+
+LLVMValueRef lp_build_coro_size(struct gallivm_state *gallivm)
+{
+   return lp_build_intrinsic(gallivm->builder,
+                             "llvm.coro.size.i32",
+                             LLVMInt32TypeInContext(gallivm->context),
+                             NULL, 0, 0);
+}
+
+LLVMValueRef lp_build_coro_begin(struct gallivm_state *gallivm,
+                                 LLVMValueRef coro_id, LLVMValueRef mem_ptr)
+{
+   LLVMValueRef coro_begin_args[2];
+   coro_begin_args[0] = coro_id;
+   coro_begin_args[1] = mem_ptr;
+   LLVMValueRef coro_hdl = lp_build_intrinsic(gallivm->builder,
+                                              "llvm.coro.begin",
+                                              LLVMPointerType(LLVMInt8TypeInContext(gallivm->context), 0),
+                                              coro_begin_args, 2, 0);
+   return coro_hdl;
+}
+
+LLVMValueRef lp_build_coro_free(struct gallivm_state *gallivm,
+                                LLVMValueRef coro_id, LLVMValueRef coro_hdl)
+{
+   LLVMValueRef coro_free_args[2];
+   coro_free_args[0] = coro_id;
+   coro_free_args[1] = coro_hdl;
+   return lp_build_intrinsic(gallivm->builder,
+                             "llvm.coro.free",
+                             LLVMPointerType(LLVMInt8TypeInContext(gallivm->context), 0),
+                             coro_free_args, 2, 0);
+}
+
+void lp_build_coro_end(struct gallivm_state *gallivm, LLVMValueRef coro_hdl)
+{
+   LLVMValueRef coro_end_args[2];
+   coro_end_args[0] = coro_hdl;
+   coro_end_args[1] = LLVMConstInt(LLVMInt1TypeInContext(gallivm->context), 0, 0);
+   lp_build_intrinsic(gallivm->builder,
+                      "llvm.coro.end",
+                      LLVMInt1TypeInContext(gallivm->context),
+                      coro_end_args, 2, 0);
+}
+
+void lp_build_coro_resume(struct gallivm_state *gallivm, LLVMValueRef coro_hdl)
+{
+   lp_build_intrinsic(gallivm->builder,
+                      "llvm.coro.resume",
+                      LLVMVoidTypeInContext(gallivm->context),
+                      &coro_hdl, 1, 0);
+}
+
+void lp_build_coro_destroy(struct gallivm_state *gallivm, LLVMValueRef coro_hdl)
+{
+   lp_build_intrinsic(gallivm->builder,
+                      "llvm.coro.destroy",
+                      LLVMVoidTypeInContext(gallivm->context),
+                      &coro_hdl, 1, 0);
+}
+
+LLVMValueRef lp_build_coro_done(struct gallivm_state *gallivm, LLVMValueRef coro_hdl)
+{
+   return lp_build_intrinsic(gallivm->builder,
+                             "llvm.coro.done",
+                             LLVMInt1TypeInContext(gallivm->context),
+                             &coro_hdl, 1, 0);
+}
+
+LLVMValueRef lp_build_coro_suspend(struct gallivm_state *gallivm, bool last)
+{
+   LLVMValueRef coro_susp_args[2];
+   coro_susp_args[0] = LLVMConstNull(LLVMTokenTypeInContext(gallivm->context));
+   coro_susp_args[1] = LLVMConstInt(LLVMInt1TypeInContext(gallivm->context), last, 0);
+   LLVMValueRef coro_suspend = lp_build_intrinsic(gallivm->builder,
+                                                  "llvm.coro.suspend",
+                                                  LLVMInt8TypeInContext(gallivm->context),
+                                                  coro_susp_args, 2, 0);
+   return coro_suspend;
+}
+
+LLVMValueRef lp_build_coro_alloc(struct gallivm_state *gallivm, LLVMValueRef id)
+{
+   return lp_build_intrinsic(gallivm->builder,
+                             "llvm.coro.alloc",
+                             LLVMInt1TypeInContext(gallivm->context),
+                             &id, 1, 0);
+}
+
+static char *
+coro_malloc(int size)
+{
+   return os_malloc_aligned(size, 4096);
+}
+
+static void
+coro_free(char *ptr)
+{
+   os_free_aligned(ptr);
+}
+
+LLVMValueRef lp_build_coro_begin_alloc_mem(struct gallivm_state *gallivm, LLVMValueRef coro_id)
+{
+   LLVMValueRef do_alloc = lp_build_coro_alloc(gallivm, coro_id);
+   LLVMTypeRef mem_ptr_type = LLVMPointerType(LLVMInt8TypeInContext(gallivm->context), 0);
+   LLVMValueRef alloc_mem_store = lp_build_alloca(gallivm, mem_ptr_type, "coro mem");
+   struct lp_build_if_state if_state_coro;
+   lp_build_if(&if_state_coro, gallivm, do_alloc);
+   LLVMValueRef coro_size = lp_build_coro_size(gallivm);
+   LLVMValueRef alloc_mem;
+   LLVMTypeRef int32_type = LLVMInt32TypeInContext(gallivm->context);
+
+   LLVMTypeRef malloc_type = LLVMFunctionType(mem_ptr_type, &int32_type, 1, 0);
+
+   LLVMValueRef func_malloc = lp_build_const_int_pointer(gallivm, func_to_pointer((func_pointer)coro_malloc));
+   func_malloc = LLVMBuildBitCast(gallivm->builder, func_malloc, LLVMPointerType(malloc_type, 0), "coro_malloc");
+   alloc_mem = LLVMBuildCall(gallivm->builder, func_malloc, &coro_size, 1, "");
+
+   LLVMBuildStore(gallivm->builder, alloc_mem, alloc_mem_store);
+   lp_build_endif(&if_state_coro);
+   alloc_mem = LLVMBuildLoad(gallivm->builder, alloc_mem_store, "");
+   LLVMValueRef coro_hdl = lp_build_coro_begin(gallivm, coro_id, alloc_mem);
+   return coro_hdl;
+}
+
+void lp_build_coro_free_mem(struct gallivm_state *gallivm, LLVMValueRef coro_id, LLVMValueRef coro_hdl)
+{
+   LLVMValueRef alloc_mem = lp_build_coro_free(gallivm, coro_id, coro_hdl);
+   LLVMTypeRef ptr_type = LLVMPointerType(LLVMInt8TypeInContext(gallivm->context), 0);
+   LLVMTypeRef free_type = LLVMFunctionType(LLVMVoidTypeInContext(gallivm->context), &ptr_type, 1, 0);
+   LLVMValueRef func_free = lp_build_const_int_pointer(gallivm, func_to_pointer((func_pointer)coro_free));
+   func_free = LLVMBuildBitCast(gallivm->builder, func_free, LLVMPointerType(free_type, 0), "coro_free");
+   alloc_mem = LLVMBuildCall(gallivm->builder, func_free, &alloc_mem, 1, "");
+}
+
+void lp_build_coro_suspend_switch(struct gallivm_state *gallivm, const struct lp_build_coro_suspend_info *sus_info,
+                                  LLVMBasicBlockRef resume_block, bool final_suspend)
+{
+   LLVMValueRef coro_suspend = lp_build_coro_suspend(gallivm, final_suspend);
+   LLVMValueRef myswitch = LLVMBuildSwitch(gallivm->builder, coro_suspend,
+                                           sus_info->suspend, resume_block ? 2 : 1);
+   LLVMAddCase(myswitch, LLVMConstInt(LLVMInt8TypeInContext(gallivm->context), 1, 0), sus_info->cleanup);
+   if (resume_block)
+      LLVMAddCase(myswitch, LLVMConstInt(LLVMInt8TypeInContext(gallivm->context), 0, 0), resume_block);
+}

src/gallium/auxiliary/gallivm/lp_bld_coro.h

@@ -0,0 +1,69 @@
+/**************************************************************************
+ *
+ * Copyright 2019 Red Hat.
+ * 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 LP_BLD_CORO_H
+#define LP_BLD_CORO_H
+
+#include <stdbool.h>
+#include "pipe/p_compiler.h"
+#include "gallivm/lp_bld.h"
+
+struct gallivm_state;
+LLVMValueRef lp_build_coro_id(struct gallivm_state *gallivm);
+
+LLVMValueRef lp_build_coro_size(struct gallivm_state *gallivm);
+
+LLVMValueRef lp_build_coro_begin(struct gallivm_state *gallivm,
+                                 LLVMValueRef coro_id, LLVMValueRef mem_ptr);
+
+LLVMValueRef lp_build_coro_free(struct gallivm_state *gallivm,
+                                LLVMValueRef coro_id, LLVMValueRef coro_hdl);
+
+void lp_build_coro_end(struct gallivm_state *gallivm,
+                       LLVMValueRef coro_hdl);
+
+void lp_build_coro_resume(struct gallivm_state *gallivm, LLVMValueRef coro_hdl);
+
+void lp_build_coro_destroy(struct gallivm_state *gallivm, LLVMValueRef coro_hdl);
+
+LLVMValueRef lp_build_coro_done(struct gallivm_state *gallivm, LLVMValueRef coro_hdl);
+
+LLVMValueRef lp_build_coro_suspend(struct gallivm_state *gallivm, bool last);
+
+LLVMValueRef lp_build_coro_alloc(struct gallivm_state *gallivm, LLVMValueRef id);
+
+LLVMValueRef lp_build_coro_begin_alloc_mem(struct gallivm_state *gallivm, LLVMValueRef coro_id);
+void lp_build_coro_free_mem(struct gallivm_state *gallivm, LLVMValueRef coro_id, LLVMValueRef coro_hdl);
+
+struct lp_build_coro_suspend_info {
+   LLVMBasicBlockRef suspend;
+   LLVMBasicBlockRef cleanup;
+};
+
+void lp_build_coro_suspend_switch(struct gallivm_state *gallivm,
+                                  const struct lp_build_coro_suspend_info *sus_info,
+                                  LLVMBasicBlockRef resume_block,
+                                  bool final_suspend);
+#endif

src/gallium/auxiliary/meson.build

@@ -379,6 +379,8 @@ if with_llvm
     'gallivm/lp_bld_const.h',
     'gallivm/lp_bld_conv.c',
     'gallivm/lp_bld_conv.h',
+    'gallivm/lp_bld_coro.c',
+    'gallivm/lp_bld_coro.h',
     'gallivm/lp_bld_debug.cpp',
     'gallivm/lp_bld_debug.h',
     'gallivm/lp_bld_flow.c',