jerryscript/tests/unit-core/test-arraybuffer.c

/* Copyright JS Foundation and other contributors, http://js.foundation
 *
 * 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 "jerryscript-port.h"
#include "jerryscript.h"

#include "test-common.h"

/**
 * Register a JavaScript value in the global object.
 */
static void
register_js_value (const char *name_p, /**< name of the function */
                   jerry_value_t value) /**< JS value */
{
  jerry_value_t global_obj_val = jerry_current_realm ();

  jerry_value_t name_val = jerry_string_sz (name_p);
  jerry_value_t result_val = jerry_object_set (global_obj_val, name_val, value);
  TEST_ASSERT (jerry_value_is_boolean (result_val));

  jerry_value_free (name_val);
  jerry_value_free (global_obj_val);

  jerry_value_free (result_val);
} /* register_js_value */

static jerry_value_t
assert_handler (const jerry_call_info_t *call_info_p, /**< call information */
                const jerry_value_t args_p[], /**< function arguments */
                const jerry_length_t args_cnt) /**< number of function arguments */
{
  JERRY_UNUSED (call_info_p);

  if (args_cnt > 0 && jerry_value_is_true (args_p[0]))
  {
    return jerry_boolean (true);
  }

  if (args_cnt > 1 && jerry_value_is_string (args_p[1]))
  {
    jerry_length_t utf8_sz = jerry_string_size (args_p[1], JERRY_ENCODING_CESU8);
    TEST_ASSERT (utf8_sz <= 127); /* 127 is the expected max assert fail message size. */
    JERRY_VLA (char, string_from_utf8, utf8_sz + 1);
    string_from_utf8[utf8_sz] = 0;

    jerry_string_to_buffer (args_p[1], JERRY_ENCODING_CESU8, (jerry_char_t *) string_from_utf8, utf8_sz);

    printf ("JS assert: %s\n", string_from_utf8);
  }

  TEST_ASSERT (false);
} /* assert_handler */

/**
 * Test ArrayBuffer 'read' api call with various offset values.
 */
static void
test_read_with_offset (uint8_t offset) /**< offset for buffer read. */
{
  const jerry_char_t eval_arraybuffer_src[] =
    TEST_STRING_LITERAL ("var array = new Uint8Array (15);"
                         "for (var i = 0; i < array.length; i++) { array[i] = i * 2; };"
                         "array.buffer");
  jerry_value_t arraybuffer =
    jerry_eval (eval_arraybuffer_src, sizeof (eval_arraybuffer_src) - 1, JERRY_PARSE_STRICT_MODE);

  TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
  TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
  TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == 15);

  uint8_t buffer[20];
  memset (buffer, 120, 20);

  /* Try to copy more than the target buffer size. */
  jerry_length_t copied = jerry_arraybuffer_read (arraybuffer, offset, buffer, 20);
  TEST_ASSERT (copied == (jerry_length_t) (15 - offset));

  for (uint8_t i = 0; i < copied; i++)
  {
    TEST_ASSERT (buffer[i] == (i + offset) * 2);
  }
  TEST_ASSERT (buffer[15 - offset] == 120);

  jerry_value_free (arraybuffer);
} /* test_read_with_offset */

/**
 * Test ArrayBuffer 'write' api call with various offset values.
 */
static void
test_write_with_offset (uint8_t offset) /**< offset for buffer write. */
{
  {
    jerry_value_t offset_val = jerry_number (offset);
    register_js_value ("offset", offset_val);
    jerry_value_free (offset_val);
  }

  const jerry_char_t eval_arraybuffer_src[] = "var array = new Uint8Array (15); array.buffer";
  jerry_value_t arraybuffer =
    jerry_eval (eval_arraybuffer_src, sizeof (eval_arraybuffer_src) - 1, JERRY_PARSE_STRICT_MODE);

  TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
  TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
  TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == 15);

  uint8_t buffer[20];

  for (uint8_t i = 0; i < 20; i++)
  {
    buffer[i] = (uint8_t) (i * 3);
  }

  /* Intentionally copy more than the allowed space. */
  jerry_length_t copied = jerry_arraybuffer_write (arraybuffer, offset, buffer, 20);
  TEST_ASSERT (copied == (jerry_length_t) (15 - offset));

  const jerry_char_t eval_test_arraybuffer[] = TEST_STRING_LITERAL (
    "for (var i = 0; i < offset; i++)"
    "{"
    "  assert (array[i] == 0, 'offset check for: ' + i + ' was: ' + array[i] + ' should be: 0');"
    "};"
    "for (var i = offset; i < array.length; i++)"
    "{"
    "  var expected = (i - offset) * 3;"
    "  assert (array[i] == expected, 'calc check for: ' + i + ' was: ' + array[i] + ' should be: ' + expected);"
    "};"
    "assert (array[15] === undefined, 'ArrayBuffer out of bounds index should return undefined value');");
  jerry_value_t res = jerry_eval (eval_test_arraybuffer, sizeof (eval_test_arraybuffer) - 1, JERRY_PARSE_STRICT_MODE);
  jerry_value_free (res);
  jerry_value_free (arraybuffer);
} /* test_write_with_offset */

