Cycles: Initial implementation of detailed statistics

Gathers information about object geometry and textures. Very basic at
this moment, but need to start somewhere.

Things which needs to be included still:

- "Runtime" information, like BVH. While it is not directly controllable
  by artists, it's still important to know.

- Device array sizes. Again, not under artists control, but is added to
  the overall size.

- Memory peak at different synchronization stages.

At this point it simply prints info to the stdout after F12 is done,
need better control over that too.

Reviewers: brecht

Differential Revision: https://developer.blender.org/D3566

1 files changed, 104 insertions, 0 deletions

diff --git a/intern/cycles/render/stats.h b/intern/cycles/render/stats.h
new file mode 100644
index 00000000000..72d5f1dd93d
--- /dev/null
+++ b/intern/cycles/render/stats.h
@@ -0,0 +1,104 @@
+/*
+ * Copyright 2011-2018 Blender Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef __RENDER_STATS_H__
+#define __RENDER_STATS_H__
+
+#include "util/util_string.h"
+#include "util/util_vector.h"
+
+CCL_NAMESPACE_BEGIN
+
+/* Named statistics entry, which corresponds to a size. There is no real
+ * semantic around the units of size, it just should be the same for all
+ * entries.
+ *
+ * This is a generic entry foi all size-related statistics, which helps
+ * avoiding duplicating code for things like sorting.
+ */
+class NamedSizeEntry {
+public:
+	NamedSizeEntry();
+	NamedSizeEntry(const string& name, size_t size);
+
+	string name;
+	size_t size;
+};
+
+/* Container of named size entries. Used, for example, to store per-mesh memory
+ * usage statistics. But also keeps track of overall memory usage of the
+ * container.
+ */
+class NamedSizeStats {
+public:
+	NamedSizeStats();
+
+	/* Add entry to the statistics. */
+	void add_entry(const NamedSizeEntry& entry);
+
+	/* Generate full human-readable report. */
+	string full_report(int indent_level = 0);
+
+	/* Total size of all entries. */
+	size_t total_size;
+
+	/* NOTE: Is fine to read directly, but for adding use add_entry(), which
+	 * makes sure all accumulating  values are properly updated.
+	 */
+	vector<NamedSizeEntry> entries;
+};
+
+/* Statistics about mesh in the render database. */
+class MeshStats {
+public:
+	MeshStats();
+
+	/* Generate full human-readable report. */
+	string full_report(int indent_level = 0);
+
+	/* Input geometry statistics, this is what is coming as an input to render
+	 * from. say, Blender. This does not include runtime or engine specific
+	 * memory like BVH.
+	 */
+	NamedSizeStats geometry;
+};
+
+/* Statistics about images held in memory. */
+class ImageStats {
+public:
+	ImageStats();
+
+	/* Generate full human-readable report. */
+	string full_report(int indent_level = 0);
+
+	NamedSizeStats textures;
+};
+
+/* Render process statistics. */
+class RenderStats {
+public:
+	RenderStats();
+
+	/* Return full report as string. */
+	string full_report();
+
+	MeshStats mesh;
+	ImageStats image;
+};
+
+CCL_NAMESPACE_END
+
+#endif /* __RENDER_STATS_H__ */