xref: /llvm-project/lldb/tools/debugserver/source/DNBDataRef.h (revision 30fdc8d841c9d24ac5f3d452b6ece84ee0ac991c)
1 //===-- DNBDataRef.h --------------------------------------------*- 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 //  Created by Greg Clayton on 1/11/06.
11 //
12 //===----------------------------------------------------------------------===//
13 //
14 //  DNBDataRef is a class that can extract data in normal or byte
15 //  swapped order from a data buffer that someone else owns. The data
16 //  buffer needs to remain intact as long as the DNBDataRef object
17 //  needs the data. Strings returned are pointers into the data buffer
18 //  and will need to be copied if they are needed after the data buffer
19 //  is no longer around.
20 //
21 //===----------------------------------------------------------------------===//
22 
23 #ifndef __DNBDataRef_h__
24 #define __DNBDataRef_h__
25 
26 #include "DNBDefs.h"
27 #include <stdint.h>
28 #include <stdio.h>
29 #include <string.h>
30 #include <limits.h>
31 
32 class DNBDataRef
33 {
34 public:
35     // For use with Dump
36     typedef enum
37     {
38         TypeUInt8 = 0,
39         TypeChar,
40         TypeUInt16,
41         TypeUInt32,
42         TypeUInt64,
43         TypePointer,
44         TypeULEB128,
45         TypeSLEB128
46     }   Type;
47     typedef uint32_t offset_t;
48     typedef nub_addr_t addr_t;
49 
50                     DNBDataRef();
51                     DNBDataRef(const uint8_t *start, size_t size, bool swap);
52                     ~DNBDataRef();
53         void        Clear()
54                     {
55                         DNBDataRef::SetData(NULL, 0);
56                         m_swap = false;
57                     }
58 
59     bool            ValidOffset(offset_t offset) const { return (m_start < m_end) && ((uint32_t)(m_end - m_start) > offset); }
60     bool            ValidOffsetForDataOfSize(offset_t offset, uint32_t num_bytes) const { return (m_start < m_end) && ((uint32_t)(m_end - m_start) > (offset + ((num_bytes > 0) ? (num_bytes - 1) : 0))); }
61     size_t          GetSize() const { return m_end - m_start; }
62     const uint8_t * GetDataStart() const { return m_start; }
63     const uint8_t * GetDataEnd() const { return m_end; }
64     bool            GetSwap() const { return m_swap; }
65     void            SetSwap(bool swap) { m_swap = swap; }
66     void            SetData(const uint8_t *start, size_t size)
67                     {
68                         m_start = start;
69                         if (m_start != NULL)
70                             m_end = start + size;
71                         else
72                             m_end = NULL;
73                     }
74     uint8_t         GetPointerSize() const { return m_ptrSize; }
75     void            SetPointerSize(uint8_t size) { m_ptrSize = size; }
76     void            SetEHPtrBaseAddrPCRelative(addr_t addr = INVALID_NUB_ADDRESS) { m_addrPCRelative = addr; }
77     void            SetEHPtrBaseAddrTEXT(addr_t addr = INVALID_NUB_ADDRESS)  { m_addrTEXT = addr; }
78     void            SetEHPtrBaseAddrDATA(addr_t addr = INVALID_NUB_ADDRESS)  { m_addrDATA = addr; }
79     uint8_t         Get8(offset_t *offset_ptr) const;
80     uint16_t        Get16(offset_t *offset_ptr) const;
81     uint32_t        Get32(offset_t *offset_ptr) const;
82     uint64_t        Get64(offset_t *offset_ptr) const;
83     uint32_t        GetMax32(offset_t *offset_ptr, uint32_t byte_size) const;
84     uint64_t        GetMax64(offset_t *offset_ptr, uint32_t byte_size) const;
85     uint64_t        GetPointer(offset_t *offset_ptr) const;
86 //  uint64_t        GetDwarfEHPtr(offset_t *offset_ptr, uint32_t eh_ptr_enc) const;
87     const char *    GetCStr(offset_t *offset_ptr, uint32_t fixed_length = 0) const;
88     const char *    PeekCStr(offset_t offset) const
89                     {
90                         if (ValidOffset(offset))
91                             return (const char*)m_start + offset;
92                         return NULL;
93                     }
94 
95     const uint8_t * GetData( offset_t *offset_ptr, uint32_t length) const;
96     uint64_t        Get_ULEB128 (offset_t *offset_ptr) const;
97     int64_t         Get_SLEB128 (offset_t *offset_ptr) const;
98     void            Skip_LEB128 (offset_t *offset_ptr) const;
99 
100     uint32_t        Dump(offset_t startOffset, offset_t endOffset, uint64_t offsetBase, DNBDataRef::Type type, uint32_t numPerLine, const char *typeFormat = NULL);
101 protected:
102     const uint8_t * m_start;
103     const uint8_t * m_end;
104     bool            m_swap;
105     uint8_t         m_ptrSize;
106     addr_t          m_addrPCRelative;
107     addr_t          m_addrTEXT;
108     addr_t          m_addrDATA;
109 };
110 
111 #endif // #ifndef __DNBDataRef_h__
112