mod-test.c 18 KB
Newer Older
1 2
/* Test GNU Emacs modules.

Paul Eggert's avatar
Paul Eggert committed
3
Copyright 2015-2020 Free Software Foundation, Inc.
4 5 6 7 8

This file is part of GNU Emacs.

GNU Emacs is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
9 10
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
11 12 13 14 15 16 17

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
18
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.  */
19

20 21
#include "config.h"

22
#undef NDEBUG
23
#include <assert.h>
24

25 26
#include <errno.h>
#include <limits.h>
27
#include <stdint.h>
28
#include <stdio.h>
29
#include <stdlib.h>
30 31 32
#include <string.h>
#include <time.h>

33 34 35 36 37 38
#ifdef HAVE_GMP
#include <gmp.h>
#else
#include "mini-gmp.h"
#endif

39
#include <emacs-module.h>
40

41 42
#include "timespec.h"

43 44
int plugin_is_GPL_compatible;

45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
#if INTPTR_MAX <= 0
# error "INTPTR_MAX misconfigured"
#elif INTPTR_MAX <= INT_MAX || INTPTR_MAX <= LONG_MAX
# define pT "ld"
# define pZ "lu"
# define T_TYPE long
# define Z_TYPE unsigned long
#elif INTPTR_MAX <= INT64_MAX
# ifdef __MINGW32__
#  define pT "lld"
#  define pZ "llu"
#  define T_TYPE long long
#  define Z_TYPE unsigned long long
# else
#  define pT "ld"
#  define pZ "lu"
#  define T_TYPE long
#  define Z_TYPE unsigned long
# endif
#else
# error "INTPTR_MAX too large"
#endif

68 69
/* Smoke test to verify that EMACS_LIMB_MAX is defined. */
_Static_assert (0 < EMACS_LIMB_MAX, "EMACS_LIMB_MAX missing or incorrect");
70

71 72
/* Always return symbol 't'.  */
static emacs_value
73 74
Fmod_test_return_t (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		    void *data)
75 76 77 78
{
  return env->intern (env, "t");
}

79
/* Expose simple sum function.  */
80 81
static intmax_t
sum (intmax_t a, intmax_t b)
82 83 84 85
{
  return a + b;
}

86
static emacs_value
87
Fmod_test_sum (emacs_env *env, ptrdiff_t nargs, emacs_value args[], void *data)
88
{
89
  assert (nargs == 2);
90
  assert ((uintptr_t) data == 0x1234);
91

92 93
  intmax_t a = env->extract_integer (env, args[0]);
  intmax_t b = env->extract_integer (env, args[1]);
94

95
  intmax_t r = sum (a, b);
96 97 98 99 100

  return env->make_integer (env, r);
}


101 102
/* Signal '(error 56).  */
static emacs_value
103 104
Fmod_test_signal (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		  void *data)
105 106
{
  assert (env->non_local_exit_check (env) == emacs_funcall_exit_return);
107 108
  env->non_local_exit_signal (env, env->intern (env, "error"),
			      env->make_integer (env, 56));
109
  return NULL;
110 111 112
}


113 114
/* Throw '(tag 65).  */
static emacs_value
115 116
Fmod_test_throw (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		 void *data)
117 118
{
  assert (env->non_local_exit_check (env) == emacs_funcall_exit_return);
119 120
  env->non_local_exit_throw (env, env->intern (env, "tag"),
			     env->make_integer (env, 65));
121
  return NULL;
122 123 124
}


125 126 127
/* Call argument function, catch all non-local exists and return
   either normal result or a list describing the non-local exit.  */
static emacs_value
128 129
Fmod_test_non_local_exit_funcall (emacs_env *env, ptrdiff_t nargs,
				  emacs_value args[], void *data)
130 131
{
  assert (nargs == 1);
Paul Eggert's avatar
Paul Eggert committed
132
  emacs_value result = env->funcall (env, args[0], 0, NULL);
133
  emacs_value non_local_exit_symbol, non_local_exit_data;
134 135 136
  enum emacs_funcall_exit code
    = env->non_local_exit_get (env, &non_local_exit_symbol,
			       &non_local_exit_data);
137 138 139 140 141 142 143
  switch (code)
    {
    case emacs_funcall_exit_return:
      return result;
    case emacs_funcall_exit_signal:
      {
        env->non_local_exit_clear (env);
Paul Eggert's avatar
Paul Eggert committed
144
        emacs_value Flist = env->intern (env, "list");
145 146
        emacs_value list_args[] = {env->intern (env, "signal"),
				   non_local_exit_symbol, non_local_exit_data};
147 148 149 150 151
        return env->funcall (env, Flist, 3, list_args);
      }
    case emacs_funcall_exit_throw:
      {
        env->non_local_exit_clear (env);
Paul Eggert's avatar
Paul Eggert committed
152
        emacs_value Flist = env->intern (env, "list");
153 154
        emacs_value list_args[] = {env->intern (env, "throw"),
				   non_local_exit_symbol, non_local_exit_data};
155 156 157
        return env->funcall (env, Flist, 3, list_args);
      }
    }
158 159

  /* Never reached.  */
160 161 162 163
  return env->intern (env, "nil");;
}


