data_viewer.h

Go to the documentation of this file.

/*
 * Copyright (C) 2024 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.
 */
 
#pragma once
 
#include <signal.h>
 
#include <functional>
#include <mutex>
#include <string>
#include <thread>
#include <unordered_map>
 
#include "cuttlefish/common/libs/fs/shared_fd.h"
#include "cuttlefish/common/libs/utils/result.h"
#include "cuttlefish/common/libs/utils/signals.h"
#include "cuttlefish/host/commands/cvd/instances/cvd_persistent_data.pb.h"
 
namespace cuttlefish {
 
class DataViewer {
 public:
  DataViewer(const std::string& backing_file) : backing_file_(backing_file) {}
 
  template <typename R>
  Result<R> WithSharedLock(
      std::function<Result<R>(const cvd::PersistentData&)> task) const {
    DeadlockProtector dp(*this);
    auto fd = CF_EXPECT(LockBackingFile(LOCK_SH));
    auto data = CF_EXPECT(LoadData(fd));
    return task(data);
  }
 
  template <typename R>
  Result<R> WithExclusiveLock(
      std::function<Result<R>(cvd::PersistentData&)> task) {
    DeadlockProtector dp(*this);
    auto fd = CF_EXPECT(LockBackingFile(LOCK_SH));
    auto data = CF_EXPECT(LoadData(fd));
    auto res = task(data);
    if (!res.ok()) {
      // Don't update if there is an error
      return res;
    }
    // Block signals while writing to the instance database file. This reduces
    // the chances of corrupting the file.
    sigset_t all_signals;
    sigfillset(&all_signals);
    SignalMasker blocker(all_signals);
    // Overwrite the file contents, don't append
    CF_EXPECTF(fd->Truncate(0) >= 0, "Failed to truncate fd: {}",
               fd->StrError());
    CF_EXPECTF(fd->LSeek(0, SEEK_SET) >= 0, "Failed to seek to 0: {}",
               fd->StrError());
    CF_EXPECT(StoreData(fd, std::move(data)));
    return res;
  }
 
 private:
  // Opens and locks the backing file. The lock will be dropped when the file
  // descriptor closes.
  Result<SharedFD> LockBackingFile(int op) const;
 
  Result<cvd::PersistentData> LoadData(SharedFD fd) const;
 
  Result<void> StoreData(SharedFD fd, cvd::PersistentData data);
 
  class DeadlockProtector {
   public:
    DeadlockProtector(const DataViewer& dv);
    ~DeadlockProtector();
    DeadlockProtector(const DeadlockProtector&) = delete;
    DeadlockProtector(DeadlockProtector&&) = delete;
 
   private:
    std::mutex& mtx_;
    std::unordered_map<std::thread::id, bool>& map_;
  };
  mutable std::mutex lock_map_mtx_;
  mutable std::unordered_map<std::thread::id, bool> lock_held_by_;
 
  std::string backing_file_;
};
 
}  // namespace cuttlefish