src/core/IAccessWindow.cpp

   1 /*
   2  * Copyright (c) 2017 ARM Limited.
   3  *
   4  * SPDX-License-Identifier: MIT
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to
   8  * deal in the Software without restriction, including without limitation the
   9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  10  * sell copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all
  14  * copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24 #include "arm_compute/core/IAccessWindow.h"
  25
  26 #include "arm_compute/core/Helpers.h"
  27 #include "arm_compute/core/TensorInfo.h"
  28 #include "arm_compute/core/Window.h"
  29
  30 using namespace arm_compute;
  31
  32 void AccessWindowRectangle::set_valid_region(const Window &window, ValidRegion input_valid_region)
  33 {
  34     set_valid_region(window, std::move(input_valid_region), false, BorderSize(0));
  35 }
  36
  37 void AccessWindowRectangle::set_valid_region(const Window &window, ValidRegion input_valid_region, bool border_undefined, BorderSize border_size)
  38 {
  39     if(_info == nullptr)
  40     {
  41         return;
  42     }
  43
  44     Coordinates &anchor = input_valid_region.anchor;
  45     Coordinates  old_anchor(anchor);
  46     TensorShape &shape = input_valid_region.shape;
  47
  48     if(!border_undefined)
  49     {
  50         border_size = BorderSize(0);
  51     }
  52
  53     // Start of the valid region is equal to the start of the window. But it
  54     // cannot be less than the start of the input's valid region plus the border
  55     // size required by this kernel (if undefined).
  56     // Additionally the valid region is shifted by the offset that is used by
  57     // the kernel to write back output values.
  58     anchor.set(0, std::max<int>(window.x().start() * _scale_x, anchor[0] + border_size.left) + _x);
  59     anchor.set(1, std::max<int>(window.y().start() * _scale_y, anchor[1] + border_size.top) + _y);
  60
  61     // End of the valid region is equal to the start of the last write of the
  62     // kernel plus the number of written elements. (This assumes that all
  63     // written elements are valid). Nevertheless the end cannot be larger than
  64     // the end of the input's valid region minus the border size.
  65     // Note: not the end points of the region are stored but its size. Thus the
  66     // old size is first converted into end points to compared against the
  67     // execution window. Afterwards the new end points are converted back into
  68     // a size of the region.
  69     shape.set(0, std::min<int>(old_anchor[0] + shape[0] - border_size.right, (window.x().end() - window.x().step()) * _scale_x + _width) - anchor[0]);
  70     shape.set(1, std::min<int>(old_anchor[1] + shape[1] - border_size.bottom, (window.y().end() - window.y().step()) * _scale_y + _height) - anchor[1]);
  71
  72     // For higher dimensions use the intersection of the window size and the
  73     // valid region of the input
  74     for(size_t d = 2; d < _info->num_dimensions(); ++d)
  75     {
  76         anchor.set(d, std::max(window[d].start(), input_valid_region.anchor[d]));
  77         shape.set(d, std::min<int>(window[d].end(), input_valid_region.shape[d]) - anchor[d]);
  78     }
  79
  80     _info->set_valid_region(input_valid_region);
  81 }
  82
  83 bool AccessWindowRectangle::update_window_if_needed(Window &window) const
  84 {
  85     // Only update the window size if we can't use padding
  86     if(_info == nullptr || _info->is_resizable())
  87     {
  88         return false;
  89     }
  90
  91     const TensorShape &shape                = _info->tensor_shape();
  92     const Strides     &strides              = _info->strides_in_bytes();
  93     const size_t       offset_first_element = _info->offset_first_element_in_bytes();
  94
  95     bool window_modified = false;
  96
  97     int front_pad_y = 0;
  98
  99     const int min_y = window.y().start() * _scale_y + _y;
 100     const int max_y = (window.y().end() - window.y().step()) * _scale_y + _y + _height;
 101
 102     // Adjust window start for Y dimension
 103     if(min_y < 0)
 104     {
 105         // Calculate rows available above the tensor
 106         const int front_pad_y_available = -static_cast<int>(offset_first_element / strides[1]);
 107
 108         if(min_y < front_pad_y_available)
 109         {
 110             // Not enough padding available, need to shrink the window
 111             const int start = adjust_up(min_y, front_pad_y_available, window.y().step() * _scale_y) - _y;
 112
 113             window.set(1, Window::Dimension(start / _scale_y, window.y().end(), window.y().step()));
 114             window_modified = true;
 115         }
 116
 117         // Update front padding with reconstructed value
 118         front_pad_y = std::max(0, static_cast<int>(std::floor(-window.y().start() * _scale_y)) - _y);
 119     }
 120
 121     // Adjust window end for Y dimension
 122     if(max_y > static_cast<int>(shape[1]))
 123     {
 124         const int stride_z = _info->num_dimensions() > 2 ? strides[2] : _info->total_size();
 125
 126         // Calculate rows available below the tensor
 127         const int tail_pad_y_available = (stride_z / strides[1]) - shape[1] - front_pad_y;
 128
 129         if(static_cast<int>(shape[1]) + tail_pad_y_available < max_y)
 130         {
 131             // Not enough padding available, need to shrink the window
 132             const int end = adjust_down(max_y, shape[1] + tail_pad_y_available, window.y().step() * _scale_y) + window.y().step() * _scale_y - _y - _height;
 133             window.set(1, Window::Dimension(window.y().start(), end / _scale_y, window.y().step()));
 134             window_modified = true;
 135         }
 136     }
 137
 138     int front_pad_x = 0;
 139
 140     const int min_x = window.x().start() * _scale_x + _x;
 141     const int max_x = (window.x().end() - window.x().step()) * _scale_x + _x + _width;
 142
 143     const int stride_y = _info->num_dimensions() > 1 ? strides[1] : _info->total_size();
 144
 145     // Adjust window start for X dimension
 146     if(min_x < 0)
 147     {
 148         const int front_pad_x_available = -std::min<int>(static_cast<int>(offset_first_element) - front_pad_y * strides[1], stride_y - shape[0] * strides[0]) / static_cast<int>(strides[0]);
 149
 150         if(min_x < front_pad_x_available)
 151         {
 152             // Not enough padding available, need to shrink the window
 153             const int start = adjust_up(min_x, front_pad_x_available, window.x().step() * _scale_x) - _x;
 154             window.set(0, Window::Dimension(start / _scale_x, window.x().end(), window.x().step()));
 155             window_modified = true;
 156         }
 157
 158         // Update front padding with reconstructed value
 159         front_pad_x = std::max(0, static_cast<int>(std::floor(-window.x().start() * _scale_x)) - _x);
 160     }
 161
 162     // Adjust window end for X dimension
 163     if(max_x > static_cast<int>(shape[0]))
 164     {
 165         const int tail_pad_x_available = (stride_y / strides[0]) - shape[0] - front_pad_x;
 166
 167         if(static_cast<int>(shape[0]) + tail_pad_x_available < max_x)
 168         {
 169             // Not enough padding available, need to shrink the window
 170             const int end = adjust_down(max_x, shape[0] + tail_pad_x_available, window.x().step() * _scale_x) + window.x().step() * _scale_x - _x - _width;
 171             window.set(0, Window::Dimension(window.x().start(), end / _scale_x, window.x().step()));
 172             window_modified = true;
 173         }
 174     }
 175
 176     return window_modified;
 177 }
 178
 179 bool AccessWindowRectangle::update_padding_if_needed(const Window &window) const
 180 {
 181     // Only update the padding if the tensor allows it
 182     if(_info == nullptr || !_info->is_resizable())
 183     {
 184         return false;
 185     }
 186
 187     ARM_COMPUTE_ERROR_ON(window.x().step() * _scale_x == 0);
 188     ARM_COMPUTE_ERROR_ON(window.y().step() * _scale_y == 0);
 189
 190     const int min_x = window.x().start() * _scale_x + _x;
 191     const int max_x = (window.x().end() - window.x().step()) * _scale_x + _x + _width;
 192     const int min_y = window.y().start() * _scale_y + _y;
 193     const int max_y = (window.y().end() - window.y().step()) * _scale_y + _y + _height;
 194
 195     const TensorShape &shape = _info->tensor_shape();
 196
 197     PaddingSize padding;
 198     padding.left   = std::max(0, -min_x);
 199     padding.right  = std::max<int>(0, max_x - shape[0]);
 200     padding.top    = shape.num_dimensions() == 1 ? 0 : std::max(0, -min_y);
 201     padding.bottom = shape.num_dimensions() == 1 ? 0 : std::max<int>(0, max_y - shape[1]);
 202
 203     // Update strides in tensor info
 204     return _info->extend_padding(padding);
 205 }