btrfs-list.h

   1 /*
   2  * Copyright (C) 2012 Fujitsu.  All rights reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public
   6  * License v2 as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public
  14  * License along with this program; if not, write to the
  15  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  16  * Boston, MA 021110-1307, USA.
  17  */
  18
  19 #include "kerncompat.h"
  20
  21 #define BTRFS_LIST_LAYOUT_DEFAULT       0
  22 #define BTRFS_LIST_LAYOUT_TABLE 1
  23
  24 /*
  25  * one of these for each root we find.
  26  */
  27 struct root_info {
  28         struct rb_node rb_node;
  29         struct rb_node sort_node;
  30
  31         /* this root's id */
  32         u64 root_id;
  33
  34         /* equal the offset of the root's key */
  35         u64 root_offset;
  36
  37         /* flags of the root */
  38         u64 flags;
  39
  40         /* the id of the root that references this one */
  41         u64 ref_tree;
  42
  43         /* the dir id we're in from ref_tree */
  44         u64 dir_id;
  45
  46         u64 top_id;
  47
  48         /* generation when the root is created or last updated */
  49         u64 gen;
  50
  51         /* creation generation of this root in sec*/
  52         u64 ogen;
  53
  54         /* creation time of this root in sec*/
  55         time_t otime;
  56
  57         u8 uuid[BTRFS_UUID_SIZE];
  58         u8 puuid[BTRFS_UUID_SIZE];
  59
  60         /* path from the subvol we live in to this root, including the
  61          * root's name.  This is null until we do the extra lookup ioctl.
  62          */
  63         char *path;
  64
  65         /* the name of this root in the directory it lives in */
  66         char *name;
  67
  68         char *full_path;
  69 };
  70
  71 typedef int (*btrfs_list_filter_func)(struct root_info *, u64);
  72 typedef int (*btrfs_list_comp_func)(struct root_info *, struct root_info *,
  73                                     int);
  74
  75 struct btrfs_list_filter {
  76         btrfs_list_filter_func filter_func;
  77         u64 data;
  78 };
  79
  80 struct btrfs_list_comparer {
  81         btrfs_list_comp_func comp_func;
  82         int is_descending;
  83 };
  84
  85 struct btrfs_list_filter_set {
  86         int total;
  87         int nfilters;
  88         struct btrfs_list_filter filters[0];
  89 };
  90
  91 struct btrfs_list_comparer_set {
  92         int total;
  93         int ncomps;
  94         struct btrfs_list_comparer comps[0];
  95 };
  96
  97 enum btrfs_list_column_enum {
  98         BTRFS_LIST_OBJECTID,
  99         BTRFS_LIST_GENERATION,
 100         BTRFS_LIST_OGENERATION,
 101         BTRFS_LIST_PARENT,
 102         BTRFS_LIST_TOP_LEVEL,
 103         BTRFS_LIST_OTIME,
 104         BTRFS_LIST_PUUID,
 105         BTRFS_LIST_UUID,
 106         BTRFS_LIST_PATH,
 107         BTRFS_LIST_ALL,
 108 };
 109
 110 enum btrfs_list_filter_enum {
 111         BTRFS_LIST_FILTER_ROOTID,
 112         BTRFS_LIST_FILTER_SNAPSHOT_ONLY,
 113         BTRFS_LIST_FILTER_FLAGS,
 114         BTRFS_LIST_FILTER_GEN,
 115         BTRFS_LIST_FILTER_GEN_EQUAL     =       BTRFS_LIST_FILTER_GEN,
 116         BTRFS_LIST_FILTER_GEN_LESS,
 117         BTRFS_LIST_FILTER_GEN_MORE,
 118         BTRFS_LIST_FILTER_CGEN,
 119         BTRFS_LIST_FILTER_CGEN_EQUAL    =       BTRFS_LIST_FILTER_CGEN,
 120         BTRFS_LIST_FILTER_CGEN_LESS,
 121         BTRFS_LIST_FILTER_CGEN_MORE,
 122         BTRFS_LIST_FILTER_TOPID_EQUAL,
 123         BTRFS_LIST_FILTER_FULL_PATH,
 124         BTRFS_LIST_FILTER_BY_PARENT,
 125         BTRFS_LIST_FILTER_MAX,
 126 };
 127
 128 enum btrfs_list_comp_enum {
 129         BTRFS_LIST_COMP_ROOTID,
 130         BTRFS_LIST_COMP_OGEN,
 131         BTRFS_LIST_COMP_GEN,
 132         BTRFS_LIST_COMP_PATH,
 133         BTRFS_LIST_COMP_MAX,
 134 };
 135
 136 int btrfs_list_parse_sort_string(char *optarg,
 137                                  struct btrfs_list_comparer_set **comps);
 138 int btrfs_list_parse_filter_string(char *optarg,
 139                                    struct btrfs_list_filter_set **filters,
 140                                    enum btrfs_list_filter_enum type);
 141 void btrfs_list_setup_print_column(enum btrfs_list_column_enum column);
 142 struct btrfs_list_filter_set *btrfs_list_alloc_filter_set(void);
 143 void btrfs_list_free_filter_set(struct btrfs_list_filter_set *filter_set);
 144 int btrfs_list_setup_filter(struct btrfs_list_filter_set **filter_set,
 145                             enum btrfs_list_filter_enum filter, u64 data);
 146 struct btrfs_list_comparer_set *btrfs_list_alloc_comparer_set(void);
 147 void btrfs_list_free_comparer_set(struct btrfs_list_comparer_set *comp_set);
 148 int btrfs_list_setup_comparer(struct btrfs_list_comparer_set **comp_set,
 149                               enum btrfs_list_comp_enum comparer,
 150                               int is_descending);
 151
 152 int btrfs_list_subvols_print(int fd, struct btrfs_list_filter_set *filter_set,
 153                        struct btrfs_list_comparer_set *comp_set,
 154                        int is_tab_result, int full_path);
 155 int btrfs_list_find_updated_files(int fd, u64 root_id, u64 oldest_gen);
 156 int btrfs_list_get_default_subvolume(int fd, u64 *default_id);
 157 char *btrfs_list_path_for_root(int fd, u64 root);
 158 u64 btrfs_list_get_path_rootid(int fd);
 159 int btrfs_get_subvol(int fd, struct root_info *the_ri);