https://github.com/siffiejoe/lua-getsize

Matthew Wild's lua-getsize module as a rock
https://github.com/siffiejoe/lua-getsize

debugging introspection lua size

Last synced: 3 months ago
JSON representation

Matthew Wild's lua-getsize module as a rock

• Host: GitHub
• URL: https://github.com/siffiejoe/lua-getsize
• Owner: siffiejoe
• Created: 2014-05-11T20:28:43.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-01-27T19:02:28.000Z (about 3 years ago)
• Last Synced: 2024-08-02T15:37:02.709Z (6 months ago)
• Topics: debugging, introspection, lua, size
• Language: C
• Homepage:
• Size: 172 KB
• Stars: 23
• Watchers: 4
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
#                             lua-getsize                            #

[![Test Status](https://github.com/siffiejoe/lua-getsize/workflows/run-tests/badge.svg)](https://github.com/siffiejoe/lua-getsize/actions?workflow=run-tests)

![License](https://img.shields.io/badge/License-MIT%2FX11,%20MIT-blue.svg)

![Lua Versions](https://img.shields.io/badge/Lua-5.1%20|%205.2%20|%205.3%20|%205.4-blue.svg)

![No LuaJIT](https://img.shields.io/badge/No-LuaJIT-red.svg)

##                           Introduction                           ##

This is a bundle of Matthew Wild's lua-getsize module with the

necessary bits from Lua's sources (5.1, 5.2, 5.3, and 5.4) included to

make it build as a standalone rock.

lua-getsize is MIT/X11-licensed. Lua's source code is available

under the MIT license.

    http://code.matthewwild.co.uk/lua-getsize/

    http://www.lua.org/

At the moment the code in this repository includes the following

changes to the original lua-getsize code:

*   ported to Lua 5.2, 5.3 and 5.4

*   fixed sizes of tables with empty hash part

*   report a userdata's full memory not just its payload

*   detect LuaJIT and raise an error

*   additionally report the sizes of a table's array/hash parts

*   additional option argument for counting shared internal objects

    like Lua upvalues and/or proto objects.

    "p" will count proto objects, "P" will _not_ count proto objects

    (the default), "u" will count Lua upvalues (the default), and "U"

    will _not_ count Lua upvalues. You can combine those options.

##                          Getting Started                         ##

This module exports just one function:

```lua

local getsize = require("getsize")

```

Calling this function with a Lua value as argument will return the

size of the value in bytes. For tables it will return the lengths of

array and hash part as additional return values. For functions you can

decide whether you want to include the sizes of the proto object

and/or the upvalues.

```lua

print(getsize(getsize))                    --> 64

local function f() return getsize end

print(getsize(f))                          --> 80

print(getsize(f, "uP"))                    --> 80

print(getsize(f, "up"))                    --> 264

print(getsize(f, "UP"))                    --> 40

print(getsize({ 1, 2, 3, x = 4, y = 5 })   --> 152  3  2

```