luau-lang/luau
1
0
Fork 0
mirror of https://github.com/luau-lang/luau.git synced 2025-04-21 12:13:47 +01:00
Code Issues Projects Releases Packages Wiki Activity
206 commits 4 branches 165 tags 49 MiB
Commit graph

206 commits

This branch
This branch
All branches
Author SHA1 Message Date
LoganDark
4373f65fbd
Add back thread identity section as thread userdata instead 
Thread userdata shouldn't be overlooked - even though security contexts are
Roblox-specific, the thread userdata can still be used to implement a
permissions model for sandboxing, whether this is based on security contexts
(like Roblox, or like Ring 0/3), on capabilities, or maybe even something else.
I think it is worth it to document this in the sandboxing page.

For everyone's future reference:

* Every lua_State has an associated userdata pointer at the end. It's just a
  pointer at the end called userdata:

    void* userdata;

  This pointer is never accessed or set by Luau itself, except for when
  first initializing the state, where it is set to NULL.

  This userdata can be set by the host after creating the thread, and is 100%
  invisible to Luau code. C functions exposed by the host can access the
  userdata by L->userdata, and, safe in the knowledge that it cannot be tampered
  with, use it to validate the thread.

* The global_State (the VM, as opposed to just the main thread) contains a field
  called cb:

    lua_Callbacks cb;

  The struct is currently defined as:

    /* Callbacks that can be used to reconfigure behavior of the VM dynamically.
     * These are shared between all coroutines.
     *
     * Note: interrupt is safe to set from an arbitrary thread but all other
     * callbacks can only be changed when the VM is not running any code */
    struct lua_Callbacks
    {
        /* gets called at safepoints (loop back edges, call/ret, gc) if set */
        void (*interrupt)(lua_State* L, int gc);

        /* gets called when an unprotected error is raised (if longjmp is
         * used) */
        void (*panic)(lua_State* L, int errcode);


        /* gets called when L is created (LP == parent) or destroyed (LP ==
         * NULL) */
        void (*userthread)(lua_State* LP, lua_State* L);

        /* gets called when a string is created; returned atom can be retrieved
         * via tostringatom */
        int16_t (*useratom)(const char* s, size_t l);


        /* gets called when BREAK instruction is encountered */
        void (*debugbreak)(lua_State* L, lua_Debug* ar);

        /* gets called after each instruction in single step mode */
        void (*debugstep)(lua_State* L, lua_Debug* ar);

        /* gets called when thread execution is interrupted by break in another
         * thread */
        void (*debuginterrupt)(lua_State* L, lua_Debug* ar);

        /* gets called when protected call results in an error */
        void (*debugprotectederror)(lua_State* L);
    };

  Assuming you cache the global_State when creating the main thread (which you
  should - it's just L->global), you can set g->cb->userthread to a C function
  to define what should happen when a new thread is created or destroyed.

  This can be used to:
  * Inherit userdata from parent threads; great for permission models.
  * Run destructors on userdata when threads are collected; great for resources.

That is a lot of information to digest, but if a Luau dev reads this, they'll
probably have said "yep, exactly" at least once. Documenting this small aspect
of the VM will be another step towards making it a bit friendlier for people to
start using Luau.

Obviously, the more technical documentation will remain here (in this commit &
pull request), but even the public facing documentation (which developers, like
me, will reference) should contain information just like the thread identity
section that was removed.

Hopefully, this is a suitable replacement, as thread userdata IS available in
the open-source version of Luau - and is used by Roblox for its "extra space" to
store things like thread identity.
 2021-11-07 07:20:42 -08:00
Arseny Kapoulkine
c6de3bd2e4
Update sandbox.md 
Remove section on thread identity: this is not part of open-source Luau and as such is now confusing.
 2021-11-05 19:50:29 -07:00
Rerumu
96b1707f87
Fix CLI analysis reporting wrong file names (#146) 2021-11-05 19:11:56 -07:00
Roni N. (Kittenz)
1e1d1f58e9
Look for .luau before .lua in REPL & Analyze (#97) (#124) 
As discussed in the issue, Luau has evolved from Lua to the point
where a new default extension `.luau` would be needed.

This change makes the REPL and Analyze look for `.luau`
extension first and if not found, fall back to `.lua`.
 2021-11-05 19:11:26 -07:00
Rerumu
6342913533
Fix small assert ordering (#143) 2021-11-05 14:38:08 -07:00
bmcq-0
ad9b47b72f
Fold length operations when argument is a constant string (#141) 
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
 2021-11-05 13:24:30 -07:00
Arseny Kapoulkine
a80fc93646
Fix unused variable treatment (#139) 
Right now our CMake infra specifies -Wno-unused only for GCC builds, but Makefile specifies it for all builds.
The intent has been to use it just for GCC, so we now do that by detecting the compiler version - this should
equalize the behavior across different types of builds.

Separately, latest version of clang appears to expose an unused variable that clang-10 was okay with, so fix that. (change from upstream)
 2021-11-05 12:39:27 -07:00
Arseny Kapoulkine
aea1f6a718
Update README.md 
Add `make` commandline as well.
 2021-11-05 10:16:28 -07:00
Arseny Kapoulkine
279855df91
Sync to upstream/release/503 (#135) 
- A series of major optimizations to type checking performance on complex
programs/types (up to two orders of magnitude speedup for programs
involving huge tagged unions)
- Fix a few issues encountered by UBSAN (and maybe fix s390x builds)
- Fix gcc-11 test builds
- Fix a rare corner case where luau_load wouldn't wake inactive threads
which could result in a use-after-free due to GC
- Fix CLI crash when error object that's not a string escapes to top level
- Fix Makefile suffixes on macOS

Co-authored-by: Rodactor <rodactor@roblox.com>
 2021-11-05 08:47:21 -07:00
Arseny Kapoulkine
c0b95b8961
Update profile.md 
Too much future.
 2021-11-04 23:24:39 -07:00
Arseny Kapoulkine
49b0c59eec
Sync to upstream/release/502 (#134) 
Changes:
- Support for time tracing for analysis/compiler (not currently exposed
  through CLI)
- Support for type pack arguments in type aliases (#83)
- Basic support for require(path) in luau-analyze
- Add a lint warning for table.move with 0 index as part of
  TableOperation lint
- Remove last STL dependency from Luau.VM
- Minor VS2022 performance tuning

Co-authored-by: Rodactor <rodactor@roblox.com>
 2021-11-04 19:34:35 -07:00
Arseny Kapoulkine
adacdcdf4e
Update profile.md 
Remove incorrect sentence copied from the incorrect internal documentation :)
 2021-11-04 18:07:34 -07:00
Arseny Kapoulkine
dc509b9849
Update navigation.yml 
Add profiling page to nav bar
 2021-11-04 17:28:24 -07:00
Arseny Kapoulkine
7c76a5a70a
Create profile.md 
Add profiler documentation.
 2021-11-04 17:27:56 -07:00
Arseny Kapoulkine
e0c4f33217
Add chess-profile.lua 2021-11-04 17:22:04 -07:00
Arseny Kapoulkine
98fa75e911 Fix fallout from #114: T is the right thread to use 2021-11-04 10:09:25 -07:00
Josh Soref
278e848cc2
Spelling (#119) 
Fixed various spelling errors.

Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
 2021-11-04 09:50:46 -05:00
Tommy Vadakumchery
57a42c4cb9
Fix HATRA '21 README.md formatting (#118) 
A misplaced backtick was causing the last two codeblocks from displaying correctly.
 2021-11-04 09:00:41 -05:00
Arseny Kapoulkine
3462a08d4a
Update CONTRIBUTING.md 
Add a section on performance.
 2021-11-03 22:08:23 -07:00
Arseny Kapoulkine
1f0084daa3 Mark RFCs that were implemented as such. 2021-11-03 21:35:25 -07:00
Valts Liepiņš
344d37f0b1
Fixes incorrect MismatchedCount error message when returning (#103) 2021-11-03 21:23:20 -07:00
Grant Hernandez
e3f8c25e9e
Fix CLI abort when non lua string passed to error (#114) 2021-11-03 21:17:07 -07:00
Arseny Kapoulkine
733ae0498d
Update index.md 
Cleanup text and remove extra buttons and redundant links
 2021-11-03 19:10:49 -07:00
Peter van Dijk
3f0eb426c9
cmake --target takes one argument, not two (#105) 
Adjust README so that we can work with CMake versions before 3.15
 2021-11-03 14:37:15 -07:00
Arseny Kapoulkine
06e79462d0
Update index.md 
Remove incorrect text about Luau being Roblox only.
 2021-11-03 14:27:42 -07:00
Amber's Careware
eed3c8c38f
Update config-luaurc.md (#104) 
When running `luau-analyze` with a .luarc that has a "mode" key, it outputs the following:
> .luaurc: Unknown key mode
I'm assuming it was named "mode" at first and was re-named "languageMode" later on?
 2021-11-03 13:15:51 -07:00
Arseny Kapoulkine
2f7e1a2395
Update CI scripts to ignore .md changes (#100) 
This reduces the load on GHA infra
 2021-11-03 12:30:30 -07:00
Arseny Kapoulkine
e34586b847
Update sandbox.md 
Soften the language around Rust
 2021-11-03 12:30:07 -07:00
Arseny Kapoulkine
05a41d5d54
Remove team restriction from RFC process documentation 
Fixes #98
 2021-11-03 12:13:42 -07:00
Pelanyo Kamara
5a18006056
Update README.md (#99) 
Update README.md to highlight CPP code snippet.
 2021-11-03 12:12:14 -07:00
Arseny Kapoulkine
dc83543f3b
Update 2021-11-03-luau-goes-open-source.md 
Fix links in the announcement
 2021-11-03 10:28:01 -07:00
Arseny Kapoulkine
fa46d35b8d Merge branch 'upstream' 2021-11-03 10:20:08 -07:00
Arseny Kapoulkine
46110524ef Sync to upstream/release/501 (#20) 
Co-authored-by: Rodactor <rodactor@roblox.com>
 2021-11-03 10:15:50 -07:00
Arseny Kapoulkine
e997a4cc57
Update index.md 
Fix overlay header - image is not optional :(
 2021-11-03 09:43:20 -07:00
Arseny Kapoulkine
cba635f71b
Update LICENSE.txt 
Add PUC-Rio copyright here as well for ease of distribution; now we don't need lua_LICENSE and might remove it in the future.
 2021-11-03 09:41:30 -07:00
Arseny Kapoulkine
36110e0f29
Update issue template config 
Fix discussion link
 2021-11-03 09:40:08 -07:00
Arseny Kapoulkine
586bef6a4c Add open-source announcement 🎉 2021-11-02 15:50:57 -07:00
Arseny Kapoulkine
dd46710280 Update index.md 
Remove language about Roblox since it suggests the thought that Luau is Roblox specific.
 2021-11-02 15:50:57 -07:00
Arseny Kapoulkine
8f901671e0 Add coverage badge 2021-11-02 15:50:57 -07:00
Arseny Kapoulkine
7f3c033162 Add Coveralls integration 
Build and upload lcov-compatible coverage file to coveralls
 2021-11-02 15:50:57 -07:00
Arseny Kapoulkine
0ded24c2d5 Switch to releases for build artifacts 2021-11-01 14:52:34 -07:00
Arseny Kapoulkine
d01addc625 Sync to upstream/release/501 (#20) 
Co-authored-by: Rodactor <rodactor@roblox.com>
 2021-11-01 14:52:34 -07:00
Arseny Kapoulkine
12b2838de0 Update .gitignore to match upstream 2021-11-01 14:52:34 -07:00
Arseny Kapoulkine
650dd30062 Update getting-started and why for open source release 2021-11-01 14:52:34 -07:00
Arseny Kapoulkine
4d168c3543 Add CONTRIBUTING.md and replace README.md 
Also add SVG logo to docs/
 2021-11-01 14:52:34 -07:00
Arseny Kapoulkine
ca965d94ee Add build scaffolding for GHA and issue templates for GH 2021-11-01 14:52:34 -07:00
Arseny Kapoulkine
33cb9d5991
Update performance.md (#94) 
Add documentation on shorter atomic pauses

Co-authored-by: vegorov-rbx <75688451+vegorov-rbx@users.noreply.github.com>
 2021-11-01 12:08:01 -07:00
vegorov-rbx
e562596bb8
Luau Recap: October 2021 (#92) 
* Draft for October post

* Rebuild pages

* Apply suggestions from code review

Co-authored-by: dcope-rbx <91100513+dcope-rbx@users.noreply.github.com>

* Update 2021-10-31-luau-recap-october-2021.md

Add optimizations

* Remove unfinished section

Co-authored-by: dcope-rbx <91100513+dcope-rbx@users.noreply.github.com>
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
 2021-10-29 11:37:43 -07:00
dcope-rbx
c1654e34eb
Fixed doc issue that was unaddressed in a previous code review (#93) 2021-10-29 09:48:58 -07:00
dcope-rbx
1b38e3c8f8
Added syntax documentation for if expressions (#91) 
* Added syntax documentation for if expressions
 2021-10-28 13:44:04 -07:00