[apple/xnu.git] / bsd / kern / mach_fat.c

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1991 NeXT Computer, Inc.  All rights reserved.
 *
 *	File:	kern/mach_fat.c
 *	Author:	Peter King
 *
 *	Fat file support routines.
 *
 */

#include <sys/param.h>
#include <sys/types.h>
#include <sys/uio.h>
#include <sys/vnode.h>
#include <vm/vm_kern.h>
#include <mach/kern_return.h>
#include <mach/vm_param.h>
#include <kern/cpu_number.h>
#include <mach-o/fat.h>
#include <kern/mach_loader.h>
#include <architecture/byte_order.h>

/* XXX should be in common header */
extern int grade_binary(cpu_type_t exectype, cpu_subtype_t execsubtype);

#define CPU_TYPE_NATIVE		(cpu_type())
#define CPU_TYPE_CLASSIC	CPU_TYPE_POWERPC

/**********************************************************************
 * Routine:	fatfile_getarch2()
 *
 * Function:	Locate the architecture-dependant contents of a fat
 *		file that match this CPU.
 *
 * Args:	vp:		The vnode for the fat file.
 *		header:		A pointer to the fat file header.
 *		req_cpu_type:	The required cpu type.
 *		mask_bits:	Bits to mask from the sub-image type when
 *				grading it vs. the req_cpu_type
 *		archret (out):	Pointer to fat_arch structure to hold
 *				the results.
 *
 * Returns:	KERN_SUCCESS:	Valid architecture found.
 *		KERN_FAILURE:	No valid architecture found.
 **********************************************************************/
static load_return_t
fatfile_getarch2(
#if 0
	struct vnode	*vp,
#else
	__unused struct vnode	*vp,
#endif
	vm_offset_t	data_ptr,
	cpu_type_t	req_cpu_type,
	cpu_type_t	mask_bits,
	struct fat_arch	*archret)
{
	/* vm_pager_t		pager; */
	vm_offset_t		addr;
	vm_size_t		size;
	load_return_t		lret;
	struct fat_arch		*arch;
	struct fat_arch		*best_arch;
	int			grade;
	int			best_grade;
	int			nfat_arch;
	int			end_of_archs;
	struct fat_header	*header;
#if 0
	off_t filesize;
#endif

	/*
	 * 	Get the pager for the file.
	 */

	header = (struct fat_header *)data_ptr;

	/*
	 *	Map portion that must be accessible directly into
	 *	kernel's map.
	 */
	nfat_arch = NXSwapBigLongToHost(header->nfat_arch);

	end_of_archs = sizeof(struct fat_header)
		+ nfat_arch * sizeof(struct fat_arch);
#if 0
	filesize = ubc_getsize(vp);
	if (end_of_archs > (int)filesize) {
		return(LOAD_BADMACHO);
	}
#endif

	/* This is beacuse we are reading only 512 bytes */

	if (end_of_archs > 512)
		return(LOAD_BADMACHO);
	/*
	 * 	Round size of fat_arch structures up to page boundry.
	 */
	size = round_page_32(end_of_archs);
	if (size == 0)
		return(LOAD_BADMACHO);

	/*
	 * Scan the fat_arch's looking for the best one.
	 */
	addr = data_ptr;
	best_arch = NULL;
	best_grade = 0;
	arch = (struct fat_arch *) (addr + sizeof(struct fat_header));
	for (; nfat_arch-- > 0; arch++) {

		/*
		 *	Check to see if right cpu type.
		 */
		if(((cpu_type_t)NXSwapBigIntToHost(arch->cputype) & ~mask_bits) != req_cpu_type)
			continue;

		/*
		 * 	Get the grade of the cpu subtype.
		 */
		grade = grade_binary(
			    NXSwapBigIntToHost(arch->cputype),
			    NXSwapBigIntToHost(arch->cpusubtype));

		/*
		 *	Remember it if it's the best we've seen.
		 */
		if (grade > best_grade) {
			best_grade = grade;
			best_arch = arch;
		}
	}

