kernel.h

Go to the documentation of this file.

// Copyright 2018 Delft University of Technology
//
// 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 <arrow/api.h>
#include <fletcher/fletcher.h>
#include <cstdint>
#include <vector>
#include <memory>
 
#include "fletcher/context.h"
#include "fletcher/platform.h"
 
namespace fletcher {
 
class Kernel {
 public:
  explicit Kernel(std::shared_ptr<Context> context);
 
  bool ImplementsSchemaSet(const std::vector<std::shared_ptr<arrow::Schema>> &schema_set);
 
  Status Reset();
 
  Status SetRange(size_t recordbatch_index, int32_t first, int32_t last);
 
  Status SetArguments(const std::vector<uint32_t> &arguments);
 
  Status Start();
 
  Status GetStatus(uint32_t *status_out);
 
  Status GetReturn(uint32_t *ret0, uint32_t *ret1 = nullptr);
 
  Status PollUntilDoneInterval(unsigned int poll_interval_usec);
 
  Status PollUntilDone();
 
  std::shared_ptr<Context> context();
 
  Status WriteMetaData();
 
  // Default control and status values:
  uint32_t ctrl_start = 1ul << FLETCHER_REG_CONTROL_START;
  uint32_t ctrl_reset = 1ul << FLETCHER_REG_CONTROL_RESET;
  uint32_t done_status = 1ul << FLETCHER_REG_STATUS_DONE;
  uint32_t done_status_mask = 1ul << FLETCHER_REG_STATUS_DONE;
 
 protected:
  bool metadata_written = false;
  std::shared_ptr<Context> context_;
};
 
}  // namespace fletcher