storage/common/blob_storage/blob_item_bytes_request.h

// Copyright 2015 The Chromium 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 STORAGE_COMMON_BLOB_STORAGE_BLOB_ITEM_BYTES_REQUEST_H_
#define STORAGE_COMMON_BLOB_STORAGE_BLOB_ITEM_BYTES_REQUEST_H_

#include <stddef.h>
#include <stdint.h>
#include <ostream>

#include "storage/common/blob_storage/blob_storage_constants.h"
#include "storage/common/storage_common_export.h"

namespace storage {

// This class is serialized over IPC to request bytes from a blob item.
// We are using uint32_t for the indexes
struct STORAGE_COMMON_EXPORT BlobItemBytesRequest {
  // Not using std::numeric_limits<T>::max() because of non-C++11 builds.
  static const uint32_t kInvalidIndex = UINT32_MAX;
  static const uint64_t kInvalidSize = UINT64_MAX;

  static BlobItemBytesRequest CreateIPCRequest(uint32_t request_number,
                                               uint32_t renderer_item_index,
                                               uint64_t renderer_item_offset,
                                               uint64_t size);

  static BlobItemBytesRequest CreateSharedMemoryRequest(
      uint32_t request_number,
      uint32_t renderer_item_index,
      uint64_t renderer_item_offset,
      uint64_t size,
      uint32_t handle_index,
      uint64_t handle_offset);

  static BlobItemBytesRequest CreateFileRequest(uint32_t request_number,
                                                uint32_t renderer_item_index,
                                                uint64_t renderer_item_offset,
                                                uint64_t size,
                                                uint32_t handle_index,
                                                uint64_t handle_offset);

  BlobItemBytesRequest();
  BlobItemBytesRequest(uint32_t request_number,
                       IPCBlobItemRequestStrategy transport_strategy,
                       uint32_t renderer_item_index,
                       uint64_t renderer_item_offset,
                       uint64_t size,
                       uint32_t handle_index,
                       uint64_t handle_offset);
  ~BlobItemBytesRequest();

  // The request number uniquely identifies the memory request. We can't use
  // the renderer item index or browser item index as there can be multiple
  // requests for both (as segmentation boundaries can exist in both).
  uint32_t request_number;
  IPCBlobItemRequestStrategy transport_strategy;
  uint32_t renderer_item_index;
  uint64_t renderer_item_offset;
  uint64_t size;
  uint32_t handle_index;
  uint64_t handle_offset;
};

STORAGE_COMMON_EXPORT void PrintTo(const BlobItemBytesRequest& request,
                                   std::ostream* os);

STORAGE_COMMON_EXPORT bool operator==(const BlobItemBytesRequest& a,
                                      const BlobItemBytesRequest& b);

STORAGE_COMMON_EXPORT bool operator!=(const BlobItemBytesRequest& a,
                                      const BlobItemBytesRequest& b);

}  // namespace storage

#endif  // STORAGE_COMMON_BLOB_STORAGE_BLOB_ITEM_BYTES_REQUEST_H_