sys/arm64/linux/linux_sysvec.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 1994-1996 Søren Schmidt
   5  * Copyright (c) 2018 Turing Robotic Industries Inc.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #include <sys/cdefs.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 #include <sys/param.h>
  33 #include <sys/systm.h>
  34 #include <sys/cdefs.h>
  35 #include <sys/elf.h>
  36 #include <sys/exec.h>
  37 #include <sys/imgact.h>
  38 #include <sys/imgact_elf.h>
  39 #include <sys/kernel.h>
  40 #include <sys/lock.h>
  41 #include <sys/module.h>
  42 #include <sys/mutex.h>
  43 #include <sys/proc.h>
  44 #include <sys/signalvar.h>
  45 #include <sys/sysctl.h>
  46 #include <sys/sysent.h>
  47
  48 #include <vm/vm_param.h>
  49
  50 #include <arm64/linux/linux.h>
  51 #include <arm64/linux/linux_proto.h>
  52 #include <compat/linux/linux_dtrace.h>
  53 #include <compat/linux/linux_emul.h>
  54 #include <compat/linux/linux_ioctl.h>
  55 #include <compat/linux/linux_mib.h>
  56 #include <compat/linux/linux_misc.h>
  57 #include <compat/linux/linux_vdso.h>
  58
  59 MODULE_VERSION(linux64elf, 1);
  60
  61 const char *linux_kplatform;
  62 static int linux_szsigcode;
  63 static vm_object_t linux_shared_page_obj;
  64 static char *linux_shared_page_mapping;
  65 extern char _binary_linux_locore_o_start;
  66 extern char _binary_linux_locore_o_end;
  67
  68 extern struct sysent linux_sysent[LINUX_SYS_MAXSYSCALL];
  69
  70 SET_DECLARE(linux_ioctl_handler_set, struct linux_ioctl_handler);
  71
  72 static register_t *linux_copyout_strings(struct image_params *imgp);
  73 static int      linux_elf_fixup(register_t **stack_base,
  74                     struct image_params *iparams);
  75 static bool     linux_trans_osrel(const Elf_Note *note, int32_t *osrel);
  76 static void     linux_vdso_install(const void *param);
  77 static void     linux_vdso_deinstall(const void *param);
  78 static void     linux_set_syscall_retval(struct thread *td, int error);
  79 static int      linux_fetch_syscall_args(struct thread *td);
  80 static void     linux_exec_setregs(struct thread *td, struct image_params *imgp,
  81                     u_long stack);
  82 static int      linux_vsyscall(struct thread *td);
  83
  84 /* DTrace init */
  85 LIN_SDT_PROVIDER_DECLARE(LINUX_DTRACE);
  86
  87 /* DTrace probes */
  88 LIN_SDT_PROBE_DEFINE2(sysvec, linux_translate_traps, todo, "int", "int");
  89 LIN_SDT_PROBE_DEFINE0(sysvec, linux_exec_setregs, todo);
  90 LIN_SDT_PROBE_DEFINE0(sysvec, linux_copyout_auxargs, todo);
  91 LIN_SDT_PROBE_DEFINE0(sysvec, linux_elf_fixup, todo);
  92 LIN_SDT_PROBE_DEFINE0(sysvec, linux_rt_sigreturn, todo);
  93 LIN_SDT_PROBE_DEFINE0(sysvec, linux_rt_sendsig, todo);
  94 LIN_SDT_PROBE_DEFINE0(sysvec, linux_vsyscall, todo);
  95 LIN_SDT_PROBE_DEFINE0(sysvec, linux_vdso_install, todo);
  96 LIN_SDT_PROBE_DEFINE0(sysvec, linux_vdso_deinstall, todo);
  97
  98 /* LINUXTODO: do we have traps to translate? */
  99 static int
 100 linux_translate_traps(int signal, int trap_code)
 101 {
 102
 103         LIN_SDT_PROBE2(sysvec, linux_translate_traps, todo, signal, trap_code);
 104         return (signal);
 105 }
 106
 107 LINUX_VDSO_SYM_CHAR(linux_platform);
 108
 109 static int
 110 linux_fetch_syscall_args(struct thread *td)
 111 {
 112         struct proc *p;
 113         struct syscall_args *sa;
 114         register_t *ap;
 115
 116         p = td->td_proc;
 117         ap = td->td_frame->tf_x;
 118         sa = &td->td_sa;
 119
 120         sa->code = td->td_frame->tf_x[8];
 121         /* LINUXTODO: generic syscall? */
 122         if (sa->code >= p->p_sysent->sv_size)
 123                 sa->callp = &p->p_sysent->sv_table[0];
 124         else
 125                 sa->callp = &p->p_sysent->sv_table[sa->code];
 126
 127         sa->narg = sa->callp->sy_narg;
 128         if (sa->narg > 8)
 129                 panic("ARM64TODO: Could we have more than 8 args?");
 130         memcpy(sa->args, ap, 8 * sizeof(register_t));
 131
 132         td->td_retval[0] = 0;
 133         return (0);
 134 }
 135
 136 static void
 137 linux_set_syscall_retval(struct thread *td, int error)
 138 {
 139
 140         td->td_retval[1] = td->td_frame->tf_x[1];
 141         cpu_set_syscall_retval(td, error);
 142 }
 143
 144 static void
 145 linux_copyout_auxargs(struct image_params *imgp, u_long *base)
 146 {
 147         Elf_Auxargs *args;
 148         Elf_Auxinfo *argarray, *pos;
 149         u_long auxlen;
 150         struct proc *p;
 151         int issetugid;
 152
 153         LIN_SDT_PROBE0(sysvec, linux_copyout_auxargs, todo);
 154         p = imgp->proc;
 155
 156         args = (Elf64_Auxargs *)imgp->auxargs;
 157         argarray = pos = malloc(LINUX_AT_COUNT * sizeof(*pos), M_TEMP,
 158             M_WAITOK | M_ZERO);
 159
 160         issetugid = p->p_flag & P_SUGID ? 1 : 0;
 161         AUXARGS_ENTRY(pos, LINUX_AT_SYSINFO_EHDR,
 162             imgp->proc->p_sysent->sv_shared_page_base);
 163 #if 0   /* LINUXTODO: implement arm64 LINUX_AT_HWCAP */
 164         AUXARGS_ENTRY(pos, LINUX_AT_HWCAP, cpu_feature);
 165 #endif
 166         AUXARGS_ENTRY(pos, LINUX_AT_CLKTCK, stclohz);
 167         AUXARGS_ENTRY(pos, AT_PHDR, args->phdr);
 168         AUXARGS_ENTRY(pos, AT_PHENT, args->phent);
 169         AUXARGS_ENTRY(pos, AT_PHNUM, args->phnum);
 170         AUXARGS_ENTRY(pos, AT_PAGESZ, args->pagesz);
 171         AUXARGS_ENTRY(pos, AT_BASE, args->base);
 172         AUXARGS_ENTRY(pos, AT_FLAGS, args->flags);
 173         AUXARGS_ENTRY(pos, AT_ENTRY, args->entry);
 174         AUXARGS_ENTRY(pos, AT_UID, imgp->proc->p_ucred->cr_ruid);
 175         AUXARGS_ENTRY(pos, AT_EUID, imgp->proc->p_ucred->cr_svuid);
 176         AUXARGS_ENTRY(pos, AT_GID, imgp->proc->p_ucred->cr_rgid);
 177         AUXARGS_ENTRY(pos, AT_EGID, imgp->proc->p_ucred->cr_svgid);
 178         AUXARGS_ENTRY(pos, LINUX_AT_SECURE, issetugid);
 179 #if 0   /* LINUXTODO: implement arm64 LINUX_AT_PLATFORM */
 180         AUXARGS_ENTRY(pos, LINUX_AT_PLATFORM, PTROUT(linux_platform));
 181 #endif
 182         AUXARGS_ENTRY(pos, LINUX_AT_RANDOM, imgp->canary);
 183         if (imgp->execpathp != 0)
 184                 AUXARGS_ENTRY(pos, LINUX_AT_EXECFN, imgp->execpathp);
 185         if (args->execfd != -1)
 186                 AUXARGS_ENTRY(pos, AT_EXECFD, args->execfd);
 187         AUXARGS_ENTRY(pos, AT_NULL, 0);
 188         free(imgp->auxargs, M_TEMP);
 189         imgp->auxargs = NULL;
 190         KASSERT(pos - argarray <= LINUX_AT_COUNT, ("Too many auxargs"));
 191
 192         auxlen = sizeof(*argarray) * (pos - argarray);
 193         *base -= auxlen;
 194         copyout(argarray, (void *)*base, auxlen);
 195         free(argarray, M_TEMP);
 196 }
 197
 198 static int
 199 linux_elf_fixup(register_t **stack_base, struct image_params *imgp)
 200 {
 201
 202         LIN_SDT_PROBE0(sysvec, linux_elf_fixup, todo);
 203
 204         return (0);
 205 }
 206
 207 /*
 208  * Copy strings out to the new process address space, constructing new arg
 209  * and env vector tables. Return a pointer to the base so that it can be used
 210  * as the initial stack pointer.
 211  * LINUXTODO: deduplicate against other linuxulator archs
 212  */
 213 static register_t *
 214 linux_copyout_strings(struct image_params *imgp)
 215 {
 216         char **vectp;
 217         char *stringp, *destp;
 218         register_t *stack_base;
 219         struct ps_strings *arginfo;
 220         char canary[LINUX_AT_RANDOM_LEN];
 221         size_t execpath_len;
 222         struct proc *p;
 223         int argc, envc;
 224
 225         /* Calculate string base and vector table pointers. */
 226         if (imgp->execpath != NULL && imgp->auxargs != NULL)
 227                 execpath_len = strlen(imgp->execpath) + 1;
 228         else
 229                 execpath_len = 0;
 230
 231         p = imgp->proc;
 232         arginfo = (struct ps_strings *)p->p_sysent->sv_psstrings;
 233         destp = (caddr_t)arginfo - SPARE_USRSPACE -
 234             roundup(sizeof(canary), sizeof(char *)) -
 235             roundup(execpath_len, sizeof(char *)) -
 236             roundup(ARG_MAX - imgp->args->stringspace, sizeof(char *));
 237
 238         if (execpath_len != 0) {
 239                 imgp->execpathp = (uintptr_t)arginfo - execpath_len;
 240                 copyout(imgp->execpath, (void *)imgp->execpathp, execpath_len);
 241         }
 242
 243         /* Prepare the canary for SSP. */
 244         arc4rand(canary, sizeof(canary), 0);
 245         imgp->canary = (uintptr_t)arginfo -
 246             roundup(execpath_len, sizeof(char *)) -
 247             roundup(sizeof(canary), sizeof(char *));
 248         copyout(canary, (void *)imgp->canary, sizeof(canary));
 249
 250         vectp = (char **)destp;
 251         if (imgp->auxargs)
 252                 imgp->sysent->sv_copyout_auxargs(imgp, (u_long *)&vectp);
 253
 254         /*
 255          * Allocate room for argc and the argv[] and env vectors including the
 256          * terminating NULL pointers.
 257          */
 258         vectp -= 1 + imgp->args->argc + 1 + imgp->args->envc + 1;
 259         vectp = (char **)STACKALIGN(vectp);
 260
 261         /* vectp also becomes our initial stack base. */
 262         stack_base = (register_t *)vectp;
 263
 264         stringp = imgp->args->begin_argv;
 265         argc = imgp->args->argc;
 266         envc = imgp->args->envc;
 267
 268         /* Copy out strings - arguments and environment. */
 269         copyout(stringp, destp, ARG_MAX - imgp->args->stringspace);
 270
 271         /* Fill in "ps_strings" struct for ps, w, etc. */
 272         suword(&arginfo->ps_argvstr, (long)(intptr_t)vectp);
 273         suword(&arginfo->ps_nargvstr, argc);
 274
 275         suword(vectp++, argc);
 276         /* Fill in argument portion of vector table. */
 277         for (; argc > 0; --argc) {
 278                 suword(vectp++, (long)(intptr_t)destp);
 279                 while (*stringp++ != 0)
 280                         destp++;
 281                 destp++;
 282         }
 283
 284         /* A null vector table pointer separates the argp's from the envp's. */
 285         suword(vectp++, 0);
 286
 287         suword(&arginfo->ps_envstr, (long)(intptr_t)vectp);
 288         suword(&arginfo->ps_nenvstr, envc);
 289
 290         /* Fill in environment portion of vector table. */
 291         for (; envc > 0; --envc) {
 292                 suword(vectp++, (long)(intptr_t)destp);
 293                 while (*stringp++ != 0)
 294                         destp++;
 295                 destp++;
 296         }
 297
 298         /* The end of the vector table is a null pointer. */
 299         suword(vectp, 0);
 300         return (stack_base);
 301 }
 302
 303 /*
 304  * Reset registers to default values on exec.
 305  */
 306 static void
 307 linux_exec_setregs(struct thread *td, struct image_params *imgp, u_long stack)
 308 {
 309         struct trapframe *regs = td->td_frame;
 310
 311         /* LINUXTODO: validate */
 312         LIN_SDT_PROBE0(sysvec, linux_exec_setregs, todo);
 313
 314         memset(regs, 0, sizeof(*regs));
 315         /* glibc start.S registers function pointer in x0 with atexit. */
 316         regs->tf_sp = stack;
 317 #if 0   /* LINUXTODO: See if this is used. */
 318         regs->tf_lr = imgp->entry_addr;
 319 #else
 320         regs->tf_lr = 0xffffffffffffffff;
 321 #endif
 322         regs->tf_elr = imgp->entry_addr;
 323 }
 324
 325 int
 326 linux_rt_sigreturn(struct thread *td, struct linux_rt_sigreturn_args *args)
 327 {
 328
 329         /* LINUXTODO: implement */
 330         LIN_SDT_PROBE0(sysvec, linux_rt_sigreturn, todo);
 331         return (EDOOFUS);
 332 }
 333
 334 static void
 335 linux_rt_sendsig(sig_t catcher, ksiginfo_t *ksi, sigset_t *mask)
 336 {
 337
 338         /* LINUXTODO: implement */
 339         LIN_SDT_PROBE0(sysvec, linux_rt_sendsig, todo);
 340 }
 341
 342 static int
 343 linux_vsyscall(struct thread *td)
 344 {
 345
 346         /* LINUXTODO: implement */
 347         LIN_SDT_PROBE0(sysvec, linux_vsyscall, todo);
 348         return (EDOOFUS);
 349 }
 350
 351 struct sysentvec elf_linux_sysvec = {
 352         .sv_size        = LINUX_SYS_MAXSYSCALL,
 353         .sv_table       = linux_sysent,
 354         .sv_errsize     = ELAST + 1,
 355         .sv_errtbl      = linux_errtbl,
 356         .sv_transtrap   = linux_translate_traps,
 357         .sv_fixup       = linux_elf_fixup,
 358         .sv_sendsig     = linux_rt_sendsig,
 359         .sv_sigcode     = &_binary_linux_locore_o_start,
 360         .sv_szsigcode   = &linux_szsigcode,
 361         .sv_name        = "Linux ELF64",
 362         .sv_coredump    = elf64_coredump,
 363         .sv_imgact_try  = linux_exec_imgact_try,
 364         .sv_minsigstksz = LINUX_MINSIGSTKSZ,
 365         .sv_minuser     = VM_MIN_ADDRESS,
 366         .sv_maxuser     = VM_MAXUSER_ADDRESS,
 367         .sv_usrstack    = USRSTACK,
 368         .sv_psstrings   = PS_STRINGS, /* XXX */
 369         .sv_stackprot   = VM_PROT_READ | VM_PROT_WRITE,
 370         .sv_copyout_auxargs = linux_copyout_auxargs,
 371         .sv_copyout_strings = linux_copyout_strings,
 372         .sv_setregs     = linux_exec_setregs,
 373         .sv_fixlimit    = NULL,
 374         .sv_maxssiz     = NULL,
 375         .sv_flags       = SV_ABI_LINUX | SV_LP64 | SV_SHP,
 376         .sv_set_syscall_retval = linux_set_syscall_retval,
 377         .sv_fetch_syscall_args = linux_fetch_syscall_args,
 378         .sv_syscallnames = NULL,
 379         .sv_shared_page_base = SHAREDPAGE,
 380         .sv_shared_page_len = PAGE_SIZE,
 381         .sv_schedtail   = linux_schedtail,
 382         .sv_thread_detach = linux_thread_detach,
 383         .sv_trap        = linux_vsyscall,
 384 };
 385
 386 static void
 387 linux_vdso_install(const void *param)
 388 {
 389
 390         linux_szsigcode = (&_binary_linux_locore_o_end -
 391             &_binary_linux_locore_o_start);
 392
 393         if (linux_szsigcode > elf_linux_sysvec.sv_shared_page_len)
 394                 panic("invalid Linux VDSO size\n");
 395
 396         __elfN(linux_vdso_fixup)(&elf_linux_sysvec);
 397
 398         linux_shared_page_obj = __elfN(linux_shared_page_init)
 399             (&linux_shared_page_mapping);
 400
 401         __elfN(linux_vdso_reloc)(&elf_linux_sysvec);
 402
 403         memcpy(linux_shared_page_mapping, elf_linux_sysvec.sv_sigcode,
 404             linux_szsigcode);
 405         elf_linux_sysvec.sv_shared_page_obj = linux_shared_page_obj;
 406
 407         printf("LINUXTODO: %s: fix linux_kplatform\n", __func__);
 408 #if 0
 409         linux_kplatform = linux_shared_page_mapping +
 410             (linux_platform - (caddr_t)elf_linux_sysvec.sv_shared_page_base);
 411 #else
 412         linux_kplatform = "arm64";
 413 #endif
 414 }
 415 SYSINIT(elf_linux_vdso_init, SI_SUB_EXEC, SI_ORDER_ANY,
 416     linux_vdso_install, NULL);
 417
 418 static void
 419 linux_vdso_deinstall(const void *param)
 420 {
 421
 422         LIN_SDT_PROBE0(sysvec, linux_vdso_deinstall, todo);
 423         __elfN(linux_shared_page_fini)(linux_shared_page_obj);
 424 }
 425 SYSUNINIT(elf_linux_vdso_uninit, SI_SUB_EXEC, SI_ORDER_FIRST,
 426     linux_vdso_deinstall, NULL);
 427
 428 static char GNU_ABI_VENDOR[] = "GNU";
 429 static int GNU_ABI_LINUX = 0;
 430
 431 /* LINUXTODO: deduplicate */
 432 static bool
 433 linux_trans_osrel(const Elf_Note *note, int32_t *osrel)
 434 {
 435         const Elf32_Word *desc;
 436         uintptr_t p;
 437
 438         p = (uintptr_t)(note + 1);
 439         p += roundup2(note->n_namesz, sizeof(Elf32_Addr));
 440
 441         desc = (const Elf32_Word *)p;
 442         if (desc[0] != GNU_ABI_LINUX)
 443                 return (false);
 444
 445         *osrel = LINUX_KERNVER(desc[1], desc[2], desc[3]);
 446         return (true);
 447 }
 448
 449 static Elf_Brandnote linux64_brandnote = {
 450         .hdr.n_namesz   = sizeof(GNU_ABI_VENDOR),
 451         .hdr.n_descsz   = 16,
 452         .hdr.n_type     = 1,
 453         .vendor         = GNU_ABI_VENDOR,
 454         .flags          = BN_TRANSLATE_OSREL,
 455         .trans_osrel    = linux_trans_osrel
 456 };
 457
 458 static Elf64_Brandinfo linux_glibc2brand = {
 459         .brand          = ELFOSABI_LINUX,
 460         .machine        = EM_AARCH64,
 461         .compat_3_brand = "Linux",
 462         .emul_path      = "/compat/linux",
 463         .interp_path    = "/lib64/ld-linux-x86-64.so.2",
 464         .sysvec         = &elf_linux_sysvec,
 465         .interp_newpath = NULL,
 466         .brand_note     = &linux64_brandnote,
 467         .flags          = BI_CAN_EXEC_DYN | BI_BRAND_NOTE
 468 };
 469
 470 Elf64_Brandinfo *linux_brandlist[] = {
 471         &linux_glibc2brand,
 472         NULL
 473 };
 474
 475 static int
 476 linux64_elf_modevent(module_t mod, int type, void *data)
 477 {
 478         Elf64_Brandinfo **brandinfo;
 479         struct linux_ioctl_handler**lihp;
 480         int error;
 481
 482         error = 0;
 483         switch(type) {
 484         case MOD_LOAD:
 485                 for (brandinfo = &linux_brandlist[0]; *brandinfo != NULL;
 486                     ++brandinfo)
 487                         if (elf64_insert_brand_entry(*brandinfo) < 0)
 488                                 error = EINVAL;
 489                 if (error == 0) {
 490                         SET_FOREACH(lihp, linux_ioctl_handler_set)
 491                                 linux_ioctl_register_handler(*lihp);
 492                         stclohz = (stathz ? stathz : hz);
 493                         if (bootverbose)
 494                                 printf("Linux arm64 ELF exec handler installed\n");
 495                 }
 496                 break;
 497         case MOD_UNLOAD:
 498                 for (brandinfo = &linux_brandlist[0]; *brandinfo != NULL;
 499                     ++brandinfo)
 500                         if (elf64_brand_inuse(*brandinfo))
 501                                 error = EBUSY;
 502                 if (error == 0) {
 503                         for (brandinfo = &linux_brandlist[0];
 504                             *brandinfo != NULL; ++brandinfo)
 505                                 if (elf64_remove_brand_entry(*brandinfo) < 0)
 506                                         error = EINVAL;
 507                 }
 508                 if (error == 0) {
 509                         SET_FOREACH(lihp, linux_ioctl_handler_set)
 510                                 linux_ioctl_unregister_handler(*lihp);
 511                         if (bootverbose)
 512                                 printf("Linux ELF exec handler removed\n");
 513                 } else
 514                         printf("Could not deinstall ELF interpreter entry\n");
 515                 break;
 516         default:
 517                 return (EOPNOTSUPP);
 518         }
 519         return (error);
 520 }
 521
 522 static moduledata_t linux64_elf_mod = {
 523         "linux64elf",
 524         linux64_elf_modevent,
 525         0
 526 };
 527
 528 DECLARE_MODULE_TIED(linux64elf, linux64_elf_mod, SI_SUB_EXEC, SI_ORDER_ANY);
 529 MODULE_DEPEND(linux64elf, linux_common, 1, 1, 1);
 530 FEATURE(linux64, "AArch64 Linux 64bit support");