#include "os/core.h"
#include "os/impl/impl.h"
#include <stdbool.h>

Include dependency graph for os.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	os_library_t
	a shared library handle More...

struct	os_file_t
	a file handle More...

struct	os_inode_t
	an inode entry More...

struct	os_iter_t
	a directory iterator More...

struct	os_thread_t
	a thread handle More...

struct	os_mutex_t
	a mutex handle More...

Functions

CT_OS_API os_error_t	os_thread_init (OUT_NOTNULL os_thread_t thread, const char name, os_thread_fn_t fn, void *arg)

CT_OS_API os_error_t	os_thread_join (os_thread_t thread, OUT_NOTNULL os_status_t status)

CT_OS_API const char *	os_thread_name (const os_thread_t *thread)

CT_OS_API bool	os_thread_cmpid (const os_thread_t *thread, os_thread_id_t id)

typedef os_exitcode_t(*	os_thread_fn_t) (void *arg)

CT_OS_API os_error_t	os_library_open (const char path, OUT_NOTNULL os_library_t library)
	open a shared library from disk More...

CT_OS_API os_error_t	os_library_close (STA_RELEASE os_library_t *library)
	close a shared library More...

CT_NODISCARD CT_OS_API os_error_t	os_library_symbol (os_library_t library, OUT_NOTNULL void symbol, const char name)
	get a symbol from a shared library More...

CT_NODISCARD CT_OS_API const char *	os_library_name (const os_library_t *library)
	get the name of a shared library More...

CT_NODISCARD OUT_NOTNULL os_inode_t *	dir

CT_OS_API os_error_t	os_file_copy (const char dst, const char src)
	copy a file from one location to another More...

CT_OS_API os_error_t	os_file_exists (const char *path)
	check if a file exists More...

CT_OS_API os_error_t	os_file_create (const char *path)
	create a file More...

CT_OS_API os_error_t	os_file_delete (const char *path)
	delete a file More...

CT_OS_API os_error_t	os_dir_create (const char *path)
	check if a directory exists More...

CT_OS_API os_error_t	os_dir_delete (const char *path)
	delete a directory More...

CT_OS_API bool	os_dir_exists (const char *path)
	check if a directory exists More...

CT_NODISCARD CT_OS_API os_dirent_t	os_dirent_type (const char *path)
	get the type of a paths inode entry More...

CT_OS_API os_error_t	os_iter_begin (const char path, OUT_NOTNULL os_iter_t iter)
	directory iteration More...

CT_OS_API os_error_t	os_iter_end (STA_RELEASE os_iter_t *iter)
	close a directory iterator More...

