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

Paul Eggert's avatar
Paul Eggert committed
3
Copyright 2015-2019 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
#include <assert.h>
23 24
#include <errno.h>
#include <limits.h>
25
#include <stdio.h>
26
#include <stdlib.h>
27 28 29
#include <string.h>
#include <time.h>

30
#define EMACS_MODULE_GMP
31
#include <emacs-module.h>
32

33 34
#include <gmp.h>

35 36
#include "timespec.h"

37 38
int plugin_is_GPL_compatible;

39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
#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


63 64
/* Always return symbol 't'.  */
static emacs_value
65 66
Fmod_test_return_t (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		    void *data)
67 68 69 70
{
  return env->intern (env, "t");
}

71
/* Expose simple sum function.  */
72 73
static intmax_t
sum (intmax_t a, intmax_t b)
74 75 76 77
{
  return a + b;
}

78
static emacs_value
79
Fmod_test_sum (emacs_env *env, ptrdiff_t nargs, emacs_value args[], void *data)
80
{
81 82
  assert (nargs == 2);

83 84
  intmax_t a = env->extract_integer (env, args[0]);
  intmax_t b = env->extract_integer (env, args[1]);
85

86
  intmax_t r = sum (a, b);
87 88 89 90 91

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


92 93
/* Signal '(error 56).  */
static emacs_value
94 95
Fmod_test_signal (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		  void *data)
96 97
{
  assert (env->non_local_exit_check (env) == emacs_funcall_exit_return);
98 99
  env->non_local_exit_signal (env, env->intern (env, "error"),
			      env->make_integer (env, 56));
100
  return NULL;
101 102 103
}


104 105
/* Throw '(tag 65).  */
static emacs_value
106 107
Fmod_test_throw (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		 void *data)
108 109
{
  assert (env->non_local_exit_check (env) == emacs_funcall_exit_return);
110 111
  env->non_local_exit_throw (env, env->intern (env, "tag"),
			     env->make_integer (env, 65));
112
  return NULL;
113 114 115
}


116 117 118
/* Call argument function, catch all non-local exists and return
   either normal result or a list describing the non-local exit.  */
static emacs_value
119 120
Fmod_test_non_local_exit_funcall (emacs_env *env, ptrdiff_t nargs,
				  emacs_value args[], void *data)
121 122
{
  assert (nargs == 1);
Paul Eggert's avatar
Paul Eggert committed
123
  emacs_value result = env->funcall (env, args[0], 0, NULL);
124
  emacs_value non_local_exit_symbol, non_local_exit_data;
125 126 127
  enum emacs_funcall_exit code
    = env->non_local_exit_get (env, &non_local_exit_symbol,
			       &non_local_exit_data);
128 129 130 131 132 133 134
  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
135
        emacs_value Flist = env->intern (env, "list");
136 137
        emacs_value list_args[] = {env->intern (env, "signal"),
				   non_local_exit_symbol, non_local_exit_data};
138 139 140 141 142
        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
143
        emacs_value Flist = env->intern (env, "list");
144 145
        emacs_value list_args[] = {env->intern (env, "throw"),
				   non_local_exit_symbol, non_local_exit_data};
146 147 148
        return env->funcall (env, Flist, 3, list_args);
      }
    }
149 150

  /* Never reached.  */
151 152 153 154
  return env->intern (env, "nil");;
}


Paul Eggert's avatar
Paul Eggert committed
155
/* Return a global reference.  */
156
static emacs_value
157
Fmod_test_globref_make (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
158
			void *data)
159
{
160 161
  /* Make a big string and make it global.  */
  char str[26 * 100];
162
  for (int i = 0; i < sizeof str; i++)
163
    str[i] = 'a' + (i % 26);
164

165 166
  /* We don't need to null-terminate str.  */
  emacs_value lisp_str = env->make_string (env, str, sizeof str);
167 168 169
  return env->make_global_ref (env, lisp_str);
}

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
/* 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");
}


188

189 190 191
/* Return a copy of the argument string where every 'a' is replaced
   with 'b'.  */
static emacs_value
192
Fmod_test_string_a_to_b (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
193
			 void *data)
194 195
{
  emacs_value lisp_str = args[0];
196
  ptrdiff_t size = 0;
197 198 199 200 201 202
  char * buf = NULL;

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

203
  for (ptrdiff_t i = 0; i + 1 < size; i++)
204 205 206
    if (buf[i] == 'a')
      buf[i] = 'b';

207
  return env->make_string (env, buf, size - 1);
208 209 210
}


211
/* Embedded pointers in lisp objects.  */
212

213
/* C struct (pointer to) that will be embedded.  */
214 215 216 217 218 219
struct super_struct
{
  int amazing_int;
  char large_unused_buffer[512];
};

220 221 222
/* Return a new user-pointer to a super_struct, with amazing_int set
   to the passed parameter.  */
static emacs_value
223
Fmod_test_userptr_make (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
224
			void *data)
225
{
226
  struct super_struct *p = calloc (1, sizeof *p);
227
  p->amazing_int = env->extract_integer (env, args[0]);
228
  return env->make_user_ptr (env, free, p);
229 230
}

231 232
/* Return the amazing_int of a passed 'user-pointer to a super_struct'.  */
static emacs_value
233 234
Fmod_test_userptr_get (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		       void *data)
235 236 237 238 239 240
{
  struct super_struct *p = env->get_user_ptr (env, args[0]);
  return env->make_integer (env, p->amazing_int);
}