	/*
	 *	Return our results.
	 */
	if (best_arch == NULL) {
		lret = LOAD_BADARCH;
	} else {
		archret->cputype	=
			    NXSwapBigIntToHost(best_arch->cputype);
		archret->cpusubtype	=
			    NXSwapBigIntToHost(best_arch->cpusubtype);
		archret->offset		=
			    NXSwapBigLongToHost(best_arch->offset);
		archret->size		=
			    NXSwapBigLongToHost(best_arch->size);
		archret->align		=
			    NXSwapBigLongToHost(best_arch->align);

		lret = LOAD_SUCCESS;
	}

	/*
	 * Free the memory we allocated and return.
	 */
	return(lret);
}

extern char classichandler[];

load_return_t
fatfile_getarch_affinity(
		struct vnode		*vp,
		vm_offset_t		data_ptr,
		struct fat_arch	*archret,
		int 				affinity)
{
		load_return_t lret;
		int handler = (classichandler[0] != 0);
		cpu_type_t primary_type, fallback_type;

		if (handler && affinity) {
				primary_type = CPU_TYPE_CLASSIC;
				fallback_type = CPU_TYPE_NATIVE;
		} else {
				primary_type = CPU_TYPE_NATIVE;
				fallback_type = CPU_TYPE_CLASSIC;
		}
		/*
		 * Ignore the architectural bits when determining if an image
		 * in a fat file should be skipped or graded.
		 */
		lret = fatfile_getarch2(vp, data_ptr, primary_type, CPU_ARCH_MASK, archret);
		if ((lret != 0) && handler) {
			lret = fatfile_getarch2(vp, data_ptr, fallback_type,
						0, archret);
		}
		return lret;
}

/**********************************************************************
 * Routine:	fatfile_getarch()
 *
 * Function:	Locate the architecture-dependant contents of a fat
 *		file that match this CPU.
 *
 * Args:	vp:		The vnode for the fat file.
 *		header:		A pointer to the fat file header.
 *		archret (out):	Pointer to fat_arch structure to hold
 *				the results.
 *
 * Returns:	KERN_SUCCESS:	Valid architecture found.
 *		KERN_FAILURE:	No valid architecture found.
 **********************************************************************/
load_return_t
fatfile_getarch(
	struct vnode		*vp,
	vm_offset_t 	data_ptr,
	struct fat_arch		*archret)
{
	return fatfile_getarch2(vp, data_ptr, CPU_TYPE_NATIVE, 0, archret);
}

/**********************************************************************
 * Routine:	fatfile_getarch_with_bits()
 *
 * Function:	Locate the architecture-dependant contents of a fat
 *		file that match this CPU.
 *
 * Args:	vp:		The vnode for the fat file.
 *		archbits:	Architecture specific feature bits
 *		header:		A pointer to the fat file header.
 *		archret (out):	Pointer to fat_arch structure to hold
 *				the results.
 *
 * Returns:	KERN_SUCCESS:	Valid architecture found.
 *		KERN_FAILURE:	No valid architecture found.
 **********************************************************************/
load_return_t
fatfile_getarch_with_bits(
	struct vnode		*vp,
	integer_t		archbits,
	vm_offset_t 	data_ptr,
	struct fat_arch		*archret)
{
	return fatfile_getarch2(vp, data_ptr, archbits | CPU_TYPE_NATIVE, 0, archret);
}
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
ff6e181a A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. Please obtain a copy of the License at
	10	* http://www.opensource.apple.com/apsl/ and read it before using this
	11	* file.
1c79356b	12	*
ff6e181a A	13	* The Original Code and all software distributed under the License are
ff6e181a A	14	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	15	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	16	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
ff6e181a A	17	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	18	* Please see the License for the specific language governing rights and
	19	* limitations under the License.
1c79356b A	20	*
	21	* @APPLE_LICENSE_HEADER_END@
	22	*/
	23	/* Copyright (c) 1991 NeXT Computer, Inc. All rights reserved.
	24	*
	25	* File: kern/mach_fat.c
	26	* Author: Peter King
	27	*
	28	* Fat file support routines.
	29	*
	30	*/
	31
	32	#include <sys/param.h>
	33	#include <sys/types.h>
	34	#include <sys/uio.h>
	35	#include <sys/vnode.h>
	36	#include <vm/vm_kern.h>
	37	#include <mach/kern_return.h>
	38	#include <mach/vm_param.h>
	39	#include <kern/cpu_number.h>
	40	#include <mach-o/fat.h>
	41	#include <kern/mach_loader.h>
	42	#include <architecture/byte_order.h>
	43
