diff --git a/Cargo.toml b/Cargo.toml index 325c8ab..c831146 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -41,6 +41,7 @@ tokio = { version = "1", features = ["rt", "rt-multi-thread", "macros", "process name = "swactor" version = "0.1.0" edition = "2024" +license = "AGPL-3.0-only" autobenches = false [profile.bench] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md index 054e109..09eb8eb 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,392 @@ # swactor -Minimal actor runtime for Rust. One trait, one message type. -Single-threaded (`tick()`) or multi-threaded (`run()`). +A small, WASM-first actor runtime for Rust: one trait, location-transparent +addresses, and a built-in cluster. Actors are ordinary structs; a message is +any `Clone + Send + Sync` type; an address works the same whether the actor +lives in this process, on a peer, or behind NAT on another node. -## Description +## What it is -Core runtime is `src/`. Actors implement `ActorInterface` (in `actor.rs`), -interact through `Ctx` (in `runtime.rs`), and run on worker threads (`worker.rs`). +Every actor is one trait. There is no separate message trait to implement — +anything `Clone + Send + Sync` is a message by blanket impl: -`crates/` builds upward: `std` adds OTP patterns (supervision, monitoring, groups), -`distribution` adds clustering, everything else composes from there. - -## Dev commands - -`cargo xtask --help` for the basic test command. - -## Testing +```rust +// src/actor.rs +pub trait Message: 'static + Sized + Clone + Send + Sync {} +impl Message for T {} +pub trait ActorInterface: 'static + Send { + type Incoming: Message; + type Response: Message; + fn handle(&mut self, ctx: &Ctx, msg: Self::Incoming); + // ...on_start, on_stop, handle_down (death monitoring) as needed +} ``` + +You drive the runtime single-threaded with `tick()` (this is what compiles to +WASM) or multi-threaded with `run()`: + +```rust +use swactor::actor::{ActorInterface, Ctx}; +use swactor::runtime::{Runtime, RuntimeConfig}; + +struct Counter { count: u64 } + +impl ActorInterface for Counter { + type Incoming = (); // `()` is Clone + Send + Sync, so it's a message + type Response = (); + fn handle(&mut self, _ctx: &Ctx, _: Self::Incoming) { + self.count += 1; + println!("hit #{self.count}"); + } +} + +fn main() -> Result<(), swactor::Error> { + let rt = Runtime::new(RuntimeConfig::default()); // 1 worker → drive with tick() + let addr = rt.spawn(Counter { count: 0 })?; + rt.send_to(addr, ())?; + for _ in 0..3 { rt.tick(); } // spawn → handle → done + Ok(()) +} +``` + +`RuntimeConfig` is four knobs — `max_actors`, `channel_buffer_size`, +`num_threads`, and a per-tick `actor_message_budget` (inspired by BEAM's +reduction count, so one chatty mailbox can't starve the rest). + +## Features + +Each feature is shown in the code that implements it. + +### Route messages by actor_id across cluster boundaries + +An actor's identity is a 32-byte address, not a pointer: + +```rust +// src/actor.rs +pub struct ActorAddress(pub [u8; 32]); +``` + +You send to it the same way whether it lives in this process, on a peer across +the room, or behind NAT on another continent — one call, `ctx.send(addr, msg)`. +The locality decision is exactly one address-map lookup; a miss hands the +message to the cluster transport instead of a local worker: + +```rust +// src/delivery.rs — the cluster boundary +fn route_nonlocal(&self, addr: ActorAddress, msg: Box) -> Result<(), Error> { + #[cfg(feature = "transport")] + { + if self.inbox_registry.contains(&addr) { // a pending reply inbox + return self.inbox_registry.try_deliver(addr, msg); + } + if let Some(sink) = self.remote_sink { // ← off this node + return sink.send(addr, msg); + } + } + self.inbox_registry.try_deliver(addr, msg) +} +``` + +The transport seam is a single trait — any cluster driver satisfies it: + +```rust +// src/runtime.rs +pub trait RemoteSink: Send + Sync { + fn send(&self, addr: ActorAddress, msg: Box) -> Result<(), Error>; +} +``` + +Where `addr` lives is resolved from a signed, gossiped directory: a host-signed +`DirectoryEntry` binds `actor_addr → node_id`, backed by an LRU `LocationCache`. +The node's own mailbox (`node_id → ActorAddress`) is rebound on restart without +changing identity, which is why `NodeId` and `ActorAddress` are deliberately +distinct types. + +### WASM by default + +The same runtime that runs on a thread pool also compiles to `wasm32` and steps +one tick at a time from a host (browser, Node, an embedding app). Randomness, +timers, and the address map all have a no-op/wasm path behind the `wasm` +feature. The [ping-pong demo](examples/ping-pong) is one runtime compiled to a +`.wasm` cdylib and driven by Node: + +```sh +cd examples/ping-pong && ./run.sh +``` + +### Built-in engine and driver, tasks included + +A node ships batteries-included: the actor engine (worker threads), a network +driver, and the pump/fanout tasks that wire them — you don't assemble the glue. +The driver tracks its own established send/recv pumps per QUIC stream and emits +lifecycle events (edge ready, stream fault, pump stopped): + +```rust +// crates/iroh-driver/src/driver_pumps.rs +pub enum DriverEventOut { + DriverEdgeReady { edge_id: EdgeId }, + StreamFault { edge_id: EdgeId }, + PumpStopped { edge_id: EdgeId, ring_id: RingId }, +} +``` + +### `iroh` integration — QUIC, TLS, and NAT traversal + +The bundled driver is [iroh](https://iroh.computer): QUIC-based peer transport +with built-in TLS, NAT hole-punching, and relay-server fallback. You hand it a +Tokio engine and it runs accepts, dials, stream I/O, retries, and shutdown on +it; peers are admitted through an optional allow-list: + +```rust +// crates/iroh-driver/src/iroh_driver.rs +pub struct IrohDriverConfig { + pub secret_key: Option, // None → fresh random identity + pub relay_mode: RelayMode, // default: n0 production relays + pub node: DistributedNodeConfig, + pub peer_auth: Option>>, + pub additional_alpns: Vec>, // opaque to the driver +} +``` + +### Built-in SWIM cluster + +Membership is a real SWIM implementation — direct + indirect (relay) probes, +suspicion timers, and Lifeguard local-health scaling — not heartbeats. The probe +state machine emits typed actions; the host adapter turns them into sends: + +```rust +// crates/distribution/src/swim/probe.rs +pub enum SwimAction { + SendPing { to: NodeId, sequence: u64 }, + SendPingReq { relay: NodeId, target: NodeId, sequence: u64 }, // indirect probe + Suspect(NodeId), + DeclareDead(NodeId), + Diag(SwimDiagEvent), // RTT samples — observation only, no protocol effect +} +``` + +Name bindings, node metadata (relay URL, human name), and the actor→host +directory each run as independent gossip actors, so the cluster goes quiet once +it converges. + +### OTP-style standard library + +Behind the `std` feature, one extension adds the patterns you reach for: +symbolic naming, death monitoring (watching), and process groups. Install it on +the runtime and actors get `CtxWatching` / `CtxNaming`: + +```rust +// src/std/extension.rs +pub struct StdExtension { + name_registry: NameRegistry, // logical names → addresses + watch_registry: WatchRegistry, // exit notifications + group_registry: GroupRegistry, // named groups / pub-sub +} +// runtime.with_extension(Arc::new(StdExtension::new())); +``` + +### Process manager for external processes + +Treat an OS process like an actor. Describe it, spawn it onto the runtime, and +send it commands; its lifecycle (started / exited / signaled) arrives as +messages: + +```rust +// crates/process/src/types.rs +pub struct ProcessSpec { + pub command: String, + pub args: Vec, + pub env: HashMap, + pub working_dir: Option, + pub label: Option, +} +``` + +There's a YAML-driven pipeline layer on top (`crates/process/src/pipeline.rs`) +for multi-step jobs with progress and failure reporting. + +### Zero-copy movement of large byte objects + +The data-plane ships large, *typed* byte objects between actors — and across +nodes — without copying. The motivating workload is sharded inference: one GPU's +output activation is the next GPU's input, so it rides a bounded ring leased from +a shared arena. A ring is either local (IPC between two actors on one node) or +the two ends of a QUIC edge: + +```text +producer → egress ring ──QUIC──▶ ingress ring → consumer + (arena lease; zero-copy at both ends) +``` + +What travels on a wire edge is typed, so the receiver knows what arrived: + +```rust +// crates/data-plane/src/actor.rs +pub enum EdgeKind { + TokenIn, + Activation, // a hidden-state tensor forwarded to the next shard + TokenOut, +} + +// crates/data-plane/src/edge_lifecycle.rs +pub struct ObjectSpec { + pub kind: ObjectKind, // Activation + pub dtype: DType, // F16 + pub max_extent_bytes: u64, +} +``` + +The edge actor owns the lifecycle: lease a byte range, install an ingress or +egress ring, and release it only with a `QuiescenceProof`, so a range is never +recycled under a live reader. The worker consumes whole objects off its ingress +ring as plain bytes: + +```rust +// apps/myelin/src/node/worker_node_runtime.rs +match ingress::read_object_record(buffer, object_spec, false)? { + ingress::ObjectRecordRead::Incomplete => Ok(None), // wait for more bytes + ingress::ObjectRecordRead::Complete(record) => { // a full activation arrived + let bytes: Vec = buffer.drain(..record.total_len).collect(); + Ok(Some(IngressRecordBytes { bytes, object_id: record.object_id.0, .. })) + } +} +``` + +### Custom metrics through the datastream + +Telemetry is a deliberately dumb pipe: producers tag bytes with a channel id, +nothing in the middle interprets the payload, and views are read-time +projections. To add a metric stream, define a type and implement one constant — +no schema registry to negotiate with: + +```rust +// crates/datastream/src/record.rs +pub trait Record { + const CHANNEL: &'static str; +} + +// crates/data-plane/src/arena.rs — the arena publishes its own health this way +impl Record for ArenaSample { + const CHANNEL: &'static str = ARENA_SAMPLE_CHANNEL; // "mvp.arena" +} +``` + +### Built-in dashboard + +A read-only HTML/SSE dashboard renders the frames the datastream already +carries — workers, the actor roster, per-actor dossiers, fleet hardware. It sends +no control signals back, so the whole thing is one Axum router: + +```rust +// crates/dashboard/src/server.rs +fn router(state: AppState) -> Router { + Router::new() + .route("/", get(root_page)) + .route("/events", get(frame_stream)) // live frames over SSE + .route("/api/frames", get(recent_frames)) + .route("/api/views", get(views_json)) + .route("/api/view/{*path}", get(view_snapshot)) + .route("/view/{*path}", get(view_page)) + .with_state(state) +} +``` + +## Architecture + +The workspace builds upward from a tiny core. Each crate is one responsibility: + +```mermaid +flowchart TD + app["myelin
node · orchestrator"] + driver["iroh-driver
QUIC network driver"] + dist["distribution
SWIM · registry · directory"] + dash["dashboard
read-only view over datastream"] + proc["process
managed external processes"] + dp["data-plane
zero-copy byte movement · IPC · links"] + ds["datastream
metrics / telemetry pipe"] + trans["transport
codec · identity · crypto"] + core["swactor
core runtime + std (OTP)
ActorInterface · Ctx"] + + app --> driver + app --> dist + app --> dp + app --> dash + app --> proc + driver --> dist + driver --> ds + dist --> trans + dist --> ds + dash --> ds + proc --> ds + ds --> trans + trans --> core + dp --> core + ds --> core + proc --> core +``` + +| Crate | Role | +| --- | --- | +| `swactor` (`src/`) | Core runtime: the actor trait, `Ctx`, scheduler, address map, channels | +| `crates/transport` | Codec registry, node identity, message signing — transport-agnostic | +| `crates/distribution` | Clustering: SWIM membership, naming, metadata + actor directory gossip | +| `crates/iroh-driver` | iroh/QUIC network driver with its pump/fanout tasks | +| `crates/datastream` | Metrics / telemetry pipe — nothing in the middle interprets payloads | +| `crates/data-plane` | Zero-copy movement of large typed byte objects over IPC or a network link | +| `crates/process` | Managed external processes and YAML pipelines | +| `crates/dashboard` | Read-only HTML/SSE dashboard over datastream frames | +| `crates/provisioning` | Cloud node provisioning | +| `crates/bindings/{python,wasm-runtime,wasm-crypto}` | Language / target bindings | +| `apps/myelin` | The node binary that wires the above into a runnable cluster node | +| `tools/vastai` | Vast.ai GPU-marketplace tooling | + +## Used for + +- **A drop-in replacement for GPU jobs on cloud infrastructure.** `apps/myelin` + ships an orchestrator plus a containerized worker node + (`apps/myelin/node-image`) that provisions, stages models, and runs them. +- **Orchestration for sharded inference.** The node image includes a + [tinygrad](https://github.com/tinygrad/tinygrad) worker + (`apps/myelin/node-image/tinygrad_worker.py`); a vLLM backend is planned. + +## Examples + +**Working:** [`examples/ping-pong`](examples/ping-pong) — two actors volley on a +single-threaded runtime compiled to WebAssembly, driven tick-by-tick from Node. +Shows spawning, message passing, and death monitoring in one file. + +**Planned** (tracked in `.deployment-notes/ROADMAP.md`): + +- Two actors talking in-process, over IPC, and across a WAN — in Rust, Python, + and WASM — from the same code. +- Typed chunk streaming across IPC or WAN. +- A non-trivially sharded training job (not easily expressed in Ray). +- A full pipeline-parallel example of a model sharded across N ≥ 3 cheap GPUs. + +## Developing + +Requires the pinned nightly toolchain (`rust-toolchain.toml`): + +```sh cargo check --workspace -cargo xtask test +cargo xtask test # see `cargo xtask --help` ``` + +The language bindings (`crates/bindings/*`) build on demand with `-p` / +`--workspace`, not during normal native iteration. + +## Status + +swactor is early and under active development. The runtime, clustering, and the +`myelin` node are exercised by the workspace test suite, but APIs are still +moving. + +## License + +Licensed under the [GNU Affero General Public License v3.0 only] +(./LICENSE) (`AGPL-3.0-only`). The AGPL's network clause (§13) requires anyone +who runs a modified swactor as a network service to offer its source to users. +The copyright holder is not bound by their own license and may relicense future +releases freely; external contributors should expect a CLA requirement before +changes are merged. diff --git a/apps/myelin/Cargo.toml b/apps/myelin/Cargo.toml index fa29a2f..290e34b 100644 --- a/apps/myelin/Cargo.toml +++ b/apps/myelin/Cargo.toml @@ -2,6 +2,7 @@ name = "myelin" version = "0.1.0" edition = "2024" +license = "AGPL-3.0-only" publish = false autobins = false diff --git a/crates/bindings/python/Cargo.toml b/crates/bindings/python/Cargo.toml index 3488195..5e3afdd 100644 --- a/crates/bindings/python/Cargo.toml +++ b/crates/bindings/python/Cargo.toml @@ -2,6 +2,7 @@ name = "python" version = "0.1.0" edition = "2024" +license = "AGPL-3.0-only" [lib] name = "swactor" diff --git a/crates/bindings/wasm-crypto/Cargo.toml b/crates/bindings/wasm-crypto/Cargo.toml index 5e31df5..45cf493 100644 --- a/crates/bindings/wasm-crypto/Cargo.toml +++ b/crates/bindings/wasm-crypto/Cargo.toml @@ -2,6 +2,7 @@ name = "wasm-crypto" version = "0.1.0" edition = "2021" +license = "AGPL-3.0-only" [lib] crate-type = ["cdylib"] diff --git a/crates/bindings/wasm-runtime/Cargo.toml b/crates/bindings/wasm-runtime/Cargo.toml index a227dbc..c47943c 100644 --- a/crates/bindings/wasm-runtime/Cargo.toml +++ b/crates/bindings/wasm-runtime/Cargo.toml @@ -2,6 +2,7 @@ name = "wasm-runtime" version = "0.1.0" edition = "2024" +license = "AGPL-3.0-only" [lib] crate-type = ["cdylib"] diff --git a/crates/dashboard/Cargo.toml b/crates/dashboard/Cargo.toml index 67803de..85f875f 100644 --- a/crates/dashboard/Cargo.toml +++ b/crates/dashboard/Cargo.toml @@ -2,6 +2,7 @@ name = "dashboard" version = "0.1.0" edition = "2024" +license = "AGPL-3.0-only" [dependencies] axum = "0.8" diff --git a/crates/data-plane/Cargo.toml b/crates/data-plane/Cargo.toml index 96fe77f..4403d93 100644 --- a/crates/data-plane/Cargo.toml +++ b/crates/data-plane/Cargo.toml @@ -2,6 +2,7 @@ name = "data-plane" version = "0.1.0" edition = "2024" +license = "AGPL-3.0-only" publish = false [dependencies] diff --git a/crates/datastream/Cargo.toml b/crates/datastream/Cargo.toml index c6510c1..a42c7f3 100644 --- a/crates/datastream/Cargo.toml +++ b/crates/datastream/Cargo.toml @@ -2,6 +2,7 @@ name = "datastream" version = "0.1.0" edition = "2024" +license = "AGPL-3.0-only" [dependencies] swactor = { path = "../..", features = ["serde", "transport"] } diff --git a/crates/distribution/Cargo.toml b/crates/distribution/Cargo.toml index a4793ac..55c2dd1 100644 --- a/crates/distribution/Cargo.toml +++ b/crates/distribution/Cargo.toml @@ -2,6 +2,7 @@ name = "distribution" version = "0.1.0" edition = "2024" +license = "AGPL-3.0-only" [features] default = [] diff --git a/crates/iroh-driver/Cargo.toml b/crates/iroh-driver/Cargo.toml index 5cfeb00..516b013 100644 --- a/crates/iroh-driver/Cargo.toml +++ b/crates/iroh-driver/Cargo.toml @@ -2,6 +2,7 @@ name = "iroh-driver" version = "0.1.0" edition = "2024" +license = "AGPL-3.0-only" [lib] name = "iroh_driver" diff --git a/crates/process/Cargo.toml b/crates/process/Cargo.toml index 9bce661..3aef69c 100644 --- a/crates/process/Cargo.toml +++ b/crates/process/Cargo.toml @@ -2,6 +2,7 @@ name = "swactor-process" version = "0.1.0" edition = "2024" +license = "AGPL-3.0-only" [dependencies] swactor = { path = "../..", default-features = false, features = ["no_random"] } diff --git a/crates/provisioning/Cargo.toml b/crates/provisioning/Cargo.toml index 56ab86d..9cb4de0 100644 --- a/crates/provisioning/Cargo.toml +++ b/crates/provisioning/Cargo.toml @@ -2,6 +2,7 @@ name = "provisioning" version = "0.1.0" edition = "2024" +license = "AGPL-3.0-only" publish = false [dependencies] diff --git a/crates/transport/Cargo.toml b/crates/transport/Cargo.toml index 7eb5c6b..6b9a404 100644 --- a/crates/transport/Cargo.toml +++ b/crates/transport/Cargo.toml @@ -2,6 +2,7 @@ name = "swactor-transport" version = "0.1.0" edition = "2021" +license = "AGPL-3.0-only" [lib] name = "swactor_transport" diff --git a/examples/ping-pong/.gitignore b/examples/ping-pong/.gitignore new file mode 100644 index 0000000..9fbaefa --- /dev/null +++ b/examples/ping-pong/.gitignore @@ -0,0 +1,3 @@ +# wasm-pack build output (regenerated by ./run.sh and ./serve.sh) +/pkg +/pkg-web diff --git a/examples/ping-pong/Cargo.lock b/examples/ping-pong/Cargo.lock new file mode 100644 index 0000000..c5fa451 --- /dev/null +++ b/examples/ping-pong/Cargo.lock @@ -0,0 +1,268 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 4 + +[[package]] +name = "bitflags" +version = "2.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b588b76d00fde79687d7646a9b5bdf3cc0f655e0bbd080335a95d7e96f3587da" + +[[package]] +name = "bumpalo" +version = "3.20.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72f5acc6cb2ba439de613abc23857ec3d78374d8ed5ac84e9d11336e87da8649" + +[[package]] +name = "cfg-if" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801" + +[[package]] +name = "crossbeam-queue" +version = "0.3.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "803d13fb3b09d88be9f4dbc29062c66b19bf7170867ceb746d2a8689bf6c7a26" +dependencies = [ + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-utils" +version = "0.8.22" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "61803da095bee82a81bb1a452ecc25d3b2f1416d1897eb86430c6159ef717c17" + +[[package]] +name = "futures-core" +version = "0.3.33" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2cd50c473c80f6d7c3670a752354b8e569b1a7cbfdc0419ec88e5edad85e0dc7" + +[[package]] +name = "futures-task" +version = "0.3.33" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b231ed28831efb4a61a08580c4bc233ec56bc009f4cd8f52da2c3cb97df0c109" + +[[package]] +name = "futures-util" +version = "0.3.33" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a77a90a256fce34da66415271e30f94ee91c57b04b8a2c042d9cf3220179deaa" +dependencies = [ + "futures-core", + "futures-task", + "pin-project-lite", + "slab", +] + +[[package]] +name = "js-sys" +version = "0.3.103" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53b44bfcdb3f8d5837a46dae1ca9660a837176eee74a28b229bc626816589102" +dependencies = [ + "cfg-if", + "futures-util", + "wasm-bindgen", +] + +[[package]] +name = "libc" +version = "0.2.189" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3eaf3ede3fee6db1a4c2ee091bf8a8b4dccdc6d17f656fb07896ee72867612f2" + +[[package]] +name = "lock_api" +version = "0.4.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "224399e74b87b5f3557511d98dff8b14089b3dadafcab6bb93eab67d3aace965" +dependencies = [ + "scopeguard", +] + +[[package]] +name = "once_cell" +version = "1.21.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50" + +[[package]] +name = "parking_lot" +version = "0.12.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93857453250e3077bd71ff98b6a65ea6621a19bb0f559a85248955ac12c45a1a" +dependencies = [ + "lock_api", + "parking_lot_core", +] + +[[package]] +name = "parking_lot_core" +version = "0.9.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2621685985a2ebf1c516881c026032ac7deafcda1a2c9b7850dc81e3dfcb64c1" +dependencies = [ + "cfg-if", + "libc", + "redox_syscall", + "smallvec", + "windows-link", +] + +[[package]] +name = "pin-project-lite" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd" + +[[package]] +name = "pingpong" +version = "0.1.0" +dependencies = [ + "swactor", + "wasm-bindgen", +] + +[[package]] +name = "proc-macro2" +version = "1.0.107" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "985e7ec9bb745e6ce6535b544d84d6cd6f7ad8bd711c398938ae983b91a766d9" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "quote" +version = "1.0.47" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fbf4db142a473a8d80c26bbf18454ed458bf8d26c8219c331daecfdbd079001" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "redox_syscall" +version = "0.5.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed2bf2547551a7053d6fdfafda3f938979645c44812fbfcda098faae3f1a362d" +dependencies = [ + "bitflags", +] + +[[package]] +name = "rustversion" +version = "1.0.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf54715a573b99ac80df0bc206da022bcd442c974952c7b9720069370852e21f" + +[[package]] +name = "scopeguard" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49" + +[[package]] +name = "slab" +version = "0.4.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c790de23124f9ab44544d7ac05d60440adc586479ce501c1d6d7da3cd8c9cf5" + +[[package]] +name = "smallvec" +version = "1.15.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8ed6a63f02c8539c91a8685a86f4099661ba3da017932f6ebbea6de3f0fa7c90" + +[[package]] +name = "swactor" +version = "0.1.0" +dependencies = [ + "crossbeam-queue", + "crossbeam-utils", + "parking_lot", + "web-time", +] + +[[package]] +name = "syn" +version = "2.0.119" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "872831b642d1a07999a962a351ed35b955ea2cfc8f3862091e2a240a84f17297" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "unicode-ident" +version = "1.0.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75" + +[[package]] +name = "wasm-bindgen" +version = "0.2.126" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4b067c0c11094aef6b7a801c1e34a26affafdf3d051dba08456b868789aaf9a4" +dependencies = [ + "cfg-if", + "once_cell", + "rustversion", + "wasm-bindgen-macro", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-macro" +version = "0.2.126" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "167ce5e579f6bcf889c4f7175a8a5a585de84e8ff93976ce393efa5f2837aab1" +dependencies = [ + "quote", + "wasm-bindgen-macro-support", +] + +[[package]] +name = "wasm-bindgen-macro-support" +version = "0.2.126" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f3997c7839262f4ef12cf90b818d6340c18e80f263f1a94bf157d0ec4420380e" +dependencies = [ + "bumpalo", + "proc-macro2", + "quote", + "syn", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-shared" +version = "0.2.126" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc1b4cb0cc549fcf58d7dfc081778139b3d283a081644e833e84682ad71cea24" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "web-time" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aa30049b1c872b72c89866d458eae9f20380ab280ffd1b1e18df2d3e2d98cfe0" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "windows-link" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5" diff --git a/examples/ping-pong/Cargo.toml b/examples/ping-pong/Cargo.toml new file mode 100644 index 0000000..87080cc --- /dev/null +++ b/examples/ping-pong/Cargo.toml @@ -0,0 +1,18 @@ +[package] +name = "pingpong" +version = "0.1.0" +edition = "2024" +license = "AGPL-3.0-only" +publish = false +description = "swactor ping-pong: a minimal WebAssembly actor demo" + +[lib] +crate-type = ["cdylib"] + +# Declares this example as its own workspace root so it builds standalone +# (with `./run.sh`) without joining the root workspace. +[workspace] + +[dependencies] +swactor = { path = "../..", default-features = false, features = ["wasm", "std"] } +wasm-bindgen = "0.2" diff --git a/examples/ping-pong/index.html b/examples/ping-pong/index.html new file mode 100644 index 0000000..bbeb8eb --- /dev/null +++ b/examples/ping-pong/index.html @@ -0,0 +1,159 @@ + + + + + +swactor · ping-pong + + + + +

swactor · ping-pong

+

+ Two actors volley a ball on a WebAssembly actor runtime. The browser drives it + one tick() at a time; each line below is one actor message.
+ swactor dashboard ↗ + — live actor stats, served alongside this page. +

+ +
+
+ + + + +
+
+
+ +
Loading wasm…
+ + + + diff --git a/examples/ping-pong/run.mjs b/examples/ping-pong/run.mjs new file mode 100644 index 0000000..f0fe58b --- /dev/null +++ b/examples/ping-pong/run.mjs @@ -0,0 +1,28 @@ +// swactor ping-pong -- host driver. +// +// Spawns a Ping and a Pong actor on the wasm actor runtime, then drives it +// tick-by-tick, printing each volley as it happens. Pass an optional volley cap: +// +// node run.mjs [volleys] (default 10) + +import { App } from "./pkg/pingpong.js"; + +const max = Math.max(2, Number(process.argv[2] ?? 10)); + +const app = new App(); +const log = app.new_log(); +const pong = app.spawn_pong(log.addr(), max); +app.spawn_ping(pong, log.addr(), max); + +console.log(`\n== swactor ping-pong == target ${max} volleys\n`); + +for (let t = 0; t < 1000; t++) { + app.tick(); + let line; + while ((line = log.try_recv())) console.log(" " + line); + if (app.actor_count() === 0) break; +} + +console.log( + `\nactors remaining: ${app.actor_count()}, messages processed: ${app.total_messages()}\n`, +); diff --git a/examples/ping-pong/run.sh b/examples/ping-pong/run.sh new file mode 100755 index 0000000..fba4c4f --- /dev/null +++ b/examples/ping-pong/run.sh @@ -0,0 +1,11 @@ +#!/usr/bin/env bash +# swactor ping-pong -- compile the demo to WebAssembly and run it. +# +# One-liner from this directory: ./run.sh [volleys] +# +# Compiles the Rust cdylib to ./pkg/ via wasm-pack, then drives it with Node. +set -euo pipefail +cd "$(dirname "$0")" + +wasm-pack build --target nodejs --out-name pingpong +node run.mjs "$@" diff --git a/examples/ping-pong/serve.sh b/examples/ping-pong/serve.sh new file mode 100755 index 0000000..81ea45b --- /dev/null +++ b/examples/ping-pong/serve.sh @@ -0,0 +1,40 @@ +#!/usr/bin/env bash +# swactor live demo -- serve the ping-pong wasm page AND the swactor dashboard. +# +# One-liner from this directory: ./serve.sh [port] +# +# Brings up two local servers: +# - swactor dashboard (native Rust; a dummy node feeds it live actor stats) +# at http://localhost:9090/ +# - ping-pong wasm demo (static files) +# at http://localhost:/ (default 8000) +# +# Ctrl+C stops both. +set -euo pipefail +cd "$(dirname "$0")" +ROOT="$(cd ../.. && pwd)" + +port="${1:-8000}" +dash_port=9090 + +# --- swactor dashboard ------------------------------------------------------- +# The dashboard is a workspace member; build it from the root manifest, then run +# the dummy-node binary, which starts the Axum server and publishes live stats. +echo ">> building swactor dashboard..." +cargo build --manifest-path "$ROOT/Cargo.toml" -p dashboard --bin swactor_dummy_node +echo ">> launching dashboard on :${dash_port}" +"$ROOT/target/debug/swactor_dummy_node" & +dash_pid=$! +cleanup() { kill "$dash_pid" 2>/dev/null || true; wait "$dash_pid" 2>/dev/null || true; } +trap cleanup EXIT INT TERM + +# --- ping-pong wasm page ----------------------------------------------------- +wasm-pack build --target web --out-name pingpong --out-dir pkg-web + +echo +echo ">> ping-pong : http://localhost:${port}/" +echo ">> dashboard : http://localhost:${dash_port}/ (live swactor stats)" +echo ">> (Ctrl+C to stop)" +echo + +python3 -m http.server "$port" diff --git a/examples/ping-pong/src/lib.rs b/examples/ping-pong/src/lib.rs new file mode 100644 index 0000000..a4be31d --- /dev/null +++ b/examples/ping-pong/src/lib.rs @@ -0,0 +1,232 @@ +//! swactor · ping-pong -- a minimal WebAssembly actor demo. +//! +//! Two actors, `Ping` and `Pong`, volley a ball back and forth on a +//! single-threaded actor runtime compiled to wasm. The host (Node.js) advances +//! the runtime one step at a time with `tick()` and drains a shared log inbox +//! to print each volley. +//! +//! When the volley cap is reached the hitter stops; the other actor, which is +//! *watching* it, observes the death, posts a final summary, and stops too. +//! This shows the three load-bearing swactor ideas in one place: spawning +//! actors, message passing, and death monitoring. +//! +//! Build & run from this directory: `./run.sh` + +use std::sync::Arc; + +use wasm_bindgen::prelude::*; + +use swactor::actor::{ActorAddress, ActorExited, ActorInterface}; +use swactor::runtime::{Ctx, Inbox, Runtime as SwactorRuntime, RuntimeConfig}; +use swactor::std::{CtxWatching, StdExtension}; + +// ─── Host-facing bindings ─────────────────────────────────────────────────── + +/// Opaque actor-address handle, passed between spawn calls and the host. +#[wasm_bindgen] +#[derive(Clone)] +pub struct Addr(ActorAddress); + +/// Inbox the host polls each tick for log lines and the final summary. +#[wasm_bindgen] +pub struct LogInbox { + inner: Inbox, +} + +#[wasm_bindgen] +impl LogInbox { + /// The address actors send their log lines to. + pub fn addr(&self) -> Addr { + Addr(*self.inner.addr()) + } + + /// Pop the next log line, or `undefined` when empty. + pub fn try_recv(&self) -> Option { + self.inner.try_recv() + } +} + +/// The ping-pong app: a single-threaded swactor runtime with the std extension +/// (watching) installed. The host drives it by calling [`App::tick`]. +#[wasm_bindgen] +pub struct App { + rt: SwactorRuntime, +} + +#[wasm_bindgen] +impl App { + #[wasm_bindgen(constructor)] + pub fn new() -> App { + let rt = SwactorRuntime::new(RuntimeConfig { + num_threads: 1, + ..RuntimeConfig::default() + }) + .with_extension(Arc::new(StdExtension::new())); + App { rt } + } + + /// Advance the runtime one tick. + pub fn tick(&self) { + self.rt.tick(); + } + + /// Actors currently alive. + pub fn actor_count(&self) -> usize { + self.rt.stats().actors.len() + } + + /// Total messages processed across all workers. + pub fn total_messages(&self) -> f64 { + self.rt + .stats() + .workers + .iter() + .map(|w| w.messages_processed) + .sum::() as f64 + } + + /// Create a log inbox the host drains each tick. + pub fn new_log(&self) -> LogInbox { + LogInbox { + inner: self.rt.new_inbox().expect("new_log"), + } + } + + /// Spawn the `Pong` actor. Returns its address. + pub fn spawn_pong(&self, log: &Addr, max_volleys: u32) -> Addr { + let addr = self + .rt + .spawn(Pong { + log: log.0, + max: max_volleys, + }) + .expect("spawn pong"); + Addr(addr) + } + + /// Spawn the `Ping` actor, pointed at an existing `Pong`. Returns its address. + pub fn spawn_ping(&self, pong: &Addr, log: &Addr, max_volleys: u32) -> Addr { + let addr = self + .rt + .spawn(Ping { + pong: pong.0, + log: log.0, + max: max_volleys, + }) + .expect("spawn ping"); + Addr(addr) + } +} + +// ─── The ball ─────────────────────────────────────────────────────────────── + +/// A ball in flight between the two actors. +/// +/// `volleys` is the running hit count -- each hitter increments it. `from` is +/// the address the ball came from (and should be returned to). `Ping` knows +/// `Pong` from spawn time so only `Pong` reads `from`, but both set it so the +/// protocol reads symmetrically. +#[derive(Clone)] +struct Ball { + volleys: u32, + from: ActorAddress, +} + +// ─── Ping ─────────────────────────────────────────────────────────────────── + +struct Ping { + pong: ActorAddress, + log: ActorAddress, + max: u32, +} + +impl Ping { + /// Hit the ball as volley number `v`: log it, then either return it to Pong + /// or, if the cap is reached, stop. + fn volley(&self, ctx: &Ctx, v: u32) { + let _ = ctx.send(self.log, format!("ping | volley {:>2}/{}", v, self.max)); + if v < self.max { + let _ = ctx.send( + self.pong, + Ball { + volleys: v, + from: ctx.self_addr(), + }, + ); + } else { + let _ = ctx.send(self.log, "ping | cap reached, stopping".to_string()); + ctx.stop_self(); + } + } +} + +impl ActorInterface for Ping { + type Incoming = Ball; + type Response = (); + + fn on_start(&mut self, ctx: &Ctx) { + // Ping knows Pong from spawn time, so it can watch it immediately. + ctx.watch(self.pong); + self.volley(ctx, 1); // serve + } + + fn handle(&mut self, ctx: &Ctx, ball: Ball) { + // Pong returned the ball; this is our next hit. + self.volley(ctx, ball.volleys + 1); + } + + fn on_actor_exit(&mut self, ctx: &Ctx, exited: ActorExited) { + let _ = ctx.send( + self.log, + format!( + "done | rally complete -- {} volleys played (pong exited: {:?})", + self.max, exited.reason + ), + ); + ctx.stop_self(); + } +} + +// ─── Pong ─────────────────────────────────────────────────────────────────── + +struct Pong { + log: ActorAddress, + max: u32, +} + +impl ActorInterface for Pong { + type Incoming = Ball; + type Response = (); + + fn handle(&mut self, ctx: &Ctx, ball: Ball) { + // Watch whoever served this ball. Idempotent across volleys, so this is + // also how Pong (spawned before Ping) first learns Ping's address. + ctx.watch(ball.from); + + let v = ball.volleys + 1; + let _ = ctx.send(self.log, format!("pong | volley {:>2}/{}", v, self.max)); + if v < self.max { + let _ = ctx.send( + ball.from, + Ball { + volleys: v, + from: ctx.self_addr(), + }, + ); + } else { + let _ = ctx.send(self.log, "pong | cap reached, stopping".to_string()); + ctx.stop_self(); + } + } + + fn on_actor_exit(&mut self, ctx: &Ctx, exited: ActorExited) { + let _ = ctx.send( + self.log, + format!( + "done | rally complete -- {} volleys played (ping exited: {:?})", + self.max, exited.reason + ), + ); + ctx.stop_self(); + } +} diff --git a/tools/vastai/Cargo.toml b/tools/vastai/Cargo.toml index 0b88b55..158acbc 100644 --- a/tools/vastai/Cargo.toml +++ b/tools/vastai/Cargo.toml @@ -2,6 +2,7 @@ name = "swactor-vastai" version = "0.1.0" edition = "2024" +license = "AGPL-3.0-only" publish = false [dependencies] diff --git a/xtask/Cargo.toml b/xtask/Cargo.toml index ba651d8..7c71cc8 100644 --- a/xtask/Cargo.toml +++ b/xtask/Cargo.toml @@ -2,6 +2,7 @@ name = "xtask" version = "0.1.0" edition = "2024" +license = "AGPL-3.0-only" [dependencies] serde_json = "1"