path: root/source/blender/draw/intern/draw_manager_profiling.c

/*
 * Copyright 2016, Blender Foundation.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * Contributor(s): Blender Institute
 *
 */

/** \file draw_manager_profiling.c
 *  \ingroup draw
 */

#include "BLI_rect.h"
#include "BLI_string.h"

#include "BKE_global.h"

#include "BLF_api.h"

#include "MEM_guardedalloc.h"

#include "GPU_glew.h"

#include "WM_api.h"
#include "WM_types.h"

#include "draw_manager_profiling.h"

#define MAX_TIMER_NAME 32
#define MAX_NESTED_TIMER 8
#define CHUNK_SIZE 8
#define GPU_TIMER_FALLOFF 0.1

typedef struct DRWTimer {
	GLuint query[2];
	GLuint64 time_average;
	char name[MAX_TIMER_NAME];
	int lvl;                  /* Hierarchy level for nested timer. */
	bool is_query;            /* Does this timer actually perform queries or is it just a group. */
} DRWTimer;

static struct DRWTimerPool {
	DRWTimer *timers;
	int chunk_count;          /* Number of chunk allocated. */
	int timer_count;          /* chunk_count * CHUNK_SIZE */
	int timer_increment;      /* Keep track of where we are in the stack. */
	int end_increment;        /* Keep track of bad usage. */
	bool is_recording;        /* Are we in the render loop? */
	bool is_querying;         /* Keep track of bad usage. */
} DTP = {NULL};

void DRW_stats_free(void)
{
	if (DTP.timers != NULL) {
		for (int i = 0; i < DTP.timer_count; ++i) {
			DRWTimer *timer = &DTP.timers[i];
			glDeleteQueries(2, timer->query);
		}
		MEM_freeN(DTP.timers);
		DTP.timers = NULL;
	}
}

void DRW_stats_begin(void)
{
	if (G.debug_value > 20) {
		DTP.is_recording = true;
	}

	if (DTP.is_recording && DTP.timers == NULL) {
		DTP.chunk_count = 1;
		DTP.timer_count = DTP.chunk_count * CHUNK_SIZE;
		DTP.timers = MEM_callocN(sizeof(DRWTimer) * DTP.timer_count, "DRWTimer stack");
	}
	else if (!DTP.is_recording && DTP.timers != NULL) {
		DRW_stats_free();
	}

	DTP.is_querying = false;
	DTP.timer_increment = 0;
	DTP.end_increment = 0;
}

static DRWTimer *drw_stats_timer_get(void)
{
	if (UNLIKELY(DTP.timer_increment >= DTP.timer_count)) {
		/* Resize the stack. */
		DTP.chunk_count++;
		DTP.timer_count = DTP.chunk_count * CHUNK_SIZE;
		DTP.timers = MEM_recallocN(DTP.timers, sizeof(DRWTimer) * DTP.timer_count);
	}

	return &DTP.timers[DTP.timer_increment++];
}

static void drw_stats_timer_start_ex(const char *name, const bool is_query)
{
	if (DTP.is_recording) {
		DRWTimer *timer = drw_stats_timer_get();
		BLI_strncpy(timer->name, name, MAX_TIMER_NAME);
		timer->lvl = DTP.timer_increment - DTP.end_increment - 1;
		timer->is_query = is_query;

		/* Queries cannot be nested or interleaved. */
		BLI_assert(!DTP.is_querying);
		if (timer->is_query) {
			if (timer->query[0] == 0) {
				glGenQueries(1, timer->query);
			}

			/* Issue query for the next frame */
			glBeginQuery(GL_TIME_ELAPSED, timer->query[0]);
			DTP.is_querying = true;
		}
	}
}

/* Use this to group the queries. It does NOT keep track
 * of the time, it only sum what the queries inside it. */
void DRW_stats_group_start(const char *name)
{
	drw_stats_timer_start_ex(name, false);
}

void DRW_stats_group_end(void)
{
	if (DTP.is_recording) {
		BLI_assert(!DTP.is_querying);
		DTP.end_increment++;
	}
}