91447636 A	44	/* XXX should be in common header */
	45	extern int grade_binary(cpu_type_t exectype, cpu_subtype_t execsubtype);
	46
	47	#define CPU_TYPE_NATIVE (cpu_type())
55e303ae	48	#define CPU_TYPE_CLASSIC CPU_TYPE_POWERPC
1c79356b A	49
1c79356b A	50	/**********************************************************************
55e303ae	51	* Routine: fatfile_getarch2()
1c79356b A	52	*
	53	* Function: Locate the architecture-dependant contents of a fat
	54	* file that match this CPU.
	55	*
	56	* Args: vp: The vnode for the fat file.
	57	* header: A pointer to the fat file header.
91447636 A	58	* req_cpu_type: The required cpu type.
	59	* mask_bits: Bits to mask from the sub-image type when
	60	* grading it vs. the req_cpu_type
1c79356b A	61	* archret (out): Pointer to fat_arch structure to hold
	62	* the results.
	63	*
	64	* Returns: KERN_SUCCESS: Valid architecture found.
	65	* KERN_FAILURE: No valid architecture found.
	66	**********************************************************************/
55e303ae A	67	static load_return_t
55e303ae A	68	fatfile_getarch2(
91447636	69	#if 0
55e303ae	70	struct vnode *vp,
91447636 A	71	#else
	72	__unused struct vnode *vp,
	73	#endif
55e303ae	74	vm_offset_t data_ptr,
91447636 A	75	cpu_type_t req_cpu_type,
91447636 A	76	cpu_type_t mask_bits,
55e303ae	77	struct fat_arch *archret)
1c79356b A	78	{
	79	/* vm_pager_t pager; */
	80	vm_offset_t addr;
	81	vm_size_t size;
1c79356b	82	load_return_t lret;
1c79356b A	83	struct fat_arch *arch;
	84	struct fat_arch *best_arch;
	85	int grade;
	86	int best_grade;
	87	int nfat_arch;
	88	int end_of_archs;
1c79356b	89	struct fat_header *header;
91447636	90	#if 0
1c79356b	91	off_t filesize;
91447636	92	#endif
1c79356b A	93
	94	/*
	95	* Get the pager for the file.
	96	*/
	97
	98	header = (struct fat_header *)data_ptr;
	99
	100	/*
	101	* Map portion that must be accessible directly into
	102	* kernel's map.
	103	*/
	104	nfat_arch = NXSwapBigLongToHost(header->nfat_arch);
	105
	106	end_of_archs = sizeof(struct fat_header)
	107	+ nfat_arch * sizeof(struct fat_arch);
	108	#if 0
	109	filesize = ubc_getsize(vp);
0b4e3aa0	110	if (end_of_archs > (int)filesize) {
1c79356b A	111	return(LOAD_BADMACHO);
	112	}
	113	#endif
	114
	115	/* This is beacuse we are reading only 512 bytes */
	116
	117	if (end_of_archs > 512)
	118	return(LOAD_BADMACHO);
	119	/*
	120	* Round size of fat_arch structures up to page boundry.
	121	*/
55e303ae	122	size = round_page_32(end_of_archs);
91447636	123	if (size == 0)
1c79356b A	124	return(LOAD_BADMACHO);
	125
	126	/*
	127	* Scan the fat_arch's looking for the best one.
	128	*/
	129	addr = data_ptr;
1c79356b A	130	best_arch = NULL;
	131	best_grade = 0;
	132	arch = (struct fat_arch *) (addr + sizeof(struct fat_header));
	133	for (; nfat_arch-- > 0; arch++) {
	134
	135	/*
	136	* Check to see if right cpu type.
	137	*/
91447636	138	if(((cpu_type_t)NXSwapBigIntToHost(arch->cputype) & ~mask_bits) != req_cpu_type)
1c79356b A	139	continue;
	140
	141	/*
	142	* Get the grade of the cpu subtype.
	143	*/
91447636 A	144	grade = grade_binary(
91447636 A	145	NXSwapBigIntToHost(arch->cputype),
1c79356b A	146	NXSwapBigIntToHost(arch->cpusubtype));
	147
	148	/*
	149	* Remember it if it's the best we've seen.
	150	*/
	151	if (grade > best_grade) {
	152	best_grade = grade;
	153	best_arch = arch;
	154	}
	155	}
	156
	157	/*
	158	* Return our results.
	159	*/
	160	if (best_arch == NULL) {
	161	lret = LOAD_BADARCH;
	162	} else {
	163	archret->cputype =
	164	NXSwapBigIntToHost(best_arch->cputype);
	165	archret->cpusubtype =
	166	NXSwapBigIntToHost(best_arch->cpusubtype);
	167	archret->offset =
	168	NXSwapBigLongToHost(best_arch->offset);
	169	archret->size =
	170	NXSwapBigLongToHost(best_arch->size);
	171	archret->align =
	172	NXSwapBigLongToHost(best_arch->align);
	173
	174	lret = LOAD_SUCCESS;
	175	}
	176
	177	/*
	178	* Free the memory we allocated and return.
	179	*/
	180	return(lret);
	181	}
	182
