src/developer/debug/zxdb/symbols/dwarf_location.h

// Copyright 2019 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SRC_DEVELOPER_DEBUG_ZXDB_SYMBOLS_DWARF_LOCATION_H_
#define SRC_DEVELOPER_DEBUG_ZXDB_SYMBOLS_DWARF_LOCATION_H_

#include "src/developer/debug/zxdb/symbols/arch.h"
#include "src/developer/debug/zxdb/symbols/variable_location.h"
#include "src/lib/containers/cpp/array_view.h"

namespace llvm {
class DWARFUnit;
class DWARFFormValue;
}  // namespace llvm

namespace zxdb {

// Decodes the variable location contained in the given form value. It's assumed the form value
// contains either a block, an ExprLoc, or an offset into the .debug_loc section.
//
// On error this will return an empty VariableLocation.
VariableLocation DecodeVariableLocation(const llvm::DWARFUnit* unit,
                                        const llvm::DWARFFormValue& form);

// Low-level decode for a variable location description. The data should start at the beginning
// of the location list to parse, and cover as much data as the location list could possibly
// cover (normally the end of the .debug_loc section).
//
// On error this will return an empty VariableLocation.
VariableLocation DecodeLocationList(TargetPointer unit_base_addr,
                                    containers::array_view<uint8_t> data);

}  // namespace zxdb

#endif  // SRC_DEVELOPER_DEBUG_ZXDB_SYMBOLS_DWARF_LOCATION_H_