[NTFS]
[reactos.git] / reactos / drivers / filesystems / ntfs / attrib.c
index e334ba9..675a2d8 100644 (file)
@@ -20,8 +20,9 @@
  * PROJECT:          ReactOS kernel
  * FILE:             drivers/filesystem/ntfs/attrib.c
  * PURPOSE:          NTFS filesystem driver
- * PROGRAMMER:       Eric Kohl
- * Updated     by       Valentin Verkhovsky  2003/09/12
+ * PROGRAMMERS:      Eric Kohl
+ *                   Valentin Verkhovsky
+ *                   HervĂ© Poussineau (hpoussin@reactos.org)
  */
 
 /* INCLUDES *****************************************************************/
 #define NDEBUG
 #include <debug.h>
 
-/* GLOBALS *****************************************************************/
-
-
 /* FUNCTIONS ****************************************************************/
 
-
-
-static ULONG
-RunLength(PUCHAR run)
+PUCHAR
+DecodeRun(PUCHAR DataRun,
+          LONGLONG *DataRunOffset,
+          ULONGLONG *DataRunLength)
 {
-  return(*run & 0x0f) + ((*run >> 4) & 0x0f) + 1;
-}
-
+    UCHAR DataRunOffsetSize;
+    UCHAR DataRunLengthSize;
+    CHAR i;
+
+    DataRunOffsetSize = (*DataRun >> 4) & 0xF;
+    DataRunLengthSize = *DataRun & 0xF;
+    *DataRunOffset = 0;
+    *DataRunLength = 0;
+    DataRun++;
+    for (i = 0; i < DataRunLengthSize; i++)
+    {
+        *DataRunLength += ((ULONG64)*DataRun) << (i * 8);
+        DataRun++;
+    }
 
-static LONGLONG
-RunLCN(PUCHAR run)
-{
-       UCHAR n1 = *run & 0x0f;
-       UCHAR n2 = (*run >> 4) & 0x0f;
-       LONGLONG lcn = (n2 == 0) ? 0 : (CHAR)(run[n1 + n2]);
-       LONG i = 0;
-
-       for (i = n1 +n2 - 1; i > n1; i--)
-               lcn = (lcn << 8) + run[i];
-       return lcn;
-}
+    /* NTFS 3+ sparse files */
+    if (DataRunOffsetSize == 0)
+    {
+        *DataRunOffset = -1;
+    }
+    else
+    {
+        for (i = 0; i < DataRunOffsetSize - 1; i++)
+        {
+            *DataRunOffset += ((ULONG64)*DataRun) << (i * 8);
+            DataRun++;
+        }
+        /* The last byte contains sign so we must process it different way. */
+        *DataRunOffset = ((LONG64)(CHAR)(*(DataRun++)) << (i * 8)) + *DataRunOffset;
+    }
 
+    DPRINT("DataRunOffsetSize: %x\n", DataRunOffsetSize);
+    DPRINT("DataRunLengthSize: %x\n", DataRunLengthSize);
+    DPRINT("DataRunOffset: %x\n", *DataRunOffset);
+    DPRINT("DataRunLength: %x\n", *DataRunLength);
 
+    return DataRun;
+}
 
-static ULONGLONG
-RunCount(PUCHAR run)
+BOOLEAN
+FindRun(PNTFS_ATTR_RECORD NresAttr,
+        ULONGLONG vcn,
+        PULONGLONG lcn,
+        PULONGLONG count)
 {
-       UCHAR n =  *run & 0xf;
-       ULONGLONG count = 0;
-       ULONG i = 0;
+    if (vcn < NresAttr->NonResident.LowestVCN || vcn > NresAttr->NonResident.HighestVCN)
+        return FALSE;
+
+    DecodeRun((PUCHAR)((ULONG_PTR)NresAttr + NresAttr->NonResident.MappingPairsOffset), (PLONGLONG)lcn, count);
 
-       for (i = n; i > 0; i--)
-               count = (count << 8) + run[i];
-       return count;
+    return TRUE;
 }
 
 
