Server-side chunk sending decision

docs/network-protocol.md

@@ -72,6 +72,14 @@ Packet sent at the beginning of every server tick.
 | - Block data  | u32         | Block ID and data                                    |
 | - Light value | u8          | Sunlight and torchlight values                       |
 
+#### ChunkUnload
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Chunk X       | s32         | Chunk X coordinate                                   |
+| Chunk Y       | s32         | Chunk Y coordinate                                   |
+| Chunk Z       | s32         | Chunk Z coordinate                                   |
+
 #### PlayerInvUpdate (clientbound)
 
 | Field name    | Field type  | Notes                                                |
@@ -260,6 +268,20 @@ Packet sent at the beginning of every server tick.
 | Hotbar slot   | u8          | ID of the current hotbar slot                        |
 | Item ID       | u16         | Current item ID (to check match with server)         |
 
+#### PlayerReady
+
+Packet sent from a client when it is ready to receive chunks.
+
+_This packet has no field._
+
+#### PlayerChunkPosUpdate
+
+| Field name    | Field type  | Notes                                                |
+| ------------- | ----------- | ---------------------------------------------------- |
+| Chunk X       | s32         | Chunk X coordinate                                   |
+| Chunk Y       | s32         | Chunk Y coordinate                                   |
+| Chunk Z       | s32         | Chunk Z coordinate                                   |
+
 #### BlockActivated
 
 | Field name    | Field type  | Notes                                                |

external/backtrace.hpp