Paul Eggert's avatar
Paul Eggert committed
164
/* Return a global reference.  */
165
static emacs_value
166
Fmod_test_globref_make (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
167
			void *data)
168
{
169 170
  /* Make a big string and make it global.  */
  char str[26 * 100];
171
  for (int i = 0; i < sizeof str; i++)
172
    str[i] = 'a' + (i % 26);
173

174 175
  /* We don't need to null-terminate str.  */
  emacs_value lisp_str = env->make_string (env, str, sizeof str);
176 177 178
  return env->make_global_ref (env, lisp_str);
}

179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
/* Create a few global references from arguments and free them.  */
static emacs_value
Fmod_test_globref_free (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
			void *data)
{
  emacs_value refs[10];
  for (int i = 0; i < 10; i++)
    {
      refs[i] = env->make_global_ref (env, args[i % nargs]);
    }
  for (int i = 0; i < 10; i++)
    {
      env->free_global_ref (env, refs[i]);
    }
  return env->intern (env, "ok");
}


197

198 199 200
/* Return a copy of the argument string where every 'a' is replaced
   with 'b'.  */
static emacs_value
201
Fmod_test_string_a_to_b (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
202
			 void *data)
203 204
{
  emacs_value lisp_str = args[0];
205
  ptrdiff_t size = 0;
206 207 208 209 210 211
  char * buf = NULL;

  env->copy_string_contents (env, lisp_str, buf, &size);
  buf = malloc (size);
  env->copy_string_contents (env, lisp_str, buf, &size);

212
  for (ptrdiff_t i = 0; i + 1 < size; i++)
213 214 215
    if (buf[i] == 'a')
      buf[i] = 'b';

216
  return env->make_string (env, buf, size - 1);
217 218 219
}


220
/* Embedded pointers in lisp objects.  */
221

222
/* C struct (pointer to) that will be embedded.  */
223 224 225 226 227 228
struct super_struct
{
  int amazing_int;
  char large_unused_buffer[512];
};

229 230 231
/* Return a new user-pointer to a super_struct, with amazing_int set
   to the passed parameter.  */
static emacs_value
232
Fmod_test_userptr_make (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
233
			void *data)
234
{
235
  struct super_struct *p = calloc (1, sizeof *p);
236
  p->amazing_int = env->extract_integer (env, args[0]);
237
  return env->make_user_ptr (env, free, p);
238 239
}

240 241
/* Return the amazing_int of a passed 'user-pointer to a super_struct'.  */
static emacs_value
242 243
Fmod_test_userptr_get (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		       void *data)
244 245 246 247 248 249
{
  struct super_struct *p = env->get_user_ptr (env, args[0]);
  return env->make_integer (env, p->amazing_int);
}


250 251
/* Fill vector in args[0] with value in args[1].  */
static emacs_value
252 253
Fmod_test_vector_fill (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		       void *data)
254 255 256
{
  emacs_value vec = args[0];
  emacs_value val = args[1];
257 258
  ptrdiff_t size = env->vec_size (env, vec);
  for (ptrdiff_t i = 0; i < size; i++)
259 260 261 262 263
    env->vec_set (env, vec, i, val);
  return env->intern (env, "t");
}


264 265 266
/* Return whether all elements of vector in args[0] are 'eq' to value
   in args[1].  */
static emacs_value
267 268
Fmod_test_vector_eq (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		     void *data)
269 270 271
{
  emacs_value vec = args[0];
  emacs_value val = args[1];
272 273
  ptrdiff_t size = env->vec_size (env, vec);
  for (ptrdiff_t i = 0; i < size; i++)
274 275 276 277 278
    if (!env->eq (env, env->vec_get (env, vec, i), val))
        return env->intern (env, "nil");
  return env->intern (env, "t");
}

279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
static emacs_value invalid_stored_value;

