aboutsummaryrefslogtreecommitdiff
path: root/src/jthread/jthread.h
blob: 89743a3e3857eab100e739f8d63f9ab0ee14fe92 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/*

    This file is a part of the JThread package, which contains some object-
    oriented thread wrappers for different thread implementations.

    Copyright (c) 2000-2006  Jori Liesenborgs (jori.liesenborgs@gmail.com)

    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.

*/

#ifndef JTHREAD_H
#define JTHREAD_H

#if __cplusplus >= 201103L
#include <atomic>
#endif

#include "jthread/jmutex.h"

#define ERR_JTHREAD_CANTINITMUTEX						-1
#define ERR_JTHREAD_CANTSTARTTHREAD						-2
#define ERR_JTHREAD_THREADFUNCNOTSET						-3
#define ERR_JTHREAD_NOTRUNNING							-4
#define ERR_JTHREAD_ALREADYRUNNING						-5

class JThread
{
public:
	JThread();
	virtual ~JThread();
	int Start();
	inline void Stop()
		{ requeststop = true; }
	int Kill();
	virtual void *Thread() = 0;
	inline bool IsRunning()
		{ return running; }
	inline bool StopRequested()
		{ return requeststop; }
	void *GetReturnValue();
	bool IsSameThread();

	/*
	 * Wait for thread to finish
	 * Note: this does not stop a thread you have to do this on your own
	 * WARNING: never ever call this on a thread not started or already killed!
	 */
	void Wait();
protected:
	void ThreadStarted();
private:

#if (defined(WIN32) || defined(_WIN32_WCE))
#ifdef _WIN32_WCE
	DWORD threadid;
	static DWORD WINAPI TheThread(void *param);
#else
	static UINT __stdcall TheThread(void *param);
	UINT threadid;
#endif // _WIN32_WCE
	HANDLE threadhandle;
#else // pthread type threads
	static void *TheThread(void *param);

	pthread_t threadid;

	/*
	 * reading and writing bool values is atomic on all relevant architectures
	 * ( x86 + arm ). No need to waste time for locking here.
	 * once C++11 is supported we can tell compiler to handle cpu caches correct
	 * too. This should cause additional improvement (and silence thread
	 * concurrency check tools.
	 */
#if __cplusplus >= 201103L
	std::atomic_bool started;
#else
	bool started;
#endif
#endif // WIN32
	void *retval;
	/*
	 * reading and writing bool values is atomic on all relevant architectures
	 * ( x86 + arm ). No need to waste time for locking here.
	 * once C++11 is supported we can tell compiler to handle cpu caches correct
	 * too. This should cause additional improvement (and silence thread
	 * concurrency check tools.
	 */
#if __cplusplus >= 201103L
	std::atomic_bool running;
	std::atomic_bool requeststop;
#else
	bool running;
	bool requeststop;
#endif

	JMutex continuemutex,continuemutex2;
};

#endif // JTHREAD_H