@@ -0,0 +1,87 @@
+/*
+ * Copyright (c) 2009-2017, Farooq Mela
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+#ifndef BACKTRACE_HPP_
+#define BACKTRACE_HPP_
+
+#include <cstdio>
+#include <string>
+
+#ifdef _WIN32
+static std::string Backtrace(int skip = 1)
+{
+	std::string buf = "Backtrace is not available on Windows.";
+	printf("%s\n", buf.c_str());
+	return buf;
+}
+#else
+
+#include <execinfo.h> // for backtrace
+#include <dlfcn.h>    // for dladdr
+#include <cxxabi.h>   // for __cxa_demangle
+
+#include <cstdlib>
+#include <sstream>
+
+// This function produces a stack backtrace with demangled function & method names.
+// Needs compilation with --export-dynamic or -Wl,-export-dynamic
+// From https://gist.github.com/fmela/591333
+static std::string Backtrace(int skip = 1)
+{
+    void *callstack[128];
+    const int nMaxFrames = sizeof(callstack) / sizeof(callstack[0]);
+    char buf[1024];
+    int nFrames = backtrace(callstack, nMaxFrames);
+    char **symbols = backtrace_symbols(callstack, nFrames);
+
+    std::ostringstream trace_buf;
+    for (int i = skip; i < nFrames; i++) {
+        printf("%s\n", symbols[i]);
+
+        Dl_info info;
+        if (dladdr(callstack[i], &info) && info.dli_sname) {
+            char *demangled = NULL;
+            int status = -1;
+            if (info.dli_sname[0] == '_')
+                demangled = abi::__cxa_demangle(info.dli_sname, NULL, 0, &status);
+            snprintf(buf, sizeof(buf), "%-3d %*p %s + %zd\n",
+                     i, int(2 + sizeof(void*) * 2), callstack[i],
+                     status == 0 ? demangled :
+                     info.dli_sname == 0 ? symbols[i] : info.dli_sname,
+                     (char *)callstack[i] - (char *)info.dli_saddr);
+            free(demangled);
+        } else {
+            snprintf(buf, sizeof(buf), "%-3d %*p %s\n",
+                     i, int(2 + sizeof(void*) * 2), callstack[i], symbols[i]);
+        }
+        trace_buf << buf;
+    }
+    free(symbols);
+    if (nFrames == nMaxFrames)
+        trace_buf << "[truncated]\n";
+    return trace_buf.str();
+}
+
+#endif // _WIN32
+
+#endif // BACKTRACE_HPP_

misc/deploy.sh

@@ -30,7 +30,6 @@ cp /usr/i686-w64-mingw32/bin/libwinpthread-1.dll deploy/win32/bin/openminer && \
 cp /usr/i686-w64-mingw32/bin/libssp-0.dll deploy/win32/bin/openminer && \
 cp /usr/i686-w64-mingw32/bin/zlib1.dll deploy/win32/bin/openminer && \
 cp /usr/i686-w64-mingw32/bin/libgcc_s_dw2-1.dll deploy/win32/bin/openminer && \
-cp deploy/win32/libjpeg.dll deploy/win32/bin/openminer && \
 mkdir -p deploy/win32/bin/openminer/docs/markdown && \
 cp docs/*.md deploy/win32/bin/openminer/docs/markdown/ && \
 cp -r deploy/html_docs deploy/win32/bin/openminer/docs/html && \
@@ -50,7 +49,6 @@ cp /usr/x86_64-w64-mingw32/bin/libwinpthread-1.dll deploy/win64/bin/openminer &&
 cp /usr/x86_64-w64-mingw32/bin/libssp-0.dll deploy/win64/bin/openminer && \
 cp /usr/x86_64-w64-mingw32/bin/zlib1.dll deploy/win64/bin/openminer && \
 cp /usr/x86_64-w64-mingw32/bin/libgcc_s_seh-1.dll deploy/win64/bin/openminer && \
-cp deploy/win64/libjpeg.dll deploy/win64/bin/openminer && \
 mkdir -p deploy/win64/bin/openminer/docs/markdown && \
 cp docs/*.md deploy/win64/bin/openminer/docs/markdown/ && \
 cp -r deploy/html_docs deploy/win64/bin/openminer/docs/html && \
@@ -75,7 +73,6 @@ cp /usr/lib/ld-linux-x86-64.so.2 \
 /usr/lib/libglib-2.0.so.0 \
 /usr/lib/libGLU.so.1 \
 /usr/lib/libGLX.so.0 \
-/usr/lib/libjpeg.so.8 \
 /usr/lib/libm.so.6 \
 /usr/lib/libpcre.so.1 \
 /usr/lib/libpthread.so.0 \

mods/default/blocks.lua

@@ -241,8 +241,6 @@ mod:block {
 		}
 
 		server:send_player_change_dimension(client.id, pos.x, pos.y, pos.z, dim, client)
-		player:set_dimension(dim)
-		-- player:set_position(pos.x, pos.y, pos.z)
 	end,
 }
 

mods/default/listeners.lua

@@ -43,7 +43,7 @@ openminer:add_listener(Event.PlayerConnected, function(pos, player, client, serv
 	player:inventory():add_stack("default:stone_axe", 1)
 
 	server:send_chat_message(0, "Welcome to OpenMiner!", client)
-	server:send_chat_message(0, "Press E to show inventory", client)
-	server:send_chat_message(0, "Press H to show creative inventory", client)
+	server:send_chat_message(0, "Press E to open inventory", client)
+	server:send_chat_message(0, "Press H to open creative inventory", client)
 end)
 

source/client/core/ClientApplication.cpp

@@ -64,12 +64,12 @@ bool ClientApplication::init() {
 
 	gk::CoreApplication::init();
 
-	m_window.addVertexAttribute(VertexAttribute::Coord3d, "coord3d", 4, GL_FLOAT, GL_FALSE, sizeof(Vertex), reinterpret_cast<GLvoid *>(offsetof(Vertex, coord3d)));
-	m_window.addVertexAttribute(VertexAttribute::TexCoord, "texCoord", 2, GL_FLOAT, GL_FALSE, sizeof(Vertex), reinterpret_cast<GLvoid *>(offsetof(Vertex, texCoord)));
-	m_window.addVertexAttribute(VertexAttribute::Color, "color", 4, GL_FLOAT, GL_FALSE, sizeof(Vertex), reinterpret_cast<GLvoid *>(offsetof(Vertex, color)));
-	m_window.addVertexAttribute(VertexAttribute::Normal, "normal", 3, GL_FLOAT, GL_FALSE, sizeof(Vertex), reinterpret_cast<GLvoid *>(offsetof(Vertex, normal)));
-	m_window.addVertexAttribute(VertexAttribute::LightValue, "lightValue", 2, GL_FLOAT, GL_FALSE, sizeof(Vertex), reinterpret_cast<GLvoid *>(offsetof(Vertex, lightValue)));
-	m_window.addVertexAttribute(VertexAttribute::AmbientOcclusion, "ambientOcclusion", 1, GL_FLOAT, GL_FALSE, sizeof(Vertex), reinterpret_cast<GLvoid *>(offsetof(Vertex, ambientOcclusion)));
+	m_window.addVertexAttribute(VertexAttribute::Coord3d, 0, "coord3d", 4, GL_FLOAT, GL_FALSE, sizeof(Vertex), reinterpret_cast<GLvoid *>(offsetof(Vertex, coord3d)));
+	m_window.addVertexAttribute(VertexAttribute::TexCoord, 1, "texCoord", 2, GL_FLOAT, GL_FALSE, sizeof(Vertex), reinterpret_cast<GLvoid *>(offsetof(Vertex, texCoord)));
+	m_window.addVertexAttribute(VertexAttribute::Color, 2, "color", 4, GL_FLOAT, GL_FALSE, sizeof(Vertex), reinterpret_cast<GLvoid *>(offsetof(Vertex, color)));
+	m_window.addVertexAttribute(VertexAttribute::Normal, 3, "normal", 3, GL_FLOAT, GL_FALSE, sizeof(Vertex), reinterpret_cast<GLvoid *>(offsetof(Vertex, normal)));
+	m_window.addVertexAttribute(VertexAttribute::LightValue, 4, "lightValue", 2, GL_FLOAT, GL_FALSE, sizeof(Vertex), reinterpret_cast<GLvoid *>(offsetof(Vertex, lightValue)));
+	m_window.addVertexAttribute(VertexAttribute::AmbientOcclusion, 5, "ambientOcclusion", 1, GL_FLOAT, GL_FALSE, sizeof(Vertex), reinterpret_cast<GLvoid *>(offsetof(Vertex, ambientOcclusion)));
 
 	if (m_argumentParser.getArgument("help").isFound)
 		return true;

source/client/core/ClientProfiler.cpp

@@ -0,0 +1,87 @@
+/*
+ * =====================================================================================
+ *
+ *  OpenMiner
+ *
+ *  Copyright (C) 2018-2020 Unarelith, Quentin Bazin <[email protected]>
+ *  Copyright (C) 2019-2020 the OpenMiner contributors (see CONTRIBUTORS.md)
+ *
+ *  This file is part of OpenMiner.
+ *
+ *  OpenMiner is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License as published by the Free Software Foundation; either
+ *  version 2.1 of the License, or (at your option) any later version.
+ *
+ *  OpenMiner 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
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public License
+ *  along with OpenMiner; if not, write to the Free Software Foundation, Inc.,
+ *  51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
+ *
+ * =====================================================================================
+ */
+#include <gk/core/Debug.hpp>
+#include <gk/core/GameClock.hpp>
+
+#include "ClientProfiler.hpp"
+
+ClientProfiler *ClientProfiler::s_instance = nullptr;
+
+void ClientProfiler::onBeginTick() {
+	m_ticks.emplace_back();
+	m_ticks.back().begin = gk::GameClock::getInstance().getTicks(true);
+}
+
+void ClientProfiler::onEndTick() {
+	m_ticks.back().end = gk::GameClock::getInstance().getTicks(true);
+}
+
+void ClientProfiler::startAction(const std::string &name) {
+	m_ticks.back().actions[name].durations.emplace_back();
+	m_ticks.back().actions[name].durations.back().first = gk::GameClock::getInstance().getTicks(true);
+}
+
+void ClientProfiler::endAction(const std::string &name) {
+	m_ticks.back().actions[name].durations.back().second = gk::GameClock::getInstance().getTicks(true);
+}
+
+void ClientProfiler::dump(u64 tickDurationMin) {
+	std::unordered_map<std::string, std::pair<u64, u64>> maxActionDuration;
+
+	u64 i = 0;
+	for (auto &tick : m_ticks) {
+		u64 tickDuration = tick.end - tick.begin;
+		if (tickDuration < tickDurationMin) continue;
+
+		gkDebug() << "Tick" << i++ << "took" << tickDuration << "ms";
+
+		if (tickDuration > 0) {
+			for (auto &[actionName, action] : tick.actions) {
+				u64 j = 0;
+				for (auto &[begin, end] : action.durations) {
+					u64 actionDuration = end - begin;
+
+					if (maxActionDuration.find(actionName) == maxActionDuration.end())
+						maxActionDuration.emplace(actionName, std::make_pair(actionDuration, 0));
+
+					maxActionDuration[actionName].first = std::max(maxActionDuration[actionName].first, actionDuration);
+
+					float actionPercentTotal = actionDuration / (float)tickDuration * 100.f;
+
+					gkDebug() << "Action" << actionName << j++ << "took" << actionDuration << "ms -" << actionPercentTotal << "% of tick";
+				}
+
+				maxActionDuration[actionName].second = std::max(maxActionDuration[actionName].second, j);
+			}
+		}
+	}
+
+	for (auto &[actionName, pair] : maxActionDuration) {
+		gkDebug() << "Max duration for action" << actionName << ":" << pair.first << "ms (" << pair.second << ")";
+	}
+}
+

