fiberd 0.2.0__tar.gz

fiberd-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

fiberd-0.2.0/MANIFEST.in

@@ -0,0 +1,5 @@
+# The sdist keeps the extension's sources on every host, and the unit tests
+# with wheel-test.sh, which cibuildwheel runs against each wheel. setup.py
+# adds the C library, LICENSE and NOTICE.
+include src/fiberd/*.c wheel-test.sh
+recursive-include src/fiberd *_test.py conftest.py _test*.py

fiberd-0.2.0/NOTICE

@@ -0,0 +1,4 @@
+fiberd
+Copyright The fiberd Authors
+
+Licensed under the Apache License, Version 2.0, in the LICENSE file.

fiberd-0.2.0/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: fiberd
+Version: 0.2.0
+Summary: The fiberd SDK. fiberd.template for code that runs inside a fiber, fiberd.client for callers of fiberd.
+Author: Heba Elayoty
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/helayoty/fiberd
+Project-URL: Documentation, https://github.com/helayoty/fiberd/blob/main/sdk/python/README.md
+Project-URL: Source, https://github.com/helayoty/fiberd/tree/main/sdk/python
+Project-URL: Issues, https://github.com/helayoty/fiberd/issues
+Project-URL: Changelog, https://github.com/helayoty/fiberd/releases
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: C
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: System :: Distributed Computing
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+Provides-Extra: client
+Requires-Dist: grpcio>=1.51; extra == "client"
+Requires-Dist: protobuf>=3.21.12; extra == "client"
+
+# fiberd for Python
+
+The Python SDK. `fiberd.template` is for code that runs inside a [fiber](https://github.com/helayoty/fiberd/blob/v0.2.0/sdk/python/../../docs/glossary.md#fiber), such as an AI agent. `fiberd.client` is for callers of fiberd, such as the activator that asks for one.
+
+## Install
+
+```bash
+pip install fiberd
+```
+
+The wheels are for CPython 3.14 or later on Linux, x86_64 or aarch64, with glibc 2.28 or later. Anywhere else pip builds the sdist. On Linux that needs a C compiler and the Python headers. Off Linux it builds without the extension. There `fiberd.client` works and `fiberd.template` raises `ImportError` when used.
+
+## Template
+
+A template warms up once and forks a fiber for every [Clone](https://github.com/helayoty/fiberd/blob/v0.2.0/sdk/python/../../docs/glossary.md#clone). Call `init()` first, do the warm-up, then `serve(on_fiber)`.
+
+```python
+import json
+import fiberd.template as ft
+
+ft.init()                                # first line, before any thread
+
+# Your own slow setup goes here (imports, model weights, config). It runs
+# once, and every fiber is a fork of this process, born with it loaded.
+with open("prompts.json") as fp:
+    prompts = json.load(fp)
+
+def on_fiber(f: ft.Fiber) -> int:        # runs in the fiber
+    task = json.loads(f.payload)         # the bytes the caller sent with the Clone
+    def handle(conn):
+        question = conn.recv(4096).decode()
+        conn.sendall(f"{prompts[task['kind']]} {question}".encode())
+    f.serve(handle)                      # listens on f.endpoint, reports ready, hands each connection over
+    return 0
+
+ft.serve(on_fiber)
+```
+
+`fiberd-template pkg.module:on_fiber` runs a module the same way, with `init()` before the import.
+
+A `Fiber` carries `fence`, `fence_parts`, `endpoint`, `kind` (unix, tcp or handoff), `payload`, `session`, `env`, `incarnation` and `backend` (fork or gvisor). `listen()` returns a bound socket for an author who runs their own server, `ready()` reports to fiberd once listening, `check_fence()` notices a resume, and `stopping` is set when the fiber is asked to stop. `@ft.on_incarnation` runs a function in every copy of the template, after `random` and OpenSSL are reseeded. The rules `serve()` enforces, and why, are in [docs/design/sdk.md](https://github.com/helayoty/fiberd/blob/v0.2.0/sdk/python/../../docs/design/sdk.md).
+
+A [handoff](https://github.com/helayoty/fiberd/blob/v0.2.0/sdk/python/../../docs/glossary.md#handoff) fiber listens on nothing. `f.serve(handle)` works the same there. Each `conn` is an `ssl.SSLSocket`, with TLS terminated under the grant's identity and the bound caller's certificate the one the handshake admits, as `f.accept()` returns it.
+
+`on_fiber` may be `async def`. Then `await f.serve_async(handler)` serves an `async def handler(reader, writer)`, and `async for reader, writer in f.connections()` is the async twin of `accept()`.
+
+## Client
+
+A caller holds a signed [grant](https://github.com/helayoty/fiberd/blob/v0.2.0/sdk/python/../../docs/glossary.md#grant) and asks a [home](https://github.com/helayoty/fiberd/blob/v0.2.0/sdk/python/../../docs/glossary.md#home) for fibers under it. `pip install 'fiberd[client]'` adds grpcio and protobuf, which a template never needs.
+
+```python
+import time
+from fiberd.client import Client, Shed, Deferred
+
+def clone(c, jwt, session):
+    while True:
+        try:
+            return c.clone(jwt, session=session, payload=b'{"task":1}')  # a Fiber, with id, fence, endpoint and kind
+        except Shed as e:                                                 # the home is busy, retry after the hint
+            time.sleep(e.retry_after)
+
+with Client.dial_tls("home:7443", cert="me.pem", key="me-key.pem", ca="ca.pem") as c:
+    try:
+        f = clone(c, jwt, "conv-42")
+    except Deferred as e:              # this home cannot serve it, take the ordinary path or go to e.preferred_home
+        raise SystemExit(f"deferred: {e.reason}")
+    with f.dial() as sock:             # its unix or tcp endpoint
+        sock.sendall(b"hello\n")
+    c.park(f)                          # checkpoint it and free its place
+    f = clone(c, jwt, "conv-42")       # kind RESUME, under the next fence
+    c.release(f, discard=True)         # end it, and drop its parked delta
+```
+
+`Client.dial(addr)` is the plaintext form for a home started with `-insecure-plaintext`. A [handoff](https://github.com/helayoty/fiberd/blob/v0.2.0/sdk/python/../../docs/glossary.md#handoff) fiber is reached with `f.dial_handoff(cert, key)`, which sends its routing key as the server name, admits only the fiber's certificate from the Clone in the handshake and checks its key pin after it. `TierGap` and `NotFound` are the other typed outcomes, and any other failure is the `grpc.RpcError` as raised. `c.watch()` yields one status per grant as the home publishes it. `fiberd.client.aio.Client` has the same methods as coroutines, with `watch` as an async iterator. The token is accepted as a string or a callable that returns one, and it is never stored, logged or shown by a repr.
+
+## Build and test
+
+The extension needs Linux and a C toolchain. In the dev container, from the repository root.
+
+```bash
+make python-test            # build the extension in place and run the unit tests
+make conform-proc-python    # C1-C10 against the reference template, fiberd.template.ref
+make conform-gvisor-python  # the same on gVisor, from a rootfs hack/python/rootfs.sh builds with CPython in it
+make conform-runc-python    # and on runc, from the same rootfs
+make python-dist            # the sdist, a wheel built from it, and the unit tests against that wheel
+```
+
+The same template serves on proc, runc and gVisor. On runc and gVisor it runs from a root filesystem that holds the interpreter and the package, which `hack/python/rootfs.sh <dir>` builds from the dev image for those runs.
+
+Elsewhere, `pip install -e 'sdk/python[client]' cryptography` builds it with what the client's tests import, and `python3 -m pytest sdk/python` runs the unit tests, which start no process.

fiberd-0.2.0/README.md

@@ -0,0 +1,90 @@
+# fiberd for Python
+
+The Python SDK. `fiberd.template` is for code that runs inside a [fiber](https://github.com/helayoty/fiberd/blob/v0.2.0/sdk/python/../../docs/glossary.md#fiber), such as an AI agent. `fiberd.client` is for callers of fiberd, such as the activator that asks for one.
+
+## Install
+
+```bash
+pip install fiberd
+```
+
+The wheels are for CPython 3.14 or later on Linux, x86_64 or aarch64, with glibc 2.28 or later. Anywhere else pip builds the sdist. On Linux that needs a C compiler and the Python headers. Off Linux it builds without the extension. There `fiberd.client` works and `fiberd.template` raises `ImportError` when used.
+
+## Template
+
+A template warms up once and forks a fiber for every [Clone](https://github.com/helayoty/fiberd/blob/v0.2.0/sdk/python/../../docs/glossary.md#clone). Call `init()` first, do the warm-up, then `serve(on_fiber)`.
+
+```python
+import json
+import fiberd.template as ft
+
+ft.init()                                # first line, before any thread
+
+# Your own slow setup goes here (imports, model weights, config). It runs
+# once, and every fiber is a fork of this process, born with it loaded.
+with open("prompts.json") as fp:
+    prompts = json.load(fp)
+
+def on_fiber(f: ft.Fiber) -> int:        # runs in the fiber
+    task = json.loads(f.payload)         # the bytes the caller sent with the Clone
+    def handle(conn):
+        question = conn.recv(4096).decode()
+        conn.sendall(f"{prompts[task['kind']]} {question}".encode())
+    f.serve(handle)                      # listens on f.endpoint, reports ready, hands each connection over
+    return 0
+
+ft.serve(on_fiber)
+```
+
+`fiberd-template pkg.module:on_fiber` runs a module the same way, with `init()` before the import.
+
+A `Fiber` carries `fence`, `fence_parts`, `endpoint`, `kind` (unix, tcp or handoff), `payload`, `session`, `env`, `incarnation` and `backend` (fork or gvisor). `listen()` returns a bound socket for an author who runs their own server, `ready()` reports to fiberd once listening, `check_fence()` notices a resume, and `stopping` is set when the fiber is asked to stop. `@ft.on_incarnation` runs a function in every copy of the template, after `random` and OpenSSL are reseeded. The rules `serve()` enforces, and why, are in [docs/design/sdk.md](https://github.com/helayoty/fiberd/blob/v0.2.0/sdk/python/../../docs/design/sdk.md).
+
+A [handoff](https://github.com/helayoty/fiberd/blob/v0.2.0/sdk/python/../../docs/glossary.md#handoff) fiber listens on nothing. `f.serve(handle)` works the same there. Each `conn` is an `ssl.SSLSocket`, with TLS terminated under the grant's identity and the bound caller's certificate the one the handshake admits, as `f.accept()` returns it.
+
+`on_fiber` may be `async def`. Then `await f.serve_async(handler)` serves an `async def handler(reader, writer)`, and `async for reader, writer in f.connections()` is the async twin of `accept()`.
+
+## Client
+
+A caller holds a signed [grant](https://github.com/helayoty/fiberd/blob/v0.2.0/sdk/python/../../docs/glossary.md#grant) and asks a [home](https://github.com/helayoty/fiberd/blob/v0.2.0/sdk/python/../../docs/glossary.md#home) for fibers under it. `pip install 'fiberd[client]'` adds grpcio and protobuf, which a template never needs.
+
+```python
+import time
+from fiberd.client import Client, Shed, Deferred
+
+def clone(c, jwt, session):
+    while True:
+        try:
+            return c.clone(jwt, session=session, payload=b'{"task":1}')  # a Fiber, with id, fence, endpoint and kind
+        except Shed as e:                                                 # the home is busy, retry after the hint
+            time.sleep(e.retry_after)
+
+with Client.dial_tls("home:7443", cert="me.pem", key="me-key.pem", ca="ca.pem") as c:
+    try:
+        f = clone(c, jwt, "conv-42")
+    except Deferred as e:              # this home cannot serve it, take the ordinary path or go to e.preferred_home
+        raise SystemExit(f"deferred: {e.reason}")
+    with f.dial() as sock:             # its unix or tcp endpoint
+        sock.sendall(b"hello\n")
+    c.park(f)                          # checkpoint it and free its place
+    f = clone(c, jwt, "conv-42")       # kind RESUME, under the next fence
+    c.release(f, discard=True)         # end it, and drop its parked delta
+```
+
+`Client.dial(addr)` is the plaintext form for a home started with `-insecure-plaintext`. A [handoff](https://github.com/helayoty/fiberd/blob/v0.2.0/sdk/python/../../docs/glossary.md#handoff) fiber is reached with `f.dial_handoff(cert, key)`, which sends its routing key as the server name, admits only the fiber's certificate from the Clone in the handshake and checks its key pin after it. `TierGap` and `NotFound` are the other typed outcomes, and any other failure is the `grpc.RpcError` as raised. `c.watch()` yields one status per grant as the home publishes it. `fiberd.client.aio.Client` has the same methods as coroutines, with `watch` as an async iterator. The token is accepted as a string or a callable that returns one, and it is never stored, logged or shown by a repr.
+
+## Build and test
+
+The extension needs Linux and a C toolchain. In the dev container, from the repository root.
+
+```bash
+make python-test            # build the extension in place and run the unit tests
+make conform-proc-python    # C1-C10 against the reference template, fiberd.template.ref
+make conform-gvisor-python  # the same on gVisor, from a rootfs hack/python/rootfs.sh builds with CPython in it
+make conform-runc-python    # and on runc, from the same rootfs
+make python-dist            # the sdist, a wheel built from it, and the unit tests against that wheel
+```
+
+The same template serves on proc, runc and gVisor. On runc and gVisor it runs from a root filesystem that holds the interpreter and the package, which `hack/python/rootfs.sh <dir>` builds from the dev image for those runs.
+
+Elsewhere, `pip install -e 'sdk/python[client]' cryptography` builds it with what the client's tests import, and `python3 -m pytest sdk/python` runs the unit tests, which start no process.