WesnothdDesign - Revision history

Egallager: /* Overview */ wikify

2023-05-07T04:12:10Z

Overview: wikify

← Older revision		Revision as of 04:12, 7 May 2023
Line 3:		Line 3:
	This page documents the design of wesnothd, Wesnoth's multiplayer server. This document was written after I (Dave) re-designed wesnothd to try and make it more efficient.		This page documents the design of wesnothd, Wesnoth's multiplayer server. This document was written after I (Dave) re-designed wesnothd to try and make it more efficient.

	Wesnothd is a network server written in C++. It shares some of Wesnoth's code, in particular the networking code. Wesnothd manages requests from Wesnoth, that are sent in WML. It manages a lobby of players who can chat with each other, create games, join games, observe games, and so forth. Wesnothd maintains a list of games, users, and so forth. Wesnothd largely operates by relaying messages to the appropriate clients. For instance, if a player in a game makes a move, wesnothd will relay this to all clients who are participating in the game. Wesnothd may also perform appropriate filtering and so forth, and allows administrators to administer a game by kicking or banning users and so forth.		Wesnothd is a network server written in C++. It shares some of Wesnoth's code, in particular the networking code. Wesnothd manages requests from Wesnoth, that are sent in [[WML]]. It manages a lobby of players who can chat with each other, create games, join games, observe games, and so forth. Wesnothd maintains a list of games, users, and so forth. Wesnothd largely operates by relaying messages to the appropriate clients. For instance, if a player in a game makes a move, wesnothd will relay this to all clients who are participating in the game. Wesnothd may also perform appropriate filtering and so forth, and allows administrators to administer a game by kicking or banning users and so forth.

	== simple_wml ==		== simple_wml ==

Pentarctagon: /* Performance Update Dec 2020 */

2020-12-25T23:36:52Z

Performance Update Dec 2020

← Older revision		Revision as of 23:36, 25 December 2020
Line 90:		Line 90:
	Just parsing the WML text with parser.cpp without assigning any values:		Just parsing the WML text with parser.cpp without assigning any values:
	* 539 ms		* 539 ms

			===== Summary =====
			* simple_wml remains approximately 6x faster than config for parsing the WML text and assigning values.
			* simple_wml can process a new WML text approximately 1.6x faster than config's copy constructor can copy the values.
			* simple_wml is approximately 2x slower than config's move constructor.
			* For config, approximately 1/3 of the time it takes is spent parsing the WML text and 2/3 of the time spent assigning values to the config object.

	== The network layer ==		== The network layer ==

Pentarctagon: /* Performance Update Dec 2020 */

2020-12-25T23:28:59Z

Performance Update Dec 2020

← Older revision		Revision as of 23:28, 25 December 2020
Line 80:		Line 80:
	Parsing from WML text to:		Parsing from WML text to:
	* config - 1619 ms		* config - 1619 ms
	* simple_wml::document; INIT_STATIC - 269 ms		* simple_wml::document (INIT_STATIC) - 269 ms
	* simple_wml::document; INIT_COMPRESSED - 353 ms

	Config copy constructor:		Config copy constructor:
Line 88:		Line 87:
	Config move constructor:		Config move constructor:
	* 131 ms		* 131 ms

			Just parsing the WML text with parser.cpp without assigning any values:
			* 539 ms

	== The network layer ==		== The network layer ==

Pentarctagon: /* simple_wml vs regular WML */

2020-12-25T23:19:41Z

simple_wml vs regular WML

← Older revision		Revision as of 23:19, 25 December 2020
Line 75:		Line 75:
	It should be noted though that simple_wml is 'simple' in that it is a stripped down, simplified version of WML. It itself is NOT 'simple' to use, and should never be considered for use in main Wesnoth code. It is very complicated to use, and should not be touched at all except by experienced C++ developers.		It should be noted though that simple_wml is 'simple' in that it is a stripped down, simplified version of WML. It itself is NOT 'simple' to use, and should never be considered for use in main Wesnoth code. It is very complicated to use, and should not be touched at all except by experienced C++ developers.

	==== Update Dec 2020 ====		==== Performance Update Dec 2020 ====
	All times were averaged over 1000 runs using a debug (-O0) build. simple_wml's clone()'s results were identical to creating a new simple_wml document. The WML text used was the preprocessed output of Ageless Era from the 1.15 add-on's server as of the time of this update.		All times were averaged over 1000 runs using a debug (-O0) build. simple_wml's clone()'s results were identical to creating a new simple_wml document. The WML text used was the preprocessed output of Ageless Era from the 1.15 add-on's server as of the time of this update.

Pentarctagon: /* simple_wml vs regular WML */

2020-12-25T23:19:25Z

simple_wml vs regular WML

