VirtualBox

source: vbox/trunk/src/bldprogs/bin2c.c@ 93115

Last change on this file since 93115 was 93115, checked in by vboxsync, 3 years ago

scm --update-copyright-year
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 8.6 KB
Line 
1/* $Id: bin2c.c 93115 2022-01-01 11:31:46Z vboxsync $ */
2/** @file
3 * bin2c - Binary 2 C Structure Converter.
4 */
5
6/*
7 * Copyright (C) 2006-2022 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18
19/*********************************************************************************************************************************
20* Header Files *
21*********************************************************************************************************************************/
22#include <ctype.h>
23#include <stdio.h>
24#include <string.h>
25#include <stdlib.h>
26#include <sys/types.h>
27
28
29/**
30 * File size.
31 *
32 * @returns file size in bytes.
33 * @returns 0 on failure.
34 * @param pFile File to size.
35 */
36static size_t fsize(FILE *pFile)
37{
38 long cbFile;
39 off_t Pos = ftell(pFile);
40 if ( Pos >= 0
41 && !fseek(pFile, 0, SEEK_END))
42 {
43 cbFile = ftell(pFile);
44 if ( cbFile >= 0
45 && !fseek(pFile, 0, SEEK_SET))
46 return cbFile;
47 }
48 return 0;
49}
50
51static int usage(const char *argv0)
52{
53 fprintf(stderr,
54 "Syntax: %s [options] <arrayname> <binaryfile> <outname>\n"
55 " --min <n> check if <binaryfile> is not smaller than <n>KB\n"
56 " --max <n> check if <binaryfile> is not bigger than <n>KB\n"
57 " --mask <n> check if size of binaryfile is <n>-aligned\n"
58 " --width <n> number of bytes per line (default: 16)\n"
59 " --break <n> break every <n> lines (default: -1)\n"
60 , argv0);
61 fprintf(stderr,
62 " --ascii show ASCII representation of binary as comment\n"
63 " --export emit DECLEXPORT\n"
64 " --append append to the output file (default: truncate)\n"
65 " --no-size Skip the size.\n"
66 " --static Static data scope.\n");
67
68 return 1;
69}
70
71int main(int argc, char *argv[])
72{
73 FILE *pFileIn;
74 FILE *pFileOut;
75 int iArg;
76 size_t cbMin = 0;
77 size_t cbMax = ~0U;
78 size_t uMask = 0;
79 int fAscii = 0;
80 int fAppend = 0;
81 int fExport = 0;
82 int fNoSize = 0;
83 int fStatic = 0;
84 long iBreakEvery = -1;
85 unsigned char abLine[32];
86 size_t cbLine = 16;
87 size_t off;
88 size_t cbRead;
89 size_t cbBin;
90 int rc = 1; /* assume the worst... */
91
92 if (argc < 2)
93 return usage(argv[0]);
94
95 for (iArg = 1; iArg < argc; iArg++)
96 {
97 if (!strcmp(argv[iArg], "--min") || !strcmp(argv[iArg], "-min"))
98 {
99 if (++iArg >= argc)
100 return usage(argv[0]);
101 cbMin = 1024 * strtoul(argv[iArg], NULL, 0);
102 }
103 else if (!strcmp(argv[iArg], "--max") || !strcmp(argv[iArg], "-max"))
104 {
105 if (++iArg >= argc)
106 return usage(argv[0]);
107 cbMax = 1024 * strtoul(argv[iArg], NULL, 0);
108 }
109 else if (!strcmp(argv[iArg], "--mask") || !strcmp(argv[iArg], "-mask"))
110 {
111 if (++iArg >= argc)
112 return usage(argv[0]);
113 uMask = strtoul(argv[iArg], NULL, 0);
114 }
115 else if (!strcmp(argv[iArg], "--ascii") || !strcmp(argv[iArg], "-ascii"))
116 fAscii = 1;
117 else if (!strcmp(argv[iArg], "--append"))
118 fAppend = 1;
119 else if (!strcmp(argv[iArg], "--export") || !strcmp(argv[iArg], "-export"))
120 fExport = 1;
121 else if (!strcmp(argv[iArg], "--no-size"))
122 fNoSize = 1;
123 else if (!strcmp(argv[iArg], "--static"))
124 fStatic = 1;
125 else if (!strcmp(argv[iArg], "--width") || !strcmp(argv[iArg], "-width"))
126 {
127 if (++iArg >= argc)
128 return usage(argv[0]);
129 cbLine = strtoul(argv[iArg], NULL, 0);
130 if (cbLine == 0 || cbLine > sizeof(abLine))
131 {
132 fprintf(stderr, "%s: '%s' is too wide, max %u\n",
133 argv[0], argv[iArg], (unsigned)sizeof(abLine));
134 return 1;
135 }
136 }
137 else if (!strcmp(argv[iArg], "--break") || !strcmp(argv[iArg], "-break"))
138 {
139 if (++iArg >= argc)
140 return usage(argv[0]);
141 iBreakEvery = strtol(argv[iArg], NULL, 0);
142 if (iBreakEvery <= 0 && iBreakEvery != -1)
143 {
144 fprintf(stderr, "%s: -break value '%s' is not >= 1 or -1.\n",
145 argv[0], argv[iArg]);
146 return 1;
147 }
148 }
149 else if (iArg == argc - 3)
150 break;
151 else
152 {
153 fprintf(stderr, "%s: syntax error: Unknown argument '%s'\n",
154 argv[0], argv[iArg]);
155 return usage(argv[0]);
156 }
157 }
158
159 pFileIn = fopen(argv[iArg+1], "rb");
160 if (!pFileIn)
161 {
162 fprintf(stderr, "Error: failed to open input file '%s'!\n", argv[iArg+1]);
163 return 1;
164 }
165
166 pFileOut = fopen(argv[iArg+2], fAppend ? "a" : "w"); /* no b! */
167 if (!pFileOut)
168 {
169 fprintf(stderr, "Error: failed to open output file '%s'!\n", argv[iArg+2]);
170 fclose(pFileIn);
171 return 1;
172 }
173
174 cbBin = fsize(pFileIn);
175
176 fprintf(pFileOut,
177 "/*\n"
178 " * This file was automatically generated\n"
179 " * from %s\n"
180 " * by %s.\n"
181 " */\n"
182 "\n"
183 "#include <iprt/cdefs.h>\n"
184 "\n"
185 "%sconst unsigned char%s g_ab%s[] =\n"
186 "{\n",
187 argv[iArg+1], argv[0], fStatic ? "static " : fExport ? "DECLEXPORT(" : "", !fStatic && fExport ? ")" : "", argv[iArg]);
188
189 /* check size restrictions */
190 if (uMask && (cbBin & uMask))
191 fprintf(stderr, "%s: size=%ld - Not aligned!\n", argv[0], (long)cbBin);
192 else if (cbBin < cbMin || cbBin > cbMax)
193 fprintf(stderr, "%s: size=%ld - Not %ld-%ldb in size!\n",
194 argv[0], (long)cbBin, (long)cbMin, (long)cbMax);
195 else
196 {
197 /* the binary data */
198 off = 0;
199 while ((cbRead = fread(&abLine[0], 1, cbLine, pFileIn)) > 0)
200 {
201 size_t j;
202
203 if ( iBreakEvery > 0
204 && off
205 && (off / cbLine) % iBreakEvery == 0)
206 fprintf(pFileOut, "\n");
207
208 fprintf(pFileOut, " ");
209 for (j = 0; j < cbRead; j++)
210 fprintf(pFileOut, " 0x%02x,", abLine[j]);
211 for (; j < cbLine; j++)
212 fprintf(pFileOut, " ");
213 if (fAscii)
214 {
215 fprintf(pFileOut, " /* 0x%08lx: ", (long)off);
216 for (j = 0; j < cbRead; j++)
217 /* be careful with '/' prefixed/followed by a '*'! */
218 fprintf(pFileOut, "%c",
219 isprint(abLine[j]) && abLine[j] != '/' ? abLine[j] : '.');
220 for (; j < cbLine; j++)
221 fprintf(pFileOut, " ");
222 fprintf(pFileOut, " */");
223 }
224 fprintf(pFileOut, "\n");
225
226 off += cbRead;
227 }
228
229 /* check for errors */
230 if (ferror(pFileIn) && !feof(pFileIn))
231 fprintf(stderr, "%s: read error\n", argv[0]);
232 else if (off != cbBin)
233 fprintf(stderr, "%s: read error off=%ld cbBin=%ld\n", argv[0], (long)off, (long)cbBin);
234 else
235 {
236 /* no errors, finish the structure. */
237 fprintf(pFileOut,
238 "};\n");
239
240 if (!fNoSize)
241 fprintf(pFileOut,
242 "\n"
243 "%sconst unsigned%s g_cb%s = sizeof(g_ab%s);\n",
244 fExport ? "DECLEXPORT(" : "", fExport ? ")" : "", argv[iArg], argv[iArg]);
245
246 fprintf(pFileOut, "/* end of file */\n");
247
248 /* flush output and check for error. */
249 fflush(pFileOut);
250 if (ferror(pFileOut))
251 fprintf(stderr, "%s: write error\n", argv[0]);
252 else
253 rc = 0; /* success! */
254 }
255 }
256
257 /* cleanup, delete the output file on failure. */
258 fclose(pFileOut);
259 fclose(pFileIn);
260 if (rc)
261 remove(argv[iArg+2]);
262
263 return rc;
264}
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette