ft_output_vector.h

Go to the documentation of this file.

/*
****************************
 
FasTensor (FT) Copyright (c) 2021, The Regents of the University of
California, through Lawrence Berkeley National Laboratory (subject to
receipt of any required approvals from the U.S. Dept. of Energy). 
All rights reserved.
 
If you have questions about your rights to use or distribute this software,
please contact Berkeley Lab's Intellectual Property Office at
[email protected].
 
NOTICE.  This Software was developed under funding from the U.S. Department
of Energy and the U.S. Government consequently retains certain rights.  As
such, the U.S. Government has been granted for itself and others acting on
its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the
Software to reproduce, distribute copies to the public, prepare derivative 
works, and perform publicly and display publicly, and to permit others to do so.
 
 
****************************
 
 
*** License Agreement ***
 
FasTensor (FT) Copyright (c) 2021, The Regents of the University of
California, through Lawrence Berkeley National Laboratory (subject to
receipt of any required approvals from the U.S. Dept. of Energy). 
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
(1) Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
 
(2) 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.
 
(3) Neither the name of the University of California, Lawrence Berkeley
National Laboratory, U.S. Dept. of Energy 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 THE COPYRIGHT OWNER OR CONTRIBUTORS 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 TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
 
You are under no obligation whatsoever to provide any bug fixes, patches,
or upgrades to the features, functionality or performance of the source
code ("Enhancements") to anyone; however, if you choose to make your
Enhancements available either publicly, or directly to Lawrence Berkeley
National Laboratory, without imposing a separate written license agreement
for such Enhancements, then you hereby grant the following license: a
non-exclusive, royalty-free perpetual license to install, use, modify,
prepare derivative works, incorporate into other computer software,
distribute, and sublicense such enhancements or derivative works thereof,
in binary and source code form.
*/
 
#ifndef _AU_OUTPUT_VECTOR_H_
#define _AU_OUTPUT_VECTOR_H_
 
#include <vector>
#include <type_traits>
#include <cstring>
#include <cmath>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <tuple>
#include <string>
#include <sstream>
#include <algorithm>
#include <iterator>
#include <iostream>
#include <utility>
#include <variant>
#include <dirent.h>
 
#include "ft_type.h"
#include "ft_utility_macro.h"
#include "ft_array_view_access.h"
inline void GetChunkAddress(const unsigned long long chunk_id, const std::vector<unsigned long long> array_size, const std::vector<size_t> chunk_size, std::vector<unsigned long long> &chunk_start_address, std::vector<unsigned long long> &chunk_end_address)
{
    int rank = array_size.size();
    //PrintScalar("rank = ", rank);
    //PrintVector("array_size = ", array_size);
    //PrintVector("chunk_size = ", chunk_size);
 
    std::vector<unsigned long long> chunks;
    unsigned long long total_chunks = 1;
    chunks.resize(rank);
 
    for (int i = 0; i < rank; i++)
    {
        if (array_size[i] % chunk_size[i] == 0)
        {
            chunks[i] = array_size[i] / chunk_size[i];
        }
        else
        {
            chunks[i] = array_size[i] / chunk_size[i] + 1;
        }
        total_chunks = chunks[i] * total_chunks;
    }
 
    if (chunk_id >= total_chunks)
    {
        AU_EXIT("chunk_id >= total_chunks: chunk_id =" + std::to_string(chunk_id) + ", total_chunks = " + std::to_string(total_chunks));
    }
    std::vector<unsigned long long> chunk_coordinate(rank);
    //PrintVector("chunks = ", chunks);
    //PrintScalar("chunk_id = ", chunk_id);
    //PrintVector("chunk_coordinate = ", chunk_coordinate);
 
    ROW_MAJOR_ORDER_REVERSE_MACRO(chunk_id, chunks, rank, chunk_coordinate);
 
    chunk_start_address.resize(rank);
    chunk_end_address.resize(rank);
    for (int i = 0; i < rank; i++)
    {
 
        if (chunk_coordinate[i] * chunk_size[i] < array_size[i])
        {
            chunk_start_address[i] = chunk_coordinate[i] * chunk_size[i];
        }
        else
        {
            chunk_start_address[i] = array_size[i];
        }
 
        if (chunk_start_address[i] + chunk_size[i] - 1 < array_size[i])
        {
            chunk_end_address[i] = chunk_start_address[i] + chunk_size[i] - 1;
        }
        else
        {
            chunk_end_address[i] = array_size[i] - 1;
        }
    }
 
    //PrintVector("chunk_start_address = ", chunk_start_address);
    //PrintVector("chunk_end_address = ", chunk_end_address);
}
 