source/client/core/ClientProfiler.hpp

@@ -0,0 +1,65 @@
+/*
+ * =====================================================================================
+ *
+ *  OpenMiner
+ *
+ *  Copyright (C) 2018-2020 Unarelith, Quentin Bazin <[email protected]>
+ *  Copyright (C) 2019-2020 the OpenMiner contributors (see CONTRIBUTORS.md)
+ *
+ *  This file is part of OpenMiner.
+ *
+ *  OpenMiner is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License as published by the Free Software Foundation; either
+ *  version 2.1 of the License, or (at your option) any later version.
+ *
+ *  OpenMiner 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
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public License
+ *  along with OpenMiner; if not, write to the Free Software Foundation, Inc.,
+ *  51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
+ *
+ * =====================================================================================
+ */
+#ifndef CLIENTPROFILER_HPP_
+#define CLIENTPROFILER_HPP_
+
+#include <deque>
+#include <string>
+#include <unordered_map>
+
+#include <gk/core/IntTypes.hpp>
+
+struct ClientAction {
+	std::deque<std::pair<u64, u64>> durations;
+};
+
+struct ClientTick {
+	u64 begin;
+	u64 end;
+	std::unordered_map<std::string, ClientAction> actions;
+};
+
+class ClientProfiler {
+	public:
+		void onBeginTick();
+		void onEndTick();
+
+		void dump(u64 tickDurationMin = 0);
+
+		void startAction(const std::string &name);
+		void endAction(const std::string &name);
+
+		static ClientProfiler &getInstance() { return *s_instance; }
+		static void setInstance(ClientProfiler *instance) { s_instance = instance; }
+
+	private:
+		static ClientProfiler *s_instance;
+
+		std::deque<ClientTick> m_ticks;
+};
+
+#endif // CLIENTPROFILER_HPP_