static int allocate_mode = 0;
static int allocate_count = 0;
static int free_count = 0;

static uint8_t *
test_allocate_cb (jerry_arraybuffer_type_t buffer_type, /**< type of the array buffer object */
                  uint32_t buffer_size, /**< size of the requested buffer */
                  void **buffer_user_p, /**< [in/out] user pointer assigned to the array buffer object */
                  void *user_p) /**< user pointer passed to jerry_arraybuffer_set_allocation_callbacks */
{
  TEST_ASSERT (buffer_type == JERRY_ARRAYBUFFER_TYPE_ARRAYBUFFER);
  TEST_ASSERT (user_p == (void *) &allocate_mode);

  if (*buffer_user_p != NULL)
  {
    TEST_ASSERT (*buffer_user_p == (void *) &allocate_count);
    TEST_ASSERT (buffer_size == 20);
    allocate_count++;
    *buffer_user_p = (void *) &free_count;
  }
  else
  {
    *buffer_user_p = (void *) &allocate_mode;
  }
  return (uint8_t *) malloc (buffer_size);
} /* test_allocate_cb */

static void
test_free_cb (jerry_arraybuffer_type_t buffer_type, /**< type of the array buffer object */
              uint8_t *buffer_p, /**< pointer to the allocated buffer */
              uint32_t buffer_size, /**< size of the allocated buffer */
              void *buffer_user_p, /**< user pointer assigned to the array buffer object */
              void *user_p) /**< user pointer passed to jerry_arraybuffer_set_allocation_callbacks */
{
  TEST_ASSERT (buffer_type == JERRY_ARRAYBUFFER_TYPE_ARRAYBUFFER);
  TEST_ASSERT (user_p == (void *) &allocate_mode);

  if (buffer_user_p == NULL)
  {
    TEST_ASSERT (buffer_size == 15);
    free_count++;
  }
  else if (buffer_user_p == (void *) &free_count)
  {
    TEST_ASSERT (buffer_size == 20);
    free_count++;
  }
  else
  {
    TEST_ASSERT (buffer_user_p == (void *) &allocate_mode);
  }

  free (buffer_p);
} /* test_free_cb */

