/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup rtems_rtl
 *
 * @brief RTEMS Run-Time Linker Allocator
 */

/*
 *  COPYRIGHT (c) 2012, 2018, 2023 Chris Johns <chrisj@rtems.org>
 *
 * 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.
 *
 * 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.
 */

#include <stdio.h>
#include <string.h>

#include <rtems/rtl/rtl.h>
#include "rtl-alloc-heap.h"
#include <rtems/rtl/rtl-trace.h>

/**
 * Tags as symbols for tracing.
 */
#if RTEMS_RTL_TRACE
static const char* tag_labels[6] =
{
  "OBJECT",
  "SYMBOL",
  "EXTERNAL",
  "READ",
  "READ_WRITE",
  "READ_EXEC",
};
#define rtems_rtl_trace_tag_label(_l) tag_labels[_l]
#else
#define rtems_rtl_trace_tag_label(_l) ""
#endif

void
rtems_rtl_alloc_initialise (rtems_rtl_alloc_data* data)
{
  int c;
  data->allocator = rtems_rtl_alloc_heap;
  for (c = 0; c < RTEMS_RTL_ALLOC_TAGS; ++c)
    rtems_chain_initialize_empty (&data->indirects[c]);
}

void*
rtems_rtl_alloc_new (rtems_rtl_alloc_tag tag, size_t size, bool zero)
{
  rtems_rtl_data* rtl = rtems_rtl_lock ();
  void*           address = NULL;

  /*
   * Obtain memory from the allocator. The address field is set by the
   * allocator.
   */
  if (rtl != NULL)
    rtl->allocator.allocator (RTEMS_RTL_ALLOC_NEW, tag, &address, size);

  rtems_rtl_unlock ();

  if (rtems_rtl_trace (RTEMS_RTL_TRACE_ALLOCATOR))
    printf ("rtl: alloc: new: %s addr=%p size=%zu\n",
            rtems_rtl_trace_tag_label (tag), address, size);

  /*
   * Only zero the memory if asked to and the allocation was successful.
   */
  if (address != NULL && zero)
    memset (address, 0, size);

  return address;
}

void
rtems_rtl_alloc_del (rtems_rtl_alloc_tag tag, void* address)
{
  rtems_rtl_data* rtl = rtems_rtl_lock ();

  if (rtems_rtl_trace (RTEMS_RTL_TRACE_ALLOCATOR))
    printf ("rtl: alloc: del: %s addr=%p\n",
            rtems_rtl_trace_tag_label (tag), address);

  if (rtl != NULL && address != NULL)
    rtl->allocator.allocator (RTEMS_RTL_ALLOC_DEL, tag, &address, 0);

  rtems_rtl_unlock ();
}

void* rtems_rtl_alloc_resize (rtems_rtl_alloc_tag tag,
                              void*               address,
                              size_t              size,
                              bool                zero)
{
  rtems_rtl_data* rtl = rtems_rtl_lock ();
  const void* prev_address = address;

  /*
   * Resize memory of an existing allocation. The address field is set
   * by the allocator and may change.
   */
  if (rtl != NULL)
    rtl->allocator.allocator (RTEMS_RTL_ALLOC_RESIZE, tag, &address, size);

  rtems_rtl_unlock ();

  if (rtems_rtl_trace (RTEMS_RTL_TRACE_ALLOCATOR))
    printf ("rtl: alloc: resize: %s%s prev-addr=%p addr=%p size=%zu\n",
            rtems_rtl_trace_tag_label (tag), prev_address == address ? "" : " MOVED",
            prev_address, address, size);

  /*
   * Only zero the memory if asked to and the resize was successful. We
   * cannot clear the resized area if bigger than the previouis allocation
   * because we do not have the original size.
   */
  if (address != NULL && zero)
    memset (address, 0, size);

  return address;
}

void
rtems_rtl_alloc_wr_enable (rtems_rtl_alloc_tag tag, void* address)
{
  rtems_rtl_data* rtl = rtems_rtl_lock ();

  if (rtems_rtl_trace (RTEMS_RTL_TRACE_ALLOCATOR))
    printf ("rtl: alloc: wr-enable: addr=%p\n", address);

  if (rtl != NULL && address != NULL)
    rtl->allocator.allocator (RTEMS_RTL_ALLOC_WR_ENABLE,
                              tag,
                              address,
                              0);

  rtems_rtl_unlock ();
}