55e303ae A	183	extern char classichandler[];
	184
	185	load_return_t
	186	fatfile_getarch_affinity(
	187	struct vnode *vp,
	188	vm_offset_t data_ptr,
	189	struct fat_arch *archret,
	190	int affinity)
	191	{
	192	load_return_t lret;
	193	int handler = (classichandler[0] != 0);
	194	cpu_type_t primary_type, fallback_type;
	195
	196	if (handler && affinity) {
	197	primary_type = CPU_TYPE_CLASSIC;
	198	fallback_type = CPU_TYPE_NATIVE;
	199	} else {
	200	primary_type = CPU_TYPE_NATIVE;
	201	fallback_type = CPU_TYPE_CLASSIC;
	202	}
91447636 A	203	/*
	204	* Ignore the architectural bits when determining if an image
	205	* in a fat file should be skipped or graded.
	206	*/
	207	lret = fatfile_getarch2(vp, data_ptr, primary_type, CPU_ARCH_MASK, archret);
55e303ae A	208	if ((lret != 0) && handler) {
55e303ae A	209	lret = fatfile_getarch2(vp, data_ptr, fallback_type,
91447636	210	0, archret);
55e303ae A	211	}
	212	return lret;
	213	}
	214
	215	/**********************************************************************
	216	* Routine: fatfile_getarch()
	217	*
	218	* Function: Locate the architecture-dependant contents of a fat
	219	* file that match this CPU.
	220	*
	221	* Args: vp: The vnode for the fat file.
	222	* header: A pointer to the fat file header.
	223	* archret (out): Pointer to fat_arch structure to hold
	224	* the results.
	225	*
	226	* Returns: KERN_SUCCESS: Valid architecture found.
	227	* KERN_FAILURE: No valid architecture found.
	228	**********************************************************************/
	229	load_return_t
	230	fatfile_getarch(
	231	struct vnode *vp,
	232	vm_offset_t data_ptr,
	233	struct fat_arch *archret)
	234	{
91447636 A	235	return fatfile_getarch2(vp, data_ptr, CPU_TYPE_NATIVE, 0, archret);
	236	}
	237
	238	/**********************************************************************
	239	* Routine: fatfile_getarch_with_bits()
	240	*
	241	* Function: Locate the architecture-dependant contents of a fat
	242	* file that match this CPU.
	243	*
	244	* Args: vp: The vnode for the fat file.
	245	* archbits: Architecture specific feature bits
	246	* header: A pointer to the fat file header.
	247	* archret (out): Pointer to fat_arch structure to hold
	248	* the results.
	249	*
	250	* Returns: KERN_SUCCESS: Valid architecture found.
	251	* KERN_FAILURE: No valid architecture found.
	252	**********************************************************************/
	253	load_return_t
	254	fatfile_getarch_with_bits(
	255	struct vnode *vp,
	256	integer_t archbits,
	257	vm_offset_t data_ptr,
	258	struct fat_arch *archret)
	259	{
	260	return fatfile_getarch2(vp, data_ptr, archbits \| CPU_TYPE_NATIVE, 0, archret);
55e303ae	261	}
1c79356b	262