summaryrefslogtreecommitdiffstats
path: root/ffs/libffs.h
diff options
context:
space:
mode:
authorBrad Bishop <bradleyb@us.ibm.com>2014-06-30 22:10:16 -0500
committerPatrick Williams <iawillia@us.ibm.com>2014-07-02 22:49:29 -0500
commitbf4630076762d9c20c16c80c1c791f352b046dd1 (patch)
treeefc67bad010a28fd1abf5aeeefda2a969514fd97 /ffs/libffs.h
downloadffs-bf4630076762d9c20c16c80c1c791f352b046dd1.tar.gz
ffs-bf4630076762d9c20c16c80c1c791f352b046dd1.zip
Port FFS tools over from Building Block repository.
Diffstat (limited to 'ffs/libffs.h')
-rw-r--r--ffs/libffs.h174
1 files changed, 174 insertions, 0 deletions
diff --git a/ffs/libffs.h b/ffs/libffs.h
new file mode 100644
index 0000000..9772cac
--- /dev/null
+++ b/ffs/libffs.h
@@ -0,0 +1,174 @@
+/*
+ * Copyright (c) International Business Machines Corp., 2012
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
+ * the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+#ifndef __LIBFFS_H__
+#define __LIBFFS_H__
+
+#include <stdbool.h>
+#include <stdarg.h>
+
+#include <clib/exception.h>
+
+#include "ffs.h"
+
+typedef struct ffs_entry ffs_entry_t;
+typedef struct ffs_hdr ffs_hdr_t;
+typedef enum type ffs_type_t;
+
+#define FFS_EXCEPTION_DATA 1024
+
+/* ============================================================ */
+
+/*!
+ * @brief ffs I/O interface
+ */
+struct ffs {
+ ffs_hdr_t * hdr;
+
+ char * path;
+ off_t offset;
+
+ FILE * file;
+ uint32_t count;
+
+ void * buf; // FILE* buffer
+ uint32_t buf_count; // multiple of hdr->block_size
+
+ bool dirty;
+};
+
+typedef struct ffs ffs_t;
+
+struct ffs_exception {
+ int rc;
+ char data[FFS_EXCEPTION_DATA];
+};
+
+typedef struct ffs_exception ffs_exception_t;
+
+#define FFS_PARTITION_NAME "part"
+
+#define FFS_INFO_ERROR 0
+#define FFS_INFO_MAGIC 1
+#define FFS_INFO_VERSION 2
+#define FFS_INFO_ENTRY_SIZE 3
+#define FFS_INFO_ENTRY_COUNT 4
+#define FFS_INFO_BLOCK_SIZE 5
+#define FFS_INFO_BLOCK_COUNT 6
+#define FFS_INFO_BUFFER_COUNT 7
+#define FFS_INFO_OFFSET 8
+
+#define FFS_CHECK_PATH -3
+#define FFS_CHECK_HEADER_MAGIC -4
+#define FFS_CHECK_HEADER_CHECKSUM -5
+#define FFS_CHECK_ENTRY_CHECKSUM -6
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+extern int __ffs_fcheck(FILE *, off_t)
+/*! @cond */ __nonnull ((1)) /*! @endcond */ ;
+
+extern int __ffs_check(const char *, off_t)
+/*! @cond */ __nonnull ((1)) /*! @endcond */ ;
+
+extern ffs_t * __ffs_fcreate(FILE *, off_t, uint32_t, uint32_t)
+/*! @cond */ __nonnull ((1)) /*! @endcond */ ;
+
+extern ffs_t * __ffs_create(const char *, off_t, uint32_t, uint32_t)
+/*! @cond */ __nonnull ((1)) /*! @endcond */ ;
+
+extern ffs_t * __ffs_fopen(FILE *, off_t)
+/*! @cond */ __nonnull ((1)) /*! @endcond */ ;
+
+extern ffs_t * __ffs_open(const char *, off_t)
+/*! @cond */ __nonnull ((1)) /*! @endcond */ ;
+
+extern int __ffs_info(ffs_t *, int, uint32_t *)
+/*! @cond */ __nonnull ((1)) /*! @endcond */ ;
+
+extern int __ffs_buffer(ffs_t *, size_t)
+/*! @cond */ __nonnull ((1)) /*! @endcond */ ;
+
+extern int __ffs_close(ffs_t *)
+/*! @cond */ __nonnull ((1)) /*! @endcond */ ;
+
+extern int __ffs_fclose(ffs_t *)
+/*! @cond */ __nonnull ((1)) /*! @endcond */ ;
+
+extern int __ffs_fsync(ffs_t *)
+/*! @cond */ __nonnull ((1)) /*! @endcond */ ;
+
+extern int __ffs_list_entries(ffs_t *, const char *, bool, FILE *)
+/*! @cond */ __nonnull ((1)) /*! @endcond */ ;
+
+extern int __ffs_iterate_entries(ffs_t *, int (*)(ffs_entry_t*))
+/*! @cond */ __nonnull ((1,2)) /*! @endcond */ ;
+
+extern int __ffs_entry_find(ffs_t *, const char *, ffs_entry_t *)
+/*! @cond */ __nonnull ((1,2)) /*! @endcond */ ;
+
+extern int __ffs_entry_find_parent(ffs_t *, const char *, ffs_entry_t *)
+/*! @cond */ __nonnull ((1,2)) /*! @endcond */ ;
+
+extern int __ffs_entry_name(ffs_t *, ffs_entry_t *, char *, size_t)
+/*! @cond */ __nonnull ((1,2,3)) /*! @endcond */ ;
+
+extern int __ffs_entry_add(ffs_t *, const char *, off_t,
+ size_t, ffs_type_t, uint32_t)
+/*! @cond */ __nonnull ((1,2)) /*! @endcond */ ;
+
+extern int __ffs_entry_delete(ffs_t *, const char *)
+/*! @cond */ __nonnull ((1,2)) /*! @endcond */ ;
+
+extern int __ffs_entry_user_get(ffs_t *, const char *, uint32_t, uint32_t *)
+/*! @cond */ __nonnull ((1,2,4)) /*! @endcond */ ;
+
+extern int __ffs_entry_user_put(ffs_t *, const char *, uint32_t, uint32_t)
+/*! @cond */ __nonnull ((1,2)) /*! @endcond */ ;
+
+extern ssize_t __ffs_entry_hexdump(ffs_t *, const char *, FILE *)
+/*! @cond */ __nonnull ((1,2,3)) /*! @endcond */ ;
+
+extern ssize_t __ffs_entry_truncate(ffs_t *, const char *, size_t)
+/*! @cond */ __nonnull ((1,2)) /*! @endcond */ ;
+
+extern ssize_t __ffs_entry_read(ffs_t *, const char *, void *, off_t, size_t)
+/*! @cond */ __nonnull ((1,2,3)) /*! @endcond */ ;
+
+extern ssize_t __ffs_entry_write(ffs_t *, const char *, const void *,
+ off_t, size_t)
+/*! @cond */ __nonnull ((1,2,3)) /*! @endcond */ ;
+
+extern ssize_t __ffs_entry_copy(ffs_t *, ffs_t *, const char *)
+/*! @cond */ __nonnull ((1,2,3)) /*! @endcond */ ;
+
+extern ssize_t __ffs_entry_compare(ffs_t *, ffs_t *, const char *)
+/*! @cond */ __nonnull ((1,2,3)) /*! @endcond */ ;
+
+extern int __ffs_entry_list(ffs_t *, ffs_entry_t ** list)
+/*! @cond */ __nonnull ((1,2)) /*! @endcond */ ;
+
+#ifdef __cplusplus
+}
+#endif
+
+/* ============================================================ */
+
+#endif /* __LIBFFS_H__ */
OpenPOWER on IntegriCloud