Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

solo5.h: Document that _acquire_ may only be called once #407

Merged
merged 1 commit into from
Sep 18, 2019
Merged

solo5.h: Document that _acquire_ may only be called once #407

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions include/solo5/solo5.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,14 @@ void solo5_exit(int status) __attribute__((noreturn));
*/
void solo5_abort(void) __attribute__((noreturn));

/*
* Set the architecture-specific TLS base register to (base).
*
* Solo5 implementations may return SOLO5_R_EINVAL if the (base) does not
* satisfy architecture-specific requirements.
*/
solo5_result_t solo5_set_tls_base(uintptr_t base);

/*
* Time.
*/
Expand Down Expand Up @@ -201,7 +209,8 @@ struct solo5_net_info {
* Acquires a handle to the network device declared as (name) in the
* application manifest. The returned handle is stored in (*handle), and
* properties of the network device are stored in (*info). Caller must supply
* space for struct solo5_net_info in (info).
* space for struct solo5_net_info in (info). This function may only be called
* once for each device (name). Subsequent calls will return SOLO5_R_EINVAL.
*/
solo5_result_t solo5_net_acquire(const char *name, solo5_handle_t *handle,
struct solo5_net_info *info);
Expand Down Expand Up @@ -236,10 +245,10 @@ solo5_result_t solo5_net_read(solo5_handle_t handle, uint8_t *buf,
*
* The minimum unit of I/O which can be performed on a block device is defined
* by solo5_block_info.block_size. In practice we currently also limit the
* *maximum* unit of I/O to the block size.
* *maximum* unit of I/O to a single block.
*
* These interfaces, depending on atomicity guarantees, may be extended to
* support I/O operations of >1 block per call.
* These interfaces, depending on atomicity guarantees, may be extended in the
* future to support I/O operations of >1 block per call.
*/

/*
Expand All @@ -253,10 +262,11 @@ struct solo5_block_info {
};

/*
* Acquires a handle to the block device declared as (name) in the
* application manifest. The returned handle is stored in (*handle), and
* properties of the block device are stored in (*info). Caller must supply
* space for struct solo5_block_info in (info).
* Acquires a handle to the block device declared as (name) in the application
* manifest. The returned handle is stored in (*handle), and properties of the
* block device are stored in (*info). Caller must supply space for struct
* solo5_block_info in (info). This function may only be called once for each
* device (name). Subsequent calls will return SOLO5_R_EINVAL.
*/
solo5_result_t solo5_block_acquire(const char *name, solo5_handle_t *handle,
struct solo5_block_info *info);
Expand Down Expand Up @@ -289,13 +299,4 @@ solo5_result_t solo5_block_write(solo5_handle_t handle, solo5_off_t offset,
solo5_result_t solo5_block_read(solo5_handle_t handle, solo5_off_t offset,
uint8_t *buf, size_t size);

/*
* Set the TLS base register. This sets the %fs segment register on
* x86_64 or the TPIDR_EL0 register on aarch64.
*
* Solo5 implementations may return SOLO5_R_EINVAL if the (base) does not
* satisfy arch-specific requirements.
*/
solo5_result_t solo5_set_tls_base(uintptr_t base);

#endif