src/gallium/auxiliary/util/u_helpers.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2012 Marek Olšák <maraeo@gmail.com>
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL THE AUTHORS AND/OR THEIR SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 #include "util/u_cpu_detect.h"
  29 #include "util/u_helpers.h"
  30 #include "util/u_inlines.h"
  31 #include "util/u_upload_mgr.h"
  32 #include "util/u_thread.h"
  33 #include <inttypes.h>
  34
  35 /**
  36  * This function is used to copy an array of pipe_vertex_buffer structures,
  37  * while properly referencing the pipe_vertex_buffer::buffer member.
  38  *
  39  * enabled_buffers is updated such that the bits corresponding to the indices
  40  * of disabled buffers are set to 0 and the enabled ones are set to 1.
  41  *
  42  * \sa util_copy_framebuffer_state
  43  */
  44 void util_set_vertex_buffers_mask(struct pipe_vertex_buffer *dst,
  45                                   uint32_t *enabled_buffers,
  46                                   const struct pipe_vertex_buffer *src,
  47                                   unsigned start_slot, unsigned count)
  48 {
  49    unsigned i;
  50    uint32_t bitmask = 0;
  51
  52    dst += start_slot;
  53
  54    if (src) {
  55       for (i = 0; i < count; i++) {
  56          if (src[i].buffer.resource)
  57             bitmask |= 1 << i;
  58
  59          pipe_vertex_buffer_unreference(&dst[i]);
  60
  61          if (!src[i].is_user_buffer)
  62             pipe_resource_reference(&dst[i].buffer.resource, src[i].buffer.resource);
  63       }
  64
  65       /* Copy over the other members of pipe_vertex_buffer. */
  66       memcpy(dst, src, count * sizeof(struct pipe_vertex_buffer));
  67
  68       *enabled_buffers &= ~(((1ull << count) - 1) << start_slot);
  69       *enabled_buffers |= bitmask << start_slot;
  70    }
  71    else {
  72       /* Unreference the buffers. */
  73       for (i = 0; i < count; i++)
  74          pipe_vertex_buffer_unreference(&dst[i]);
  75
  76       *enabled_buffers &= ~(((1ull << count) - 1) << start_slot);
  77    }
  78 }
  79
  80 /**
  81  * Same as util_set_vertex_buffers_mask, but it only returns the number
  82  * of bound buffers.
  83  */
  84 void util_set_vertex_buffers_count(struct pipe_vertex_buffer *dst,
  85                                    unsigned *dst_count,
  86                                    const struct pipe_vertex_buffer *src,
  87                                    unsigned start_slot, unsigned count)
  88 {
  89    unsigned i;
  90    uint32_t enabled_buffers = 0;
  91
  92    for (i = 0; i < *dst_count; i++) {
  93       if (dst[i].buffer.resource)
  94          enabled_buffers |= (1ull << i);
  95    }
  96
  97    util_set_vertex_buffers_mask(dst, &enabled_buffers, src, start_slot,
  98                                 count);
  99
 100    *dst_count = util_last_bit(enabled_buffers);
 101 }
 102
 103 /**
 104  * Given a user index buffer, save the structure to "saved", and upload it.
 105  */
 106 bool
 107 util_upload_index_buffer(struct pipe_context *pipe,
 108                          const struct pipe_draw_info *info,
 109                          struct pipe_resource **out_buffer,
 110                          unsigned *out_offset)
 111 {
 112    unsigned start_offset = info->start * info->index_size;
 113
 114    u_upload_data(pipe->stream_uploader, start_offset,
 115                  info->count * info->index_size, 4,
 116                  (char*)info->index.user + start_offset,
 117                  out_offset, out_buffer);
 118    u_upload_unmap(pipe->stream_uploader);
 119    *out_offset -= start_offset;
 120    return *out_buffer != NULL;
 121 }
 122
 123 /**
 124  * Called by MakeCurrent. Used to notify the driver that the application
 125  * thread may have been changed.
 126  *
 127  * The function pins the current thread and driver threads to a group of
 128  * CPU cores that share the same L3 cache. This is needed for good multi-
 129  * threading performance on AMD Zen CPUs.
 130  *
 131  * \param upper_thread  thread in the state tracker that also needs to be
 132  *                      pinned.
 133  */
 134 void
 135 util_context_thread_changed(struct pipe_context *ctx, thrd_t *upper_thread)
 136 {
 137    thrd_t current = thrd_current();
 138    int cache = util_get_L3_for_pinned_thread(current,
 139                                              util_cpu_caps.cores_per_L3);
 140
 141    /* If the main thread is not pinned, choose the L3 cache. */
 142    if (cache == -1) {
 143       unsigned num_caches = util_cpu_caps.nr_cpus /
 144                             util_cpu_caps.cores_per_L3;
 145       static unsigned last_cache;
 146
 147       /* Choose a different L3 cache for each subsequent MakeCurrent. */
 148       cache = p_atomic_inc_return(&last_cache) % num_caches;
 149       util_pin_thread_to_L3(current, cache, util_cpu_caps.cores_per_L3);
 150    }
 151
 152    /* Tell the driver to pin its threads to the same L3 cache. */
 153    if (ctx->set_context_param) {
 154       ctx->set_context_param(ctx, PIPE_CONTEXT_PARAM_PIN_THREADS_TO_L3_CACHE,
 155                              cache);
 156    }
 157
 158    /* Do the same for the upper level thread if there is any (e.g. glthread) */
 159    if (upper_thread)
 160       util_pin_thread_to_L3(*upper_thread, cache, util_cpu_caps.cores_per_L3);
 161 }
 162
 163 /* This is a helper for hardware bring-up. Don't remove. */
 164 struct pipe_query *
 165 util_begin_pipestat_query(struct pipe_context *ctx)
 166 {
 167    struct pipe_query *q =
 168       ctx->create_query(ctx, PIPE_QUERY_PIPELINE_STATISTICS, 0);
 169    if (!q)
 170       return NULL;
 171
 172    ctx->begin_query(ctx, q);
 173    return q;
 174 }
 175
 176 /* This is a helper for hardware bring-up. Don't remove. */
 177 void
 178 util_end_pipestat_query(struct pipe_context *ctx, struct pipe_query *q,
 179                         FILE *f)
 180 {
 181    static unsigned counter;
 182    struct pipe_query_data_pipeline_statistics stats;
 183
 184    ctx->end_query(ctx, q);
 185    ctx->get_query_result(ctx, q, true, (void*)&stats);
 186    ctx->destroy_query(ctx, q);
 187
 188    fprintf(f,
 189            "Draw call %u:\n"
 190            "    ia_vertices    = %"PRIu64"\n"
 191            "    ia_primitives  = %"PRIu64"\n"
 192            "    vs_invocations = %"PRIu64"\n"
 193            "    gs_invocations = %"PRIu64"\n"
 194            "    gs_primitives  = %"PRIu64"\n"
 195            "    c_invocations  = %"PRIu64"\n"
 196            "    c_primitives   = %"PRIu64"\n"
 197            "    ps_invocations = %"PRIu64"\n"
 198            "    hs_invocations = %"PRIu64"\n"
 199            "    ds_invocations = %"PRIu64"\n"
 200            "    cs_invocations = %"PRIu64"\n",
 201            p_atomic_inc_return(&counter),
 202            stats.ia_vertices,
 203            stats.ia_primitives,
 204            stats.vs_invocations,
 205            stats.gs_invocations,
 206            stats.gs_primitives,
 207            stats.c_invocations,
 208            stats.c_primitives,
 209            stats.ps_invocations,
 210            stats.hs_invocations,
 211            stats.ds_invocations,
 212            stats.cs_invocations);
 213 }
 214
 215 /* This is a helper for hardware bring-up. Don't remove. */
 216 void
 217 util_wait_for_idle(struct pipe_context *ctx)
 218 {
 219    struct pipe_fence_handle *fence = NULL;
 220
 221    ctx->flush(ctx, &fence, 0);
 222    ctx->screen->fence_finish(ctx->screen, NULL, fence, PIPE_TIMEOUT_INFINITE);
 223 }
 224
 225 void
 226 util_throttle_init(struct util_throttle *t, uint64_t max_mem_usage)
 227 {
 228    t->max_mem_usage = max_mem_usage;
 229 }
 230
 231 void
 232 util_throttle_deinit(struct pipe_screen *screen, struct util_throttle *t)
 233 {
 234    for (unsigned i = 0; i < ARRAY_SIZE(t->ring); i++)
 235       screen->fence_reference(screen, &t->ring[i].fence, NULL);
 236 }
 237
 238 static uint64_t
 239 util_get_throttle_total_memory_usage(struct util_throttle *t)
 240 {
 241    uint64_t total_usage = 0;
 242
 243    for (unsigned i = 0; i < ARRAY_SIZE(t->ring); i++)
 244       total_usage += t->ring[i].mem_usage;
 245    return total_usage;
 246 }
 247
 248 static void util_dump_throttle_ring(struct util_throttle *t)
 249 {
 250    printf("Throttle:\n");
 251    for (unsigned i = 0; i < ARRAY_SIZE(t->ring); i++) {
 252       printf("  ring[%u]: fence = %s, mem_usage = %"PRIu64"%s%s\n",
 253              i, t->ring[i].fence ? "yes" : " no",
 254              t->ring[i].mem_usage,
 255              t->flush_index == i ? " [flush]" : "",
 256              t->wait_index == i ? " [wait]" : "");
 257    }
 258 }
 259
 260 /**
 261  * Notify util_throttle that the next operation allocates memory.
 262  * util_throttle tracks memory usage and waits for fences until its tracked
 263  * memory usage decreases.
 264  *
 265  * Example:
 266  *   util_throttle_memory_usage(..., w*h*d*Bpp);
 267  *   TexSubImage(..., w, h, d, ...);
 268  *
 269  * This means that TexSubImage can't allocate more memory its maximum limit
 270  * set during initialization.
 271  */
 272 void
 273 util_throttle_memory_usage(struct pipe_context *pipe,
 274                            struct util_throttle *t, uint64_t memory_size)
 275 {
 276    (void)util_dump_throttle_ring; /* silence warning */
 277
 278    if (!t->max_mem_usage)
 279       return;
 280
 281    struct pipe_screen *screen = pipe->screen;
 282    struct pipe_fence_handle **fence = NULL;
 283    unsigned ring_size = ARRAY_SIZE(t->ring);
 284    uint64_t total = util_get_throttle_total_memory_usage(t);
 285
 286    /* If there is not enough memory, walk the list of fences and find
 287     * the latest one that we need to wait for.
 288     */
 289    while (t->wait_index != t->flush_index &&
 290           total && total + memory_size > t->max_mem_usage) {
 291       assert(t->ring[t->wait_index].fence);
 292
 293       /* Release an older fence if we need to wait for a newer one. */
 294       if (fence)
 295          screen->fence_reference(screen, fence, NULL);
 296
 297       fence = &t->ring[t->wait_index].fence;
 298       t->ring[t->wait_index].mem_usage = 0;
 299       t->wait_index = (t->wait_index + 1) % ring_size;
 300
 301       total = util_get_throttle_total_memory_usage(t);
 302    }
 303
 304    /* Wait for the fence to decrease memory usage. */
 305    if (fence) {
 306       screen->fence_finish(screen, pipe, *fence, PIPE_TIMEOUT_INFINITE);
 307       screen->fence_reference(screen, fence, NULL);
 308    }
 309
 310    /* Flush and get a fence if we've exhausted memory usage for the current
 311     * slot.
 312     */
 313    if (t->ring[t->flush_index].mem_usage &&
 314        t->ring[t->flush_index].mem_usage + memory_size >
 315        t->max_mem_usage / (ring_size / 2)) {
 316       struct pipe_fence_handle **fence =
 317          &t->ring[t->flush_index].fence;
 318
 319       /* Expect that the current flush slot doesn't have a fence yet. */
 320       assert(!*fence);
 321
 322       pipe->flush(pipe, fence, PIPE_FLUSH_ASYNC);
 323       t->flush_index = (t->flush_index + 1) % ring_size;
 324
 325       /* Vacate the next slot if it's occupied. This should be rare. */
 326       if (t->flush_index == t->wait_index) {
 327          struct pipe_fence_handle **fence =
 328             &t->ring[t->wait_index].fence;
 329
 330          t->ring[t->wait_index].mem_usage = 0;
 331          t->wait_index = (t->wait_index + 1) % ring_size;
 332
 333          assert(*fence);
 334          screen->fence_finish(screen, pipe, *fence, PIPE_TIMEOUT_INFINITE);
 335          screen->fence_reference(screen, fence, NULL);
 336       }
 337
 338       assert(!t->ring[t->flush_index].mem_usage);
 339       assert(!t->ring[t->flush_index].fence);
 340    }
 341
 342    t->ring[t->flush_index].mem_usage += memory_size;
 343 }