[mirror_edk2.git] / BaseTools / Source / C / EfiLdrImage / EfiLdrImage.c

/** @file\r
Creates and EFILDR image.\r
This tool combines several PE Image files together using following format denoted as EBNF:\r
FILE := EFILDR_HEADER\r
        EFILDR_IMAGE +\r
        <PeImageFileContent> +\r
The order of EFILDR_IMAGE is same as the order of placing PeImageFileContent.\r
  \r
Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
\r
#include <stdio.h>\r
#include <stdlib.h>\r
#include <string.h>\r
#include "ParseInf.h"\r
#include "CommonLib.h"\r
#include "EfiUtilityMsgs.h"\r
\r
#define MAX_PE_IMAGES                  63\r
#define FILE_TYPE_FIXED_LOADER         0\r
#define FILE_TYPE_RELOCATABLE_PE_IMAGE 1\r
\r
typedef struct {\r
  UINT32 CheckSum;\r
  UINT32 Offset;\r
  UINT32 Length;\r
  UINT8  FileName[52];\r
} EFILDR_IMAGE;\r
\r
typedef struct {          \r
  UINT32       Signature;     \r
  UINT32       HeaderCheckSum;\r
  UINT32       FileLength;\r
  UINT32       NumberOfImages;\r
} EFILDR_HEADER;\r
\r
//\r
// Utility Name\r
//\r
#define UTILITY_NAME  "EfiLdrImage"\r
\r
//\r
// Utility version information\r
//\r
#define UTILITY_MAJOR_VERSION 1\r
#define UTILITY_MINOR_VERSION 0\r
\r
void\r
Version (\r
  void\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Displays the standard utility information to SDTOUT\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
{\r
  printf ("%s Version %d.%d Build %s\n", UTILITY_NAME, UTILITY_MAJOR_VERSION, UTILITY_MINOR_VERSION, __BUILD_VERSION);\r
  exit (0);\r
}\r
\r
VOID\r
Usage (\r
  VOID\r
  )\r
{\r
  printf ("Usage: EfiLdrImage -o OutImage LoaderImage PeImage1 PeImage2 ... PeImageN\n");\r
  printf ("%s Version %d.%d Build %s\n", UTILITY_NAME, UTILITY_MAJOR_VERSION, UTILITY_MINOR_VERSION, __BUILD_VERSION);\r
  printf ("Copyright (c) 1999-2016 Intel Corporation. All rights reserved.\n");\r
  printf ("\n  The EfiLdrImage tool is used to combine PE files into EFILDR image with Efi loader header.\n");\r
}\r
\r
EFI_STATUS\r
CountVerboseLevel (\r
  IN CONST CHAR8* VerboseLevelString,\r
  IN CONST UINT64 Length,\r
  OUT UINT64 *ReturnValue\r
)\r
{\r
  UINT64 i = 0;\r
  for (;i < Length; ++i) {\r
    if (VerboseLevelString[i] != 'v' && VerboseLevelString[i] != 'V') {\r
      return EFI_ABORTED;\r
    }\r
    ++(*ReturnValue);\r
  }\r
  \r
  return EFI_SUCCESS;\r
}\r
\r
UINT64\r
FCopyFile (\r
  FILE    *in,\r
  FILE    *out\r
  )\r
/*++\r
Routine Description:\r
  Write all the content of input file to output file.\r
\r
Arguments:\r
  in  - input file pointer\r
  out - output file pointer\r
\r
Return:\r
  UINT64 : file size of input file\r
--*/\r
{\r
  UINT32          filesize, offset, length;\r
  CHAR8           Buffer[8*1024];\r
\r
  fseek (in, 0, SEEK_END);\r
  filesize = ftell(in);\r
\r
  fseek (in, 0, SEEK_SET);\r
\r
  offset = 0;\r
  while (offset < filesize)  {\r
    length = sizeof(Buffer);\r
    if (filesize-offset < length) {\r
      length = filesize-offset;\r
    }\r
\r
    fread (Buffer, length, 1, in);\r
    fwrite (Buffer, length, 1, out);\r
    offset += length;\r
  }\r
\r
  return filesize;\r
}\r
\r
\r
int\r
main (\r
  int argc,\r
  char *argv[]\r
  )\r
