backend/Backend.cpp

/*
 * Copyright (C) 2020 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.
 */

#include "Backend.h"

#include <climits>

#include "BackendManager.h"
#include "bufferinfo/BufferInfoGetter.h"
#include "hardware/hwcomposer2.h"

namespace android {

namespace {

bool HasCursorLayer(const std::vector<HwcLayer *> &layers) {
  return std::find_if(layers.begin(), layers.end(), [&](auto *layer) -> bool {
           return layer->GetSfType() == HWC2::Composition::Cursor;
         }) != layers.end();
}

}  // namespace

HWC2::Error Backend::ValidateDisplay(HwcDisplay *display, uint32_t *num_types,
                                     uint32_t *num_requests) {
  *num_types = 0;
  *num_requests = 0;

  auto layers = display->GetOrderLayersByZPos();

  int client_start = -1;
  size_t client_size = 0;

  auto flatcon = display->GetFlatCon();
  if (flatcon) {
    bool should_flatten = false;
    if (layers.size() <= 1)
      flatcon->Disable();
    else
      should_flatten = flatcon->NewFrame();

    if (should_flatten) {
      display->total_stats().frames_flattened_++;
      MarkValidated(layers, 0, layers.size());
      *num_types = layers.size();
      return HWC2::Error::HasChanges;
    }
  }

  std::tie(client_start, client_size) = GetClientLayers(display, layers);

  MarkValidated(layers, client_start, client_size);

  auto testing_needed = client_start != 0 || client_size != layers.size();

  AtomicCommitArgs a_args = {.test_only = true};

  if (testing_needed &&
      display->CreateComposition(a_args) != HWC2::Error::None) {
    ++display->total_stats().failed_kms_validate_;
    client_start = 0;
    client_size = layers.size();

    // Expand the client range to include all layers except the cursor layer (if
    // there is one) and retry.
    auto [_, cursor_plane] = display->GetPipe().GetUsablePlanes();
    if (cursor_plane && HasCursorLayer(layers)) {
      --client_size;
      MarkValidated(layers, 0, client_size);

      testing_needed = display->CreateComposition(a_args) != HWC2::Error::None;

      // If testing is still needed, expand the client range to include the
      // cursor layer for the next retry.
      if (testing_needed) {
        ++client_size;
        ++display->total_stats().failed_kms_validate_;
      }
    }

    if (testing_needed) {
      MarkValidated(layers, 0, client_size);
    }
  }

  *num_types = client_size;

  display->total_stats().gpu_pixops_ += CalcPixOps(layers, client_start,
                                                   client_size);
  display->total_stats().total_pixops_ += CalcPixOps(layers, 0, layers.size());

  return *num_types != 0 ? HWC2::Error::HasChanges : HWC2::Error::None;
}

std::tuple<int, size_t> Backend::GetClientLayers(
    HwcDisplay *display, const std::vector<HwcLayer *> &layers) {
  int client_start = -1;
  size_t client_size = 0;

  for (size_t z_order = 0; z_order < layers.size(); ++z_order) {
    if (IsClientLayer(display, layers[z_order])) {
      if (client_start < 0)
        client_start = (int)z_order;
      client_size = (z_order - client_start) + 1;
    }
  }

  return GetExtraClientRange(display, layers, client_start, client_size);
}

bool Backend::IsClientLayer(HwcDisplay *display, HwcLayer *layer) {
  return !HardwareSupportsLayerType(layer->GetSfType()) ||
         !layer->IsLayerUsableAsDevice() || display->CtmByGpu() ||
         (layer->GetLayerData().pi.RequireScalingOrPhasing() &&
          display->GetHwc()->GetResMan().ForcedScalingWithGpu());
}

bool Backend::HardwareSupportsLayerType(HWC2::Composition comp_type) {
  return comp_type == HWC2::Composition::Device ||
         comp_type == HWC2::Composition::Cursor;
}

uint32_t Backend::CalcPixOps(const std::vector<HwcLayer *> &layers,
                             size_t first_z, size_t size) {
  uint32_t pixops = 0;
  for (size_t z_order = 0; z_order < layers.size(); ++z_order) {
    if (z_order >= first_z && z_order < first_z + size) {
      auto &df = layers[z_order]->GetLayerData().pi.display_frame;
      if (df.i_rect) {
        pixops += (df.i_rect->right - df.i_rect->left) *
                  (df.i_rect->bottom - df.i_rect->top);
      }
    }
  }
  return pixops;
}

void Backend::MarkValidated(std::vector<HwcLayer *> &layers,
                            size_t client_first_z, size_t client_size) {
  for (size_t z_order = 0; z_order < layers.size(); ++z_order) {
    if (z_order >= client_first_z && z_order < client_first_z + client_size) {
      layers[z_order]->SetValidatedType(HWC2::Composition::Client);
    } else if (layers[z_order]->GetSfType() == HWC2::Composition::Cursor) {
      layers[z_order]->SetValidatedType(HWC2::Composition::Cursor);
    } else {
      layers[z_order]->SetValidatedType(HWC2::Composition::Device);
    }
  }
}

std::tuple<int, int> Backend::GetExtraClientRange(
    HwcDisplay *display, const std::vector<HwcLayer *> &layers,
    int client_start, size_t client_size) {
  auto [planes, cursor_plane] = display->GetPipe().GetUsablePlanes();
  size_t avail_planes = planes.size();
  size_t layers_size = layers.size();

  // |cursor_plane| is not counted among |avail_planes|, so the cursor layer
  // shouldn't be counted in |layers_size|.
  if (cursor_plane && HasCursorLayer(layers)) {
    --layers_size;
  }

  /*
   * If more layers than planes, save one plane
   * for client composited layers
   */
  if (avail_planes < layers_size) {
    avail_planes--;
  }

  const int extra_client = int(layers_size - client_size) - int(avail_planes);

  if (extra_client > 0) {
    int start = 0;
    size_t steps = 0;
    if (client_size != 0) {
      const int prepend = std::min(client_start, extra_client);
      const int append = std::min(int(layers_size) -
                                      int(client_start + client_size),
                                  extra_client);
      start = client_start - (int)prepend;
      client_size += extra_client;
      steps = 1 + std::min(std::min(append, prepend),
                           int(layers_size) - int(start + client_size));
    } else {
      client_size = extra_client;
      steps = 1 + layers_size - extra_client;
    }

    uint32_t gpu_pixops = UINT32_MAX;
    for (size_t i = 0; i < steps; i++) {
      const uint32_t po = CalcPixOps(layers, start + i, client_size);
      if (po < gpu_pixops) {
        gpu_pixops = po;
        client_start = start + int(i);
      }
    }
  }

  return std::make_tuple(client_start, client_size);
}

// clang-format off
// NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables, cert-err58-cpp)
REGISTER_BACKEND("generic", Backend);
// clang-format on

}  // namespace android