int
main (void)
{
  jerry_init (JERRY_INIT_EMPTY);

  if (!jerry_feature_enabled (JERRY_FEATURE_TYPEDARRAY))
  {
    jerry_log (JERRY_LOG_LEVEL_ERROR, "ArrayBuffer is disabled!\n");
    jerry_cleanup ();
    return 0;
  }

  jerry_arraybuffer_heap_allocation_limit (4);
  jerry_arraybuffer_allocator (test_allocate_cb, test_free_cb, (void *) &allocate_mode);

  jerry_value_t function_val = jerry_function_external (assert_handler);
  register_js_value ("assert", function_val);
  jerry_value_free (function_val);

  /* Test array buffer queries */
  {
    const jerry_char_t eval_arraybuffer_src[] = "new ArrayBuffer (10)";
    jerry_value_t eval_arraybuffer =
      jerry_eval (eval_arraybuffer_src, sizeof (eval_arraybuffer_src) - 1, JERRY_PARSE_STRICT_MODE);
    TEST_ASSERT (!jerry_value_is_exception (eval_arraybuffer));
    TEST_ASSERT (jerry_value_is_arraybuffer (eval_arraybuffer));
    TEST_ASSERT (jerry_arraybuffer_size (eval_arraybuffer) == 10);
    jerry_value_free (eval_arraybuffer);
  }

  /* Test array buffer creation */
  {
    const uint32_t length = 15;
    jerry_value_t arraybuffer = jerry_arraybuffer (length);
    TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
    TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
    TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == length);
    jerry_value_free (arraybuffer);
  }

  /* Test array buffer read operations */
  for (uint8_t i = 0; i < 15; i++)
  {
    test_read_with_offset (i);
  }

  /* Test zero length ArrayBuffer read */
  {
    const uint32_t length = 0;
    jerry_value_t arraybuffer = jerry_arraybuffer (length);
    TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
    TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
    TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == length);

    uint8_t data[20];
    memset (data, 11, 20);

    jerry_length_t bytes_read = jerry_arraybuffer_read (arraybuffer, 0, data, 20);
    TEST_ASSERT (bytes_read == 0);

    for (int i = 0; i < 20; i++)
    {
      TEST_ASSERT (data[i] == 11);
    }

    jerry_value_free (arraybuffer);
  }

  /* Test array buffer write operations */
  for (uint8_t i = 0; i < 15; i++)
  {
    test_write_with_offset (i);
  }

  /* Test zero length ArrayBuffer write */
  {
    const uint32_t length = 0;
    jerry_value_t arraybuffer = jerry_arraybuffer (length);
    TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
    TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
    TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == length);

    uint8_t data[20];
    memset (data, 11, 20);

    jerry_length_t bytes_written = jerry_arraybuffer_write (arraybuffer, 0, data, 20);
    TEST_ASSERT (bytes_written == 0);

    jerry_value_free (arraybuffer);
  }

  /* Test zero length external ArrayBuffer */
  {
    const uint32_t length = 0;
    jerry_value_t arraybuffer = jerry_arraybuffer_external (NULL, length, NULL);
    TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
    TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
    TEST_ASSERT (jerry_arraybuffer_is_detachable (arraybuffer));
    TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == length);

    uint8_t data[20];
    memset (data, 11, 20);

    jerry_length_t bytes_written = jerry_arraybuffer_write (arraybuffer, 0, data, 20);
    TEST_ASSERT (bytes_written == 0);

    jerry_value_free (arraybuffer);
  }

  /* Test ArrayBuffer with buffer allocated externally */
  {
    const uint32_t buffer_size = 15;
    const uint8_t base_value = 51;

    uint8_t *buffer_p = (uint8_t *) malloc (buffer_size);
    memset (buffer_p, base_value, buffer_size);

    jerry_value_t arrayb = jerry_arraybuffer_external (buffer_p, buffer_size, NULL);
    uint8_t new_value = 123;
    jerry_length_t copied = jerry_arraybuffer_write (arrayb, 0, &new_value, 1);
    TEST_ASSERT (copied == 1);
    TEST_ASSERT (buffer_p[0] == new_value);
    TEST_ASSERT (jerry_arraybuffer_size (arrayb) == buffer_size);

    for (uint32_t i = 1; i < buffer_size; i++)
    {
      TEST_ASSERT (buffer_p[i] == base_value);
    }

    JERRY_VLA (uint8_t, test_buffer, buffer_size);
    jerry_length_t read = jerry_arraybuffer_read (arrayb, 0, test_buffer, buffer_size);
    TEST_ASSERT (read == buffer_size);
    TEST_ASSERT (test_buffer[0] == new_value);

    for (uint32_t i = 1; i < buffer_size; i++)
    {
      TEST_ASSERT (test_buffer[i] == base_value);
    }

    TEST_ASSERT (jerry_value_is_arraybuffer (arrayb));
    jerry_value_free (arrayb);
  }

  /* Test ArrayBuffer external memory map/unmap */
  {
    const uint32_t buffer_size = 20;

    jerry_value_t input_buffer = jerry_arraybuffer_external (NULL, buffer_size, (void *) &allocate_count);
    register_js_value ("input_buffer", input_buffer);
    jerry_value_free (input_buffer);

    const jerry_char_t eval_arraybuffer_src[] = TEST_STRING_LITERAL ("var array = new Uint8Array(input_buffer);"
                                                                     "for (var i = 0; i < array.length; i++)"
                                                                     "{"
                                                                     "  array[i] = i * 2;"
                                                                     "};"
                                                                     "array.buffer");
    jerry_value_t buffer =
      jerry_eval (eval_arraybuffer_src, sizeof (eval_arraybuffer_src) - 1, JERRY_PARSE_STRICT_MODE);

    TEST_ASSERT (!jerry_value_is_exception (buffer));
    TEST_ASSERT (jerry_value_is_arraybuffer (buffer));
    TEST_ASSERT (jerry_arraybuffer_size (buffer) == 20);

    uint8_t *const data = jerry_arraybuffer_data (buffer);

    TEST_ASSERT (data != NULL);

    /* test memory read */
    for (int i = 0; i < 20; i++)
    {
      TEST_ASSERT (data[i] == (uint8_t) (i * 2));
    }

    /* "upload" new data */
    double sum = 0;
    for (int i = 0; i < 20; i++)
    {
      data[i] = (uint8_t) (i * 3);
      sum += data[i];
    }

    const jerry_char_t eval_test_arraybuffer[] = TEST_STRING_LITERAL (
      "var sum = 0;"
      "for (var i = 0; i < array.length; i++)"
      "{"
      "  var expected = i * 3;"
      "  assert(array[i] == expected, 'Array at index ' + i + ' was: ' + array[i] + ' should be: ' + expected);"
      "  sum += array[i]"
      "};"
      "sum");
    jerry_value_t res = jerry_eval (eval_test_arraybuffer, sizeof (eval_test_arraybuffer) - 1, JERRY_PARSE_STRICT_MODE);
    TEST_ASSERT (jerry_value_is_number (res));
    TEST_ASSERT (jerry_value_as_number (res) == sum);
    jerry_value_free (res);

    jerry_value_free (buffer);
  }

  /* Test internal ArrayBuffer detach */
  {
    const uint32_t length = 4;
    jerry_value_t arraybuffer = jerry_arraybuffer (length);
    TEST_ASSERT (jerry_arraybuffer_has_buffer (arraybuffer));
    TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
    TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
    TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == length);
    TEST_ASSERT (jerry_arraybuffer_is_detachable (arraybuffer));

    jerry_value_t res = jerry_arraybuffer_detach (arraybuffer);
    TEST_ASSERT (!jerry_arraybuffer_has_buffer (arraybuffer));
    TEST_ASSERT (!jerry_value_is_exception (res));
    TEST_ASSERT (jerry_arraybuffer_data (arraybuffer) == NULL);
    TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == 0);
    TEST_ASSERT (!jerry_arraybuffer_is_detachable (arraybuffer));

    jerry_value_free (res);
    jerry_value_free (arraybuffer);
  }

  /* Test external ArrayBuffer detach */
  {
    const uint32_t length = 64;
    jerry_value_t arraybuffer = jerry_arraybuffer_external (NULL, length, NULL);
    TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
    TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
    TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == length);
    TEST_ASSERT (!jerry_arraybuffer_has_buffer (arraybuffer));

    uint8_t buf[1] = { 1 };
    TEST_ASSERT (jerry_arraybuffer_write (arraybuffer, 0, buf, 1) == 1);
    TEST_ASSERT (jerry_arraybuffer_has_buffer (arraybuffer));
    TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == length);
    TEST_ASSERT (jerry_arraybuffer_is_detachable (arraybuffer));

    jerry_value_t res = jerry_arraybuffer_detach (arraybuffer);
    TEST_ASSERT (!jerry_value_is_exception (res));
    TEST_ASSERT (jerry_arraybuffer_data (arraybuffer) == NULL);
    TEST_ASSERT (jerry_arraybuffer_size (arraybuffer) == 0);
    TEST_ASSERT (!jerry_arraybuffer_has_buffer (arraybuffer));
    TEST_ASSERT (!jerry_arraybuffer_is_detachable (arraybuffer));

    jerry_value_free (res);
    jerry_value_free (arraybuffer);
  }

  /* Test ArrayBuffer created in ECMAScript */
  for (int i = 0; i < 3; i++)
  {
    const jerry_char_t source[] = TEST_STRING_LITERAL ("new ArrayBuffer(64)");
    jerry_value_t arraybuffer = jerry_eval (source, sizeof (source) - 1, JERRY_PARSE_NO_OPTS);
    TEST_ASSERT (!jerry_value_is_exception (arraybuffer));
    TEST_ASSERT (jerry_value_is_arraybuffer (arraybuffer));
    TEST_ASSERT (!jerry_arraybuffer_has_buffer (arraybuffer));

    if (i == 0)
    {
      uint8_t buf[2] = { 2, 3 };
      TEST_ASSERT (jerry_arraybuffer_write (arraybuffer, 63, buf, 2) == 1);
    }
    else if (i == 1)
    {
      uint8_t buf[2] = { 1, 1 };
      TEST_ASSERT (jerry_arraybuffer_read (arraybuffer, 63, buf, 2) == 1);
      TEST_ASSERT (buf[0] == 0 && buf[1] == 1);
    }
    else
    {
      uint8_t *buffer_p = jerry_arraybuffer_data (arraybuffer);
      TEST_ASSERT (buffer_p != NULL);
    }

    TEST_ASSERT (jerry_arraybuffer_has_buffer (arraybuffer));

    jerry_value_free (arraybuffer);
  }

  jerry_cleanup ();

  TEST_ASSERT (allocate_count == 1);
  TEST_ASSERT (free_count == 2);

  return 0;
} /* main */