filesystem.c File Reference

Include dependency graph for filesystem.c:

Macros
#define	lstat(a, b)   stat(a, b)

Functions
int	vlc_open (const char *filename, int flags,...)
	Opens a system file handle.
int	vlc_openat (int dir, const char *filename, int flags,...)
	Opens a system file handle relative to an existing directory handle.
int	vlc_mkdir (const char *dirname, mode_t mode)
	Creates a directory using UTF-8 paths.
DIR *	vlc_opendir (const char *dirname)
	Opens a DIR pointer.
char *	vlc_readdir (DIR *dir)
	Reads the next file name from an open directory.
int	vlc_stat (const char *filename, struct stat *buf)
	Finds file/inode information, as stat().
int	vlc_lstat (const char *filename, struct stat *buf)
	Finds file/inode information, as lstat().
int	vlc_unlink (const char *filename)
	Removes a file.
int	vlc_rename (const char *oldpath, const char *newpath)
	Moves a file atomically.
char *	vlc_getcwd (void)
	Determines the current working directory.
int	vlc_dup (int oldfd)
	Duplicates a file descriptor.
int	vlc_pipe (int fds[2])
	Creates a pipe (see "man pipe" for further reference).
int	vlc_socket (int pf, int type, int proto, bool nonblock)
	Creates a socket file descriptor.
int	vlc_accept (int lfd, struct sockaddr *addr, socklen_t *alen, bool nonblock)
	Accepts an inbound connection request on a listening socket.

Macro Definition Documentation

#define lstat	(		a,
			b
	)		stat(a, b)

Referenced by vlc_lstat(), and vlc_statEx().

Function Documentation

int vlc_accept	(	int	lfd,
		struct sockaddr *	addr,
		socklen_t *	alen,
		bool	nonblock
	)

Accepts an inbound connection request on a listening socket.

The new file descriptor has the close-on-exec flag set.

Parameters

lfd	listening socket file descriptor
addr	pointer to the peer address or NULL [OUT]
alen	pointer to the length of the peer address or NULL [OUT]
nonblock	whether to put the new socket in non-blocking mode

Returns

a new file descriptor, or -1 on error.

int vlc_dup

(

int

oldfd

)

Duplicates a file descriptor.

The new file descriptor has the close-on-exec descriptor flag set.

Returns

a new file descriptor or -1

References likely, and unlikely.

char* vlc_getcwd

(

void

)

Determines the current working directory.

Returns

the current working directory (must be free()'d) or NULL on error

References getenv(), strdup(), and unlikely.

int vlc_lstat	(	const char *	filename,
		struct stat *	buf
	)

Finds file/inode information, as lstat().

Consider using fstat() instead, if possible.

Parameters

filename

UTF-8 file path

References lstat.

int vlc_mkdir	(	const char *	dirname,
		mode_t	mode
	)

Creates a directory using UTF-8 paths.

Parameters

dirname	a UTF-8 string with the name of the directory that you want to create.
mode	directory permissions

Returns

0 on success, -1 on error (see errno).

int vlc_open	(	const char *	filename,
		int	flags,
			...
	)

Opens a system file handle.

Parameters

filename	file path to open (with UTF-8 encoding)
flags	open() flags, see the C library open() documentation

Returns

a file handle on success, -1 on error (see errno).

Note

Contrary to standard open(), this function returns file handles with the close-on-exec flag enabled.

int vlc_openat	(	int	dir,
		const char *	filename,
		int	flags,
			...
	)

Opens a system file handle relative to an existing directory handle.

Parameters

dir	directory file descriptor
filename	file path to open (with UTF-8 encoding)
flags	open() flags, see the C library open() documentation

Returns

a file handle on success, -1 on error (see errno).

Note

Contrary to standard open(), this function returns file handles with the close-on-exec flag enabled.

DIR* vlc_opendir

(

const char *

dirname

)

Opens a DIR pointer.

Parameters

dirname

UTF-8 representation of the directory name

Returns

a pointer to the DIR struct, or NULL in case of error. Release with standard closedir().

int vlc_pipe

(

int

fds[2]

)

Creates a pipe (see "man pipe" for further reference).

char* vlc_readdir

(

DIR *

dir

)

Reads the next file name from an open directory.

Parameters

dir	The directory that is being read

Returns

a UTF-8 string of the directory entry. Use free() to release it. If there are no more entries in the directory, NULL is returned. If an error occurs, errno is set and NULL is returned.

References dirfd(), strdup(), and unlikely.

int vlc_rename	(	const char *	oldpath,
		const char *	newpath
	)

Moves a file atomically.

This only works within a single file system.

Parameters

oldpath	path to the file before the move
newpath	intended path to the file after the move

Returns

A 0 return value indicates success. A -1 return value indicates an error, and an error code is stored in errno

int vlc_socket	(	int	pf,
		int	type,
		int	proto,
		bool	nonblock
	)

Creates a socket file descriptor.

The new file descriptor has the close-on-exec flag set.

Parameters

pf	protocol family
type	socket type
proto	network protocol
nonblock	true to create a non-blocking socket

Returns

a new file descriptor or -1

int vlc_stat	(	const char *	filename,
		struct stat *	buf
	)

Finds file/inode information, as stat().

Consider using fstat() instead, if possible.

Parameters

filename

UTF-8 file path

int vlc_unlink

(

const char *

filename

)

Removes a file.

Parameters

filename

a UTF-8 string with the name of the file you want to delete.

Returns

A 0 return value indicates success. A -1 return value indicates an error, and an error code is stored in errno