kernel_thread_globals.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2011-2022 Blender Foundation
 *
 * SPDX-License-Identifier: Apache-2.0 */
 
#pragma once
 
#include "kernel/device/cpu/compat.h"
#include "kernel/device/cpu/globals.h"
 
CCL_NAMESPACE_BEGIN
 
class Profiler;
 
/* A special class which extends memory ownership of the `KernelGlobalsCPU` decoupling any resource
 * which is not thread-safe for access. Every worker thread which needs to operate on
 * `KernelGlobalsCPU` needs to initialize its own copy of this object.
 *
 * NOTE: Only minimal subset of objects are copied: `KernelData` is never copied. This means that
 * there is no unnecessary data duplication happening when using this object. */
class CPUKernelThreadGlobals : public KernelGlobalsCPU {
 public:
  /* TODO(sergey): Would be nice to have properly typed OSLGlobals even in the case when building
   * without OSL support. Will avoid need to those unnamed pointers and casts. */
  CPUKernelThreadGlobals(const KernelGlobalsCPU &kernel_globals,
                         void *osl_globals_memory,
                         Profiler &cpu_profiler,
                         const int thread_index);
 
  ~CPUKernelThreadGlobals();
 
  CPUKernelThreadGlobals(const CPUKernelThreadGlobals &other) = delete;
  CPUKernelThreadGlobals(CPUKernelThreadGlobals &&other) noexcept;
 
  CPUKernelThreadGlobals &operator=(const CPUKernelThreadGlobals &other) = delete;
  CPUKernelThreadGlobals &operator=(CPUKernelThreadGlobals &&other);
 
  void start_profiling();
  void stop_profiling();
 
 protected:
  void clear_runtime_pointers();
 
  Profiler &cpu_profiler_;
};
 
CCL_NAMESPACE_END