-BOOLEAN
-FindRun (PNONRESIDENT_ATTRIBUTE NresAttr,
-        ULONGLONG vcn,
-        PULONGLONG lcn,
-        PULONGLONG count)
+static
+VOID
+NtfsDumpFileNameAttribute(PNTFS_ATTR_RECORD Attribute)
 {
-  PUCHAR run;
-
-  ULONGLONG base = NresAttr->StartVcn;
-
-  if (vcn < NresAttr->StartVcn || vcn > NresAttr->LastVcn)
-    return FALSE;
+    PFILENAME_ATTRIBUTE FileNameAttr;
 
-  *lcn = 0;
+    DbgPrint("  $FILE_NAME ");
 
-  for (run = (PUCHAR)((ULONG_PTR)NresAttr + NresAttr->RunArrayOffset);
-       *run != 0; run += RunLength(run))
-    {
-      *lcn += RunLCN(run);
-      *count = RunCount(run);
-
-      if (base <= vcn && vcn < base + *count)
-       {
-         *lcn = (RunLCN(run) == 0) ? 0 : *lcn + vcn - base;
-         *count -= (ULONG)(vcn - base);
-
-         return TRUE;
-       }
-      else
-       {
-         base += *count;
-       }
-    }
+//    DbgPrint(" Length %lu  Offset %hu ", Attribute->Resident.ValueLength, Attribute->Resident.ValueOffset);
 
-  return FALSE;
+    FileNameAttr = (PFILENAME_ATTRIBUTE)((ULONG_PTR)Attribute + Attribute->Resident.ValueOffset);
+    DbgPrint(" '%.*S' ", FileNameAttr->NameLength, FileNameAttr->Name);
 }
 
 
-static VOID
-NtfsDumpFileNameAttribute(PATTRIBUTE Attribute)
+static
+VOID
+NtfsDumpVolumeNameAttribute(PNTFS_ATTR_RECORD Attribute)
 {
-  PRESIDENT_ATTRIBUTE ResAttr;
-  PFILENAME_ATTRIBUTE FileNameAttr;
+    PWCHAR VolumeName;
 
-  DbgPrint("  $FILE_NAME ");
+    DbgPrint("  $VOLUME_NAME ");
 
-  ResAttr = (PRESIDENT_ATTRIBUTE)Attribute;
-//  DbgPrint(" Length %lu  Offset %hu ", ResAttr->ValueLength, ResAttr->ValueOffset);
+//    DbgPrint(" Length %lu  Offset %hu ", Attribute->Resident.ValueLength, Attribute->Resident.ValueOffset);
 
-  FileNameAttr = (PFILENAME_ATTRIBUTE)((ULONG_PTR)ResAttr + ResAttr->ValueOffset);
-  DbgPrint(" '%.*S' ", FileNameAttr->NameLength, FileNameAttr->Name);
+    VolumeName = (PWCHAR)((ULONG_PTR)Attribute + Attribute->Resident.ValueOffset);
+    DbgPrint(" '%.*S' ", Attribute->Resident.ValueLength / sizeof(WCHAR), VolumeName);
 }
 
 
-static VOID
-NtfsDumpVolumeNameAttribute(PATTRIBUTE Attribute)
+static
+VOID
+NtfsDumpVolumeInformationAttribute(PNTFS_ATTR_RECORD Attribute)
 {
-  PRESIDENT_ATTRIBUTE ResAttr;
-  PWCHAR VolumeName;
+    PVOLINFO_ATTRIBUTE VolInfoAttr;
 
-  DbgPrint("  $VOLUME_NAME ");
+    DbgPrint("  $VOLUME_INFORMATION ");
 
-  ResAttr = (PRESIDENT_ATTRIBUTE)Attribute;
-//  DbgPrint(" Length %lu  Offset %hu ", ResAttr->ValueLength, ResAttr->ValueOffset);
+//    DbgPrint(" Length %lu  Offset %hu ", Attribute->Resident.ValueLength, Attribute->Resident.ValueOffset);
 
-  VolumeName = (PWCHAR)((ULONG_PTR)ResAttr + ResAttr->ValueOffset);
-  DbgPrint(" '%.*S' ", ResAttr->ValueLength / sizeof(WCHAR), VolumeName);
+    VolInfoAttr = (PVOLINFO_ATTRIBUTE)((ULONG_PTR)Attribute + Attribute->Resident.ValueOffset);
+    DbgPrint(" NTFS Version %u.%u  Flags 0x%04hx ",
+             VolInfoAttr->MajorVersion,
+             VolInfoAttr->MinorVersion,
+             VolInfoAttr->Flags);
 }
 
 