/* NOTE: Only call this when no sub timer will be called. */
void DRW_stats_query_start(const char *name)
{
	drw_stats_timer_start_ex(name, true);
}

void DRW_stats_query_end(void)
{
	if (DTP.is_recording) {
		DTP.end_increment++;
		BLI_assert(DTP.is_querying);
		glEndQuery(GL_TIME_ELAPSED);
		DTP.is_querying = false;
	}
}

void DRW_stats_reset(void)
{
	BLI_assert((DTP.timer_increment - DTP.end_increment) <= 0 && "You forgot a DRW_stats_group/query_end somewhere!");
	BLI_assert((DTP.timer_increment - DTP.end_increment) >= 0 && "You forgot a DRW_stats_group/query_start somewhere!");

	if (DTP.is_recording) {
		GLuint64 lvl_time[MAX_NESTED_TIMER] = {0};

		/* Swap queries for the next frame and sum up each lvl time. */
		for (int i = DTP.timer_increment - 1; i >= 0; --i) {
			DRWTimer *timer = &DTP.timers[i];
			SWAP(GLuint, timer->query[0], timer->query[1]);

			BLI_assert(timer->lvl < MAX_NESTED_TIMER);

			if (timer->is_query) {
				GLuint64 time;
				if (timer->query[0] != 0) {
					glGetQueryObjectui64v(timer->query[0], GL_QUERY_RESULT, &time);
				}
				else {
					time = 1000000000; /* 1ms default */
				}

				timer->time_average = timer->time_average * (1.0 - GPU_TIMER_FALLOFF) + time * GPU_TIMER_FALLOFF;
				timer->time_average = MIN2(timer->time_average, 1000000000);
			}
			else {
				timer->time_average = lvl_time[timer->lvl + 1];
				lvl_time[timer->lvl + 1] = 0;
			}

			lvl_time[timer->lvl] += timer->time_average;
		}

		DTP.is_recording = false;
	}
}

void DRW_stats_draw(rcti *rect)
{
	char stat_string[64];
	int lvl_index[MAX_NESTED_TIMER];
	int v = 0;

	BLI_snprintf(stat_string, sizeof(stat_string), "GPU Render Stats");
	BLF_draw_default_ascii(rect->xmin + 1 * U.widget_unit, rect->ymax - v++ * U.widget_unit, 0.0f, stat_string, sizeof(stat_string));

	for (int i = 0; i < DTP.timer_increment; ++i) {
		double time_ms, time_percent;
		DRWTimer *timer = &DTP.timers[i];
		DRWTimer *timer_parent = (timer->lvl > 0) ? &DTP.timers[lvl_index[timer->lvl - 1]] : NULL;

		/* Only display a number of lvl at a time */
		if ((G.debug_value - 21) < timer->lvl) continue;

		BLI_assert(timer->lvl < MAX_NESTED_TIMER);
		lvl_index[timer->lvl] = i;

		time_ms = timer->time_average / 1000000.0;

		if (timer_parent != NULL) {
			time_percent = ((double)timer->time_average / (double)timer_parent->time_average) * 100.0;
		}
		else {
			time_percent = 100.0;
		}

		/* avoid very long number */
		time_ms = MIN2(time_ms, 999.0);
		time_percent = MIN2(time_percent, 100.0);

		BLI_snprintf(stat_string, sizeof(stat_string), "%s", timer->name);
		BLF_draw_default_ascii(rect->xmin + (1 + timer->lvl) * U.widget_unit, rect->ymax - v * U.widget_unit, 0.0f, stat_string, sizeof(stat_string));
		BLI_snprintf(stat_string, sizeof(stat_string), "%.2fms", time_ms);
		BLF_draw_default_ascii(rect->xmin + (13 + timer->lvl) * U.widget_unit, rect->ymax - v * U.widget_unit, 0.0f, stat_string, sizeof(stat_string));
		BLI_snprintf(stat_string, sizeof(stat_string), "%.0f", time_percent);
		BLF_draw_default_ascii(rect->xmin + (17 + timer->lvl) * U.widget_unit, rect->ymax - v * U.widget_unit, 0.0f, stat_string, sizeof(stat_string));
		v++;
	}
}