block.h

/* Jazz (c) 2018-2025 kaalam.ai (The Authors of Jazz), using (under the same license):
 
    1. Biomodelling - The AATBlockQueue class (c) Jacques Basaldúa, 2009-2012 licensed
      exclusively for the use in the Jazz server software.
 
      Copyright 2009-2012 Jacques Basaldúa
 
    2. BBVA - Jazz: A lightweight analytical web server for data-driven applications.
 
      Copyright 2016-2017 Banco Bilbao Vizcaya Argentaria, S.A.
 
      This product includes software developed at
 
      BBVA (https://www.bbva.com/)
 
    3. LMDB, Copyright 2011-2017 Howard Chu, Symas Corp. All rights reserved.
 
      Licensed under http://www.OpenLDAP.org/license.html
 
 
      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.
*/
 
 
#include <limits.h>
#include <map>
#include <string.h>
#include <iostream>
 
 
#include "src/jazz_elements/utils.h"
 
#ifdef CATCH_TEST
#ifndef INCLUDED_JAZZ_CATCH2
#define INCLUDED_JAZZ_CATCH2
 
#include "src/catch2/catch.hpp"
 
#endif
#endif
 
 
#ifndef INCLUDED_JAZZ_ELEMENTS_BLOCK
#define INCLUDED_JAZZ_ELEMENTS_BLOCK
 
 
namespace jazz_elements
{
 
// Forward declarations
 
typedef std::map<int, const char *> AttributeMap;
 
typedef class Block *pBlock;
 
 
class Block: public StaticBlockHeader {
 
    public:
 
    // Methods on indices.
 
        inline void set_dimensions(int *p_dim) {
            rank = MAX_TENSOR_RANK;
            int j = 1;
            for (int i = MAX_TENSOR_RANK - 1; i > 0; i--)
                if (p_dim[i] > 0) { range.dim[i] = j; j *= p_dim[i]; } else { j = 1; range.dim[i] = 0; rank = i; }
            range.dim[0] = j;
            j           *= p_dim[0];
            size         = j;
        }
 
        inline void get_dimensions(int *p_dim) {
            int j = size;
            for (int i = 0; i < MAX_TENSOR_RANK; i++)
                if (i < rank) { p_dim[i] = j/range.dim[i]; j = range.dim[i]; } else p_dim[i] = 0;
        }
 
        inline bool validate_index(int *p_idx) {
            int j = size;
            for (int i = 0; i < rank; i++) {
                if (p_idx[i] < 0 || p_idx[i]*range.dim[i] >= j) return false;
                j = range.dim[i];
            }
            return true;
        }
 
        inline int validate_offset(int offset) { return offset >=0 & offset < size; }
 
        inline int get_offset(int *p_idx) {
            int j = 0;
            for (int i = 0; i < rank; i++) j += p_idx[i]*range.dim[i];
            return j;
        }
 
        inline void get_index(int offset, int *p_idx) {
            for (int i = 0; i < rank; i++) { p_idx[i] = offset/range.dim[i]; offset -= p_idx[i]*range.dim[i]; }
        }
 
    // Methods on strings.
 
        inline char *get_string(int *p_idx) {
            return reinterpret_cast<char *>(&p_string_buffer()->buffer[tensor.cell_int[get_offset(p_idx)]]);
        }
 
        inline char *get_string(int offset)  {
            return reinterpret_cast<char *>(&p_string_buffer()->buffer[tensor.cell_int[offset]]);
        }
 
        inline void set_string(int *p_idx, const char *p_str) {
            pStringBuffer psb = p_string_buffer();
            tensor.cell_int[get_offset(p_idx)] = get_string_offset(psb, p_str);
        }
 
        inline void set_string(int offset, const char *p_str) {
            pStringBuffer psb = p_string_buffer();
            tensor.cell_int[offset] = get_string_offset(psb, p_str);
        }
 
    // Methods on attributes.
 
        inline char *get_attribute(int attribute_id) {
            int *ptk = p_attribute_keys();
            for (int i = 0; i < num_attributes; i++)
                if (ptk[i] == attribute_id)
                    return reinterpret_cast<char *>(&p_string_buffer()->buffer[ptk[i + num_attributes]]);
            return nullptr;
        }
 
        inline void set_attributes(AttributeMap *all_att) {
            if (num_attributes)
                return;
 
            if (all_att == nullptr) {
                init_string_buffer();
                return;
            }
            num_attributes = all_att->size();
            init_string_buffer();
 
            int i = 0;
            int *ptk = p_attribute_keys();
            pStringBuffer psb = p_string_buffer();
            for (AttributeMap::iterator it = all_att->begin(); it != all_att->end(); ++it) {
                if (i < num_attributes) {
                    ptk[i] = it->first;
                    ptk[i + num_attributes] = get_string_offset(psb, it->second);
                }
                i++;
            }
        }
 