template <typename T>
void *InsertOutputVV2WriteV(std::vector<std::vector<T>> &v, std::vector<size_t> &v_shape, std::vector<unsigned long long> &write_start_address, std::vector<unsigned long long> &write_end_address, bool last_chunk_flag, std::vector<size_t> &prev_v_shape)
{
    //First to infer the size of the WriteVector from (write_end_address  -  write_start_address) and v_shape
 
    int rank = write_start_address.size();
 
    //We can only deal with one extra dimension
    if (v_shape.size() > (rank + 1))
    {
        AU_INFO("Warning: the shape of output Stencil has more dimensions than current support !\n");
    }
 
    std::vector<unsigned long long> write_vector_size;
    unsigned long long write_vector_length = 1, temp_address;
    for (int i = 0; i < v_shape.size(); i++)
    {
        if (i >= rank) //have extra dimension to deal with
        {
            write_start_address.push_back(0);
            write_end_address.push_back(v_shape[i] - 1);
        }
        else
        {
            // write_start_address = 2  write_end_address = 3  v_shape = 2
            //   ==> write_start_address = 4 write_end_address = 7
            temp_address = write_start_address[i];
            if (last_chunk_flag)
            {
                write_start_address[i] = write_start_address[i] * prev_v_shape[i];
            }
            else
            {
                write_start_address[i] = write_start_address[i] * v_shape[i];
            }
            write_end_address[i] = write_start_address[i] + (write_end_address[i] - temp_address + 1) * v_shape[i] - 1;
        }
        //std::cout << write_end_address[i] << "  ,,  " << write_start_address[i] << "\n";
        write_vector_size.push_back(write_end_address[i] - write_start_address[i] + 1);
        write_vector_length = write_vector_length * write_vector_size[i];
    }
 
    //update the rank to add new dimensions
    rank = v_shape.size();
 
    T *rv = (T *)malloc(write_vector_length * sizeof(T));
    //Now we have output vector with the shape write_vector_size and each element in v has the shape v_shape.
    //we need to write the v into
    //template <class T>
    //inline int ArrayViewAccessP(T * view_v, T * array_v, std::vector<unsigned long long> ///array_size, std::vector<unsigned long long> start, std::vector<unsigned long long> end, int read_write_code)
 
    //PrintVector("v_shape = ", v_shape);
    //PrintVector("write_vector_size = ", write_vector_size);
    //PrintVector("write_start_address = ", write_start_address);
    //PrintVector("write_end_address = ", write_end_address);
 
    std::vector<unsigned long long> view_start(rank), view_end(rank);
    for (size_t i = 0; i < v.size(); i++)
    {
        GetChunkAddress(i, write_vector_size, v_shape, view_start, view_end);
        ArrayViewAccessP(v[i].data(), rv, write_vector_size, view_start, view_end, ARRAY_VIEW_WRITE);
    }
 
    return rv;
}
 
template <typename T>
void *InsertOutputVV2WriteV(std::vector<T> &v, std::vector<size_t> &v_shape, std::vector<unsigned long long> &write_start_address, std::vector<unsigned long long> &write_end_address, bool last_chunk_flag, std::vector<size_t> &prev_v_shape)
{
    AU_EXIT("This function should not be called !");
}
 
template <typename T>
void *InsertOutputVV2WriteV(T &v, std::vector<size_t> &v_shape, std::vector<unsigned long long> &write_start_address, std::vector<unsigned long long> &write_end_address, bool last_chunk_flag, std::vector<size_t> &prev_v_shape)
{
    AU_EXIT("This function should not be called !");
}
//
//Below are old code to delete
//
 
template <typename T>
void *FlatVector(std::vector<std::vector<T>> &v, OutputVectorFlatDirection direction, std::vector<unsigned long long> &start_address, std::vector<unsigned long long> &end_address, size_t &v_size)
{
    if (v.size() < 1)
    {
        return NULL;
    }
 
    if (v[0].size() < 1)
    {
        return NULL;
    }
 
    //Check v's elemtnt has same size
    for (unsigned j = 0; j < v.size() - 1; j++)
    {
        if (v[j].size() != v[j + 1].size())
        {
            AU_EXIT("Size of each element of vector must be equal.");
        }
    }
    v_size = v[0].size();
 
    if (direction == AU_FLAT_OUTPUT_NEW)
    {
        start_address.push_back(0);
        end_address.push_back(v_size - 1);
        return &v[0];
    }
 
    T *rv = (T *)malloc(v.size() * v_size * sizeof(T)); //Assuming all rows have the same size
    if (rv == NULL)
    {
        AU_EXIT("Not enough memory");
    }
 
    if (direction == AU_FLAT_OUTPUT_COL)
    {
        for (unsigned i = 0; i < v_size; i++)
        {
            for (unsigned j = 0; j < v.size(); j++)
            {
                memcpy(rv + v.size() * i + j, &(v[j][i]), sizeof(T));
            }
        }
    }
    else if (direction == AU_FLAT_OUTPUT_ROW)
    {
 
        for (unsigned i = 0; i < v.size(); i++)
        {
            memcpy(rv + v_size * i, &(v[i][0]), v_size * sizeof(T));
        }
    }
    else
    {
        AU_EXIT("Not supported option yet to flat vector");
    }
 
    end_address[direction] = start_address[direction] + (end_address[direction] - start_address[direction] + 1) * v_size - 1;
 
    return (void *)rv;
}
 
template <typename T>
void *FlatVector(std::vector<T> &v, OutputVectorFlatDirection direction, std::vector<unsigned long long> &start_address, std::vector<unsigned long long> &end_address, size_t &v_size)
{
    AU_EXIT("Should not be here");
}
 
template <typename T>
void *FlatVector(T &v, OutputVectorFlatDirection direction, std::vector<unsigned long long> &start_address, std::vector<unsigned long long> &end_address, size_t &v_size)
{
    AU_EXIT("Should not be here");
}
 
#endif