/* The next two functions perform a possibly-invalid operation: they
   store a value in a static variable and load it.  This causes
   undefined behavior if the environment that the value was created
   from is no longer live.  The module assertions check for this
   error.  */

static emacs_value
Fmod_test_invalid_store (emacs_env *env, ptrdiff_t nargs, emacs_value *args,
                         void *data)
{
  return invalid_stored_value = env->make_integer (env, 123);
}

static emacs_value
Fmod_test_invalid_load (emacs_env *env, ptrdiff_t nargs, emacs_value *args,
                        void *data)
{
  return invalid_stored_value;
}

301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
/* An invalid finalizer: Finalizers are run during garbage collection,
   where Lisp code can’t be executed.  -module-assertions tests for
   this case.  */

static emacs_env *current_env;

static void
invalid_finalizer (void *ptr)
{
  current_env->intern (current_env, "nil");
}

static emacs_value
Fmod_test_invalid_finalizer (emacs_env *env, ptrdiff_t nargs, emacs_value *args,
                             void *data)
{
  current_env = env;
  env->make_user_ptr (env, invalid_finalizer, NULL);
319
  return env->intern (env, "nil");
320 321
}

322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
static void
signal_errno (emacs_env *env, const char *function)
{
  const char *message = strerror (errno);
  emacs_value message_value = env->make_string (env, message, strlen (message));
  emacs_value symbol = env->intern (env, "file-error");
  emacs_value elements[2]
    = {env->make_string (env, function, strlen (function)), message_value};
  emacs_value data = env->funcall (env, env->intern (env, "list"), 2, elements);
  env->non_local_exit_signal (env, symbol, data);
}

/* A long-running operation that occasionally calls `should_quit' or
   `process_input'.  */

static emacs_value
Fmod_test_sleep_until (emacs_env *env, ptrdiff_t nargs, emacs_value *args,
                       void *data)
{
  assert (nargs == 2);
342
  const struct timespec until = env->extract_time (env, args[0]);
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
  if (env->non_local_exit_check (env))
    return NULL;
  const bool process_input = env->is_not_nil (env, args[1]);
  const struct timespec amount = make_timespec(0,  10000000);
  while (true)
    {
      const struct timespec now = current_timespec ();
      if (timespec_cmp (now, until) >= 0)
        break;
      if (nanosleep (&amount, NULL) && errno != EINTR)
        {
          signal_errno (env, "nanosleep");
          return NULL;
        }
      if ((process_input
           && env->process_input (env) == emacs_process_input_quit)
          || env->should_quit (env))
        return NULL;
    }
  return env->intern (env, "finished");
}
364

365 366 367 368 369 370 371 372 373 374 375 376
static emacs_value
Fmod_test_add_nanosecond (emacs_env *env, ptrdiff_t nargs, emacs_value *args,
                          void *data)
{
  assert (nargs == 1);
  struct timespec time = env->extract_time (env, args[0]);
  assert (time.tv_nsec >= 0);
  assert (time.tv_nsec < 2000000000);  /* possible leap second */
  time.tv_nsec++;
  return env->make_time (env, time);
}

377
static void
378
signal_error (emacs_env *env, const char *message)
379 380 381 382 383 384 385
{
  emacs_value data = env->make_string (env, message, strlen (message));
  env->non_local_exit_signal (env, env->intern (env, "error"),
                              env->funcall (env, env->intern (env, "list"), 1,
                                            &data));
}

386 387 388 389 390 391
static void
memory_full (emacs_env *env)
{
  signal_error (env, "Memory exhausted");
}

392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
enum
{
  max_count = ((SIZE_MAX < PTRDIFF_MAX ? SIZE_MAX : PTRDIFF_MAX)
               / sizeof (emacs_limb_t))
};

static bool
extract_big_integer (emacs_env *env, emacs_value arg, mpz_t result)
{
  int sign;
  ptrdiff_t count;
  bool success = env->extract_big_integer (env, arg, &sign, &count, NULL);
  if (!success)
    return false;
  if (sign == 0)
    {
      mpz_set_ui (result, 0);
      return true;
    }
411
  enum { order = -1, size = sizeof (emacs_limb_t), endian = 0, nails = 0 };
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
  assert (0 < count && count <= max_count);
  emacs_limb_t *magnitude = malloc (count * size);
  if (magnitude == NULL)
    {
      memory_full (env);
      return false;
    }
  success = env->extract_big_integer (env, arg, NULL, &count, magnitude);
  assert (success);
  mpz_import (result, count, order, size, endian, nails, magnitude);
  free (magnitude);
  if (sign < 0)
    mpz_neg (result, result);
  return true;
}