CT_NODISCARD	STA_SUCCESS (return==true) CT_OS_API bool os_iter_next(os_iter_t *iter
	get the next directory entry More...

CT_OS_API os_error_t	os_iter_error (const os_iter_t *iter)
	get the error state of a directory iterator More...

CT_OS_API os_error_t	os_file_open (const char path, os_access_t access, OUT_NOTNULL os_file_t file)
	file api More...

CT_OS_API os_error_t	os_tmpfile_open (OUT_NOTNULL os_file_t *file)
	create a temporary file More...

CT_OS_API os_error_t	os_file_close (STA_RELEASE os_file_t *file)
	close a file More...

CT_OS_API os_error_t	os_file_read (os_file_t file, STA_WRITES(size) void buffer, size_t size, OUT_NOTNULL size_t *actual)
	read from a file More...

CT_OS_API os_error_t	os_file_write (os_file_t file, STA_READS(size) const void buffer, size_t size, OUT_NOTNULL size_t *actual)
	write to a file More...

CT_OS_API os_error_t	os_file_size (os_file_t file, OUT_NOTNULL size_t actual)
	get the size of a file More...

CT_OS_API os_error_t	os_file_seek (os_file_t file, size_t offset, OUT_NOTNULL size_t actual)
	seek to a position in a file More...

CT_OS_API os_error_t	os_file_tell (os_file_t file, OUT_NOTNULL size_t actual)
	get the current position in a file More...

CT_OS_API os_error_t	os_file_resize (os_file_t *file, size_t size)
	truncate/expand a file to a specific size More...

CT_OS_API os_error_t	os_file_map (os_file_t file, os_protect_t protect, size_t size, OUT_NOTNULL os_mapping_t mapping)
	map a file into memory More...

CT_OS_API os_error_t	os_unmap (INOUT_NOTNULL os_mapping_t *mapping)
	unmap a file from memory More...

CT_NODISCARD CT_OS_API void *	os_mapping_data (os_mapping_t *mapping)
	get the data of a file mapping More...

CT_NODISCARD CT_OS_API size_t	os_mapping_size (const os_mapping_t *mapping)
	get the size of a file mapping More...

CT_NODISCARD CT_PUREFN CT_OS_API bool	os_mapping_active (const os_mapping_t *mapping)
	does the mapping object contain a valid mapping checks if the mapping data exists, not for the validity of the mapping More...

CT_NODISCARD CT_PUREFN CT_OS_API const char *	os_file_name (const os_file_t *file)
	get the name of a file More...

Function Documentation

◆ os_dir_create()

CT_OS_API os_error_t os_dir_create ( const char * path )

check if a directory exists

Parameters

path	the path to the directory to check

Returns: an error if the directory could not be checked

Return values

eOsSuccess	if the directory was created
eOsExists	if the directory already exists

Definition at line 29 of file fs.c.

◆ os_dir_delete()

CT_OS_API os_error_t os_dir_delete ( const char * path )

delete a directory

Parameters

path	the path to the directory to delete

Returns: an error if the directory could not be deleted

Definition at line 52 of file fs.c.

◆ os_dir_exists()

CT_OS_API bool os_dir_exists ( const char * path )

check if a directory exists

Parameters

path	the path to the directory to check

Returns: true if the directory exists, false otherwise

fs operations

Definition at line 353 of file os.c.

◆ os_dirent_type()

CT_NODISCARD CT_OS_API os_dirent_t os_dirent_type ( const char * path )

get the type of a paths inode entry

Parameters

path	the path to the inode entry to check

Returns: the type of the inode entry

Definition at line 65 of file fs.c.

◆ os_file_close()

CT_OS_API os_error_t os_file_close ( STA_RELEASE os_file_t * file )

close a file

Parameters

file	the file to close

◆ os_file_create()

CT_OS_API os_error_t os_file_create ( const char * path )

create a file

Parameters

path	the path to the file to create

Returns: an error if the file could not be created

Definition at line 289 of file os.c.

◆ os_file_delete()

CT_OS_API os_error_t os_file_delete ( const char * path )

delete a file

Parameters

path	the path to the file to delete

Returns: an error if the file could not be deleted

Definition at line 16 of file fs.c.

◆ os_file_exists()

CT_OS_API os_error_t os_file_exists ( const char * path )

check if a file exists

Parameters

path	the path to the file to check

Returns: error if the file could not be checked

Return values

eOsExists	if the file exists
eOsNotFound	if the file does not exist

Definition at line 38 of file file.c.

◆ os_file_map()

CT_OS_API os_error_t os_file_map	(	os_file_t *	file,
		os_protect_t	protect,
		size_t	size,
		OUT_NOTNULL os_mapping_t *	mapping
	)

map a file into memory

Parameters

file	the file to map
protect	the memory protection to use
size	the size of the mapping, 0 for the whole file
mapping	the mapping to fill

Returns: an error if the file could not be mapped

◆ os_file_name()

CT_NODISCARD CT_PUREFN CT_OS_API const char* os_file_name ( const os_file_t * file )

get the name of a file

Parameters

file	the file to get the name of

Returns: the name of the file

Definition at line 281 of file os.c.

◆ os_file_open()

CT_OS_API os_error_t os_file_open	(	const char *	path,
		os_access_t	access,
		OUT_NOTNULL os_file_t *	file
	)

file api

open a file

Parameters

path	the path to the file to open
access	the access mode to open the file with
file	the file handle to fill

Returns: an error if the file could not be opened

◆ os_file_read()

CT_OS_API os_error_t os_file_read	(	os_file_t *	file,
		STA_WRITES(size) void *	buffer,
		size_t	size,
		OUT_NOTNULL size_t *	actual
	)

read from a file

Parameters

file	the file to read from
buffer	the buffer to read into
size	the number of bytes to read
actual	the number of bytes actually read

Returns: the number of bytes read; an error if the file could not be read from

◆ os_file_resize()

CT_OS_API os_error_t os_file_resize	(	os_file_t *	file,
		size_t	size
	)

truncate/expand a file to a specific size

Parameters

file	the file to truncate/expand
size	the size to truncate/expand the file to

Returns: an error if the operation could not be performed

Definition at line 143 of file file.c.

◆ os_file_seek()

CT_OS_API os_error_t os_file_seek	(	os_file_t *	file,
		size_t	offset,
		OUT_NOTNULL size_t *	actual
	)

seek to a position in a file

Parameters

file	the file to seek in
offset	the offset to seek to
actual	the actual offset after seeking

Returns: an error if the file could not be seeked

◆ os_file_size()

CT_OS_API os_error_t os_file_size	(	os_file_t *	file,
		OUT_NOTNULL size_t *	actual
	)

get the size of a file

Parameters

file	the file to get the size of
actual	the size of the file

Returns: an error if the file size could not be retrieved

◆ os_file_tell()

CT_OS_API os_error_t os_file_tell	(	os_file_t *	file,
		OUT_NOTNULL size_t *	actual
	)

get the current position in a file

Parameters

file	the file to get the position of
actual	the current position in the file

Returns: an error if the file position could not be retrieved

◆ os_file_write()

CT_OS_API os_error_t os_file_write	(	os_file_t *	file,
		STA_READS(size) const void *	buffer,
		size_t	size,
		OUT_NOTNULL size_t *	actual
	)

write to a file

Parameters

file	the file to write to
buffer	the buffer to write from
size	the number of bytes to write
actual	the number of bytes actually written

Returns: the number of bytes written; an error if the file could not be written to

◆ os_iter_begin()

CT_OS_API os_error_t os_iter_begin	(	const char *	path,
		OUT_NOTNULL os_iter_t *	iter
	)

directory iteration

open a directory for iteration

Note: the iterator must be closed with os_iter_end

Parameters

path	path to directory
iter	iterator to fill

Returns: result containing either a valid iterator or an error, NULL if dir does not exist

◆ os_iter_end()

CT_OS_API os_error_t os_iter_end ( STA_RELEASE os_iter_t * iter )

close a directory iterator

Parameters

iter	iterator to close

◆ os_iter_error()

CT_OS_API os_error_t os_iter_error ( const os_iter_t * iter )

get the error state of a directory iterator

Parameters

iter	iterator to check

Returns: the error state of the iterator

Definition at line 437 of file os.c.

◆ os_mapping_active()

CT_NODISCARD CT_PUREFN CT_OS_API bool os_mapping_active ( const os_mapping_t * mapping )

does the mapping object contain a valid mapping checks if the mapping data exists, not for the validity of the mapping

Parameters

mapping the mapping to check

Returns: true if the mapping is valid

Definition at line 175 of file os.c.

◆ os_mapping_data()

CT_NODISCARD CT_OS_API void* os_mapping_data ( os_mapping_t * mapping )

get the data of a file mapping

Parameters

mapping the mapping to get the data of

Returns: the data of the mapping

Definition at line 166 of file os.c.

◆ os_mapping_size()

CT_NODISCARD CT_OS_API size_t os_mapping_size ( const os_mapping_t * mapping )

get the size of a file mapping

Parameters

mapping the mapping to get the size of

Returns: the size of the mapping

Definition at line 157 of file os.c.

◆ os_tmpfile_open()

CT_OS_API os_error_t os_tmpfile_open ( OUT_NOTNULL os_file_t * file )

create a temporary file

Parameters

file	the file handle to fill

Returns: an error if the file could not be created

◆ os_unmap()

CT_OS_API os_error_t os_unmap ( INOUT_NOTNULL os_mapping_t * mapping )

unmap a file from memory

Note: invalidates all memory pointers returned by os_mapping_data

Parameters

mapping the mapping to unmap

◆ STA_SUCCESS()

CT_NODISCARD STA_SUCCESS ( return = = true )

get the next directory entry

Parameters

iter	iterator to use
dir	directory entry to fill

Returns: true if there was a new directory entry

Variable Documentation

◆ dir

CT_NODISCARD OUT_NOTNULL os_inode_t* dir

Definition at line 245 of file os.h.

Data Structures

Functions

Function Documentation

◆ os_dir_create()

◆ os_dir_delete()

◆ os_dir_exists()

◆ os_dirent_type()

◆ os_file_close()

◆ os_file_create()

◆ os_file_delete()

◆ os_file_exists()

◆ os_file_map()

◆ os_file_name()

◆ os_file_open()

◆ os_file_read()

◆ os_file_resize()

◆ os_file_seek()

◆ os_file_size()

◆ os_file_tell()

◆ os_file_write()

◆ os_iter_begin()

◆ os_iter_end()

◆ os_iter_error()

◆ os_mapping_active()

◆ os_mapping_data()

◆ os_mapping_size()

◆ os_tmpfile_open()

◆ os_unmap()

◆ STA_SUCCESS()

Variable Documentation

◆ dir