Fcalva/cyclone
1
0
Fork 0
mirror of https://github.com/justinethier/cyclone.git synced 2025-05-23 20:15:05 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Revised shared objects section

Browse source
This commit is contained in:
Justin Ethier 2019-06-14 13:24:25 -04:00
parent 05ee7961be
commit 67d7bb52a9
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/api/cyclone/concurrent.md
View file

@ -1,6 +1,6 @@
# Concurrency Library
The `(cyclone concurrency)` library provides functions to make it easier to write concurrent programs.
The `(cyclone concurrent)` library provides functions to make it easier to write concurrent programs.
## Index
@ -15,11 +15,15 @@ The `(cyclone concurrency)` library provides functions to make it easier to writ
## Shared Objects
By default Cyclone allocates new objects in a thread-local stack. This is very efficient for computations done within a thread but is problematic when an object must be shared by multiple threads.
By default Cyclone allocates new objects in a thread-local stack. This is very efficient for computations done within a thread but is problematic when an object must be shared by multiple threads. An object on another thread's stack could be overwritten or moved at any time, causing undefined behavior.
TODO: explain this better
Shared objects are the method that Cyclone uses to deal with this problem. A shared object is any object that is located in a segment of memory that may be shared across threads. Note that concurrency primitives must still be used to coordinate access to these objects among multiple threads!
TODO: list objects shared by default (mutex, atom, cond-var, etc) or not affected (immediates, booleans, symbols, etc)
The following types of objects are already shared:
- Concurrency primitives (mutex, conditional variable, atom). These object are always allocated on the heap since the intent is for multiple threads to use them for synchronization.
- Booleans, bignums, fixnum integers, symbols, and the EOF object.
### make-shared