static emacs_value
make_big_integer (emacs_env *env, const mpz_t value)
{
  if (mpz_sgn (value) == 0)
    return env->make_integer (env, 0);
  /* See
     https://gmplib.org/manual/Integer-Import-and-Export.html#index-Export. */
  enum
  {
    order = -1,
    size = sizeof (emacs_limb_t),
    endian = 0,
    nails = 0,
    numb = 8 * size - nails
  };
  size_t count = (mpz_sizeinbase (value, 2) + numb - 1) / numb;
  if (max_count < count)
    {
      memory_full (env);
      return NULL;
    }
  emacs_limb_t *magnitude = malloc (count * size);
  if (magnitude == NULL)
    {
      memory_full (env);
      return NULL;
    }
  size_t written;
  mpz_export (magnitude, &written, order, size, endian, nails, value);
  assert (written == count);
  assert (count <= PTRDIFF_MAX);
  emacs_value result = env->make_big_integer (env, mpz_sgn (value),
                                              (ptrdiff_t) count, magnitude);
  free (magnitude);
  return result;
}

465 466 467 468
static emacs_value
Fmod_test_nanoseconds (emacs_env *env, ptrdiff_t nargs, emacs_value *args, void *data) {
  assert (nargs == 1);
  struct timespec time = env->extract_time (env, args[0]);
469
  mpz_t nanoseconds;
470
  assert (LONG_MIN <= time.tv_sec && time.tv_sec <= LONG_MAX);
471
  mpz_init_set_si (nanoseconds, time.tv_sec);
472 473 474
#ifdef __MINGW32__
  _Static_assert (1000000000 <= ULONG_MAX, "unsupported architecture");
#else
475
  static_assert (1000000000 <= ULONG_MAX, "unsupported architecture");
476
#endif
477
  mpz_mul_ui (nanoseconds, nanoseconds, 1000000000);
478
  assert (0 <= time.tv_nsec && time.tv_nsec <= ULONG_MAX);
479 480 481
  mpz_add_ui (nanoseconds, nanoseconds, time.tv_nsec);
  emacs_value result = make_big_integer (env, nanoseconds);
  mpz_clear (nanoseconds);
482 483 484
  return result;
}

485 486 487 488 489 490
static emacs_value
Fmod_test_double (emacs_env *env, ptrdiff_t nargs, emacs_value *args,
                  void *data)
{
  assert (nargs == 1);
  emacs_value arg = args[0];
491 492 493 494 495 496
  mpz_t value;
  mpz_init (value);
  extract_big_integer (env, arg, value);
  mpz_mul_ui (value, value, 2);
  emacs_value result = make_big_integer (env, value);
  mpz_clear (value);
497 498 499
  return result;
}

500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
static int function_data;
static int finalizer_calls_with_correct_data;
static int finalizer_calls_with_incorrect_data;

static void
finalizer (void *data)
{
  if (data == &function_data)
    ++finalizer_calls_with_correct_data;
  else
    ++finalizer_calls_with_incorrect_data;
}

static emacs_value
Fmod_test_make_function_with_finalizer (emacs_env *env, ptrdiff_t nargs,
                                        emacs_value *args, void *data)
{
  emacs_value fun
    = env->make_function (env, 2, 2, Fmod_test_sum, NULL, &function_data);
  env->set_function_finalizer (env, fun, finalizer);
  if (env->get_function_finalizer (env, fun) != finalizer)
    signal_error (env, "Invalid finalizer");
  return fun;
}

static emacs_value
Fmod_test_function_finalizer_calls (emacs_env *env, ptrdiff_t nargs,
                                    emacs_value *args, void *data)
{
  emacs_value Flist = env->intern (env, "list");
  emacs_value list_args[]
    = {env->make_integer (env, finalizer_calls_with_correct_data),
       env->make_integer (env, finalizer_calls_with_incorrect_data)};
  return env->funcall (env, Flist, 2, list_args);
}

536
/* Lisp utilities for easier readability (simple wrappers).  */
537

538 539 540
/* Provide FEATURE to Emacs.  */
static void
provide (emacs_env *env, const char *feature)
541 542 543 544 545 546 547 548
{
  emacs_value Qfeat = env->intern (env, feature);
  emacs_value Qprovide = env->intern (env, "provide");
  emacs_value args[] = { Qfeat };

  env->funcall (env, Qprovide, 1, args);
}