-static VOID
-NtfsDumpVolumeInformationAttribute(PATTRIBUTE Attribute)
+static
+VOID
+NtfsDumpIndexRootAttribute(PNTFS_ATTR_RECORD Attribute)
 {
-  PRESIDENT_ATTRIBUTE ResAttr;
-  PVOLINFO_ATTRIBUTE VolInfoAttr;
+    PINDEX_ROOT_ATTRIBUTE IndexRootAttr;
+
+    IndexRootAttr = (PINDEX_ROOT_ATTRIBUTE)((ULONG_PTR)Attribute + Attribute->Resident.ValueOffset);
 
-  DbgPrint("  $VOLUME_INFORMATION ");
+    if (IndexRootAttr->AttributeType == AttributeFileName)
+        ASSERT(IndexRootAttr->CollationRule == COLLATION_FILE_NAME);
 
-  ResAttr = (PRESIDENT_ATTRIBUTE)Attribute;
-//  DbgPrint(" Length %lu  Offset %hu ", ResAttr->ValueLength, ResAttr->ValueOffset);
+    DbgPrint("  $INDEX_ROOT (%uB, %u) ", IndexRootAttr->SizeOfEntry, IndexRootAttr->ClustersPerIndexRecord);
 
-  VolInfoAttr = (PVOLINFO_ATTRIBUTE)((ULONG_PTR)ResAttr + ResAttr->ValueOffset);
-  DbgPrint(" NTFS Version %u.%u  Flags 0x%04hx ",
-          VolInfoAttr->MajorVersion,
-          VolInfoAttr->MinorVersion,
-          VolInfoAttr->Flags);
+    if (IndexRootAttr->Header.Flags == INDEX_ROOT_SMALL)
+    {
+        DbgPrint(" (small) ");
+    }
+    else
+    {
+        ASSERT(IndexRootAttr->Header.Flags == INDEX_ROOT_LARGE);
+        DbgPrint(" (large) ");
+    }
 }
 
 
