#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
#include <string.h>
#include "config.h"

Functions
void	tarfs_os_init ()
	Create a recursive sync object.
void	tarfs_os_acquire_mutex ()
	Lock access to s_tarfs[] table and to the s_numfs counter only.
void	tarfs_os_release_mutex ()
	Unlock access to s_tarfs[] table and to the s_numfs counter only.
void const *	tarfs_os_map_tarfile (const char name, void os_handle_out, size_t size_out)
	Map a ESP32 flash partition to a virtual address space.
void	tarfs_os_unmap_tarfile (void os_handle, const void ptr, size_t size)
	Opposite of tarfs_os_map_tarfile().
bool	tarfs_os_register_fs (const char prefix, void context)
	Tell the VFS that TARFS is now handle all the paths starting from 'prefix'.
bool	tarfs_os_unregister_fs (const char *prefix)
	Tell the VFS that path 'prefix' is not handled by tarfs anymore.
size_t	tarfs_os_mp_maxlen ()
	Return the maximum mount point name length supported by the platform.
void *	tarfs_os_malloc (size_t size)
	Memory allocation backend.
void	tarfs_os_free (void *buffer)

Function Documentation

◆ tarfs_os_acquire_mutex()

void tarfs_os_acquire_mutex ( )

Lock access to s_tarfs[] table and to the s_numfs counter only.

Definition at line 156 of file os_esp32.c.

◆ tarfs_os_free()

void tarfs_os_free ( void * buffer )

Definition at line 207 of file os_esp32.c.

Referenced by inode_free(), inode_resolve(), tard_closedir(), tard_fdopendir(), tarf_open(), and tarfs_mount_memory().

◆ tarfs_os_init()

void tarfs_os_init ( )

Create a recursive sync object.

Definition at line 147 of file os_esp32.c.

◆ tarfs_os_malloc()

void * tarfs_os_malloc ( size_t size )

Memory allocation backend.

By default, these functions map directly to malloc() and free(). Platform-specific implementations may override them to use a custom allocator.

Note that default implementation sets errno to ENOMEM if allocation fails The same behavior is expected for a custom allocator

Definition at line 187 of file os_esp32.c.

References size.

Referenced by tar_strdup1(), tarfs_calloc(), and tarfs_strdup().

◆ tarfs_os_map_tarfile()

void const * tarfs_os_map_tarfile	(	const char *	label,
		void **	os_handle_out,
		size_t *	size_out )

Map a ESP32 flash partition to a virtual address space.

Parameters

label	esp32 partition label
os_handle_out	a pointer to an opaque OS-specific mapping handle. MUST NOT be NULL
size_out	a pointer to a size_t var where total mapped region size will be stored. Can be NULL

Returns: an address where resource named "label" is accessible

Definition at line 222 of file os_esp32.c.

References log.

Referenced by tarfs_fsck(), and tarfs_mount().

◆ tarfs_os_mp_maxlen()

size_t tarfs_os_mp_maxlen ( )

Return the maximum mount point name length supported by the platform.

Some operating systems impose a limit on mount point names. TARFS uses this value when validating the archive root directory before mounting.

For platforms without such a restriction, return SIZE_MAX.

Example:

ESP-IDF returns 16.

Definition at line 175 of file os_esp32.c.

Referenced by tar_rootdir().

◆ tarfs_os_register_fs()

bool tarfs_os_register_fs	(	const char *	prefix,
		void *	context )

Tell the VFS that TARFS is now handle all the paths starting from 'prefix'.

VFS in turn promises that it will pass the 'context' in every handler function later (e.g. tarf_open(context,) etc)

Definition at line 319 of file os_esp32.c.

References prefix.

Referenced by tarfs_mount_memory().

◆ tarfs_os_release_mutex()

void tarfs_os_release_mutex ( )

Unlock access to s_tarfs[] table and to the s_numfs counter only.

Definition at line 166 of file os_esp32.c.

◆ tarfs_os_unmap_tarfile()

void tarfs_os_unmap_tarfile	(	void *	os_handle,
		const void *	map,
		size_t	size )

Opposite of tarfs_os_map_tarfile().

Parameters

label	esp32 partition label
os_handle	an opaque value as returned by tarfs_os_map_tarfile()
size	total mapped region size

Definition at line 279 of file os_esp32.c.