Add libbtrfsutil
Currently, users wishing to manage Btrfs filesystems programatically
have to shell out to btrfs-progs and parse the output. This isn't ideal.
The goal of libbtrfsutil is to provide a library version of as many of
the operations of btrfs-progs as possible and to migrate btrfs-progs to
use it.
Rather than simply refactoring the existing btrfs-progs code, the code
has to be written from scratch for a couple of reasons:
* A lot of the btrfs-progs code was not designed with a nice library API
in mind in terms of reusability, naming, and error reporting.
* libbtrfsutil is licensed under the LGPL, whereas btrfs-progs is under
the GPL, which makes it dubious to directly copy or move the code.
Eventually, most of the low-level btrfs-progs code should either live in
libbtrfsutil or the shared kernel/userspace filesystem code, and
btrfs-progs will just be the CLI wrapper.
This first commit just includes the build system changes, license,
README, and error reporting helper.
Signed-off-by: Omar Sandoval <osandov@fb.com>
Reviewed-by: Liu Bo <bo.li.liu@oracle.com>
Signed-off-by: David Sterba <dsterba@suse.com>
2018-02-15 19:04:47 +00:00
|
|
|
/*
|
|
|
|
* Copyright (C) 2018 Facebook
|
|
|
|
*
|
|
|
|
* This file is part of libbtrfsutil.
|
|
|
|
*
|
|
|
|
* libbtrfsutil is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
2021-03-17 20:01:44 +00:00
|
|
|
* the Free Software Foundation, either version 2.1 of the License, or
|
Add libbtrfsutil
Currently, users wishing to manage Btrfs filesystems programatically
have to shell out to btrfs-progs and parse the output. This isn't ideal.
The goal of libbtrfsutil is to provide a library version of as many of
the operations of btrfs-progs as possible and to migrate btrfs-progs to
use it.
Rather than simply refactoring the existing btrfs-progs code, the code
has to be written from scratch for a couple of reasons:
* A lot of the btrfs-progs code was not designed with a nice library API
in mind in terms of reusability, naming, and error reporting.
* libbtrfsutil is licensed under the LGPL, whereas btrfs-progs is under
the GPL, which makes it dubious to directly copy or move the code.
Eventually, most of the low-level btrfs-progs code should either live in
libbtrfsutil or the shared kernel/userspace filesystem code, and
btrfs-progs will just be the CLI wrapper.
This first commit just includes the build system changes, license,
README, and error reporting helper.
Signed-off-by: Omar Sandoval <osandov@fb.com>
Reviewed-by: Liu Bo <bo.li.liu@oracle.com>
Signed-off-by: David Sterba <dsterba@suse.com>
2018-02-15 19:04:47 +00:00
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* libbtrfsutil 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 Lesser General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
|
|
* along with libbtrfsutil. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef BTRFS_UTIL_INTERNAL_H
|
|
|
|
#define BTRFS_UTIL_INTERNAL_H
|
|
|
|
|
|
|
|
#include <asm/byteorder.h>
|
2019-07-04 12:26:47 +00:00
|
|
|
#include <string.h>
|
2022-09-15 11:59:39 +00:00
|
|
|
#include <errno.h>
|
|
|
|
#include <unistd.h>
|
Add libbtrfsutil
Currently, users wishing to manage Btrfs filesystems programatically
have to shell out to btrfs-progs and parse the output. This isn't ideal.
The goal of libbtrfsutil is to provide a library version of as many of
the operations of btrfs-progs as possible and to migrate btrfs-progs to
use it.
Rather than simply refactoring the existing btrfs-progs code, the code
has to be written from scratch for a couple of reasons:
* A lot of the btrfs-progs code was not designed with a nice library API
in mind in terms of reusability, naming, and error reporting.
* libbtrfsutil is licensed under the LGPL, whereas btrfs-progs is under
the GPL, which makes it dubious to directly copy or move the code.
Eventually, most of the low-level btrfs-progs code should either live in
libbtrfsutil or the shared kernel/userspace filesystem code, and
btrfs-progs will just be the CLI wrapper.
This first commit just includes the build system changes, license,
README, and error reporting helper.
Signed-off-by: Omar Sandoval <osandov@fb.com>
Reviewed-by: Liu Bo <bo.li.liu@oracle.com>
Signed-off-by: David Sterba <dsterba@suse.com>
2018-02-15 19:04:47 +00:00
|
|
|
|
|
|
|
#include "btrfsutil.h"
|
2018-02-21 19:55:11 +00:00
|
|
|
#include "btrfs.h"
|
|
|
|
#include "btrfs_tree.h"
|
Add libbtrfsutil
Currently, users wishing to manage Btrfs filesystems programatically
have to shell out to btrfs-progs and parse the output. This isn't ideal.
The goal of libbtrfsutil is to provide a library version of as many of
the operations of btrfs-progs as possible and to migrate btrfs-progs to
use it.
Rather than simply refactoring the existing btrfs-progs code, the code
has to be written from scratch for a couple of reasons:
* A lot of the btrfs-progs code was not designed with a nice library API
in mind in terms of reusability, naming, and error reporting.
* libbtrfsutil is licensed under the LGPL, whereas btrfs-progs is under
the GPL, which makes it dubious to directly copy or move the code.
Eventually, most of the low-level btrfs-progs code should either live in
libbtrfsutil or the shared kernel/userspace filesystem code, and
btrfs-progs will just be the CLI wrapper.
This first commit just includes the build system changes, license,
README, and error reporting helper.
Signed-off-by: Omar Sandoval <osandov@fb.com>
Reviewed-by: Liu Bo <bo.li.liu@oracle.com>
Signed-off-by: David Sterba <dsterba@suse.com>
2018-02-15 19:04:47 +00:00
|
|
|
|
|
|
|
#define PUBLIC __attribute__((visibility("default")))
|
2024-03-05 21:38:53 +00:00
|
|
|
#define LIBBTRFSUTIL_ALIAS(orig) __attribute__((alias(#orig)))
|
Add libbtrfsutil
Currently, users wishing to manage Btrfs filesystems programatically
have to shell out to btrfs-progs and parse the output. This isn't ideal.
The goal of libbtrfsutil is to provide a library version of as many of
the operations of btrfs-progs as possible and to migrate btrfs-progs to
use it.
Rather than simply refactoring the existing btrfs-progs code, the code
has to be written from scratch for a couple of reasons:
* A lot of the btrfs-progs code was not designed with a nice library API
in mind in terms of reusability, naming, and error reporting.
* libbtrfsutil is licensed under the LGPL, whereas btrfs-progs is under
the GPL, which makes it dubious to directly copy or move the code.
Eventually, most of the low-level btrfs-progs code should either live in
libbtrfsutil or the shared kernel/userspace filesystem code, and
btrfs-progs will just be the CLI wrapper.
This first commit just includes the build system changes, license,
README, and error reporting helper.
Signed-off-by: Omar Sandoval <osandov@fb.com>
Reviewed-by: Liu Bo <bo.li.liu@oracle.com>
Signed-off-by: David Sterba <dsterba@suse.com>
2018-02-15 19:04:47 +00:00
|
|
|
|
|
|
|
#define le16_to_cpu __le16_to_cpu
|
|
|
|
#define le32_to_cpu __le32_to_cpu
|
|
|
|
#define le64_to_cpu __le64_to_cpu
|
|
|
|
|
|
|
|
#define SAVE_ERRNO_AND_CLOSE(fd) do { \
|
|
|
|
int saved_errno = errno; \
|
|
|
|
\
|
|
|
|
close(fd); \
|
|
|
|
errno = saved_errno; \
|
|
|
|
} while (0)
|
|
|
|
|
2019-07-04 12:26:47 +00:00
|
|
|
/*
|
|
|
|
* Accessors of search header that is commonly mapped to a byte buffer so the
|
|
|
|
* alignment is not guraranteed
|
|
|
|
*/
|
|
|
|
static inline __u64 btrfs_search_header_transid(const struct btrfs_ioctl_search_header *sh)
|
|
|
|
{
|
|
|
|
__u64 tmp;
|
|
|
|
memcpy(&tmp, &sh->transid, sizeof(__u64));
|
|
|
|
return tmp;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline __u64 btrfs_search_header_objectid(const struct btrfs_ioctl_search_header *sh)
|
|
|
|
{
|
|
|
|
__u64 tmp;
|
|
|
|
memcpy(&tmp, &sh->objectid, sizeof(__u64));
|
|
|
|
return tmp;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline __u64 btrfs_search_header_offset(const struct btrfs_ioctl_search_header *sh)
|
|
|
|
{
|
|
|
|
__u64 tmp;
|
|
|
|
memcpy(&tmp, &sh->offset, sizeof(__u64));
|
|
|
|
return tmp;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline __u32 btrfs_search_header_type(const struct btrfs_ioctl_search_header *sh)
|
|
|
|
{
|
|
|
|
__u32 tmp;
|
|
|
|
memcpy(&tmp, &sh->type, sizeof(__u32));
|
|
|
|
return tmp;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline __u32 btrfs_search_header_len(const struct btrfs_ioctl_search_header *sh)
|
|
|
|
{
|
|
|
|
__u32 tmp;
|
|
|
|
memcpy(&tmp, &sh->len, sizeof(__u32));
|
|
|
|
return tmp;
|
|
|
|
}
|
|
|
|
|
Add libbtrfsutil
Currently, users wishing to manage Btrfs filesystems programatically
have to shell out to btrfs-progs and parse the output. This isn't ideal.
The goal of libbtrfsutil is to provide a library version of as many of
the operations of btrfs-progs as possible and to migrate btrfs-progs to
use it.
Rather than simply refactoring the existing btrfs-progs code, the code
has to be written from scratch for a couple of reasons:
* A lot of the btrfs-progs code was not designed with a nice library API
in mind in terms of reusability, naming, and error reporting.
* libbtrfsutil is licensed under the LGPL, whereas btrfs-progs is under
the GPL, which makes it dubious to directly copy or move the code.
Eventually, most of the low-level btrfs-progs code should either live in
libbtrfsutil or the shared kernel/userspace filesystem code, and
btrfs-progs will just be the CLI wrapper.
This first commit just includes the build system changes, license,
README, and error reporting helper.
Signed-off-by: Omar Sandoval <osandov@fb.com>
Reviewed-by: Liu Bo <bo.li.liu@oracle.com>
Signed-off-by: David Sterba <dsterba@suse.com>
2018-02-15 19:04:47 +00:00
|
|
|
#endif /* BTRFS_UTIL_INTERNAL_H */
|