mirror of
https://git.code.sf.net/p/ntfs-3g/ntfs-3g.git
synced 2024-11-23 18:14:24 +08:00
140 lines
4.1 KiB
C
140 lines
4.1 KiB
C
/*
|
|
* utils.h - Part of the Linux-NTFS project.
|
|
*
|
|
* Copyright (c) 2002-2005 Richard Russon
|
|
* Copyright (c) 2004 Anton Altaparmakov
|
|
*
|
|
* A set of shared functions for ntfs utilities
|
|
*
|
|
* This program 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 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 _NTFS_UTILS_H_
|
|
#define _NTFS_UTILS_H_
|
|
|
|
#include "config.h"
|
|
|
|
#include "types.h"
|
|
#include "layout.h"
|
|
#include "volume.h"
|
|
|
|
#ifdef HAVE_ERRNO_H
|
|
#include <errno.h>
|
|
#endif
|
|
#ifdef HAVE_STDARG_H
|
|
#include <stdarg.h>
|
|
#endif
|
|
|
|
extern const char *ntfs_bugs;
|
|
extern const char *ntfs_home;
|
|
extern const char *ntfs_gpl;
|
|
|
|
#define DEC_PRINTF(NAME) \
|
|
int NAME(const char *format, ...) \
|
|
__attribute__((format(printf, 1, 2)));
|
|
|
|
#define GEN_PRINTF(NAME, STREAM, CONTROL, TRIGGER) \
|
|
__attribute__((format(printf, 1, 2))) \
|
|
int NAME(const char *format, ...) \
|
|
{ \
|
|
int ret, olderr = errno, *control = (CONTROL); \
|
|
va_list args; \
|
|
\
|
|
if (!(STREAM)) \
|
|
return -1; \
|
|
if (control && \
|
|
((*control && !(TRIGGER)) || (!*control && (TRIGGER)))) \
|
|
return -1; \
|
|
\
|
|
va_start(args, format); \
|
|
ret = vfprintf((STREAM), format, args); \
|
|
va_end(args); \
|
|
errno = olderr; \
|
|
return ret; \
|
|
}
|
|
|
|
|
|
/* utils.c's utilities require the following functions implemented.
|
|
* Example of implementation is:
|
|
* GEN_PRINTF(Eprintf, stderr, NULL, FALSE)
|
|
* GEN_PRINTF(Vprintf, stderr, &opts.verbose, TRUE)
|
|
* GEN_PRINTF(Qprintf, stderr, &opts.quiet, FALSE)
|
|
*/
|
|
extern DEC_PRINTF(Eprintf)
|
|
extern DEC_PRINTF(Vprintf)
|
|
extern DEC_PRINTF(Qprintf)
|
|
|
|
int utils_set_locale(void);
|
|
int utils_parse_size(const char *value, s64 *size, BOOL scale);
|
|
int utils_parse_range(const char *string, s64 *start, s64 *finish, BOOL scale);
|
|
int utils_inode_get_name(ntfs_inode *inode, char *buffer, int bufsize);
|
|
int utils_attr_get_name(ntfs_volume *vol, ATTR_RECORD *attr, char *buffer, int bufsize);
|
|
int utils_cluster_in_use(ntfs_volume *vol, long long lcn);
|
|
int utils_mftrec_in_use(ntfs_volume *vol, MFT_REF mref);
|
|
int utils_is_metadata(ntfs_inode *inode);
|
|
void utils_dump_mem(void *buf, int start, int length, int ascii);
|
|
|
|
#ifndef _NTFS_RICH_H_
|
|
ATTR_RECORD * find_attribute(const ATTR_TYPES type, ntfs_attr_search_ctx *ctx);
|
|
ATTR_RECORD * find_first_attribute(const ATTR_TYPES type, MFT_RECORD *mft);
|
|
#endif
|
|
|
|
#if !(defined(_NTFS_VOLUME_H) && defined(NTFS_RICH))
|
|
int utils_valid_device(const char *name, int force);
|
|
ntfs_volume * utils_mount_volume(const char *device, unsigned long flags, BOOL force);
|
|
#endif
|
|
|
|
/**
|
|
* defines...
|
|
* if *not in use* then the other flags are ignored?
|
|
*/
|
|
#define FEMR_IN_USE 1 << 0
|
|
#define FEMR_NOT_IN_USE 1 << 1
|
|
#define FEMR_FILE 1 << 2 // $DATA
|
|
#define FEMR_DIR 1 << 3 // $INDEX_ROOT, "$I30"
|
|
#define FEMR_METADATA 1 << 4
|
|
#define FEMR_NOT_METADATA 1 << 5
|
|
#define FEMR_BASE_RECORD 1 << 6
|
|
#define FEMR_NOT_BASE_RECORD 1 << 7
|
|
#define FEMR_ALL_RECORDS 0xFF
|
|
|
|
/**
|
|
* struct mft_search_ctx
|
|
*/
|
|
struct mft_search_ctx {
|
|
int flags_search;
|
|
int flags_match;
|
|
ntfs_inode *inode;
|
|
ntfs_volume *vol;
|
|
u64 mft_num;
|
|
};
|
|
|
|
struct mft_search_ctx * mft_get_search_ctx(ntfs_volume *vol);
|
|
void mft_put_search_ctx(struct mft_search_ctx *ctx);
|
|
int mft_next_record(struct mft_search_ctx *ctx);
|
|
|
|
// Flags for dump mem
|
|
#define DM_DEFAULTS 0
|
|
#define DM_NO_ASCII (1 << 0)
|
|
#define DM_NO_DIVIDER (1 << 1)
|
|
#define DM_INDENT (1 << 2)
|
|
#define DM_RED (1 << 3)
|
|
#define DM_GREEN (1 << 4)
|
|
#define DM_BLUE (1 << 5)
|
|
#define DM_BOLD (1 << 6)
|
|
|
|
#endif /* _NTFS_UTILS_H_ */
|