gemm_shared_stream.h

Go to the documentation of this file.

/***************************************************************************************************
 * Copyright (c) 2017-2018, NVIDIA CORPORATION.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted
 * provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright notice, this list of
 *       conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright notice, this list of
 *       conditions and the following disclaimer in the documentation and/or other materials
 *       provided with the distribution.
 *     * Neither the name of the NVIDIA CORPORATION nor the names of its contributors may be used
 *       to endorse or promote products derived from this software without specific prior written
 *       permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NVIDIA CORPORATION BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TOR (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 **************************************************************************************************/
#pragma once

#include <cutlass/gemm/gemm_shared_tile.h>

namespace cutlass {
namespace gemm {


template <
    typename Iterator_,
    typename Transformer_ = Copy<typename Iterator_::Fragment> >

struct SharedLoadStream {
  typedef Iterator_ Iterator;
  typedef Transformer_ Transformer;

  typedef typename Iterator::Fragment FetchedFragment;
  typedef typename Transformer::OutputFragment TransformedFragment;
  static_assert((platform::is_same<FetchedFragment, typename Transformer::InputFragment>::value),
                "");
  typedef TransformedFragment Fragment;

  struct Params {
    typename Iterator::Params iterator;

    CUTLASS_HOST_DEVICE int initialize() { return iterator.initialize(); }
  };

  typedef typename Iterator::Storage SharedStorage;

  CUTLASS_DEVICE SharedLoadStream() {}

  CUTLASS_DEVICE SharedLoadStream(Params const &params, SharedStorage &shared_storage) {
    this->initialize(params, shared_storage);
  }

  CUTLASS_DEVICE void initialize(Params const &params, SharedStorage &shared_storage) {
    // The iterator.
    iterator = Iterator(params.iterator, shared_storage);
    // The transformer.
    transformer = Transformer();
  }

  CUTLASS_DEVICE void copy(FetchedFragment &fetched) { shared_iterator_load(iterator, fetched); }

  CUTLASS_DEVICE void copy(int d, FetchedFragment &fetched) {
    shared_iterator_load(iterator, fetched, d);
  }

  CUTLASS_DEVICE void commit(FetchedFragment &fetched, TransformedFragment &transformed) {
    transformer.transform(fetched, transformed);
  }

  CUTLASS_DEVICE void inc_stage() { iterator.inc_stage(); }

  Iterator iterator;
  Transformer transformer;
};


}  // namespace gemm
}  // namespace cutlass