void
rtems_rtl_alloc_lock (void)
{
  rtems_rtl_data* rtl = rtems_rtl_lock ();

  if (rtems_rtl_trace (RTEMS_RTL_TRACE_ALLOCATOR))
    printf ("rtl: alloc: lock\n");

  if (rtl != NULL)
    rtl->allocator.allocator (RTEMS_RTL_ALLOC_LOCK,
                              RTEMS_RTL_ALLOC_OBJECT, /* should be ignored */
                              NULL,
                              0);

  rtems_rtl_unlock ();
}


void
rtems_rtl_alloc_unlock (void)
{
  rtems_rtl_data* rtl = rtems_rtl_lock ();

  if (rtems_rtl_trace (RTEMS_RTL_TRACE_ALLOCATOR))
    printf ("rtl: alloc: unlock\n");

  if (rtl != NULL)
    rtl->allocator.allocator (RTEMS_RTL_ALLOC_UNLOCK,
                              RTEMS_RTL_ALLOC_OBJECT, /* should be ignored */
                              NULL,
                              0);

  rtems_rtl_unlock ();
}
void
rtems_rtl_alloc_wr_disable (rtems_rtl_alloc_tag tag, void* address)
{
  rtems_rtl_data* rtl = rtems_rtl_lock ();

  if (rtems_rtl_trace (RTEMS_RTL_TRACE_ALLOCATOR))
    printf ("rtl: alloc: wr-disable: addr=%p\n", address);

  if (rtl != NULL && address != NULL)
    rtl->allocator.allocator (RTEMS_RTL_ALLOC_WR_DISABLE,
                              tag,
                              address,
                              0);

  rtems_rtl_unlock ();
}

rtems_rtl_allocator
rtems_rtl_alloc_hook (rtems_rtl_allocator handler)
{
  rtems_rtl_data*     rtl = rtems_rtl_lock ();
  rtems_rtl_allocator previous = rtl->allocator.allocator;
  rtl->allocator.allocator = handler;
  rtems_rtl_unlock ();
  return previous;
}

void
rtems_rtl_alloc_indirect_new (rtems_rtl_alloc_tag tag,
                              rtems_rtl_ptr*      handle,
                              size_t              size)
{
  rtems_rtl_data* rtl = rtems_rtl_lock ();

  if (rtems_rtl_trace (RTEMS_RTL_TRACE_ALLOCATOR))
  {
    if (!rtems_rtl_ptr_null (handle))
      printf ("rtl: alloc: inew: %s handle=%p: not null\n",
              rtems_rtl_trace_tag_label (tag), handle);
    printf ("rtl: alloc: inew: %s handle=%p size=%zd\n",
            rtems_rtl_trace_tag_label (tag), handle, size);
  }

  if (rtl)
  {
    rtems_rtl_alloc_data* allocator = &rtl->allocator;
    handle->pointer = rtems_rtl_alloc_new (tag, size, false);
    if (!rtems_rtl_ptr_null (handle))
      rtems_chain_append_unprotected (&allocator->indirects[tag],
                                      &handle->node);
  }

  rtems_rtl_unlock ();
}

void
rtems_rtl_alloc_indirect_del (rtems_rtl_alloc_tag tag,
                              rtems_rtl_ptr*      handle)
{
  rtems_rtl_data* rtl = rtems_rtl_lock ();

  if (rtems_rtl_trace (RTEMS_RTL_TRACE_ALLOCATOR))
  {
    if (rtems_rtl_ptr_null (handle))
      printf ("rtl: alloc: idel: %s handle=%p: is null\n",
              rtems_rtl_trace_tag_label (tag), handle);
    printf ("rtl: alloc: idel: %s handle=%p\n",
            rtems_rtl_trace_tag_label (tag), handle);
  }

  if (rtl && !rtems_rtl_ptr_null (handle))
  {
    rtems_chain_extract_unprotected (&handle->node);
    rtems_rtl_alloc_del (tag, &handle->pointer);
  }
}

rtems_rtl_alloc_tag
rtems_rtl_alloc_text_tag (void)
{
  return RTEMS_RTL_ALLOC_READ_EXEC;
}

rtems_rtl_alloc_tag
rtems_rtl_alloc_const_tag (void)
{
  return RTEMS_RTL_ALLOC_READ;
}

rtems_rtl_alloc_tag
rtems_rtl_alloc_eh_tag (void)
{
  return RTEMS_RTL_ALLOC_READ;
}

rtems_rtl_alloc_tag
rtems_rtl_alloc_data_tag (void)
{
  return RTEMS_RTL_ALLOC_READ_WRITE;
}