-static VOID
-NtfsDumpAttribute (PATTRIBUTE Attribute)
+static
+VOID
+NtfsDumpAttribute(PNTFS_ATTR_RECORD Attribute)
 {
-  PNONRESIDENT_ATTRIBUTE NresAttr;
-  UNICODE_STRING Name;
+    UNICODE_STRING Name;
 
-  ULONGLONG lcn = 0;
-  ULONGLONG runcount = 0;
+    ULONGLONG lcn = 0;
+    ULONGLONG runcount = 0;
 
-  switch (Attribute->AttributeType)
+    switch (Attribute->Type)
     {
-      case AttributeFileName:
-       NtfsDumpFileNameAttribute(Attribute);
-       break;
-
-      case AttributeStandardInformation:
-       DbgPrint("  $STANDARD_INFORMATION ");
-       break;
-
-      case AttributeAttributeList:
-       DbgPrint("  $ATTRIBUTE_LIST ");
-       break;
-
-      case AttributeObjectId:
-       DbgPrint("  $OBJECT_ID ");
-       break;
-
-      case AttributeSecurityDescriptor:
-       DbgPrint("  $SECURITY_DESCRIPTOR ");
-       break;
-
-      case AttributeVolumeName:
-       NtfsDumpVolumeNameAttribute(Attribute);
-       break;
-
-      case AttributeVolumeInformation:
-       NtfsDumpVolumeInformationAttribute(Attribute);
-       break;
-
-      case AttributeData:
-       DbgPrint("  $DATA ");
-       //DataBuf = ExAllocatePool(NonPagedPool,AttributeLengthAllocated(Attribute));
-       break;
-
-      case AttributeIndexRoot:
-       DbgPrint("  $INDEX_ROOT ");
-       break;
-
-      case AttributeIndexAllocation:
-       DbgPrint("  $INDEX_ALLOCATION ");
-       break;
-
-      case AttributeBitmap:
-       DbgPrint("  $BITMAP ");
-       break;
-
-      case AttributeReparsePoint:
-       DbgPrint("  $REPARSE_POINT ");
-       break;
-
-      case AttributeEAInformation:
-       DbgPrint("  $EA_INFORMATION ");
-       break;
-
-      case AttributeEA:
-       DbgPrint("  $EA ");
-       break;
-
-      case AttributePropertySet:
-       DbgPrint("  $PROPERTY_SET ");
-       break;
-
-      case AttributeLoggedUtilityStream:
-       DbgPrint("  $LOGGED_UTILITY_STREAM ");
-       break;
-
-      default:
-       DbgPrint("  Attribute %lx ",
-                Attribute->AttributeType);
-       break;
+        case AttributeFileName:
+            NtfsDumpFileNameAttribute(Attribute);
+            break;
+
+        case AttributeStandardInformation:
+            DbgPrint("  $STANDARD_INFORMATION ");
+            break;
+
+        case AttributeAttributeList:
+            DbgPrint("  $ATTRIBUTE_LIST ");
+            break;
+
+        case AttributeObjectId:
+            DbgPrint("  $OBJECT_ID ");
+            break;
+
+        case AttributeSecurityDescriptor:
+            DbgPrint("  $SECURITY_DESCRIPTOR ");
+            break;
+
+        case AttributeVolumeName:
+            NtfsDumpVolumeNameAttribute(Attribute);
+            break;
+
+        case AttributeVolumeInformation:
+            NtfsDumpVolumeInformationAttribute(Attribute);
+            break;
+
+        case AttributeData:
+            DbgPrint("  $DATA ");
+            //DataBuf = ExAllocatePool(NonPagedPool,AttributeLengthAllocated(Attribute));
+            break;
+
+        case AttributeIndexRoot:
+            NtfsDumpIndexRootAttribute(Attribute);
+            break;
+
+        case AttributeIndexAllocation:
+            DbgPrint("  $INDEX_ALLOCATION ");
+            break;
+
+        case AttributeBitmap:
+            DbgPrint("  $BITMAP ");
+            break;
+
+        case AttributeReparsePoint:
+            DbgPrint("  $REPARSE_POINT ");
+            break;
+
+        case AttributeEAInformation:
+            DbgPrint("  $EA_INFORMATION ");
+            break;
+
+        case AttributeEA:
+            DbgPrint("  $EA ");
+            break;
+
+        case AttributePropertySet:
+            DbgPrint("  $PROPERTY_SET ");
+            break;
+
+        case AttributeLoggedUtilityStream:
+            DbgPrint("  $LOGGED_UTILITY_STREAM ");
+            break;
+
+        default:
+            DbgPrint("  Attribute %lx ",
+                     Attribute->Type);
+            break;
     }
 
-  if (Attribute->NameLength != 0)
+    if (Attribute->NameLength != 0)
     {
-      Name.Length = Attribute->NameLength * sizeof(WCHAR);
-      Name.MaximumLength = Name.Length;
-      Name.Buffer = (PWCHAR)((ULONG_PTR)Attribute + Attribute->NameOffset);
+        Name.Length = Attribute->NameLength * sizeof(WCHAR);
+        Name.MaximumLength = Name.Length;
+        Name.Buffer = (PWCHAR)((ULONG_PTR)Attribute + Attribute->NameOffset);
 
-      DbgPrint("'%wZ' ", &Name);
+        DbgPrint("'%wZ' ", &Name);
     }
 
-  DbgPrint("(%s)\n",
-          Attribute->Nonresident ? "non-resident" : "resident");
+    DbgPrint("(%s)\n",
+             Attribute->IsNonResident ? "non-resident" : "resident");
 
-  if (Attribute->Nonresident)
+    if (Attribute->IsNonResident)
     {
-      NresAttr = (PNONRESIDENT_ATTRIBUTE)Attribute;
-
-      FindRun (NresAttr,0,&lcn, &runcount);
+        FindRun(Attribute,0,&lcn, &runcount);
 
-      DbgPrint ("  AllocatedSize %I64u  DataSize %I64u\n",
-               NresAttr->AllocatedSize, NresAttr->DataSize);
-      DbgPrint ("  logical clusters: %I64u - %I64u\n",
-               lcn, lcn + runcount - 1);
+        DbgPrint("  AllocatedSize %I64u  DataSize %I64u\n",
+                 Attribute->NonResident.AllocatedSize, Attribute->NonResident.DataSize);
+        DbgPrint("  logical clusters: %I64u - %I64u\n",
+                 lcn, lcn + runcount - 1);
     }
 }
 
 
 VOID
