array.h

// Copyright 2018-2019 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 <cerata/api.h>
#include <fletcher/common.h>
 
#include <string>
#include <memory>
#include <utility>
 
#include "fletchgen/basic_types.h"
 
namespace fletchgen {
 
using cerata::Component;
using cerata::Instance;
using cerata::intl;
using cerata::Literal;
 
// ArrayReader/Writer parameters:
PARAM_DECL_FACTORY(index_width, 32)
PARAM_DECL_FACTORY(tag_width, 1)
 
size_t GetCtrlBufferCount(const arrow::Field &field);
uint32_t GetTagWidth(const arrow::Field &field);
 
// ArrayReader/Writer types:
 
std::shared_ptr<Type> cmd_type(const std::shared_ptr<Node> &index_width,
                               const std::shared_ptr<Node> &tag_width,
                               const std::optional<std::shared_ptr<Node>> &ctrl_width = std::nullopt);
std::shared_ptr<Type> unlock_type(const std::shared_ptr<Node> &tag_width);
 
std::shared_ptr<Type> array_reader_out(uint32_t num_streams = 0, uint32_t full_width = 0);
std::shared_ptr<Type> array_reader_out(std::pair<uint32_t, uint32_t> spec);
 
std::shared_ptr<Type> array_writer_in(uint32_t num_streams = 0, uint32_t full_width = 0);
std::shared_ptr<Type> array_writer_in(std::pair<uint32_t, uint32_t> spec);
 
enum class ConfigType {
  ARB,        
  NUL,        
  PRIM,       
  LIST,       
  LIST_PRIM,  
  STRUCT      
};
 
std::shared_ptr<Node> GetWidthNode(const arrow::DataType &type);
 
ConfigType GetConfigType(const arrow::DataType &type);
 
std::string GenerateConfigString(const arrow::Field &field, int level = 0);
 
std::shared_ptr<TypeMapper> GetStreamTypeMapper(Type *stream_type, Type *other);
 
std::shared_ptr<Type> GetStreamType(const arrow::Field &arrow_field, fletcher::Mode mode, int level = 0);
 
std::pair<uint32_t, uint32_t> GetArrayDataSpec(const arrow::Field &arrow_field);
 
Component *array(fletcher::Mode mode);
 
}  // namespace fletchgen