/*++\r
\r
Routine Description:\r
\r
\r
Arguments:\r
\r
\r
Returns:\r
\r
\r
--*/\r
{\r
  UINT64         i;\r
  UINT64         filesize;\r
  FILE          *fpIn, *fpOut;\r
  EFILDR_HEADER EfiLdrHeader;\r
  EFILDR_IMAGE  EfiLdrImage[MAX_PE_IMAGES];\r
  CHAR8* OutputFileName = NULL;\r
  CHAR8* InputFileNames[MAX_PE_IMAGES + 1];\r
  UINT8 InputFileCount = 0;\r
  UINT64        DebugLevel = 0;\r
  UINT64        VerboseLevel = 0;\r
  EFI_STATUS Status = EFI_SUCCESS;\r
  \r
  SetUtilityName (UTILITY_NAME);\r
\r
  if (argc == 1) {\r
    printf ("Usage: EfiLdrImage -o OutImage LoaderImage PeImage1 PeImage2 ... PeImageN\n");\r
    return STATUS_ERROR;\r
  }\r
  \r
  argc --;\r
  argv ++;\r
\r
  if ((stricmp (argv[0], "-h") == 0) || (stricmp (argv[0], "--help") == 0)) {\r
    Usage();\r
    return STATUS_SUCCESS;    \r
  }\r
\r
  if (stricmp (argv[0], "--version") == 0) {\r
    Version();\r
    return STATUS_SUCCESS;    \r
  }\r
\r
  while (argc > 0) {\r
   \r
    if ((stricmp (argv[0], "-o") == 0) || (stricmp (argv[0], "--output") == 0)) {\r
      OutputFileName = argv[1];\r
      if (OutputFileName == NULL) {\r
        Error (NULL, 0, 1003, "Invalid option value", "Output file can't be null");\r
        return STATUS_ERROR;\r
      }\r
      argc -= 2;\r
      argv += 2;\r
      continue; \r
    }\r
    \r
    if ((stricmp (argv[0], "-q") == 0) || (stricmp (argv[0], "--quiet") == 0)) {\r
      argc --;\r
      argv ++;\r
      continue; \r
    }\r
    \r
    if ((strlen(argv[0]) >= 2 && argv[0][0] == '-' && (argv[0][1] == 'v' || argv[0][1] == 'V')) || (stricmp (argv[0], "--verbose") == 0)) {\r
      VerboseLevel = 1;\r
      if (strlen(argv[0]) > 2) {\r
        Status = CountVerboseLevel (&argv[0][2], strlen(argv[0]) - 2, &VerboseLevel);\r
        if (EFI_ERROR (Status)) {\r
          Error (NULL, 0, 1003, "Invalid option value", argv[0]);\r
          return STATUS_ERROR;        \r
        }\r
      }\r
      \r
      argc --;\r
      argv ++;\r
      continue; \r
    }\r
    \r
    if ((stricmp (argv[0], "-d") == 0) || (stricmp (argv[0], "--debug") == 0)) {\r
      Status = AsciiStringToUint64 (argv[1], FALSE, &DebugLevel);\r
      if (EFI_ERROR (Status)) {\r
        Error (NULL, 0, 1003, "Invalid option value", "%s = %s", argv[0], argv[1]);\r
        return STATUS_ERROR;        \r
      }\r
      argc -= 2;\r
      argv += 2;\r
      continue; \r
    }\r
    //\r
    // Don't recognize the parameter, should be regarded as the input file name.\r
    //\r
    InputFileNames[InputFileCount] = argv[0];\r
    InputFileCount++;\r
    argc--;\r
    argv++;\r
  }\r
\r
  if (InputFileCount == 0) {\r
    Error (NULL, 0, 1001, "Missing option", "No input file");\r
    return STATUS_ERROR;\r
  }\r
  //\r
  // Open output file for write\r
  //\r
  if (OutputFileName == NULL) {\r
    Error (NULL, 0, 1001, "Missing option", "No output file");\r
    return STATUS_ERROR;\r
  }\r
\r
  fpOut = fopen (LongFilePath (OutputFileName), "w+b");\r
  if (!fpOut) {\r
    Error (NULL, 0, 0001, "Could not open output file", OutputFileName);\r
    return STATUS_ERROR;\r
  }\r
\r
  memset (&EfiLdrHeader, 0, sizeof (EfiLdrHeader));\r
  memset (&EfiLdrImage, 0, sizeof (EFILDR_IMAGE) * (InputFileCount));\r
\r
  memcpy (&EfiLdrHeader.Signature, "EFIL", 4);\r
  EfiLdrHeader.FileLength = sizeof(EFILDR_HEADER) + sizeof(EFILDR_IMAGE)*(InputFileCount);\r
\r
  //\r
  // Skip the file header first\r
  //\r
  fseek (fpOut, EfiLdrHeader.FileLength, SEEK_SET);\r
\r
  //\r
  // copy all the input files to the output file\r
  //\r
  for(i=0;i<InputFileCount;i++) {\r
    //\r
    // Copy the content of PeImage file to output file\r
    //\r
    fpIn = fopen (LongFilePath (InputFileNames[i]), "rb");\r
    if (!fpIn) {\r
      Error (NULL, 0, 0001, "Could not open input file", InputFileNames[i]);\r
      fclose (fpOut);\r
      return STATUS_ERROR;\r
    }\r
    filesize = FCopyFile (fpIn, fpOut);\r
    fclose(fpIn);\r
\r
    //\r
    //  And in the same time update the EfiLdrHeader and EfiLdrImage array\r
    //\r
    EfiLdrImage[i].Offset = EfiLdrHeader.FileLength;\r
    EfiLdrImage[i].Length = (UINT32) filesize;\r
    strncpy ((CHAR8*) EfiLdrImage[i].FileName, InputFileNames[i], sizeof (EfiLdrImage[i].FileName) - 1);\r
    EfiLdrHeader.FileLength += (UINT32) filesize;\r
    EfiLdrHeader.NumberOfImages++;\r
  }\r
\r
  //\r
  // Write the image header to the output file finally\r
  //\r
  fseek (fpOut, 0, SEEK_SET);\r
  fwrite (&EfiLdrHeader, sizeof(EFILDR_HEADER)        , 1, fpOut);\r
  fwrite (&EfiLdrImage , sizeof(EFILDR_IMAGE)*(InputFileCount), 1, fpOut);\r
\r
  fclose (fpOut);\r
  printf ("Created %s\n", OutputFileName);\r
  return 0;\r
}\r
\r
Commit	Line	Data
30fdf114	1	/** @file\r
97fa0ee9 YL	2	Creates and EFILDR image.\r
	3	This tool combines several PE Image files together using following format denoted as EBNF:\r
	4	FILE := EFILDR_HEADER\r
	5	EFILDR_IMAGE +\r
	6	<PeImageFileContent> +\r
	7	The order of EFILDR_IMAGE is same as the order of placing PeImageFileContent.\r
	8	\r
45258285	9	Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
40d841f6	10	This program and the accompanying materials \r
30fdf114 LG	11	are licensed and made available under the terms and conditions of the BSD License \r
	12	which accompanies this distribution. The full text of the license may be found at \r
	13	http://opensource.org/licenses/bsd-license.php \r
	14	\r
	15	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	16	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	17	\r
30fdf114 LG	18	**/\r
	19	\r
	20	\r
	21	#include <stdio.h>\r
	22	#include <stdlib.h>\r
	23	#include <string.h>\r
	24	#include "ParseInf.h"\r
	25	#include "CommonLib.h"\r
	26	#include "EfiUtilityMsgs.h"\r
	27	\r
	28	#define MAX_PE_IMAGES 63\r
	29	#define FILE_TYPE_FIXED_LOADER 0\r
	30	#define FILE_TYPE_RELOCATABLE_PE_IMAGE 1\r
	31	\r
	32	typedef struct {\r
	33	UINT32 CheckSum;\r
	34	UINT32 Offset;\r
	35	UINT32 Length;\r
	36	UINT8 FileName[52];\r
	37	} EFILDR_IMAGE;\r
	38	\r
	39	typedef struct { \r
	40	UINT32 Signature; \r
	41	UINT32 HeaderCheckSum;\r
	42	UINT32 FileLength;\r
	43	UINT32 NumberOfImages;\r
	44	} EFILDR_HEADER;\r
	45	\r
	46	//\r
	47	// Utility Name\r
	48	//\r
	49	#define UTILITY_NAME "EfiLdrImage"\r
	50	\r
	51	//\r
	52	// Utility version information\r
	53	//\r