an class="hl opt">) if str and str:len() > length then return "..." .. str:sub(-(length-3)) end return str end local function filter_matches(filter, text) return not filter or string.match(text, filter) end local function format_number(number, fmt) number = tonumber(number) if not number then return "N/A" end return sprintf(fmt or "%d", number) end local Formatter = { new = function(self, object) object = object or {} object.out = {} -- output buffer self.__index = self return setmetatable(object, self) end, __tostring = function (self) return table.concat(self.out, LINE_DELIM) end, print = function(self, text, ...) if (...) then text = sprintf(text, ...) end if text then -- Avoid format unicode issues. text = text:gsub("Ms", "µs") end table.insert(self.out, text or LINE_DELIM) end, flush = function(self) table.insert(self.out, LINE_DELIM) local text = table.concat(self.out, LINE_DELIM) self.out = {} return text end } local widths = { 55, 9, 9, 9, 5, 5, 5 } local txt_row_format = sprintf(" %%-%ds | %%%ds | %%%ds | %%%ds | %%%ds | %%%ds | %%%ds", unpack(widths)) local HR = {} for i=1, #widths do HR[i]= rep("-", widths[i]) end -- ' | ' should break less with github than '-+-', when people are pasting there HR = sprintf("-%s-", table.concat(HR, " | ")) local TxtFormatter = Formatter:new { format_row = function(self, modname, instrument_name, statistics) local label if instrument_name then label = shorten(instrument_name, widths[1] - 5) label = sprintf(" - %s %s", label, rep(".", widths[1] - 5 - label:len())) else -- Print mod_stats label = shorten(modname, widths[1] - 2) .. ":" end self:print(txt_row_format, label, format_number(statistics.time_min), format_number(statistics.time_max), format_number(statistics:get_time_avg()), format_number(statistics.part_min, "%.1f"), format_number(statistics.part_max, "%.1f"), format_number(statistics:get_part_avg(), "%.1f") ) end, format = function(self, filter) local profile = self.profile self:print(S("Values below show absolute/relative times spend per server step by the instrumented function.")) self:print(S("A total of @1 sample(s) were taken.", profile.stats_total.samples)) if filter then self:print(S("The output is limited to '@1'.", filter)) end self:print() self:print( txt_row_format, "instrumentation", "min Ms", "max Ms", "avg Ms", "min %", "max %", "avg %" ) self:print(HR) for modname,mod_stats in pairs(profile.stats) do if filter_matches(filter, modname) then self:format_row(modname, nil, mod_stats) if mod_stats.instruments ~= nil then for instrument_name, instrument_stats in pairs(mod_stats.instruments) do self:format_row(nil, instrument_name, instrument_stats) end end end end self:print(HR) if not filter then self:format_row("total", nil, profile.stats_total) end end } local CsvFormatter = Formatter:new { format_row = function(self, modname, instrument_name, statistics) self:print( "%q,%q,%d,%d,%d,%d,%d,%f,%f,%f", modname, instrument_name, statistics.samples, statistics.time_min, statistics.time_max, statistics:get_time_avg(), statistics.time_all, statistics.part_min, statistics.part_max, statistics:get_part_avg() ) end, format = function(self, filter) self:print( "%q,%q,%q,%q,%q,%q,%q,%q,%q,%q", "modname", "instrumentation", "samples", "time min µs", "time max µs", "time avg µs", "time all µs", "part min %", "part max %", "part avg %" ) for modname, mod_stats in pairs(self.profile.stats) do if filter_matches(filter, modname) then self:format_row(modname, "*", mod_stats) if mod_stats.instruments ~= nil then for instrument_name, instrument_stats in pairs(mod_stats.instruments) do self:format_row(modname, instrument_name, instrument_stats) end end end end end } local function format_statistics(profile, format, filter) local formatter if format == "csv" then formatter = CsvFormatter:new { profile = profile } else formatter = TxtFormatter:new { profile = profile } end formatter:format(filter) return formatter:flush() end --- -- Format the profile ready for display and -- @return string to be printed to the console -- function reporter.print(profile, filter) if filter == "" then filter = nil end return format_statistics(profile, "txt", filter) end --- -- Serialize the profile data and -- @return serialized data to be saved to a file -- local function serialize_profile(profile, format, filter) if format == "lua" or format == "json" or format == "json_pretty" then local stats = filter and {} or profile.stats if filter then for modname, mod_stats in pairs(profile.stats) do if filter_matches(filter, modname) then stats[modname] = mod_stats end end end if format == "lua" then return core.serialize(stats) elseif format == "json" then return core.write_json(stats) elseif format == "json_pretty" then return core.write_json(stats, true) end end -- Fall back to textual formats. return format_statistics(profile, format, filter) end local worldpath = core.get_worldpath() local function get_save_path(format, filter) local report_path = settings:get("profiler.report_path") or "" if report_path ~= "" then core.mkdir(sprintf("%s%s%s", worldpath, DIR_DELIM, report_path)) end return (sprintf( "%s/%s/profile-%s%s.%s", worldpath, report_path, os.date("%Y%m%dT%H%M%S"), filter and ("-" .. filter) or "", format ):gsub("[/\\]+", DIR_DELIM))-- Clean up delims end --- -- Save the profile to the world path. -- @return success, log message -- function reporter.save(profile, format, filter) if not format or format == "" then format = settings:get("profiler.default_report_format") or "txt" end if filter == "" then filter = nil end local path = get_save_path(format, filter) local output, io_err = io.open(path, "w") if not output then return false, S("Saving of profile failed: @1", io_err) end local content, err = serialize_profile(profile, format, filter) if not content then output:close() return false, S("Saving of profile failed: @1", err) end output:write(content) output:close() core.log("action", "Profile saved to " .. path) return true, S("Profile saved to @1", path) end return reporter