rtems_rtl_alloc_tag
rtems_rtl_alloc_bss_tag (void)
{
  return RTEMS_RTL_ALLOC_READ_WRITE;
}

bool
rtems_rtl_alloc_module_new (void** text_base, size_t text_size,
                            void** const_base, size_t const_size,
                            void** eh_base, size_t eh_size,
                            void** data_base, size_t data_size,
                            void** bss_base, size_t bss_size)
{
  *text_base = *const_base = *data_base = *bss_base = NULL;

  if (data_size != 0)
  {
    *data_base = rtems_rtl_alloc_new (rtems_rtl_alloc_data_tag (),
                                      data_size, false);
    if (*data_base == NULL)
    {
      rtems_rtl_alloc_module_del (text_base, const_base, eh_base,
                                  data_base, bss_base);
      return false;
    }
  }

  if (bss_size != 0)
  {
    *bss_base = rtems_rtl_alloc_new (rtems_rtl_alloc_bss_tag (),
                                     bss_size, false);
    if (*bss_base == NULL)
    {
      rtems_rtl_alloc_module_del (text_base, const_base, eh_base,
                                  data_base, bss_base);
      return false;
    }
  }

  if (eh_size != 0)
  {
    *eh_base = rtems_rtl_alloc_new (rtems_rtl_alloc_eh_tag (),
                                    eh_size, false);
    if (*eh_base == NULL)
    {
      rtems_rtl_alloc_module_del (text_base, const_base, eh_base,
                                  data_base, bss_base);
      return false;
    }
  }

  if (const_size != 0)
  {
    *const_base = rtems_rtl_alloc_new (rtems_rtl_alloc_const_tag (),
                                       const_size, false);
    if (*const_base == NULL)
    {
      rtems_rtl_alloc_module_del (text_base, const_base, eh_base,
                                  data_base, bss_base);
      return false;
    }
  }

  if (text_size != 0)
  {
    *text_base = rtems_rtl_alloc_new (rtems_rtl_alloc_text_tag (),
                                      text_size, false);
    if (*text_base == NULL)
    {
      return false;
    }
  }

  return true;
}

bool
rtems_rtl_alloc_module_resize (void** text_base, size_t text_size,
                               void** const_base, size_t const_size,
                               void** eh_base, size_t eh_size,
                               void** data_base, size_t data_size,
                               void** bss_base, size_t bss_size)
{
  if (data_size != 0)
  {
    *data_base = rtems_rtl_alloc_resize (rtems_rtl_alloc_data_tag (),
                                         *data_base, data_size, false);
    if (*data_base == NULL)
    {
      return false;
    }
  }

  if (bss_size != 0)
  {
    *bss_base = rtems_rtl_alloc_resize (rtems_rtl_alloc_bss_tag (),
                                        *bss_base, bss_size, false);
    if (*bss_base == NULL)
    {
      return false;
    }
  }

  if (eh_size != 0)
  {
    *eh_base = rtems_rtl_alloc_resize (rtems_rtl_alloc_eh_tag (),
                                       *eh_base, eh_size, false);
    if (*eh_base == NULL)
    {
      return false;
    }
  }

  if (const_size != 0)
  {
    *const_base = rtems_rtl_alloc_resize (rtems_rtl_alloc_const_tag (),
                                          *const_base, const_size, false);
    if (*const_base == NULL)
    {
      return false;
    }
  }

  if (text_size != 0)
  {
    *text_base = rtems_rtl_alloc_resize (rtems_rtl_alloc_text_tag (),
                                         *text_base, text_size, false);
    if (*text_base == NULL)
    {
      return false;
    }
  }

  return true;
}

void
rtems_rtl_alloc_module_del (void** text_base,
                            void** const_base,
                            void** eh_base,
                            void** data_base,
                            void** bss_base)
{
  rtems_rtl_alloc_del (RTEMS_RTL_ALLOC_READ_WRITE, *bss_base);
  rtems_rtl_alloc_del (RTEMS_RTL_ALLOC_READ_WRITE, *data_base);
  rtems_rtl_alloc_del (RTEMS_RTL_ALLOC_READ, *eh_base);
  rtems_rtl_alloc_del (RTEMS_RTL_ALLOC_READ, *const_base);
  rtems_rtl_alloc_del (RTEMS_RTL_ALLOC_READ_EXEC, *text_base);
  *text_base = *const_base = *eh_base = *data_base = *bss_base = NULL;
}