instrumentation.lua 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  1. --Minetest
  2. --Copyright (C) 2016 T4im
  3. --
  4. --This program is free software; you can redistribute it and/or modify
  5. --it under the terms of the GNU Lesser General Public License as published by
  6. --the Free Software Foundation; either version 2.1 of the License, or
  7. --(at your option) any later version.
  8. --
  9. --This program is distributed in the hope that it will be useful,
  10. --but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. --MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. --GNU Lesser General Public License for more details.
  13. --
  14. --You should have received a copy of the GNU Lesser General Public License along
  15. --with this program; if not, write to the Free Software Foundation, Inc.,
  16. --51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17. local format, pairs, type = string.format, pairs, type
  18. local core, get_current_modname = core, core.get_current_modname
  19. local profiler, sampler, get_bool_default = ...
  20. local instrument_builtin = get_bool_default("instrument.builtin", false)
  21. local register_functions = {
  22. register_globalstep = 0,
  23. register_playerevent = 0,
  24. register_on_placenode = 0,
  25. register_on_dignode = 0,
  26. register_on_punchnode = 0,
  27. register_on_generated = 0,
  28. register_on_newplayer = 0,
  29. register_on_dieplayer = 0,
  30. register_on_respawnplayer = 0,
  31. register_on_prejoinplayer = 0,
  32. register_on_joinplayer = 0,
  33. register_on_leaveplayer = 0,
  34. register_on_cheat = 0,
  35. register_on_chat_message = 0,
  36. register_on_player_receive_fields = 0,
  37. register_on_craft = 0,
  38. register_craft_predict = 0,
  39. register_on_protection_violation = 0,
  40. register_on_item_eat = 0,
  41. register_on_punchplayer = 0,
  42. register_on_player_hpchange = 0,
  43. }
  44. ---
  45. -- Create an unique instrument name.
  46. -- Generate a missing label with a running index number.
  47. --
  48. local counts = {}
  49. local function generate_name(def)
  50. local class, label, func_name = def.class, def.label, def.func_name
  51. if label then
  52. if class or func_name then
  53. return format("%s '%s' %s", class or "", label, func_name or ""):trim()
  54. end
  55. return format("%s", label):trim()
  56. elseif label == false then
  57. return format("%s", class or func_name):trim()
  58. end
  59. local index_id = def.mod .. (class or func_name)
  60. local index = counts[index_id] or 1
  61. counts[index_id] = index + 1
  62. return format("%s[%d] %s", class or func_name, index, class and func_name or ""):trim()
  63. end
  64. ---
  65. -- Keep `measure` and the closure in `instrument` lean, as these, and their
  66. -- directly called functions are the overhead that is caused by instrumentation.
  67. --
  68. local time, log = core.get_us_time, sampler.log
  69. local function measure(modname, instrument_name, start, ...)
  70. log(modname, instrument_name, time() - start)
  71. return ...
  72. end
  73. --- Automatically instrument a function to measure and log to the sampler.
  74. -- def = {
  75. -- mod = "",
  76. -- class = "",
  77. -- func_name = "",
  78. -- -- if nil, will create a label based on registration order
  79. -- label = "" | false,
  80. -- }
  81. local function instrument(def)
  82. if not def or not def.func then
  83. return
  84. end
  85. def.mod = def.mod or get_current_modname()
  86. local modname = def.mod
  87. local instrument_name = generate_name(def)
  88. local func = def.func
  89. if not instrument_builtin and modname == "*builtin*" then
  90. return func
  91. end
  92. return function(...)
  93. -- This tail-call allows passing all return values of `func`
  94. -- also called https://en.wikipedia.org/wiki/Continuation_passing_style
  95. -- Compared to table creation and unpacking it won't lose `nil` returns
  96. -- and is expected to be faster
  97. -- `measure` will be executed after time() and func(...)
  98. return measure(modname, instrument_name, time(), func(...))
  99. end
  100. end
  101. local function can_be_called(func)
  102. -- It has to be a function or callable table
  103. return type(func) == "function" or
  104. ((type(func) == "table" or type(func) == "userdata") and
  105. getmetatable(func) and getmetatable(func).__call)
  106. end
  107. local function assert_can_be_called(func, func_name, level)
  108. if not can_be_called(func) then
  109. -- Then throw an *helpful* error, by pointing on our caller instead of us.
  110. error(format("Invalid argument to %s. Expected function-like type instead of '%s'.", func_name, type(func)), level + 1)
  111. end
  112. end
  113. ---
  114. -- Wraps a registration function `func` in such a way,
  115. -- that it will automatically instrument any callback function passed as first argument.
  116. --
  117. local function instrument_register(func, func_name)
  118. local register_name = func_name:gsub("^register_", "", 1)
  119. return function(callback, ...)
  120. assert_can_be_called(callback, func_name, 2)
  121. register_functions[func_name] = register_functions[func_name] + 1
  122. return func(instrument {
  123. func = callback,
  124. func_name = register_name
  125. }, ...)
  126. end
  127. end
  128. local function init_chatcommand()
  129. if get_bool_default("instrument.chatcommand", true) then
  130. local orig_register_chatcommand = core.register_chatcommand
  131. core.register_chatcommand = function(cmd, def)
  132. def.func = instrument {
  133. func = def.func,
  134. label = "/" .. cmd,
  135. }
  136. orig_register_chatcommand(cmd, def)
  137. end
  138. end
  139. end
  140. ---
  141. -- Start instrumenting selected functions
  142. --
  143. local function init()
  144. if get_bool_default("instrument.entity", true) then
  145. -- Explicitly declare entity api-methods.
  146. -- Simple iteration would ignore lookup via __index.
  147. local entity_instrumentation = {
  148. "on_activate",
  149. "on_step",
  150. "on_punch",
  151. "rightclick",
  152. "get_staticdata",
  153. }
  154. -- Wrap register_entity() to instrument them on registration.
  155. local orig_register_entity = core.register_entity
  156. core.register_entity = function(name, prototype)
  157. local modname = get_current_modname()
  158. for _, func_name in pairs(entity_instrumentation) do
  159. prototype[func_name] = instrument {
  160. func = prototype[func_name],
  161. mod = modname,
  162. func_name = func_name,
  163. label = prototype.label,
  164. }
  165. end
  166. orig_register_entity(name,prototype)
  167. end
  168. end
  169. if get_bool_default("instrument.abm", true) then
  170. -- Wrap register_abm() to automatically instrument abms.
  171. local orig_register_abm = core.register_abm
  172. core.register_abm = function(spec)
  173. spec.action = instrument {
  174. func = spec.action,
  175. class = "ABM",
  176. label = spec.label,
  177. }
  178. orig_register_abm(spec)
  179. end
  180. end
  181. if get_bool_default("instrument.lbm", true) then
  182. -- Wrap register_lbm() to automatically instrument lbms.
  183. local orig_register_lbm = core.register_lbm
  184. core.register_lbm = function(spec)
  185. spec.action = instrument {
  186. func = spec.action,
  187. class = "LBM",
  188. label = spec.label or spec.name,
  189. }
  190. orig_register_lbm(spec)
  191. end
  192. end
  193. if get_bool_default("instrument.global_callback", true) then
  194. for func_name, _ in pairs(register_functions) do
  195. core[func_name] = instrument_register(core[func_name], func_name)
  196. end
  197. end
  198. if get_bool_default("instrument.profiler", false) then
  199. -- Measure overhead of instrumentation, but keep it down for functions
  200. -- So keep the `return` for better optimization.
  201. profiler.empty_instrument = instrument {
  202. func = function() return end,
  203. mod = "*profiler*",
  204. class = "Instrumentation overhead",
  205. label = false,
  206. }
  207. end
  208. end
  209. return {
  210. register_functions = register_functions,
  211. instrument = instrument,
  212. init = init,
  213. init_chatcommand = init_chatcommand,
  214. }