/*
 * Copyright (c) 2025 Ian Marco Moffett and L5 engineers
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the project nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _OS_VFS_H_
#define _OS_VFS_H_ 1

#include <sys/types.h>
#include <sys/mount.h>

/*
 * Initialize the virtual filesystem
 * layer
 *
 * Returns zero on success, otherwise a less
 * than zero value on failure.
 */
int vfs_init(void);

/*
 * Get a VFS file table entry by name
 *
 * @name: Name of desired entry
 * @resp: Result pointer is written here
 *
 * Returns zero on success, otherwise a less than zero
 * value upon failure.
 */
int vfs_by_name(const char *name, struct fs_info **resp);

/*
 * Get a VFS file table entry by index.
 *
 * @index: Index to desired entry
 * @resp: Result pointer is written here
 *
 * Returns zero on success and the entry being
 * found, otherwise a less than zero failure if
 * the entry has not been found.
 */
int vfs_by_index(uint16_t index, struct fs_info **resp);

/*
 * Count the number of components within a path and
 * return a negative value if the path is invalid.
 *
 * @path: Path to check
 *
 * Returns the number of components on success,
 * otherwise a less than zero value on failure.
 */
int vfs_cmp_cnt(const char *path);

#endif  /* !_OS_VFS_H_ */