LLVM  4.0.0
MSFCommon.h
Go to the documentation of this file.
1 //===- MSFCommon.h - Common types and functions for MSF files ---*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #ifndef LLVM_DEBUGINFO_MSF_MSFCOMMON_H
11 #define LLVM_DEBUGINFO_MSF_MSFCOMMON_H
12 
13 #include "llvm/ADT/ArrayRef.h"
14 #include "llvm/ADT/BitVector.h"
15 
16 #include "llvm/Support/Endian.h"
17 #include "llvm/Support/Error.h"
19 
20 #include <vector>
21 
22 namespace llvm {
23 namespace msf {
24 static const char Magic[] = {'M', 'i', 'c', 'r', 'o', 's', 'o', 'f',
25  't', ' ', 'C', '/', 'C', '+', '+', ' ',
26  'M', 'S', 'F', ' ', '7', '.', '0', '0',
27  '\r', '\n', '\x1a', 'D', 'S', '\0', '\0', '\0'};
28 
29 // The superblock is overlaid at the beginning of the file (offset 0).
30 // It starts with a magic header and is followed by information which
31 // describes the layout of the file system.
32 struct SuperBlock {
33  char MagicBytes[sizeof(Magic)];
34  // The file system is split into a variable number of fixed size elements.
35  // These elements are referred to as blocks. The size of a block may vary
36  // from system to system.
38  // The index of the free block map.
40  // This contains the number of blocks resident in the file system. In
41  // practice, NumBlocks * BlockSize is equivalent to the size of the MSF
42  // file.
44  // This contains the number of bytes which make up the directory.
46  // This field's purpose is not yet known.
48  // This contains the block # of the block map.
50 };
51 
52 struct MSFLayout {
53  MSFLayout() : SB(nullptr) {}
54  const SuperBlock *SB;
58  std::vector<ArrayRef<support::ulittle32_t>> StreamMap;
59 };
60 
61 inline bool isValidBlockSize(uint32_t Size) {
62  switch (Size) {
63  case 512:
64  case 1024:
65  case 2048:
66  case 4096:
67  return true;
68  }
69  return false;
70 }
71 
72 // Super Block, Fpm0, Fpm1, and Block Map
73 inline uint32_t getMinimumBlockCount() { return 4; }
74 
75 // Super Block, Fpm0, and Fpm1 are reserved. The Block Map, although required
76 // need not be at block 3.
77 inline uint32_t getFirstUnreservedBlock() { return 3; }
78 
79 inline uint64_t bytesToBlocks(uint64_t NumBytes, uint64_t BlockSize) {
80  return alignTo(NumBytes, BlockSize) / BlockSize;
81 }
82 
83 inline uint64_t blockToOffset(uint64_t BlockNumber, uint64_t BlockSize) {
84  return BlockNumber * BlockSize;
85 }
86 
88  return L.SB->BlockSize;
89 }
90 
92  uint32_t Length = getFpmIntervalLength(L);
93  return llvm::alignTo(L.SB->NumBlocks, Length) / Length;
94 }
95 
97  return llvm::alignTo(L.SB->NumBlocks, 8) / 8;
98 }
99 
100 Error validateSuperBlock(const SuperBlock &SB);
101 } // namespace msf
102 } // namespace llvm
103 
104 #endif // LLVM_DEBUGINFO_MSF_MSFCOMMON_H
MachineLoop * L
char MagicBytes[sizeof(Magic)]
Definition: MSFCommon.h:33
Error validateSuperBlock(const SuperBlock &SB)
Definition: MSFCommon.cpp:16
uint64_t blockToOffset(uint64_t BlockNumber, uint64_t BlockSize)
Definition: MSFCommon.h:83
uint32_t getMinimumBlockCount()
Definition: MSFCommon.h:73
uint64_t alignTo(uint64_t Value, uint64_t Align, uint64_t Skew=0)
Returns the next integer (mod 2**64) that is greater than or equal to Value and is a multiple of Alig...
Definition: MathExtras.h:664
uint32_t getFpmIntervalLength(const MSFLayout &L)
Definition: MSFCommon.h:87
support::ulittle32_t BlockSize
Definition: MSFCommon.h:37
support::ulittle32_t BlockMapAddr
Definition: MSFCommon.h:49
INITIALIZE_PASS(HexagonEarlyIfConversion,"hexagon-eif","Hexagon early if conversion", false, false) bool HexagonEarlyIfConversion MachineBasicBlock * SB
static const char Magic[]
Definition: MSFCommon.h:24
support::ulittle32_t Unknown1
Definition: MSFCommon.h:47
uint32_t getNumFpmIntervals(const MSFLayout &L)
Definition: MSFCommon.h:91
static const int BlockSize
Definition: TarWriter.cpp:34
ArrayRef< support::ulittle32_t > DirectoryBlocks
Definition: MSFCommon.h:56
BitVector FreePageMap
Definition: MSFCommon.h:55
uint64_t bytesToBlocks(uint64_t NumBytes, uint64_t BlockSize)
Definition: MSFCommon.h:79
std::vector< ArrayRef< support::ulittle32_t > > StreamMap
Definition: MSFCommon.h:58
uint32_t getFullFpmByteSize(const MSFLayout &L)
Definition: MSFCommon.h:96
ArrayRef< support::ulittle32_t > StreamSizes
Definition: MSFCommon.h:57
support::ulittle32_t FreeBlockMapBlock
Definition: MSFCommon.h:39
Lightweight error class with error context and mandatory checking.
bool isValidBlockSize(uint32_t Size)
Definition: MSFCommon.h:61
uint32_t getFirstUnreservedBlock()
Definition: MSFCommon.h:77
const SuperBlock * SB
Definition: MSFCommon.h:54
support::ulittle32_t NumDirectoryBytes
Definition: MSFCommon.h:45
support::ulittle32_t NumBlocks
Definition: MSFCommon.h:43