241 242
/* Fill vector in args[0] with value in args[1].  */
static emacs_value
243 244
Fmod_test_vector_fill (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		       void *data)
245 246 247
{
  emacs_value vec = args[0];
  emacs_value val = args[1];
248 249
  ptrdiff_t size = env->vec_size (env, vec);
  for (ptrdiff_t i = 0; i < size; i++)
250 251 252 253 254
    env->vec_set (env, vec, i, val);
  return env->intern (env, "t");
}


255 256 257
/* Return whether all elements of vector in args[0] are 'eq' to value
   in args[1].  */
static emacs_value
258 259
Fmod_test_vector_eq (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		     void *data)
260 261 262
{
  emacs_value vec = args[0];
  emacs_value val = args[1];
263 264
  ptrdiff_t size = env->vec_size (env, vec);
  for (ptrdiff_t i = 0; i < size; i++)
265 266 267 268 269
    if (!env->eq (env, env->vec_get (env, vec, i), val))
        return env->intern (env, "nil");
  return env->intern (env, "t");
}

270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
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;
}

292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
/* 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);
310
  return env->intern (env, "nil");
311 312
}

313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
static void
signal_wrong_type_argument (emacs_env *env, const char *predicate,
                            emacs_value arg)
{
  emacs_value symbol = env->intern (env, "wrong-type-argument");
  emacs_value elements[2] = {env->intern (env, predicate), arg};
  emacs_value data = env->funcall (env, env->intern (env, "list"), 2, elements);
  env->non_local_exit_signal (env, symbol, data);
}

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);
  const double until_seconds = env->extract_float (env, args[0]);
  if (env->non_local_exit_check (env))
    return NULL;
  if (until_seconds <= 0)
    {
      signal_wrong_type_argument (env, "cl-plusp", args[0]);
      return NULL;
    }
  const bool process_input = env->is_not_nil (env, args[1]);
  const struct timespec until = dtotimespec (until_seconds);
  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");
}
371

372 373 374 375 376 377 378 379 380 381 382 383
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);
}

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
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];
  struct emacs_mpz value;
  mpz_init (value.value);
  env->extract_big_integer (env, arg, &value);
  mpz_mul_ui (value.value, value.value, 2);
  emacs_value result = env->make_big_integer (env, &value);
  mpz_clear (value.value);
  return result;
}

399
/* Lisp utilities for easier readability (simple wrappers).  */
400

401 402 403
/* Provide FEATURE to Emacs.  */
static void
provide (emacs_env *env, const char *feature)
404 405 406 407 408 409 410 411
{
  emacs_value Qfeat = env->intern (env, feature);
  emacs_value Qprovide = env->intern (env, "provide");
  emacs_value args[] = { Qfeat };

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

412 413 414
/* Bind NAME to FUN.  */
static void
bind_function (emacs_env *env, const char *name, emacs_value Sfun)
415
{
416
  emacs_value Qdefalias = env->intern (env, "defalias");
417 418 419
  emacs_value Qsym = env->intern (env, name);
  emacs_value args[] = { Qsym, Sfun };

420
  env->funcall (env, Qdefalias, 2, args);
421 422
}

423 424 425
/* Module init function.  */
int
emacs_module_init (struct emacs_runtime *ert)
426
{
427
  if (ert->size < sizeof *ert)
428
    {
429 430 431
      fprintf (stderr, "Runtime size of runtime structure (%"pT" bytes) "
               "smaller than compile-time size (%"pZ" bytes)",
               (T_TYPE) ert->size, (Z_TYPE) sizeof (*ert));
432 433
      return 1;
    }
434

435 436
  emacs_env *env = ert->get_environment (ert);

Philipp Stephani's avatar
Philipp Stephani committed
437
  if (env->size < sizeof *env)
438
    {
439 440 441
      fprintf (stderr, "Runtime size of environment structure (%"pT" bytes) "
               "smaller than compile-time size (%"pZ" bytes)",
               (T_TYPE) env->size, (Z_TYPE) sizeof (*env));
442 443
      return 2;
    }
444

445
#define DEFUN(lsym, csym, amin, amax, doc, data) \
446 447
  bind_function (env, lsym, \
		 env->make_function (env, amin, amax, csym, doc, data))
448 449

  DEFUN ("mod-test-return-t", Fmod_test_return_t, 1, 1, NULL, NULL);
450
  DEFUN ("mod-test-sum", Fmod_test_sum, 2, 2, "Return A + B\n\n(fn a b)", NULL);
451 452
  DEFUN ("mod-test-signal", Fmod_test_signal, 0, 0, NULL, NULL);
  DEFUN ("mod-test-throw", Fmod_test_throw, 0, 0, NULL, NULL);
453 454
  DEFUN ("mod-test-non-local-exit-funcall", Fmod_test_non_local_exit_funcall,
	 1, 1, NULL, NULL);
455
  DEFUN ("mod-test-globref-make", Fmod_test_globref_make, 0, 0, NULL, NULL);
456
  DEFUN ("mod-test-globref-free", Fmod_test_globref_free, 4, 4, NULL, NULL);
457 458 459 460 461
  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);
462 463
  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);
464 465
  DEFUN ("mod-test-invalid-finalizer", Fmod_test_invalid_finalizer, 0, 0,
         NULL, NULL);
466
  DEFUN ("mod-test-sleep-until", Fmod_test_sleep_until, 2, 2, NULL, NULL);
467
  DEFUN ("mod-test-add-nanosecond", Fmod_test_add_nanosecond, 1, 1, NULL, NULL);
468
  DEFUN ("mod-test-double", Fmod_test_double, 1, 1, NULL, NULL);
469 470 471 472 473 474

#undef DEFUN

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