        inline void get_attributes(AttributeMap *all_att) {
            if (!num_attributes)
                return;
            int *ptk = p_attribute_keys();
            pStringBuffer psb = p_string_buffer();
            for (int i = 0; i < num_attributes; i++)
                (*all_att)[ptk[i]] = reinterpret_cast<char *>(&psb->buffer[ptk[i + num_attributes]]);
        }
 
        inline void init_string_buffer() {
            pStringBuffer psb = p_string_buffer();
 
            int buff_size = total_bytes - ((uintptr_t) psb - (uintptr_t) &cell_type) - sizeof(StringBuffer);
            if (buff_size < 4) {
                psb->alloc_failed = true;
                return;
            }
            memset(psb, 0, sizeof(StringBuffer) + 4);   // This also clears psb->buffer[0..3]
            // psb->buffer[0] = 0;  // STRING_NA
            // psb->buffer[1] = 0;  // STRING_EMPTY
            // psb->buffer[2] = 0;  // The end of string for searching (will change once a string is inserted)
            psb->buffer_size = buff_size;
            psb->last_idx    = 2;   // Where the first string will be inserted
        }
 
        bool find_NAs_in_tensor();
 
        inline int *align64bit(uintptr_t ipt) {
            uintptr_t gap = (uintptr_t) this & 0x7;
            return reinterpret_cast<int *>(((ipt - gap + 0x7) & 0xffffFFFFffffFFF8) + gap);
        }
 
        inline int *p_attribute_keys() {
            return align64bit((uintptr_t) &tensor + (cell_type & 0xff)*size);
        }
 
        inline pStringBuffer p_string_buffer() {
            return reinterpret_cast<pStringBuffer>((uintptr_t) p_attribute_keys() + 2*num_attributes*sizeof(int));
        }
 
        int get_string_offset(pStringBuffer psb, const char *p_str);
 
    // Methods for filtering (selecting).
 
        bool is_a_filter();
 
        inline bool can_filter(pBlock p_block) {
            int rows = p_block->range.dim[0];
 
            if (p_block->rank < 1 || rows <= 0 || rank != 1)
                return false;
 
            rows = p_block->size/rows;
 
            switch (cell_type) {
            case CELL_TYPE_BYTE_BOOLEAN:
                return size == rows;
 
            case CELL_TYPE_INTEGER:
                return size <= rows && (size == 0 || (tensor.cell_int[0] >= 0 && tensor.cell_int[size - 1] < rows));
            }
            return false;
        }
 
        inline void close_block(int set_has_NA = SET_HAS_NA_FALSE,
                                bool set_hash = true,
                                bool set_time = true) {
            switch (set_has_NA) {
            case SET_HAS_NA_FALSE:
                has_NA = false;
                break;
            case SET_HAS_NA_TRUE:
                has_NA = cell_type != CELL_TYPE_BYTE;   // CELL_TYPE_BYTE must always be has_NA == FALSE
                break;
            default:
                has_NA = find_NAs_in_tensor();
            }
 
#ifdef DEBUG    // Initialize the RAM between the end of the string buffer and last allocated byte for Valgrind.
 
            void *p_start;
            if (cell_type != CELL_TYPE_TUPLE_ITEM) {
                pStringBuffer psb = p_string_buffer();
                p_start           = &psb->buffer[psb->last_idx];
            } else {
                pBlock p_blk = (pBlock) ((uintptr_t) &tensor + tensor.cell_item[size - 1].data_start);
                p_start      = (void *) ((uintptr_t) p_blk + p_blk->total_bytes);
            }
            uintptr_t void_size = total_bytes + (uintptr_t) &cell_type - (uintptr_t) p_start;
 
            if (void_size > 0)
                memset(p_start, 0, void_size);
#endif
            if (set_hash)
                hash64 = MurmurHash64A(&tensor, total_bytes - sizeof(BlockHeader));
 
            if (set_time)
                created = std::chrono::steady_clock::now();
        }
 
        inline bool check_hash() {
            int siz = total_bytes - sizeof(BlockHeader);
            return siz > 0 && hash64 == MurmurHash64A(&tensor, siz);
        }
};
 
} // namespace jazz_elements
 
#endif // ifndef INCLUDED_JAZZ_ELEMENTS_BLOCK