← Older revision		Revision as of 23:19, 25 December 2020
Line 72:		Line 72:

	Performance tests show simple_wml to be MUCH faster than WML used in Wesnoth. Parsing a WML document is between 10 and 30 times faster with simple_wml. Of course, benefits of simple_wml include smart optimizations to try and avoid parsing and outputting at all when unnecessary.		Performance tests show simple_wml to be MUCH faster than WML used in Wesnoth. Parsing a WML document is between 10 and 30 times faster with simple_wml. Of course, benefits of simple_wml include smart optimizations to try and avoid parsing and outputting at all when unnecessary.

			It should be noted though that simple_wml is 'simple' in that it is a stripped down, simplified version of WML. It itself is NOT 'simple' to use, and should never be considered for use in main Wesnoth code. It is very complicated to use, and should not be touched at all except by experienced C++ developers.

	==== Update Dec 2020 ====		==== Update Dec 2020 ====
Line 86:		Line 88:
	Config move constructor:		Config move constructor:
	* 131 ms		* 131 ms

	It should be noted though that simple_wml is 'simple' in that it is a stripped down, simplified version of WML. It itself is NOT 'simple' to use, and should never be considered for use in main Wesnoth code. It is very complicated to use, and should not be touched at all except by experienced C++ developers.

	== The network layer ==		== The network layer ==

Pentarctagon: /* Update Dec 2020 */

2020-12-25T23:18:51Z

Update Dec 2020

← Older revision		Revision as of 23:18, 25 December 2020
Line 74:		Line 74:

	==== Update Dec 2020 ====		==== Update Dec 2020 ====
	All times were averaged over 1000 runs using a debug (-O0) build. simple_wml's clone()'s results were identical to creating a new simple_wml document.		All times were averaged over 1000 runs using a debug (-O0) build. simple_wml's clone()'s results were identical to creating a new simple_wml document. The WML text used was the preprocessed output of Ageless Era from the 1.15 add-on's server as of the time of this update.

	Parsing from WML text:		Parsing from WML text to:
	* config - 1619 ms		* config - 1619 ms
	* simple_wml::document; INIT_STATIC - 269 ms		* simple_wml::document; INIT_STATIC - 269 ms

Pentarctagon: /* Update Dec 2020 */

2020-12-13T03:38:17Z

Update Dec 2020

← Older revision		Revision as of 03:38, 13 December 2020
Line 81:		Line 81:
	* simple_wml::document; INIT_COMPRESSED - 353 ms		* simple_wml::document; INIT_COMPRESSED - 353 ms

	Config ~~move~~ constructor:		Config copy constructor:
	* 431 ms		* 431 ms

Pentarctagon: /* Update Dec 2020 */

2020-12-13T03:37:41Z

Update Dec 2020

← Older revision		Revision as of 03:37, 13 December 2020
Line 74:		Line 74:

	==== Update Dec 2020 ====		==== Update Dec 2020 ====
	All times were averaged over 1000 runs using a debug (-O0) build.		All times were averaged over 1000 runs using a debug (-O0) build. simple_wml's clone()'s results were identical to creating a new simple_wml document.

	Parsing from WML text:		Parsing from WML text:

Pentarctagon: /* Update Dec 2020 */

2020-12-13T03:36:39Z

Update Dec 2020

← Older revision		Revision as of 03:36, 13 December 2020
Line 74:		Line 74:

	==== Update Dec 2020 ====		==== Update Dec 2020 ====
	All times ~~are in milliseconds~~ averaged over 1000 runs using a debug (-O0) build.		All times were averaged over 1000 runs using a debug (-O0) build.

	Parsing from WML text:		Parsing from WML text:
	* config - 1619		* config - 1619 ms
	* simple_wml::document; INIT_STATIC - 269		* simple_wml::document; INIT_STATIC - 269 ms
	* simple_wml::document; INIT_COMPRESSED - 353		* simple_wml::document; INIT_COMPRESSED - 353 ms

	Config move constructor:		Config move constructor:
	* 431		* 431 ms

	Config move constructor:		Config move constructor:
	* 131		* 131 ms

	It should be noted though that simple_wml is 'simple' in that it is a stripped down, simplified version of WML. It itself is NOT 'simple' to use, and should never be considered for use in main Wesnoth code. It is very complicated to use, and should not be touched at all except by experienced C++ developers.		It should be noted though that simple_wml is 'simple' in that it is a stripped down, simplified version of WML. It itself is NOT 'simple' to use, and should never be considered for use in main Wesnoth code. It is very complicated to use, and should not be touched at all except by experienced C++ developers.

Pentarctagon: /* simple_wml vs regular WML */

2020-12-13T03:29:15Z

simple_wml vs regular WML

@@ Line 71: / Line 71: @@
 === simple_wml vs regular WML ===
-Performance tests show simple_wml to be MUCH faster than WML used in Wesnoth. Parsing a WML document is between 10 and 30 times faster with simple_wml (Update 2020: a recent test reduces this to ~6 times faster). Of course, benefits of simple_wml include smart optimizations to try and avoid parsing and outputting at all when unnecessary.
+Performance tests show simple_wml to be MUCH faster than WML used in Wesnoth. Parsing a WML document is between 10 and 30 times faster with simple_wml. Of course, benefits of simple_wml include smart optimizations to try and avoid parsing and outputting at all when unnecessary.
 It should be noted though that simple_wml is 'simple' in that it is a stripped down, simplified version of WML. It itself is NOT 'simple' to use, and should never be considered for use in main Wesnoth code. It is very complicated to use, and should not be touched at all except by experienced C++ developers.