From patchwork Thu Feb 15 19:05:00 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Omar Sandoval X-Patchwork-Id: 10223423 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 79EF1602CB for ; Thu, 15 Feb 2018 19:06:39 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 6828F29486 for ; Thu, 15 Feb 2018 19:06:39 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 5CAFF294B1; Thu, 15 Feb 2018 19:06:39 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.8 required=2.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_HI,T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 3F61929486 for ; Thu, 15 Feb 2018 19:06:38 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1161366AbeBOTGf (ORCPT ); Thu, 15 Feb 2018 14:06:35 -0500 Received: from mail-pl0-f66.google.com ([209.85.160.66]:42836 "EHLO mail-pl0-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1167165AbeBOTFo (ORCPT ); Thu, 15 Feb 2018 14:05:44 -0500 Received: by mail-pl0-f66.google.com with SMTP id 31so346361ple.9 for ; Thu, 15 Feb 2018 11:05:44 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=osandov-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :in-reply-to:references; bh=4npTsT6d2qnIhLe2V6TXHr3WNjwqhqYy8WigY9aDlwE=; b=Tno/57Fa0ojU1guqeAmVWg3zdmEZrpSzfC08IwKIup5j1MZA2Ujs4E1ISJKZI9Mjqu JZN1uUmKwNrD5f5RxrCkPqZnPXZcBGBxOZKoiH5kRzUx8HDIhKxHYvuu70RmW5UvJtt/ lyIe/XdHUnLZN7MMKSgAgFDhf0R/848brc+F6uXPX2FTLwsdgPzz/SK6mxWnUveKZJje eiYsu6BvWmdeHBIeJvpNuu6h//hqF18r5kOQyvywzZdx8LbeotOA4e6j3NKpvjGjMvhW fah5hHs2dadjmVWE0BKpCVQb075Z5sFaJHt4VsiAP4xeP6DVd0YxOt6Pv8yMHvDYZUWX B4Pw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:in-reply-to:references; bh=4npTsT6d2qnIhLe2V6TXHr3WNjwqhqYy8WigY9aDlwE=; b=LH0o/MPatY0sBxMr4gAKvqa4nZI3Ucb+ZLUmEMY/U8OUOUITXoGRzt4+/P6oBswNlM EkAb4OJMQSAg8Ss58R8P0Tsa3c3/hSHMiEJkasUW1Vh3wl+F6CNy+A3JYZ3K37tC4ohd GXclTkeDq2RbinlQX7Ap5+qYvQ+LGaVwXiQbfpv5Y6wDc0hH2xyDmeo2yWyM5WsEpuy1 ZKv3LcZrJe6cT4wiZgKWY4U5StQMxs73YPWVrAu85pyNvp2R5Lf2U5EIiIw+gxvh/fFE OXV0UId9xjyaF7dfxhlb+10w3rlZqk8xPZzTtJwOARnvQrTugXzpXafvpMM7slG+t4BH p7qg== X-Gm-Message-State: APf1xPBhOm99jt6xHo4KiRqqWXrVdeeIUZx5K6yIHuZPMCFVeV7QAMuB 97N7hItsG7ay8FtYx75Cm1qXAl2vKW4= X-Google-Smtp-Source: AH8x224zhNX8G5tF5DLeAIXhNl/n350N9+nhJa7VoN8onNUwcSFwoHJp25p9Rid8m7hycUwtVOpKjA== X-Received: by 2002:a17:902:7883:: with SMTP id q3-v6mr3412067pll.361.1518721543053; Thu, 15 Feb 2018 11:05:43 -0800 (PST) Received: from vader.thefacebook.com ([2620:10d:c090:200::6:4a19]) by smtp.gmail.com with ESMTPSA id p1sm40467428pgr.44.2018.02.15.11.05.41 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 15 Feb 2018 11:05:42 -0800 (PST) From: Omar Sandoval To: linux-btrfs@vger.kernel.org Cc: kernel-team@fb.com Subject: [PATCH v2 15/27] libbtrfsutil: add filesystem sync helpers Date: Thu, 15 Feb 2018 11:05:00 -0800 Message-Id: <6781520f9495a917484119df37b0a7ada42dbcc0.1518720598.git.osandov@fb.com> X-Mailer: git-send-email 2.16.1 In-Reply-To: References: In-Reply-To: References: Sender: linux-btrfs-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-btrfs@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP From: Omar Sandoval Namely, sync, start_sync, and wait_sync. Signed-off-by: Omar Sandoval --- Makefile | 4 +- libbtrfsutil/btrfsutil.h | 44 ++++++++++++ libbtrfsutil/filesystem.c | 103 +++++++++++++++++++++++++++ libbtrfsutil/python/btrfsutilpy.h | 3 + libbtrfsutil/python/filesystem.c | 94 ++++++++++++++++++++++++ libbtrfsutil/python/module.c | 21 ++++++ libbtrfsutil/python/setup.py | 1 + libbtrfsutil/python/tests/test_filesystem.py | 73 +++++++++++++++++++ 8 files changed, 341 insertions(+), 2 deletions(-) create mode 100644 libbtrfsutil/filesystem.c create mode 100644 libbtrfsutil/python/filesystem.c create mode 100644 libbtrfsutil/python/tests/test_filesystem.py diff --git a/Makefile b/Makefile index fa32c50d..37bd6e5d 100644 --- a/Makefile +++ b/Makefile @@ -135,8 +135,8 @@ libbtrfsutil_major := $(shell sed -rn 's/^\#define BTRFS_UTIL_VERSION_MAJOR ([0- libbtrfsutil_minor := $(shell sed -rn 's/^\#define BTRFS_UTIL_VERSION_MINOR ([0-9])+$$/\1/p' libbtrfsutil/btrfsutil.h) libbtrfsutil_patch := $(shell sed -rn 's/^\#define BTRFS_UTIL_VERSION_PATCH ([0-9])+$$/\1/p' libbtrfsutil/btrfsutil.h) libbtrfsutil_version := $(libbtrfsutil_major).$(libbtrfsutil_minor).$(libbtrfsutil_patch) -libbtrfsutil_objects = libbtrfsutil/errors.o libbtrfsutil/qgroup.o \ - libbtrfsutil/subvolume.o +libbtrfsutil_objects = libbtrfsutil/errors.o libbtrfsutil/filesystem.o \ + libbtrfsutil/qgroup.o libbtrfsutil/subvolume.o convert_objects = convert/main.o convert/common.o convert/source-fs.o \ convert/source-ext2.o convert/source-reiserfs.o mkfs_objects = mkfs/main.o mkfs/common.o mkfs/rootdir.o diff --git a/libbtrfsutil/btrfsutil.h b/libbtrfsutil/btrfsutil.h index 677ab3c1..34a2fc4a 100644 --- a/libbtrfsutil/btrfsutil.h +++ b/libbtrfsutil/btrfsutil.h @@ -74,6 +74,50 @@ enum btrfs_util_error { */ const char *btrfs_util_strerror(enum btrfs_util_error err); +/** + * btrfs_util_sync() - Force a sync on a specific Btrfs filesystem. + * @path: Path on a Btrfs filesystem. + * + * Return: %BTRFS_UTIL_OK on success, non-zero error code on failure. + */ +enum btrfs_util_error btrfs_util_sync(const char *path); + +/** + * btrfs_util_sync_fd() - See btrfs_util_sync(). + */ +enum btrfs_util_error btrfs_util_sync_fd(int fd); + +/** + * btrfs_util_start_sync() - Start a sync on a specific Btrfs filesystem but + * don't wait for it. + * @path: Path on a Btrfs filesystem. + * @transid: Returned transaction ID which can be waited on with + * btrfs_util_wait_sync(). This can be %NULL. + * + * Return: %BTRFS_UTIL_OK on success, non-zero error code on failure. + */ +enum btrfs_util_error btrfs_util_start_sync(const char *path, + uint64_t *transid); + +/** + * btrfs_util_start_sync_fd() - See btrfs_util_start_sync(). + */ +enum btrfs_util_error btrfs_util_start_sync_fd(int fd, uint64_t *transid); + +/** + * btrfs_util_wait_sync() - Wait for a transaction with a given ID to sync. + * @path: Path on a Btrfs filesystem. + * @transid: Transaction ID to wait for, or zero for the current transaction. + * + * Return: %BTRFS_UTIL_OK on success, non-zero error code on failure. + */ +enum btrfs_util_error btrfs_util_wait_sync(const char *path, uint64_t transid); + +/** + * btrfs_util_wait_sync_fd() - See btrfs_util_wait_sync(). + */ +enum btrfs_util_error btrfs_util_wait_sync_fd(int fd, uint64_t transid); + /** * btrfs_util_is_subvolume() - Return whether a given path is a Btrfs subvolume. * @path: Path to check. diff --git a/libbtrfsutil/filesystem.c b/libbtrfsutil/filesystem.c new file mode 100644 index 00000000..dfd171bf --- /dev/null +++ b/libbtrfsutil/filesystem.c @@ -0,0 +1,103 @@ +/* + * 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 + * the Free Software Foundation, either version 3 of the License, or + * (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 . + */ + +#include +#include +#include +#include +#include + +#include "btrfsutil_internal.h" + +PUBLIC enum btrfs_util_error btrfs_util_sync(const char *path) +{ + enum btrfs_util_error err; + int fd; + + fd = open(path, O_RDONLY); + if (fd == -1) + return BTRFS_UTIL_ERROR_OPEN_FAILED; + + err = btrfs_util_sync_fd(fd); + SAVE_ERRNO_AND_CLOSE(fd); + return err; +} + +PUBLIC enum btrfs_util_error btrfs_util_sync_fd(int fd) +{ + int ret; + + ret = ioctl(fd, BTRFS_IOC_SYNC, NULL); + if (ret == -1) + return BTRFS_UTIL_ERROR_SYNC_FAILED; + + return BTRFS_UTIL_OK; +} + +PUBLIC enum btrfs_util_error btrfs_util_start_sync(const char *path, + uint64_t *transid) +{ + enum btrfs_util_error err; + int fd; + + fd = open(path, O_RDONLY); + if (fd == -1) + return BTRFS_UTIL_ERROR_OPEN_FAILED; + + err = btrfs_util_start_sync_fd(fd, transid); + SAVE_ERRNO_AND_CLOSE(fd); + return err; +} + +PUBLIC enum btrfs_util_error btrfs_util_start_sync_fd(int fd, uint64_t *transid) +{ + int ret; + + ret = ioctl(fd, BTRFS_IOC_START_SYNC, transid); + if (ret == -1) + return BTRFS_UTIL_ERROR_START_SYNC_FAILED; + + return BTRFS_UTIL_OK; +} + +PUBLIC enum btrfs_util_error btrfs_util_wait_sync(const char *path, + uint64_t transid) +{ + enum btrfs_util_error err; + int fd; + + fd = open(path, O_RDONLY); + if (fd == -1) + return BTRFS_UTIL_ERROR_OPEN_FAILED; + + err = btrfs_util_wait_sync_fd(fd, transid); + SAVE_ERRNO_AND_CLOSE(fd); + return err; +} + +PUBLIC enum btrfs_util_error btrfs_util_wait_sync_fd(int fd, uint64_t transid) +{ + int ret; + + ret = ioctl(fd, BTRFS_IOC_WAIT_SYNC, &transid); + if (ret == -1) + return BTRFS_UTIL_ERROR_WAIT_SYNC_FAILED; + + return BTRFS_UTIL_OK; +} diff --git a/libbtrfsutil/python/btrfsutilpy.h b/libbtrfsutil/python/btrfsutilpy.h index be5122e2..af3a6edf 100644 --- a/libbtrfsutil/python/btrfsutilpy.h +++ b/libbtrfsutil/python/btrfsutilpy.h @@ -63,6 +63,9 @@ void SetFromBtrfsUtilErrorWithPaths(enum btrfs_util_error err, struct path_arg *path1, struct path_arg *path2); +PyObject *filesystem_sync(PyObject *self, PyObject *args, PyObject *kwds); +PyObject *start_sync(PyObject *self, PyObject *args, PyObject *kwds); +PyObject *wait_sync(PyObject *self, PyObject *args, PyObject *kwds); PyObject *is_subvolume(PyObject *self, PyObject *args, PyObject *kwds); PyObject *subvolume_id(PyObject *self, PyObject *args, PyObject *kwds); PyObject *subvolume_path(PyObject *self, PyObject *args, PyObject *kwds); diff --git a/libbtrfsutil/python/filesystem.c b/libbtrfsutil/python/filesystem.c new file mode 100644 index 00000000..627ed193 --- /dev/null +++ b/libbtrfsutil/python/filesystem.c @@ -0,0 +1,94 @@ +/* + * 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 + * the Free Software Foundation, either version 3 of the License, or + * (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 . + */ + +#include "btrfsutilpy.h" + +PyObject *filesystem_sync(PyObject *self, PyObject *args, PyObject *kwds) +{ + static char *keywords[] = {"path", NULL}; + struct path_arg path = {.allow_fd = true}; + enum btrfs_util_error err; + + if (!PyArg_ParseTupleAndKeywords(args, kwds, "O&:sync", keywords, + &path_converter, &path)) + return NULL; + + if (path.path) + err = btrfs_util_sync(path.path); + else + err = btrfs_util_sync_fd(path.fd); + if (err) { + SetFromBtrfsUtilErrorWithPath(err, &path); + path_cleanup(&path); + return NULL; + } + + path_cleanup(&path); + Py_RETURN_NONE; +} + +PyObject *start_sync(PyObject *self, PyObject *args, PyObject *kwds) +{ + static char *keywords[] = {"path", NULL}; + struct path_arg path = {.allow_fd = true}; + uint64_t transid; + enum btrfs_util_error err; + + if (!PyArg_ParseTupleAndKeywords(args, kwds, "O&:start_sync", keywords, + &path_converter, &path)) + return NULL; + + if (path.path) + err = btrfs_util_start_sync(path.path, &transid); + else + err = btrfs_util_start_sync_fd(path.fd, &transid); + if (err) { + SetFromBtrfsUtilErrorWithPath(err, &path); + path_cleanup(&path); + return NULL; + } + + path_cleanup(&path); + return PyLong_FromUnsignedLongLong(transid); +} + +PyObject *wait_sync(PyObject *self, PyObject *args, PyObject *kwds) +{ + static char *keywords[] = {"path", "transid", NULL}; + struct path_arg path = {.allow_fd = true}; + unsigned long long transid = 0; + enum btrfs_util_error err; + + if (!PyArg_ParseTupleAndKeywords(args, kwds, "O&|K:wait_sync", keywords, + &path_converter, &path, &transid)) + return NULL; + + if (path.path) + err = btrfs_util_wait_sync(path.path, transid); + else + err = btrfs_util_wait_sync_fd(path.fd, transid); + if (err) { + SetFromBtrfsUtilErrorWithPath(err, &path); + path_cleanup(&path); + return NULL; + } + + path_cleanup(&path); + Py_RETURN_NONE; +} diff --git a/libbtrfsutil/python/module.c b/libbtrfsutil/python/module.c index eaa062ac..2dbdc7be 100644 --- a/libbtrfsutil/python/module.c +++ b/libbtrfsutil/python/module.c @@ -155,6 +155,27 @@ void path_cleanup(struct path_arg *path) } static PyMethodDef btrfsutil_methods[] = { + {"sync", (PyCFunction)filesystem_sync, + METH_VARARGS | METH_KEYWORDS, + "sync(path)\n\n" + "Sync a specific Btrfs filesystem.\n\n" + "Arguments:\n" + "path -- string, bytes, path-like object, or open file descriptor"}, + {"start_sync", (PyCFunction)start_sync, + METH_VARARGS | METH_KEYWORDS, + "start_sync(path) -> int\n\n" + "Start a sync on a specific Btrfs filesystem and return the\n" + "transaction ID.\n\n" + "Arguments:\n" + "path -- string, bytes, path-like object, or open file descriptor"}, + {"wait_sync", (PyCFunction)wait_sync, + METH_VARARGS | METH_KEYWORDS, + "wait_sync(path, transid=0)\n\n" + "Wait for a transaction to sync.\n" + "Arguments:\n" + "path -- string, bytes, path-like object, or open file descriptor\n" + "transid -- int transaction ID to wait for, or zero for the current\n" + "transaction"}, {"is_subvolume", (PyCFunction)is_subvolume, METH_VARARGS | METH_KEYWORDS, "is_subvolume(path) -> bool\n\n" diff --git a/libbtrfsutil/python/setup.py b/libbtrfsutil/python/setup.py index 06857084..131f1755 100755 --- a/libbtrfsutil/python/setup.py +++ b/libbtrfsutil/python/setup.py @@ -90,6 +90,7 @@ module = Extension( sources=[ 'constants.c', 'error.c', + 'filesystem.c', 'module.c', 'qgroup.c', 'subvolume.c', diff --git a/libbtrfsutil/python/tests/test_filesystem.py b/libbtrfsutil/python/tests/test_filesystem.py new file mode 100644 index 00000000..006a6b1e --- /dev/null +++ b/libbtrfsutil/python/tests/test_filesystem.py @@ -0,0 +1,73 @@ +# 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 +# the Free Software Foundation, either version 3 of the License, or +# (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 . + +import os +import time + +import btrfsutil +from tests import BtrfsTestCase, HAVE_PATH_LIKE + + +def touch(path): + now = time.time() + os.utime(path, (now, now)) + + +class TestSubvolume(BtrfsTestCase): + def super_generation(self): + with open(self.image, 'rb') as f: + # csum is 32 bytes, fsid is 16 bytes, bytenr is 8 bytes, flags is 8 + # bytes + f.seek(65536 + 32 + 16 + 8 + 8) + self.assertEqual(f.read(8), b'_BHRfS_M') + return int.from_bytes(f.read(8), 'little') + + def test_sync(self): + old_generation = self.super_generation() + for arg in self.path_or_fd(self.mountpoint): + with self.subTest(type=type(arg)): + touch(arg) + btrfsutil.sync(arg) + new_generation = self.super_generation() + self.assertGreater(new_generation, old_generation) + old_generation = new_generation + + def test_start_sync(self): + old_generation = self.super_generation() + for arg in self.path_or_fd(self.mountpoint): + with self.subTest(type=type(arg)): + touch(arg) + transid = btrfsutil.start_sync(arg) + self.assertGreater(transid, old_generation) + + def test_wait_sync(self): + old_generation = self.super_generation() + for arg in self.path_or_fd(self.mountpoint): + with self.subTest(type=type(arg)): + touch(arg) + transid = btrfsutil.start_sync(arg) + btrfsutil.wait_sync(arg, transid) + new_generation = self.super_generation() + self.assertGreater(new_generation, old_generation) + old_generation = new_generation + + touch(arg) + btrfsutil.start_sync(arg) + btrfsutil.wait_sync(arg) + new_generation = self.super_generation() + self.assertGreater(new_generation, old_generation) + old_generation = new_generation