9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn/*
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * CDDL HEADER START
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn *
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * The contents of this file are subject to the terms of the
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * Common Development and Distribution License (the "License").
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * You may not use this file except in compliance with the License.
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn *
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * or http://www.opensolaris.org/os/licensing.
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * See the License for the specific language governing permissions
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * and limitations under the License.
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn *
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * When distributing Covered Code, include this CDDL HEADER in each
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * If applicable, add the following below this CDDL HEADER, with the
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * fields enclosed by brackets "[]" replaced with your own identifying
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * information: Portions Copyright [yyyy] [name of copyright owner]
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn *
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * CDDL HEADER END
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn */
eb9dbf0cbc8141f9da4ed18e6b5515d9eaea0e00Roger A. Faulkner
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn/*
80e2ca8596e3435bc3b76f3c597833ea0a87f85e * Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved.
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn */
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#ifndef _SYS_BRAND_H
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#define _SYS_BRAND_H
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#ifdef __cplusplus
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnextern "C" {
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#endif
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#include <sys/proc.h>
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#include <sys/exec.h>
80e2ca8596e3435bc3b76f3c597833ea0a87f85e#include <sys/modctl.h>
e9f7cbf00b5dbfafe45ffb00125fa0cc683595c6Vamsi Nagineni#include <sys/types.h>
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn/*
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * All Brands supported by this kernel must use BRAND_VER_1.
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn */
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#define BRAND_VER_1 1
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn/*
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * sub-commands to brandsys.
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * 1 - 128 are for common commands
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * 128+ are available for brand-specific commands.
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn */
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#define B_REGISTER 1
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#define B_TTYMODES 2
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#define B_ELFDATA 3
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#define B_EXEC_NATIVE 4
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#define B_EXEC_BRAND 5
80e2ca8596e3435bc3b76f3c597833ea0a87f85e#define B_TRUSS_POINT 6
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn/*
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * Structure used by zoneadmd to communicate the name of a brand and the
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * supporting brand module into the kernel.
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn */
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnstruct brand_attr {
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn char ba_brandname[MAXNAMELEN];
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn char ba_modname[MAXPATHLEN];
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn};
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn/* What we call the native brand. */
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#define NATIVE_BRAND_NAME "native"
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
9a5d73e03cd3312ddb571a748c40a63c58bd66e5Ric Aleshire/* What we call the labeled brand. */
9a5d73e03cd3312ddb571a748c40a63c58bd66e5Ric Aleshire#define LABELED_BRAND_NAME "labeled"
9a5d73e03cd3312ddb571a748c40a63c58bd66e5Ric Aleshire
80e2ca8596e3435bc3b76f3c597833ea0a87f85e/*
80e2ca8596e3435bc3b76f3c597833ea0a87f85e * Aux vector containing lddata pointer of brand library linkmap.
80e2ca8596e3435bc3b76f3c597833ea0a87f85e * Used by common {brand}_librtld_db.
80e2ca8596e3435bc3b76f3c597833ea0a87f85e */
80e2ca8596e3435bc3b76f3c597833ea0a87f85e#define AT_SUN_BRAND_COMMON_LDDATA AT_SUN_BRAND_AUX1
80e2ca8596e3435bc3b76f3c597833ea0a87f85e
80e2ca8596e3435bc3b76f3c597833ea0a87f85e/*
80e2ca8596e3435bc3b76f3c597833ea0a87f85e * Information needed by the brand library to launch an executable.
80e2ca8596e3435bc3b76f3c597833ea0a87f85e */
80e2ca8596e3435bc3b76f3c597833ea0a87f85etypedef struct brand_elf_data {
80e2ca8596e3435bc3b76f3c597833ea0a87f85e ulong_t sed_phdr;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e ulong_t sed_phent;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e ulong_t sed_phnum;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e ulong_t sed_entry;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e ulong_t sed_base;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e ulong_t sed_ldentry;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e ulong_t sed_lddata;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e} brand_elf_data_t;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e
80e2ca8596e3435bc3b76f3c597833ea0a87f85e/*
80e2ca8596e3435bc3b76f3c597833ea0a87f85e * Common structure used to register a branded processes
80e2ca8596e3435bc3b76f3c597833ea0a87f85e */
80e2ca8596e3435bc3b76f3c597833ea0a87f85etypedef struct brand_proc_reg {
80e2ca8596e3435bc3b76f3c597833ea0a87f85e uint_t sbr_version; /* version number */
80e2ca8596e3435bc3b76f3c597833ea0a87f85e caddr_t sbr_handler; /* base address of handler */
80e2ca8596e3435bc3b76f3c597833ea0a87f85e} brand_proc_reg_t;
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
80e2ca8596e3435bc3b76f3c597833ea0a87f85e#ifdef _KERNEL
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnstruct proc;
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnstruct uarg;
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnstruct brand_mach_ops;
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnstruct intpdata;
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnstruct execa;
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnstruct brand_ops {
319378d99bca1eacf64f0a464b0175bf66b422abeh void (*b_init_brand_data)(zone_t *);
319378d99bca1eacf64f0a464b0175bf66b422abeh void (*b_free_brand_data)(zone_t *);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn int (*b_brandsys)(int, int64_t *, uintptr_t, uintptr_t, uintptr_t,
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn uintptr_t, uintptr_t, uintptr_t);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn void (*b_setbrand)(struct proc *);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn int (*b_getattr)(zone_t *, int, void *, size_t *);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn int (*b_setattr)(zone_t *, int, void *, size_t);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn void (*b_copy_procdata)(struct proc *, struct proc *);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn void (*b_proc_exit)(struct proc *, klwp_t *);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn void (*b_exec)();
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn void (*b_lwp_setrval)(klwp_t *, int, int);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn int (*b_initlwp)(klwp_t *);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn void (*b_forklwp)(klwp_t *, klwp_t *);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn void (*b_freelwp)(klwp_t *);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn void (*b_lwpexit)(klwp_t *);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn int (*b_elfexec)(struct vnode *vp, struct execa *uap,
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn struct uarg *args, struct intpdata *idata, int level,
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn long *execsz, int setid, caddr_t exec_file,
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn struct cred *cred, int brand_action);
8f798d3afbe38d59cc0a708261dbb729f1b6b209Roger A. Faulkner void (*b_sigset_native_to_brand)(sigset_t *);
8f798d3afbe38d59cc0a708261dbb729f1b6b209Roger A. Faulkner void (*b_sigset_brand_to_native)(sigset_t *);
eb9dbf0cbc8141f9da4ed18e6b5515d9eaea0e00Roger A. Faulkner int b_nsig;
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn};
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn/*
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * The b_version field must always be the first entry in this struct.
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn */
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnntypedef struct brand {
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn int b_version;
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn char *b_name;
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn struct brand_ops *b_ops;
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn struct brand_mach_ops *b_machops;
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn} brand_t;
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnextern brand_t native_brand;
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn/*
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn * Convenience macros
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn */
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#define lwptolwpbrand(l) ((l)->lwp_brand)
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#define ttolwpbrand(t) (lwptolwpbrand(ttolwp(t)))
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#define PROC_IS_BRANDED(p) ((p)->p_brand != &native_brand)
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#define ZONE_IS_BRANDED(z) ((z)->zone_brand != &native_brand)
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#define BROP(p) ((p)->p_brand->b_ops)
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#define ZBROP(z) ((z)->zone_brand->b_ops)
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#define BRMOP(p) ((p)->p_brand->b_machops)
8f798d3afbe38d59cc0a708261dbb729f1b6b209Roger A. Faulkner#define SIGSET_NATIVE_TO_BRAND(sigset) \
8f798d3afbe38d59cc0a708261dbb729f1b6b209Roger A. Faulkner if (PROC_IS_BRANDED(curproc) && \
8f798d3afbe38d59cc0a708261dbb729f1b6b209Roger A. Faulkner BROP(curproc)->b_sigset_native_to_brand) \
8f798d3afbe38d59cc0a708261dbb729f1b6b209Roger A. Faulkner BROP(curproc)->b_sigset_native_to_brand(sigset)
8f798d3afbe38d59cc0a708261dbb729f1b6b209Roger A. Faulkner#define SIGSET_BRAND_TO_NATIVE(sigset) \
8f798d3afbe38d59cc0a708261dbb729f1b6b209Roger A. Faulkner if (PROC_IS_BRANDED(curproc) && \
8f798d3afbe38d59cc0a708261dbb729f1b6b209Roger A. Faulkner BROP(curproc)->b_sigset_brand_to_native) \
8f798d3afbe38d59cc0a708261dbb729f1b6b209Roger A. Faulkner BROP(curproc)->b_sigset_brand_to_native(sigset)
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnextern void brand_init();
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnextern int brand_register(brand_t *);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnextern int brand_unregister(brand_t *);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnextern brand_t *brand_register_zone(struct brand_attr *);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnextern brand_t *brand_find_name(char *);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnextern void brand_unregister_zone(brand_t *);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnextern int brand_zone_count(brand_t *);
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnnextern void brand_setbrand(proc_t *);
e9f7cbf00b5dbfafe45ffb00125fa0cc683595c6Vamsi Nagineniextern void brand_clearbrand(proc_t *, boolean_t);
80e2ca8596e3435bc3b76f3c597833ea0a87f85e
80e2ca8596e3435bc3b76f3c597833ea0a87f85e/*
80e2ca8596e3435bc3b76f3c597833ea0a87f85e * The following functions can be shared among kernel brand modules which
80e2ca8596e3435bc3b76f3c597833ea0a87f85e * implement Solaris-derived brands, all of which need to do similar tasks to
80e2ca8596e3435bc3b76f3c597833ea0a87f85e * manage the brand.
80e2ca8596e3435bc3b76f3c597833ea0a87f85e */
80e2ca8596e3435bc3b76f3c597833ea0a87f85eextern int brand_solaris_cmd(int, uintptr_t, uintptr_t, uintptr_t,
80e2ca8596e3435bc3b76f3c597833ea0a87f85e struct brand *, int);
80e2ca8596e3435bc3b76f3c597833ea0a87f85eextern void brand_solaris_copy_procdata(proc_t *, proc_t *,
80e2ca8596e3435bc3b76f3c597833ea0a87f85e struct brand *);
80e2ca8596e3435bc3b76f3c597833ea0a87f85eextern int brand_solaris_elfexec(vnode_t *, execa_t *, uarg_t *,
80e2ca8596e3435bc3b76f3c597833ea0a87f85e intpdata_t *, int, long *, int, caddr_t, cred_t *, int,
80e2ca8596e3435bc3b76f3c597833ea0a87f85e struct brand *, char *, char *, char *, char *, char *);
80e2ca8596e3435bc3b76f3c597833ea0a87f85eextern void brand_solaris_exec(struct brand *);
80e2ca8596e3435bc3b76f3c597833ea0a87f85eextern int brand_solaris_fini(char **, struct modlinkage *,
80e2ca8596e3435bc3b76f3c597833ea0a87f85e struct brand *);
80e2ca8596e3435bc3b76f3c597833ea0a87f85eextern void brand_solaris_forklwp(klwp_t *, klwp_t *, struct brand *);
80e2ca8596e3435bc3b76f3c597833ea0a87f85eextern void brand_solaris_freelwp(klwp_t *, struct brand *);
80e2ca8596e3435bc3b76f3c597833ea0a87f85eextern int brand_solaris_initlwp(klwp_t *, struct brand *);
80e2ca8596e3435bc3b76f3c597833ea0a87f85eextern void brand_solaris_lwpexit(klwp_t *, struct brand *);
80e2ca8596e3435bc3b76f3c597833ea0a87f85eextern void brand_solaris_proc_exit(struct proc *, klwp_t *,
80e2ca8596e3435bc3b76f3c597833ea0a87f85e struct brand *);
80e2ca8596e3435bc3b76f3c597833ea0a87f85eextern void brand_solaris_setbrand(proc_t *, struct brand *);
80e2ca8596e3435bc3b76f3c597833ea0a87f85e
80e2ca8596e3435bc3b76f3c597833ea0a87f85e#if defined(_SYSCALL32)
80e2ca8596e3435bc3b76f3c597833ea0a87f85etypedef struct brand_elf_data32 {
80e2ca8596e3435bc3b76f3c597833ea0a87f85e uint32_t sed_phdr;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e uint32_t sed_phent;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e uint32_t sed_phnum;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e uint32_t sed_entry;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e uint32_t sed_base;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e uint32_t sed_ldentry;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e uint32_t sed_lddata;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e} brand_elf_data32_t;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e
80e2ca8596e3435bc3b76f3c597833ea0a87f85etypedef struct brand_common_reg32 {
80e2ca8596e3435bc3b76f3c597833ea0a87f85e uint32_t sbr_version; /* version number */
80e2ca8596e3435bc3b76f3c597833ea0a87f85e caddr32_t sbr_handler; /* base address of handler */
80e2ca8596e3435bc3b76f3c597833ea0a87f85e} brand_common_reg32_t;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e#endif /* _SYSCALL32 */
80e2ca8596e3435bc3b76f3c597833ea0a87f85e
80e2ca8596e3435bc3b76f3c597833ea0a87f85e/*
80e2ca8596e3435bc3b76f3c597833ea0a87f85e * Common information associated with all branded processes
80e2ca8596e3435bc3b76f3c597833ea0a87f85e */
80e2ca8596e3435bc3b76f3c597833ea0a87f85etypedef struct brand_proc_data {
80e2ca8596e3435bc3b76f3c597833ea0a87f85e caddr_t spd_handler; /* address of user-space handler */
80e2ca8596e3435bc3b76f3c597833ea0a87f85e brand_elf_data_t spd_elf_data; /* common ELF data for branded app. */
80e2ca8596e3435bc3b76f3c597833ea0a87f85e} brand_proc_data_t;
80e2ca8596e3435bc3b76f3c597833ea0a87f85e
80e2ca8596e3435bc3b76f3c597833ea0a87f85e#define BRAND_NATIVE_DIR "/.SUNWnative/"
80e2ca8596e3435bc3b76f3c597833ea0a87f85e#define BRAND_NATIVE_LINKER32 BRAND_NATIVE_DIR "lib/ld.so.1"
80e2ca8596e3435bc3b76f3c597833ea0a87f85e#define BRAND_NATIVE_LINKER64 BRAND_NATIVE_DIR "lib/64/ld.so.1"
80e2ca8596e3435bc3b76f3c597833ea0a87f85e
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#endif /* _KERNEL */
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#ifdef __cplusplus
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn}
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#endif
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn
9acbbeaf2a1ffe5c14b244867d427714fab43c5cnn#endif /* _SYS_BRAND_H */