fs/ntfs/types.h

   1 /*
   2  * types.h - Defines for NTFS Linux kernel driver specific types.
   3  *           Part of the Linux-NTFS project.
   4  *
   5  * Copyright (c) 2001-2004 Anton Altaparmakov
   6  *
   7  * This program/include file is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License as published
   9  * by the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program/include file is distributed in the hope that it will be
  13  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program (in the main directory of the Linux-NTFS
  19  * distribution in the file COPYING); if not, write to the Free Software
  20  * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifndef _LINUX_NTFS_TYPES_H
  24 #define _LINUX_NTFS_TYPES_H
  25
  26 /* 2-byte Unicode character type. */
  27 typedef u16 ntfschar;
  28 #define UCHAR_T_SIZE_BITS 1
  29
  30 /*
  31  * Clusters are signed 64-bit values on NTFS volumes. We define two types, LCN
  32  * and VCN, to allow for type checking and better code readability.
  33  */
  34 typedef s64 VCN;
  35 typedef s64 LCN;
  36
  37 /*
  38  * The NTFS journal $LogFile uses log sequence numbers which are signed 64-bit
  39  * values.  We define our own type LSN, to allow for type checking and better
  40  * code readability.
  41  */
  42 typedef s64 LSN;
  43
  44 /**
  45  * run_list_element - in memory vcn to lcn mapping array element
  46  * @vcn:        starting vcn of the current array element
  47  * @lcn:        starting lcn of the current array element
  48  * @length:     length in clusters of the current array element
  49  *
  50  * The last vcn (in fact the last vcn + 1) is reached when length == 0.
  51  *
  52  * When lcn == -1 this means that the count vcns starting at vcn are not
  53  * physically allocated (i.e. this is a hole / data is sparse).
  54  */
  55 typedef struct {        /* In memory vcn to lcn mapping structure element. */
  56         VCN vcn;        /* vcn = Starting virtual cluster number. */
  57         LCN lcn;        /* lcn = Starting logical cluster number. */
  58         s64 length;     /* Run length in clusters. */
  59 } run_list_element;
  60
  61 /**
  62  * run_list - in memory vcn to lcn mapping array including a read/write lock
  63  * @rl:         pointer to an array of run list elements
  64  * @lock:       read/write spinlock for serializing access to @rl
  65  *
  66  */
  67 typedef struct {
  68         run_list_element *rl;
  69         struct rw_semaphore lock;
  70 } run_list;
  71
  72 typedef enum {
  73         FALSE = 0,
  74         TRUE = 1
  75 } BOOL;
  76
  77 typedef enum {
  78         CASE_SENSITIVE = 0,
  79         IGNORE_CASE = 1,
  80 } IGNORE_CASE_BOOL;
  81
  82 #endif /* _LINUX_NTFS_TYPES_H */