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 #if BTRFS_FLAT_INCLUDES
  20 #include "kerncompat.h"
  21 #else
  22 #include <btrfs/kerncompat.h>
  23 #endif /* BTRFS_FLAT_INCLUDES */
  24
  25 #define BTRFS_LIST_LAYOUT_DEFAULT       0
  26 #define BTRFS_LIST_LAYOUT_TABLE 1
  27 #define BTRFS_LIST_LAYOUT_RAW           2
  28
  29 /*
  30  * one of these for each root we find.
  31  */
  32 struct root_info {
  33         struct rb_node rb_node;
  34         struct rb_node sort_node;
  35
  36         /* this root's id */
  37         u64 root_id;
  38
  39         /* equal the offset of the root's key */
  40         u64 root_offset;
  41
  42         /* flags of the root */
  43         u64 flags;
  44
  45         /* the id of the root that references this one */
  46         u64 ref_tree;
  47
  48         /* the dir id we're in from ref_tree */
  49         u64 dir_id;
  50
  51         u64 top_id;
  52
  53         /* generation when the root is created or last updated */
  54         u64 gen;
  55
  56         /* creation generation of this root in sec*/
  57         u64 ogen;
  58
  59         /* creation time of this root in sec*/
  60         time_t otime;
  61
  62         u8 uuid[BTRFS_UUID_SIZE];
  63         u8 puuid[BTRFS_UUID_SIZE];
  64
  65         /* path from the subvol we live in to this root, including the
  66          * root's name.  This is null until we do the extra lookup ioctl.
  67          */
  68         char *path;
  69
  70         /* the name of this root in the directory it lives in */
  71         char *name;
  72
  73         char *full_path;
  74 };
  75
  76 typedef int (*btrfs_list_filter_func)(struct root_info *, u64);
  77 typedef int (*btrfs_list_comp_func)(struct root_info *, struct root_info *,
  78                                     int);
  79
  80 struct btrfs_list_filter {
  81         btrfs_list_filter_func filter_func;
  82         u64 data;
  83 };
  84
  85 struct btrfs_list_comparer {
  86         btrfs_list_comp_func comp_func;
  87         int is_descending;
  88 };
  89
  90 struct btrfs_list_filter_set {
  91         int total;
  92         int nfilters;
  93         struct btrfs_list_filter filters[0];
  94 };
  95
  96 struct btrfs_list_comparer_set {
  97         int total;
  98         int ncomps;
  99         struct btrfs_list_comparer comps[0];
 100 };
 101
 102 enum btrfs_list_column_enum {
 103         BTRFS_LIST_OBJECTID,
 104         BTRFS_LIST_GENERATION,
 105         BTRFS_LIST_OGENERATION,
 106         BTRFS_LIST_PARENT,
 107         BTRFS_LIST_TOP_LEVEL,
 108         BTRFS_LIST_OTIME,
 109         BTRFS_LIST_PUUID,
 110         BTRFS_LIST_UUID,
 111         BTRFS_LIST_PATH,
 112         BTRFS_LIST_ALL,
 113 };
 114
 115 enum btrfs_list_filter_enum {
 116         BTRFS_LIST_FILTER_ROOTID,
 117         BTRFS_LIST_FILTER_SNAPSHOT_ONLY,
 118         BTRFS_LIST_FILTER_FLAGS,
 119         BTRFS_LIST_FILTER_GEN,
 120         BTRFS_LIST_FILTER_GEN_EQUAL     =       BTRFS_LIST_FILTER_GEN,
 121         BTRFS_LIST_FILTER_GEN_LESS,
 122         BTRFS_LIST_FILTER_GEN_MORE,
 123         BTRFS_LIST_FILTER_CGEN,
 124         BTRFS_LIST_FILTER_CGEN_EQUAL    =       BTRFS_LIST_FILTER_CGEN,
 125         BTRFS_LIST_FILTER_CGEN_LESS,
 126         BTRFS_LIST_FILTER_CGEN_MORE,
 127         BTRFS_LIST_FILTER_TOPID_EQUAL,
 128         BTRFS_LIST_FILTER_FULL_PATH,
 129         BTRFS_LIST_FILTER_BY_PARENT,
 130         BTRFS_LIST_FILTER_MAX,
 131 };
 132
 133 enum btrfs_list_comp_enum {
 134         BTRFS_LIST_COMP_ROOTID,
 135         BTRFS_LIST_COMP_OGEN,
 136         BTRFS_LIST_COMP_GEN,
 137         BTRFS_LIST_COMP_PATH,
 138         BTRFS_LIST_COMP_MAX,
 139 };
 140
 141 int btrfs_list_parse_sort_string(char *optarg,
 142                                  struct btrfs_list_comparer_set **comps);
 143 int btrfs_list_parse_filter_string(char *optarg,
 144                                    struct btrfs_list_filter_set **filters,
 145                                    enum btrfs_list_filter_enum type);
 146 void btrfs_list_setup_print_column(enum btrfs_list_column_enum column);
 147 struct btrfs_list_filter_set *btrfs_list_alloc_filter_set(void);
 148 void btrfs_list_free_filter_set(struct btrfs_list_filter_set *filter_set);
 149 int btrfs_list_setup_filter(struct btrfs_list_filter_set **filter_set,
 150                             enum btrfs_list_filter_enum filter, u64 data);
 151 struct btrfs_list_comparer_set *btrfs_list_alloc_comparer_set(void);
 152 void btrfs_list_free_comparer_set(struct btrfs_list_comparer_set *comp_set);
 153
 154 int btrfs_list_subvols_print(int fd, struct btrfs_list_filter_set *filter_set,
 155                        struct btrfs_list_comparer_set *comp_set,
 156                        int is_tab_result, int full_path, char *raw_prefix);
 157 int btrfs_list_find_updated_files(int fd, u64 root_id, u64 oldest_gen);
 158 int btrfs_list_get_default_subvolume(int fd, u64 *default_id);
 159 char *btrfs_list_path_for_root(int fd, u64 root);
 160 int btrfs_list_get_path_rootid(int fd, u64 *treeid);
 161 int btrfs_get_subvol(int fd, struct root_info *the_ri);