mod-test.c 13.2 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
#include <emacs-module.h>
31

32 33
#include "timespec.h"

34 35
int plugin_is_GPL_compatible;

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


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

68
/* Expose simple sum function.  */
69 70
static intmax_t
sum (intmax_t a, intmax_t b)
71 72 73 74
{
  return a + b;
}

75
static emacs_value
76
Fmod_test_sum (emacs_env *env, ptrdiff_t nargs, emacs_value args[], void *data)
77
{
78 79
  assert (nargs == 2);

80 81
  intmax_t a = env->extract_integer (env, args[0]);
  intmax_t b = env->extract_integer (env, args[1]);
82

83
  intmax_t r = sum (a, b);
84 85 86 87 88

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


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


101 102
/* Throw '(tag 65).  */
static emacs_value
103 104
Fmod_test_throw (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_throw (env, env->intern (env, "tag"),
			     env->make_integer (env, 65));
109
  return NULL;
110 111 112
}


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

  /* Never reached.  */
148 149 150 151
  return env->intern (env, "nil");;
}


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

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

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


185

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

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

200
  for (ptrdiff_t i = 0; i + 1 < size; i++)
201 202 203
    if (buf[i] == 'a')
      buf[i] = 'b';

204
  return env->make_string (env, buf, size - 1);
205 206 207
}


208
/* Embedded pointers in lisp objects.  */
209

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

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

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


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


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

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

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

310 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
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");
}
368

369 370 371 372 373 374 375 376 377 378 379 380
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);
}

381
/* Lisp utilities for easier readability (simple wrappers).  */
382

383 384 385
/* Provide FEATURE to Emacs.  */
static void
provide (emacs_env *env, const char *feature)
386 387 388 389 390 391 392 393
{
  emacs_value Qfeat = env->intern (env, feature);
  emacs_value Qprovide = env->intern (env, "provide");
  emacs_value args[] = { Qfeat };

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

394 395 396
/* Bind NAME to FUN.  */
static void
bind_function (emacs_env *env, const char *name, emacs_value Sfun)
397
{
398
  emacs_value Qdefalias = env->intern (env, "defalias");
399 400 401
  emacs_value Qsym = env->intern (env, name);
  emacs_value args[] = { Qsym, Sfun };

402
  env->funcall (env, Qdefalias, 2, args);
403 404
}

405 406 407
/* Module init function.  */
int
emacs_module_init (struct emacs_runtime *ert)
408
{
409
  if (ert->size < sizeof *ert)
410
    {
411 412 413
      fprintf (stderr, "Runtime size of runtime structure (%"pT" bytes) "
               "smaller than compile-time size (%"pZ" bytes)",
               (T_TYPE) ert->size, (Z_TYPE) sizeof (*ert));
414 415
      return 1;
    }
416

417 418
  emacs_env *env = ert->get_environment (ert);

Philipp Stephani's avatar
Philipp Stephani committed
419
  if (env->size < sizeof *env)
420
    {
421 422 423
      fprintf (stderr, "Runtime size of environment structure (%"pT" bytes) "
               "smaller than compile-time size (%"pZ" bytes)",
               (T_TYPE) env->size, (Z_TYPE) sizeof (*env));
424 425
      return 2;
    }
426

427
#define DEFUN(lsym, csym, amin, amax, doc, data) \
428 429
  bind_function (env, lsym, \
		 env->make_function (env, amin, amax, csym, doc, data))
430 431

  DEFUN ("mod-test-return-t", Fmod_test_return_t, 1, 1, NULL, NULL);
432
  DEFUN ("mod-test-sum", Fmod_test_sum, 2, 2, "Return A + B\n\n(fn a b)", NULL);
433 434
  DEFUN ("mod-test-signal", Fmod_test_signal, 0, 0, NULL, NULL);
  DEFUN ("mod-test-throw", Fmod_test_throw, 0, 0, NULL, NULL);
435 436
  DEFUN ("mod-test-non-local-exit-funcall", Fmod_test_non_local_exit_funcall,
	 1, 1, NULL, NULL);
437
  DEFUN ("mod-test-globref-make", Fmod_test_globref_make, 0, 0, NULL, NULL);
438
  DEFUN ("mod-test-globref-free", Fmod_test_globref_free, 4, 4, NULL, NULL);
439 440 441 442 443
  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);
444 445
  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);
446 447
  DEFUN ("mod-test-invalid-finalizer", Fmod_test_invalid_finalizer, 0, 0,
         NULL, NULL);
448
  DEFUN ("mod-test-sleep-until", Fmod_test_sleep_until, 2, 2, NULL, NULL);
449
  DEFUN ("mod-test-add-nanosecond", Fmod_test_add_nanosecond, 1, 1, NULL, NULL);
450 451 452 453 454 455

#undef DEFUN

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