-NtfsDumpFileAttributes (PFILE_RECORD_HEADER FileRecord)
+NtfsDumpFileAttributes(PFILE_RECORD_HEADER FileRecord)
 {
-  PATTRIBUTE Attribute;
+    PNTFS_ATTR_RECORD Attribute;
 
-  Attribute = (PATTRIBUTE)((ULONG_PTR)FileRecord + FileRecord->AttributeOffset);
-  while (Attribute < (PATTRIBUTE)((ULONG_PTR)FileRecord + FileRecord->BytesInUse) &&
-         Attribute->AttributeType != (ATTRIBUTE_TYPE)-1)
+    Attribute = (PNTFS_ATTR_RECORD)((ULONG_PTR)FileRecord + FileRecord->AttributeOffset);
+    while (Attribute < (PNTFS_ATTR_RECORD)((ULONG_PTR)FileRecord + FileRecord->BytesInUse) &&
+           Attribute->Type != AttributeEnd)
     {
-      NtfsDumpAttribute (Attribute);
+        NtfsDumpAttribute(Attribute);
 
-      Attribute = (PATTRIBUTE)((ULONG_PTR)Attribute + Attribute->Length);
+        Attribute = (PNTFS_ATTR_RECORD)((ULONG_PTR)Attribute + Attribute->Length);
     }
 }
 
+PFILENAME_ATTRIBUTE
+GetFileNameFromRecord(PFILE_RECORD_HEADER FileRecord, UCHAR NameType)
+{
+    PNTFS_ATTR_RECORD Attribute;
+    PFILENAME_ATTRIBUTE Name;
+
+    Attribute = (PNTFS_ATTR_RECORD)((ULONG_PTR)FileRecord + FileRecord->AttributeOffset);
+    while (Attribute < (PNTFS_ATTR_RECORD)((ULONG_PTR)FileRecord + FileRecord->BytesInUse) &&
+           Attribute->Type != AttributeEnd)
+    {
+        if (Attribute->Type == AttributeFileName)
+        {
+            Name = (PFILENAME_ATTRIBUTE)((ULONG_PTR)Attribute + Attribute->Resident.ValueOffset);
+            if (Name->NameType == NameType ||
+                (Name->NameType == NTFS_FILE_NAME_WIN32_AND_DOS && NameType == NTFS_FILE_NAME_WIN32) ||
+                (Name->NameType == NTFS_FILE_NAME_WIN32_AND_DOS && NameType == NTFS_FILE_NAME_DOS))
+            {
+                return Name;
+            }
+        }
+
+        Attribute = (PNTFS_ATTR_RECORD)((ULONG_PTR)Attribute + Attribute->Length);
+    }
+
+    return NULL;
+}
+
+PFILENAME_ATTRIBUTE
+GetBestFileNameFromRecord(PFILE_RECORD_HEADER FileRecord)
+{
+    PFILENAME_ATTRIBUTE FileName;
+
+    FileName = GetFileNameFromRecord(FileRecord, NTFS_FILE_NAME_POSIX);
+    if (FileName == NULL)
+    {
+        FileName = GetFileNameFromRecord(FileRecord, NTFS_FILE_NAME_WIN32);
+        if (FileName == NULL)
+        {
+            FileName = GetFileNameFromRecord(FileRecord, NTFS_FILE_NAME_DOS);
+        }
+    }
+
+    return FileName;
+}
+
 /* EOF */