549 550 551
/* Bind NAME to FUN.  */
static void
bind_function (emacs_env *env, const char *name, emacs_value Sfun)
552
{
553
  emacs_value Qdefalias = env->intern (env, "defalias");
554 555 556
  emacs_value Qsym = env->intern (env, name);
  emacs_value args[] = { Qsym, Sfun };

557
  env->funcall (env, Qdefalias, 2, args);
558 559
}

560 561 562
/* Module init function.  */
int
emacs_module_init (struct emacs_runtime *ert)
563
{
564 565 566 567 568
  /* Check that EMACS_MAJOR_VERSION is defined and an integral
     constant.  */
  char dummy[EMACS_MAJOR_VERSION];
  assert (27 <= sizeof dummy);

569
  if (ert->size < sizeof *ert)
570
    {
571 572 573
      fprintf (stderr, "Runtime size of runtime structure (%"pT" bytes) "
               "smaller than compile-time size (%"pZ" bytes)",
               (T_TYPE) ert->size, (Z_TYPE) sizeof (*ert));
574 575
      return 1;
    }
576

577 578
  emacs_env *env = ert->get_environment (ert);

Philipp Stephani's avatar
Philipp Stephani committed
579
  if (env->size < sizeof *env)
580
    {
581 582 583
      fprintf (stderr, "Runtime size of environment structure (%"pT" bytes) "
               "smaller than compile-time size (%"pZ" bytes)",
               (T_TYPE) env->size, (Z_TYPE) sizeof (*env));
584 585
      return 2;
    }
586

587
#define DEFUN(lsym, csym, amin, amax, doc, data) \
588 589
  bind_function (env, lsym, \
		 env->make_function (env, amin, amax, csym, doc, data))
590 591

  DEFUN ("mod-test-return-t", Fmod_test_return_t, 1, 1, NULL, NULL);
592 593
  DEFUN ("mod-test-sum", Fmod_test_sum, 2, 2, "Return A + B\n\n(fn a b)",
         (void *) (uintptr_t) 0x1234);
594 595
  DEFUN ("mod-test-signal", Fmod_test_signal, 0, 0, NULL, NULL);
  DEFUN ("mod-test-throw", Fmod_test_throw, 0, 0, NULL, NULL);
596 597
  DEFUN ("mod-test-non-local-exit-funcall", Fmod_test_non_local_exit_funcall,
	 1, 1, NULL, NULL);
598
  DEFUN ("mod-test-globref-make", Fmod_test_globref_make, 0, 0, NULL, NULL);
599
  DEFUN ("mod-test-globref-free", Fmod_test_globref_free, 4, 4, NULL, NULL);
600 601 602 603 604
  DEFUN ("mod-test-string-a-to-b", Fmod_test_string_a_to_b, 1, 1, NULL, NULL);
  DEFUN ("mod-test-userptr-make", Fmod_test_userptr_make, 1, 1, NULL, NULL);
  DEFUN ("mod-test-userptr-get", Fmod_test_userptr_get, 1, 1, NULL, NULL);
  DEFUN ("mod-test-vector-fill", Fmod_test_vector_fill, 2, 2, NULL, NULL);
  DEFUN ("mod-test-vector-eq", Fmod_test_vector_eq, 2, 2, NULL, NULL);
605 606
  DEFUN ("mod-test-invalid-store", Fmod_test_invalid_store, 0, 0, NULL, NULL);
  DEFUN ("mod-test-invalid-load", Fmod_test_invalid_load, 0, 0, NULL, NULL);
607 608
  DEFUN ("mod-test-invalid-finalizer", Fmod_test_invalid_finalizer, 0, 0,
         NULL, NULL);
609
  DEFUN ("mod-test-sleep-until", Fmod_test_sleep_until, 2, 2, NULL, NULL);
610
  DEFUN ("mod-test-add-nanosecond", Fmod_test_add_nanosecond, 1, 1, NULL, NULL);
611
  DEFUN ("mod-test-nanoseconds", Fmod_test_nanoseconds, 1, 1, NULL, NULL);
612
  DEFUN ("mod-test-double", Fmod_test_double, 1, 1, NULL, NULL);
613 614 615 616
  DEFUN ("mod-test-make-function-with-finalizer",
         Fmod_test_make_function_with_finalizer, 0, 0, NULL, NULL);
  DEFUN ("mod-test-function-finalizer-calls",
         Fmod_test_function_finalizer_calls, 0, 0, NULL, NULL);
617 618 619 620 621 622

#undef DEFUN

  provide (env, "mod-test");
  return 0;
}