Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 9c3c2946 authored by David Anderson's avatar David Anderson
Browse files

liblp: Clean up public headers. 

This changes reader.h and writer.h to be private includes. A new liblp.h
header now contains the public API surface of those two files, as well
as some miscellanious functions previously in metadata_format.h.

Bug: 79173901
Test: N/A
Change-Id: I40c5dda0c8e5765f8bccfd5c17b4c800b41be77b
parent a5cb671e

fs_mgr/liblp/builder.cpp

+2 −2
Original line number Diff line number Diff line
@@ -27,8 +27,8 @@ 
#include <android-base/unique_fd.h>

#include <uuid/uuid.h>



#include "liblp/metadata_format.h"

#include "liblp/reader.h"

#include "liblp/liblp.h"

#include "reader.h"

#include "utility.h"



namespace android {

fs_mgr/liblp/include/liblp/builder.h

+1 −1
Original line number Diff line number Diff line
@@ -23,7 +23,7 @@ 
#include <map>

#include <memory>



#include "metadata_format.h"

#include "liblp.h"



namespace android {

namespace fs_mgr {

fs_mgr/liblp/include/liblp/liblp.h

0 → 100644
+75 −0
Original line number Diff line number Diff line 
//

// Copyright (C) 2018 The Android Open Source Project

//

// Licensed under the Apache License, Version 2.0 (the "License");

// you may not use this file except in compliance with the License.

// You may obtain a copy of the License at

//

//      http://www.apache.org/licenses/LICENSE-2.0

//

// Unless required by applicable law or agreed to in writing, software

// distributed under the License is distributed on an "AS IS" BASIS,

// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

// See the License for the specific language governing permissions and

// limitations under the License.

//



#ifndef LIBLP_LIBLP_H

#define LIBLP_LIBLP_H



#include <stddef.h>

#include <stdint.h>



#include <memory>

#include <string>



#include "metadata_format.h"



namespace android {

namespace fs_mgr {



// Helper structure for easily interpreting deserialized metadata, or

// re-serializing metadata.

struct LpMetadata {

    LpMetadataGeometry geometry;

    LpMetadataHeader header;

    std::vector<LpMetadataPartition> partitions;

    std::vector<LpMetadataExtent> extents;

};



// Place an initial partition table on the device. This will overwrite the

// existing geometry, and should not be used for normal partition table

// updates. False can be returned if the geometry is incompatible with the

// block device or an I/O error occurs.

bool FlashPartitionTable(const std::string& block_device, const LpMetadata& metadata,

                         uint32_t slot_number);



// Update the partition table for a given metadata slot number. False is

// returned if an error occurs, which can include:

//  - Invalid slot number.

//  - I/O error.

//  - Corrupt or missing metadata geometry on disk.

//  - Incompatible geometry.

bool UpdatePartitionTable(const std::string& block_device, const LpMetadata& metadata,

                          uint32_t slot_number);



// Read logical partition metadata from its predetermined location on a block

// device. If readback fails, we also attempt to load from a backup copy.

std::unique_ptr<LpMetadata> ReadMetadata(const char* block_device, uint32_t slot_number);



// Read/Write logical partition metadata to an image file, for diagnostics or

// flashing.

bool WriteToImageFile(const char* file, const LpMetadata& metadata);

std::unique_ptr<LpMetadata> ReadFromImageFile(const char* file);



// Helper to extract safe C++ strings from partition info.

std::string GetPartitionName(const LpMetadataPartition& partition);

std::string GetPartitionGuid(const LpMetadataPartition& partition);



// Helper to return a slot number for a slot suffix.

uint32_t SlotNumberForSlotSuffix(const std::string& suffix);



}  // namespace fs_mgr

}  // namespace android



#endif  // LIBLP_LIBLP_H

fs_mgr/liblp/include/liblp/metadata_format.h

+0 −24
Original line number Diff line number Diff line
@@ -262,28 +262,4 @@ typedef struct LpMetadataExtent { 
} /* extern "C" */

#endif



#ifdef __cplusplus

namespace android {

namespace fs_mgr {



// Helper structure for easily interpreting deserialized metadata, or

// re-serializing metadata.

struct LpMetadata {

    LpMetadataGeometry geometry;

    LpMetadataHeader header;

    std::vector<LpMetadataPartition> partitions;

    std::vector<LpMetadataExtent> extents;

};



// Helper to extract safe C++ strings from partition info.

std::string GetPartitionName(const LpMetadataPartition& partition);

std::string GetPartitionGuid(const LpMetadataPartition& partition);



// Helper to return a slot number for a slot suffix.

uint32_t SlotNumberForSlotSuffix(const std::string& suffix);



}  // namespace fs_mgr

}  // namespace android

#endif



#endif /* LOGICAL_PARTITION_METADATA_FORMAT_H_ */

fs_mgr/liblp/io_test.cpp

+2 −2
Original line number Diff line number Diff line
@@ -23,10 +23,10 @@ 
#include <android-base/unique_fd.h>

#include <gtest/gtest.h>

#include <liblp/builder.h>

#include <liblp/reader.h>

#include <liblp/writer.h>



#include "reader.h"

#include "utility.h"

#include "writer.h"



using namespace std;

using namespace android::fs_mgr;