a1d312de7780e (Thomas Gleixner 2019-05-22 09:51:42 +0200 1) /* SPDX-License-Identifier: GPL-2.0-or-later */
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 2) /*
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 3) * attrib.h - Defines for attribute handling in NTFS Linux kernel driver.
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 4) * Part of the Linux-NTFS project.
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 5) *
271849a988493 (Anton Altaparmakov 2005-03-07 21:36:18 +0000 6) * Copyright (c) 2001-2005 Anton Altaparmakov
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 7) * Copyright (c) 2002 Richard Russon
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 8) */
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 9)
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 10) #ifndef _LINUX_NTFS_ATTRIB_H
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 11) #define _LINUX_NTFS_ATTRIB_H
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 12)
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 13) #include "endian.h"
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 14) #include "types.h"
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 15) #include "layout.h"
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 16) #include "inode.h"
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 17) #include "runlist.h"
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 18) #include "volume.h"
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 19)
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 20) /**
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 21) * ntfs_attr_search_ctx - used in attribute search functions
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 22) * @mrec: buffer containing mft record to search
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 23) * @attr: attribute record in @mrec where to begin/continue search
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 24) * @is_first: if true ntfs_attr_lookup() begins search with @attr, else after
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 25) *
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 26) * Structure must be initialized to zero before the first call to one of the
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 27) * attribute search functions. Initialize @mrec to point to the mft record to
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 28) * search, and @attr to point to the first attribute within @mrec (not necessary
c49c31115067b (Richard Knutsson 2006-09-30 23:27:12 -0700 29) * if calling the _first() functions), and set @is_first to 'true' (not necessary
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 30) * if calling the _first() functions).
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 31) *
c49c31115067b (Richard Knutsson 2006-09-30 23:27:12 -0700 32) * If @is_first is 'true', the search begins with @attr. If @is_first is 'false',
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 33) * the search begins after @attr. This is so that, after the first call to one
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 34) * of the search attribute functions, we can call the function again, without
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 35) * any modification of the search context, to automagically get the next
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 36) * matching attribute.
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 37) */
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 38) typedef struct {
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 39) MFT_RECORD *mrec;
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 40) ATTR_RECORD *attr;
c49c31115067b (Richard Knutsson 2006-09-30 23:27:12 -0700 41) bool is_first;
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 42) ntfs_inode *ntfs_ino;
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 43) ATTR_LIST_ENTRY *al_entry;
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 44) ntfs_inode *base_ntfs_ino;
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 45) MFT_RECORD *base_mrec;
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 46) ATTR_RECORD *base_attr;
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 47) } ntfs_attr_search_ctx;
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 48)
fd9d63678d42f (Anton Altaparmakov 2005-10-04 13:44:48 +0100 49) extern int ntfs_map_runlist_nolock(ntfs_inode *ni, VCN vcn,
fd9d63678d42f (Anton Altaparmakov 2005-10-04 13:44:48 +0100 50) ntfs_attr_search_ctx *ctx);
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 51) extern int ntfs_map_runlist(ntfs_inode *ni, VCN vcn);
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 52)
271849a988493 (Anton Altaparmakov 2005-03-07 21:36:18 +0000 53) extern LCN ntfs_attr_vcn_to_lcn_nolock(ntfs_inode *ni, const VCN vcn,
c49c31115067b (Richard Knutsson 2006-09-30 23:27:12 -0700 54) const bool write_locked);
271849a988493 (Anton Altaparmakov 2005-03-07 21:36:18 +0000 55)
c0c1cc0e46b36 (Anton Altaparmakov 2005-03-07 21:43:38 +0000 56) extern runlist_element *ntfs_attr_find_vcn_nolock(ntfs_inode *ni,
69b41e3c0223b (Anton Altaparmakov 2005-10-04 14:01:14 +0100 57) const VCN vcn, ntfs_attr_search_ctx *ctx);
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 58)
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 59) int ntfs_attr_lookup(const ATTR_TYPE type, const ntfschar *name,
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 60) const u32 name_len, const IGNORE_CASE_BOOL ic,
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 61) const VCN lowest_vcn, const u8 *val, const u32 val_len,
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 62) ntfs_attr_search_ctx *ctx);
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 63)
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 64) extern int load_attribute_list(ntfs_volume *vol, runlist *rl, u8 *al_start,
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 65) const s64 size, const s64 initialized_size);
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 66)
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 67) static inline s64 ntfs_attr_size(const ATTR_RECORD *a)
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 68) {
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 69) if (!a->non_resident)
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 70) return (s64)le32_to_cpu(a->data.resident.value_length);
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 71) return sle64_to_cpu(a->data.non_resident.data_size);
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 72) }
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 73)
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 74) extern void ntfs_attr_reinit_search_ctx(ntfs_attr_search_ctx *ctx);
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 75) extern ntfs_attr_search_ctx *ntfs_attr_get_search_ctx(ntfs_inode *ni,
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 76) MFT_RECORD *mrec);
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 77) extern void ntfs_attr_put_search_ctx(ntfs_attr_search_ctx *ctx);
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 78)
53d59aad93261 (Anton Altaparmakov 2005-03-17 10:51:33 +0000 79) #ifdef NTFS_RW
53d59aad93261 (Anton Altaparmakov 2005-03-17 10:51:33 +0000 80)
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 81) extern int ntfs_attr_size_bounds_check(const ntfs_volume *vol,
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 82) const ATTR_TYPE type, const s64 size);
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 83) extern int ntfs_attr_can_be_non_resident(const ntfs_volume *vol,
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 84) const ATTR_TYPE type);
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 85) extern int ntfs_attr_can_be_resident(const ntfs_volume *vol,
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 86) const ATTR_TYPE type);
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 87)
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 88) extern int ntfs_attr_record_resize(MFT_RECORD *m, ATTR_RECORD *a, u32 new_size);
0aacceacf3545 (Anton Altaparmakov 2005-09-08 20:40:32 +0100 89) extern int ntfs_resident_attr_value_resize(MFT_RECORD *m, ATTR_RECORD *a,
0aacceacf3545 (Anton Altaparmakov 2005-09-08 20:40:32 +0100 90) const u32 new_size);
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 91)
8925d4f0d3479 (Anton Altaparmakov 2005-10-04 14:48:20 +0100 92) extern int ntfs_attr_make_non_resident(ntfs_inode *ni, const u32 data_size);
2bfb4fff3e973 (Anton Altaparmakov 2005-03-09 15:15:06 +0000 93)
2d86829b846d1 (Anton Altaparmakov 2005-10-04 15:18:56 +0100 94) extern s64 ntfs_attr_extend_allocation(ntfs_inode *ni, s64 new_alloc_size,
2d86829b846d1 (Anton Altaparmakov 2005-10-04 15:18:56 +0100 95) const s64 new_data_size, const s64 data_start);
2d86829b846d1 (Anton Altaparmakov 2005-10-04 15:18:56 +0100 96)
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 97) extern int ntfs_attr_set(ntfs_inode *ni, const s64 ofs, const s64 cnt,
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 98) const u8 val);
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 99)
53d59aad93261 (Anton Altaparmakov 2005-03-17 10:51:33 +0000 100) #endif /* NTFS_RW */
53d59aad93261 (Anton Altaparmakov 2005-03-17 10:51:33 +0000 101)
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 102) #endif /* _LINUX_NTFS_ATTRIB_H */