45258285 LG	54	#define UTILITY_MAJOR_VERSION 1\r
45258285 LG	55	#define UTILITY_MINOR_VERSION 0\r
30fdf114 LG	56	\r
	57	void\r
	58	Version (\r
	59	void\r
	60	)\r
	61	/*++\r
	62	\r
	63	Routine Description:\r
	64	\r
	65	Displays the standard utility information to SDTOUT\r
	66	\r
	67	Arguments:\r
	68	\r
	69	None\r
	70	\r
	71	Returns:\r
	72	\r
	73	None\r
	74	\r
	75	--*/\r
	76	{\r
45258285 LG	77	printf ("%s Version %d.%d Build %s\n", UTILITY_NAME, UTILITY_MAJOR_VERSION, UTILITY_MINOR_VERSION, __BUILD_VERSION);\r
45258285 LG	78	exit (0);\r
30fdf114 LG	79	}\r
	80	\r
	81	VOID\r
	82	Usage (\r
	83	VOID\r
	84	)\r
	85	{\r
	86	printf ("Usage: EfiLdrImage -o OutImage LoaderImage PeImage1 PeImage2 ... PeImageN\n");\r
45258285 LG	87	printf ("%s Version %d.%d Build %s\n", UTILITY_NAME, UTILITY_MAJOR_VERSION, UTILITY_MINOR_VERSION, __BUILD_VERSION);\r
	88	printf ("Copyright (c) 1999-2016 Intel Corporation. All rights reserved.\n");\r
	89	printf ("\n The EfiLdrImage tool is used to combine PE files into EFILDR image with Efi loader header.\n");\r
30fdf114 LG	90	}\r
	91	\r
	92	EFI_STATUS\r
	93	CountVerboseLevel (\r
	94	IN CONST CHAR8* VerboseLevelString,\r
	95	IN CONST UINT64 Length,\r
	96	OUT UINT64 *ReturnValue\r
	97	)\r
	98	{\r
	99	UINT64 i = 0;\r
	100	for (;i < Length; ++i) {\r
	101	if (VerboseLevelString[i] != 'v' && VerboseLevelString[i] != 'V') {\r
	102	return EFI_ABORTED;\r
	103	}\r
	104	++(*ReturnValue);\r
	105	}\r
	106	\r
	107	return EFI_SUCCESS;\r
	108	}\r
	109	\r
	110	UINT64\r
	111	FCopyFile (\r
	112	FILE *in,\r
	113	FILE *out\r
	114	)\r
	115	/*++\r
	116	Routine Description:\r
	117	Write all the content of input file to output file.\r
	118	\r
	119	Arguments:\r
	120	in - input file pointer\r
	121	out - output file pointer\r
	122	\r
	123	Return:\r
	124	UINT64 : file size of input file\r
	125	--*/\r
	126	{\r
fd171542	127	UINT32 filesize, offset, length;\r
30fdf114 LG	128	CHAR8 Buffer[8*1024];\r
	129	\r
	130	fseek (in, 0, SEEK_END);\r
	131	filesize = ftell(in);\r
	132	\r
	133	fseek (in, 0, SEEK_SET);\r
	134	\r
	135	offset = 0;\r
	136	while (offset < filesize) {\r
	137	length = sizeof(Buffer);\r
	138	if (filesize-offset < length) {\r
	139	length = filesize-offset;\r
	140	}\r
	141	\r
	142	fread (Buffer, length, 1, in);\r
	143	fwrite (Buffer, length, 1, out);\r
	144	offset += length;\r
	145	}\r
	146	\r
	147	return filesize;\r
	148	}\r
	149	\r
	150	\r
	151	int\r
	152	main (\r
	153	int argc,\r
	154	char *argv[]\r
	155	)\r
	156	/*++\r
	157	\r
	158	Routine Description:\r
	159	\r
	160	\r
	161	Arguments:\r
	162	\r
	163	\r
	164	Returns:\r
	165	\r
	166	\r
	167	--*/\r
	168	{\r
	169	UINT64 i;\r
	170	UINT64 filesize;\r
	171	FILE fpIn, fpOut;\r
	172	EFILDR_HEADER EfiLdrHeader;\r
	173	EFILDR_IMAGE EfiLdrImage[MAX_PE_IMAGES];\r
	174	CHAR8* OutputFileName = NULL;\r
	175	CHAR8* InputFileNames[MAX_PE_IMAGES + 1];\r
	176	UINT8 InputFileCount = 0;\r
30fdf114 LG	177	UINT64 DebugLevel = 0;\r
	178	UINT64 VerboseLevel = 0;\r
	179	EFI_STATUS Status = EFI_SUCCESS;\r
	180	\r
	181	SetUtilityName (UTILITY_NAME);\r
	182	\r
	183	if (argc == 1) {\r
45258285	184	printf ("Usage: EfiLdrImage -o OutImage LoaderImage PeImage1 PeImage2 ... PeImageN\n");\r
30fdf114 LG	185	return STATUS_ERROR;\r
	186	}\r
	187	\r
	188	argc --;\r
	189	argv ++;\r
	190	\r
	191	if ((stricmp (argv[0], "-h") == 0) \|\| (stricmp (argv[0], "--help") == 0)) {\r
	192	Usage();\r
	193	return STATUS_SUCCESS; \r
	194	}\r
	195	\r
	196	if (stricmp (argv[0], "--version") == 0) {\r
	197	Version();\r
	198	return STATUS_SUCCESS; \r
	199	}\r
	200	\r
	201	while (argc > 0) {\r
	202	\r
	203	if ((stricmp (argv[0], "-o") == 0) \|\| (stricmp (argv[0], "--output") == 0)) {\r
	204	OutputFileName = argv[1];\r
	205	if (OutputFileName == NULL) {\r
	206	Error (NULL, 0, 1003, "Invalid option value", "Output file can't be null");\r
	207	return STATUS_ERROR;\r
	208	}\r
	209	argc -= 2;\r
	210	argv += 2;\r
	211	continue; \r
	212	}\r
	213	\r
	214	if ((stricmp (argv[0], "-q") == 0) \|\| (stricmp (argv[0], "--quiet") == 0)) {\r
30fdf114 LG	215	argc --;\r
	216	argv ++;\r
	217	continue; \r
	218	}\r
	219	\r
	220	if ((strlen(argv[0]) >= 2 && argv[0][0] == '-' && (argv[0][1] == 'v' \|\| argv[0][1] == 'V')) \|\| (stricmp (argv[0], "--verbose") == 0)) {\r
	221	VerboseLevel = 1;\r
	222	if (strlen(argv[0]) > 2) {\r
	223	Status = CountVerboseLevel (&argv[0][2], strlen(argv[0]) - 2, &VerboseLevel);\r
	224	if (EFI_ERROR (Status)) {\r
	225	Error (NULL, 0, 1003, "Invalid option value", argv[0]);\r
	226	return STATUS_ERROR; \r
	227	}\r
	228	}\r
	229	\r
	230	argc --;\r
	231	argv ++;\r
	232	continue; \r
	233	}\r
	234	\r
	235	if ((stricmp (argv[0], "-d") == 0) \|\| (stricmp (argv[0], "--debug") == 0)) {\r
	236	Status = AsciiStringToUint64 (argv[1], FALSE, &DebugLevel);\r
	237	if (EFI_ERROR (Status)) {\r
	238	Error (NULL, 0, 1003, "Invalid option value", "%s = %s", argv[0], argv[1]);\r
	239	return STATUS_ERROR; \r
	240	}\r
	241	argc -= 2;\r
	242	argv += 2;\r
	243	continue; \r
	244	}\r
	245	//\r
fd171542	246	// Don't recognize the parameter, should be regarded as the input file name.\r
30fdf114 LG	247	//\r
	248	InputFileNames[InputFileCount] = argv[0];\r
	249	InputFileCount++;\r
	250	argc--;\r
	251	argv++;\r
	252	}\r
	253	\r
	254	if (InputFileCount == 0) {\r
	255	Error (NULL, 0, 1001, "Missing option", "No input file");\r
	256	return STATUS_ERROR;\r
	257	}\r
	258	//\r
	259	// Open output file for write\r
	260	//\r
	261	if (OutputFileName == NULL) {\r
	262	Error (NULL, 0, 1001, "Missing option", "No output file");\r
	263	return STATUS_ERROR;\r
	264	}\r
	265	\r
1be2ed90	266	fpOut = fopen (LongFilePath (OutputFileName), "w+b");\r
30fdf114 LG	267	if (!fpOut) {\r
	268	Error (NULL, 0, 0001, "Could not open output file", OutputFileName);\r
	269	return STATUS_ERROR;\r
	270	}\r
	271	\r
	272	memset (&EfiLdrHeader, 0, sizeof (EfiLdrHeader));\r
	273	memset (&EfiLdrImage, 0, sizeof (EFILDR_IMAGE) * (InputFileCount));\r
	274	\r
	275	memcpy (&EfiLdrHeader.Signature, "EFIL", 4);\r
	276	EfiLdrHeader.FileLength = sizeof(EFILDR_HEADER) + sizeof(EFILDR_IMAGE)*(InputFileCount);\r
	277	\r
	278	//\r
	279	// Skip the file header first\r
	280	//\r
	281	fseek (fpOut, EfiLdrHeader.FileLength, SEEK_SET);\r
	282	\r
	283	//\r
	284	// copy all the input files to the output file\r
	285	//\r
	286	for(i=0;i<InputFileCount;i++) {\r
	287	//\r
	288	// Copy the content of PeImage file to output file\r
	289	//\r
1be2ed90	290	fpIn = fopen (LongFilePath (InputFileNames[i]), "rb");\r
30fdf114 LG	291	if (!fpIn) {\r
	292	Error (NULL, 0, 0001, "Could not open input file", InputFileNames[i]);\r
	293	fclose (fpOut);\r
	294	return STATUS_ERROR;\r
	295	}\r
	296	filesize = FCopyFile (fpIn, fpOut);\r
	297	fclose(fpIn);\r
	298	\r
	299	//\r
	300	// And in the same time update the EfiLdrHeader and EfiLdrImage array\r
	301	//\r
	302	EfiLdrImage[i].Offset = EfiLdrHeader.FileLength;\r
fd171542	303	EfiLdrImage[i].Length = (UINT32) filesize;\r
30fdf114	304	strncpy ((CHAR8*) EfiLdrImage[i].FileName, InputFileNames[i], sizeof (EfiLdrImage[i].FileName) - 1);\r
fd171542	305	EfiLdrHeader.FileLength += (UINT32) filesize;\r
30fdf114 LG	306	EfiLdrHeader.NumberOfImages++;\r
	307	}\r
	308	\r
	309	//\r
	310	// Write the image header to the output file finally\r
	311	//\r
	312	fseek (fpOut, 0, SEEK_SET);\r
	313	fwrite (&EfiLdrHeader, sizeof(EFILDR_HEADER) , 1, fpOut);\r
	314	fwrite (&EfiLdrImage , sizeof(EFILDR_IMAGE)*(InputFileCount), 1, fpOut);\r
	315	\r
	316	fclose (fpOut);\r
	317	printf ("Created %s\n", OutputFileName);\r
	318	return 0;\r
	319	}\r
	320	\r