[net-next-2.6.git] / fs / ntfs / attrib.h

/*
 * attrib.h - Defines for attribute handling in NTFS Linux kernel driver.
 *	      Part of the Linux-NTFS project.
 *
 * Copyright (c) 2001-2004 Anton Altaparmakov
 * Copyright (c) 2002 Richard Russon
 *
 * This program/include file is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program/include file 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program (in the main directory of the Linux-NTFS
 * distribution in the file COPYING); if not, write to the Free Software
 * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef _LINUX_NTFS_ATTRIB_H
#define _LINUX_NTFS_ATTRIB_H

#include "endian.h"
#include "types.h"
#include "layout.h"
#include "inode.h"
#include "runlist.h"
#include "volume.h"

/**
 * ntfs_attr_search_ctx - used in attribute search functions
 * @mrec:	buffer containing mft record to search
 * @attr:	attribute record in @mrec where to begin/continue search
 * @is_first:	if true ntfs_attr_lookup() begins search with @attr, else after
 *
 * Structure must be initialized to zero before the first call to one of the
 * attribute search functions. Initialize @mrec to point to the mft record to
 * search, and @attr to point to the first attribute within @mrec (not necessary
 * if calling the _first() functions), and set @is_first to TRUE (not necessary
 * if calling the _first() functions).
 *
 * If @is_first is TRUE, the search begins with @attr. If @is_first is FALSE,
 * the search begins after @attr. This is so that, after the first call to one
 * of the search attribute functions, we can call the function again, without
 * any modification of the search context, to automagically get the next
 * matching attribute.
 */
typedef struct {
	MFT_RECORD *mrec;
	ATTR_RECORD *attr;
	BOOL is_first;
	ntfs_inode *ntfs_ino;
	ATTR_LIST_ENTRY *al_entry;
	ntfs_inode *base_ntfs_ino;
	MFT_RECORD *base_mrec;
	ATTR_RECORD *base_attr;
} ntfs_attr_search_ctx;

extern int ntfs_map_runlist_nolock(ntfs_inode *ni, VCN vcn);
extern int ntfs_map_runlist(ntfs_inode *ni, VCN vcn);

extern runlist_element *ntfs_find_vcn_nolock(ntfs_inode *ni, const VCN vcn,
		const BOOL write_locked);

int ntfs_attr_lookup(const ATTR_TYPE type, const ntfschar *name,
		const u32 name_len, const IGNORE_CASE_BOOL ic,
		const VCN lowest_vcn, const u8 *val, const u32 val_len,
		ntfs_attr_search_ctx *ctx);

extern int load_attribute_list(ntfs_volume *vol, runlist *rl, u8 *al_start,
		const s64 size, const s64 initialized_size);

static inline s64 ntfs_attr_size(const ATTR_RECORD *a)
{
	if (!a->non_resident)
		return (s64)le32_to_cpu(a->data.resident.value_length);
	return sle64_to_cpu(a->data.non_resident.data_size);
}

extern void ntfs_attr_reinit_search_ctx(ntfs_attr_search_ctx *ctx);
extern ntfs_attr_search_ctx *ntfs_attr_get_search_ctx(ntfs_inode *ni,
		MFT_RECORD *mrec);
extern void ntfs_attr_put_search_ctx(ntfs_attr_search_ctx *ctx);

extern int ntfs_attr_size_bounds_check(const ntfs_volume *vol,
		const ATTR_TYPE type, const s64 size);
extern int ntfs_attr_can_be_non_resident(const ntfs_volume *vol,
		const ATTR_TYPE type);
extern int ntfs_attr_can_be_resident(const ntfs_volume *vol,
		const ATTR_TYPE type);

extern int ntfs_attr_record_resize(MFT_RECORD *m, ATTR_RECORD *a, u32 new_size);

extern int ntfs_attr_set(ntfs_inode *ni, const s64 ofs, const s64 cnt,
		const u8 val);