source/client/core/Config.cpp

@@ -67,6 +67,7 @@ u8 Config::mouseSensitivity = 8;
 
 // Debug
 bool Config::isChunkMinimapEnabled = false;
+bool Config::isLightmapViewerEnabled = false;
 
 // Other
 std::string Config::defaultUsername = "";
@@ -110,6 +111,7 @@ void Config::loadConfigFromFile(const char *filename) {
 			mouseSensitivity = lua["mouseSensitivity"].get_or(mouseSensitivity);
 
 			isChunkMinimapEnabled = lua["isChunkMinimapEnabled"].get_or(isChunkMinimapEnabled);
+			isLightmapViewerEnabled = lua["isLightmapViewerEnabled"].get_or(isLightmapViewerEnabled);
 
 			defaultUsername = lua["defaultUsername"].get_or(defaultUsername);
 			defaultServerAddress = lua["defaultServerAddress"].get_or(defaultServerAddress);
@@ -150,6 +152,7 @@ void Config::saveConfigToFile(const char *filename) {
 	file << "mouseSensitivity = " << (u16)mouseSensitivity << std::endl;
 	file << std::endl;
 	file << "isChunkMinimapEnabled = " << (isChunkMinimapEnabled ? "true" : "false") << std::endl;
+	file << "isLightmapViewerEnabled = " << (isLightmapViewerEnabled ? "true" : "false") << std::endl;
 	file << std::endl;
 	file << "defaultUsername = \"" << defaultUsername << "\"" << std::endl;
 	file << "defaultServerAddress = \"" << defaultServerAddress << "\"" << std::endl;

source/client/core/Config.hpp

@@ -62,6 +62,7 @@ namespace Config {
 
 	// Debug
 	extern bool isChunkMinimapEnabled;
+	extern bool isLightmapViewerEnabled;
 
 	// Other
 	extern std::string defaultUsername;