#endif /* _LINUX_NTFS_ATTRIB_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* attrib.h - Defines for attribute handling in NTFS Linux kernel driver.
	3	* Part of the Linux-NTFS project.
	4	*
	5	* Copyright (c) 2001-2004 Anton Altaparmakov
	6	* Copyright (c) 2002 Richard Russon
	7	*
	8	* This program/include file is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU General Public License as published
	10	* by the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program/include file is distributed in the hope that it will be
	14	* useful, but WITHOUT ANY WARRANTY; without even the implied warranty
	15	* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program (in the main directory of the Linux-NTFS
	20	* distribution in the file COPYING); if not, write to the Free Software
	21	* Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	22	*/
	23
	24	#ifndef _LINUX_NTFS_ATTRIB_H
	25	#define _LINUX_NTFS_ATTRIB_H
	26
	27	#include "endian.h"
	28	#include "types.h"
	29	#include "layout.h"
	30	#include "inode.h"
	31	#include "runlist.h"
	32	#include "volume.h"
	33
	34	/**
	35	* ntfs_attr_search_ctx - used in attribute search functions
	36	* @mrec: buffer containing mft record to search
	37	* @attr: attribute record in @mrec where to begin/continue search
	38	* @is_first: if true ntfs_attr_lookup() begins search with @attr, else after
	39	*
	40	* Structure must be initialized to zero before the first call to one of the
	41	* attribute search functions. Initialize @mrec to point to the mft record to
	42	* search, and @attr to point to the first attribute within @mrec (not necessary
	43	* if calling the _first() functions), and set @is_first to TRUE (not necessary
	44	* if calling the _first() functions).
	45	*
	46	* If @is_first is TRUE, the search begins with @attr. If @is_first is FALSE,
	47	* the search begins after @attr. This is so that, after the first call to one
	48	* of the search attribute functions, we can call the function again, without
	49	* any modification of the search context, to automagically get the next
	50	* matching attribute.
	51	*/
	52	typedef struct {
	53	MFT_RECORD *mrec;
	54	ATTR_RECORD *attr;
	55	BOOL is_first;
	56	ntfs_inode *ntfs_ino;
	57	ATTR_LIST_ENTRY *al_entry;
	58	ntfs_inode *base_ntfs_ino;
	59	MFT_RECORD *base_mrec;
	60	ATTR_RECORD *base_attr;
	61	} ntfs_attr_search_ctx;
	62
b6ad6c52	63	extern int ntfs_map_runlist_nolock(ntfs_inode *ni, VCN vcn);
1da177e4 LT	64	extern int ntfs_map_runlist(ntfs_inode *ni, VCN vcn);
1da177e4 LT	65
b6ad6c52 AA	66	extern runlist_element ntfs_find_vcn_nolock(ntfs_inode ni, const VCN vcn,
b6ad6c52 AA	67	const BOOL write_locked);
1da177e4 LT	68
	69	int ntfs_attr_lookup(const ATTR_TYPE type, const ntfschar *name,
	70	const u32 name_len, const IGNORE_CASE_BOOL ic,
	71	const VCN lowest_vcn, const u8 *val, const u32 val_len,
	72	ntfs_attr_search_ctx *ctx);
	73
	74	extern int load_attribute_list(ntfs_volume vol, runlist rl, u8 *al_start,
	75	const s64 size, const s64 initialized_size);
	76
	77	static inline s64 ntfs_attr_size(const ATTR_RECORD *a)
	78	{
	79	if (!a->non_resident)
	80	return (s64)le32_to_cpu(a->data.resident.value_length);
	81	return sle64_to_cpu(a->data.non_resident.data_size);
	82	}
	83
	84	extern void ntfs_attr_reinit_search_ctx(ntfs_attr_search_ctx *ctx);
	85	extern ntfs_attr_search_ctx ntfs_attr_get_search_ctx(ntfs_inode ni,
	86	MFT_RECORD *mrec);
	87	extern void ntfs_attr_put_search_ctx(ntfs_attr_search_ctx *ctx);
	88
	89	extern int ntfs_attr_size_bounds_check(const ntfs_volume *vol,
	90	const ATTR_TYPE type, const s64 size);
	91	extern int ntfs_attr_can_be_non_resident(const ntfs_volume *vol,
	92	const ATTR_TYPE type);
	93	extern int ntfs_attr_can_be_resident(const ntfs_volume *vol,
	94	const ATTR_TYPE type);
	95
	96	extern int ntfs_attr_record_resize(MFT_RECORD m, ATTR_RECORD a, u32 new_size);
	97
	98	extern int ntfs_attr_set(ntfs_inode *ni, const s64 ofs, const s64 cnt,
	99	const u8 val);
	100
	101	#endif /* _LINUX_NTFS_ATTRIB_H */