EADK (StdLib, AppPkg, StdLibPrivateInternalFiles): Update ReadMe.txt in all packages.
[mirror_edk2.git] / StdLib / ReadMe.txt
1                                      EADK\r
2                   EDK II Standard Libraries and Applications\r
3                                     ReadMe\r
4                                  Version 1.02\r
5                                  21 Dec. 2012\r
6 \r
7 \r
8 OVERVIEW\r
9 ========\r
10 The EADK (uEfi Application Development Kit) provides a set of standards-based\r
11 libraries, along with utility and demonstration applications, intended to\r
12 ease development of UEFI applications based upon the EDK II Open-Source\r
13 distribution.\r
14 \r
15 At this time, applications developed with the EADK are intended to reside\r
16 on, and be loaded from, storage separate from the core firmware.  This is\r
17 primarily due to size and environmental requirements.\r
18 \r
19 This release of the EADK should only be used to produce UEFI Applications.  Due to the execution\r
20 environment built by the StdLib component, execution as a UEFI driver can cause system stability\r
21 issues.\r
22 \r
23 This document describes the EDK II specific aspects of installing, building,\r
24 and using the Standard C Library component of the EDK II Application\r
25 Development Kit, EADK.\r
26 \r
27 The EADK is comprised of three packages:\r
28         AppPkg, StdLib, and StdLibPrivateInternalFiles.\r
29 \r
30   AppPkg   This package contains applications which demonstrate use of the\r
31            Standard C and Sockets Libraries.\r
32            These applications reside in AppPkg/Applications.\r
33 \r
34       Enquire  This is a program that determines many properties of the\r
35                C compiler and the target machine that Enquire is run on.  The\r
36                only changes required to port this 1990s era Unix program to\r
37                EDK II were the addition of eight pragmas to enquire.c in\r
38                order to disable some Microsoft VC++ specific warnings.\r
39 \r
40       Hello    This is a very simple EDK II native application that doesn't use\r
41                any features of the Standard C Library.\r
42 \r
43       Main     This application is functionally identical to Hello, except that\r
44                it uses the Standard C Library to provide a main() entry point.\r
45 \r
46       Python   A port of the Python-2.7.2 interpreter for UEFI.  Building this\r
47                application is disabled by default.\r
48                See the PythonReadMe.txt file, in the Python directory,\r
49                for information on configuring and building Python.\r
50 \r
51       Sockets  A collection of applications demonstrating use of the\r
52                EDK II Socket Libraries.  These applications include:\r
53 \r
54                *   DataSink                     *   DataSource\r
55                *   GetAddrInfo                  *   GetHostByAddr\r
56                *   GetHostByDns                 *   GetHostByName\r
57                *   GetNetByAddr                 *   GetNetByName\r
58                *   GetServByName                *   GetServByPort\r
59                *   OobRx                        *   OobTx\r
60                *   RawIp4Rx                     *   RawIp4Tx\r
61                *   RecvDgram                    *   SetHostName\r
62                *   SetSockOpt                   *   TftpServer\r
63                *   WebServer\r
64 \r
65   StdLib   The StdLib package contains the standard header files as well as\r
66            implementations of other standards-based libraries.\r
67 \r
68            *   BsdSocketLib\r
69                   Support routines above the sockets layer and C interface for\r
70                   the UEFI socket library.\r
71            *   Efi\r
72                   Template contents for the target system's\r
73                   \Efi\StdLib\etc directory.\r
74            *   EfiSocketLib\r
75                   UEFI socket implementation, may be linked into an\r
76                   application or run as a driver.\r
77            *   Include\r
78                   Standard include files.\r
79            *   LibC\r
80                   C Standard Library implementation as per\r
81                   ISO/IEC 9899:199409 (C95).\r
82            *   PosixLib\r
83                   Selected functions from the "Single Unix v4" specification.\r
84            *   SocketDxe\r
85                   UEFI sockets driver, includes EfiSocketLib.\r
86            *   UseSocketDxe\r
87                   Alternate linkage for applications that get built into the\r
88                   firmware.  Cause application to use a common instance of the\r
89                   sockets driver instead of including all of sockets into the\r
90                   application.\r
91 \r
92   StdLibPrivateInternalFiles  The contents of this package are for the\r
93            exclusive use of the library implementations in StdLib.  Please do\r
94            not use anything from this package in your application or else\r
95            unexpected behavior may occur.\r
96            This package may be removed in a future release.\r
97 \r
98 \r
99 RELEASE NOTES\r
100 =============\r
101   Fixes and Additions\r
102   -------------------\r
103 Beginning with release 1.01, applications built with the StdLib package\r
104 no longer have a dependency on the TimerLib.\r
105 \r
106   Known Issues\r
107   -----------------\r
108 This release of the EADK has some restrictions, as described below.\r
109 \r
110     1.  The target machine must be running firmware which provides the\r
111         UEFI 2.3 HII protocol.\r
112 \r
113     2.  Applications must be launched from within the EFI Shell.\r
114 \r
115     3.  Absolute file paths may optionally be prefixed by a volume specifier\r
116         such as "FS0:".  The volume specifier is separated from the remainder\r
117         of the path by a single colon ':'.  The volume specifier must be one of\r
118         the Shell's mapped volume names as shown by the "map" command.\r
119 \r
120     4.  Absolute file paths that don't begin with a volume specifier;\r
121         e.g. paths that begin with "/", are relative to the currently selected\r
122         volume.  When the EFI Shell first starts, there is NO selected volume.\r
123 \r
124     5.  The tmpfile(), and related, functions require that the current volume\r
125         have a temporary directory as specified in <paths.h>.  This directory\r
126         is specified by macro _PATH_TMP as /Efi/StdLib/tmp.\r
127 \r
128 The Standard C Library provided by this package is a "hosted" implementation\r
129 conforming to the ISO/IEC 9899-1990 C Language Standard with Addendum 1. This\r
130 is commonly referred to as the "C 95" specification or ISO/IEC 9899:199409.\r
131 The following instructions assume that you have an existing EDK II or UDK 2010\r
132 source tree that has been configured to build with your tool chain.  For\r
133 convenience, it is assumed that your EDK II source tree is located at\r
134 C:\Source\Edk2.\r
135 \r
136 \r
137 EADK INSTALLATION\r
138 =================\r
139 The EADK is integrated within the EDK II source tree and is included with\r
140 current EDK II check-outs.  If they are missing from your tree, they may be\r
141 installed by extracting, downloading or copying them to the root of your EDK II\r
142 source tree.  The three package directories should be peers to the Conf,\r
143 MdePkg, Nt32Pkg, etc. directories.\r
144 \r
145 There are some boiler-plate declarations and definitions that need to be\r
146 included in your application's INF and DSC build files.  These are described\r
147 in the CONFIGURATION section, below.\r
148 \r
149 A subset of the Python 2.7.2 distribution is included as part of AppPkg.  If desired,\r
150 the full Python 2.7.2 distribution may be downloaded from python.org and used instead.\r
151 Delete or rename the existing Python-2.7.2 directory then extract the downloaded\r
152 Python-2.7.2.tgz file into the AppPkg\Applications\Python directory.  This will produce a\r
153 Python-2.7.2 directory containing the full Python distribution.  Python files that had to be\r
154 modified for EDK II are in the AppPkg\Applications\Python\PyMod-2.7.2 directory.  These\r
155 files need to be copied into the corresponding directories within the extracted Python-2.7.2\r
156 directory before Python can be built.\r
157 \r
158 \r
159 BUILDING\r
160 ========\r
161 It is not necessary to build the libraries separately from the target\r
162 application(s). If the application references the libraries, as described in\r
163 USAGE, below; the required libraries will be built as needed.\r
164 To build the applications included in AppPkg, one would execute the following\r
165 commands within the "Visual Studio Command Prompt" window:\r
166 \r
167     > cd C:\Source\Edk2\r
168     > .\edksetup.bat\r
169     > build -a X64 -p AppPkg\AppPkg.dsc\r
170 \r
171 This will produce the application executables: Enquire.efi, Hello.efi, and\r
172 Main.efi in the C:\Source\Edk2\Build\AppPkg\DEBUG_VS2008\X64 directory; with\r
173 the DEBUG_VS2008 component being replaced with the actual tool chain and build\r
174 type you have selected in Conf\Tools_def.txt. These executables can now be\r
175 loaded onto the target platform and executed.\r
176 \r
177 If you examine the AppPkg.dsc file, you will notice that the StdLib package is\r
178 referenced in order to resolve the library classes comprising the Standard\r
179 C Library.  This, plus referencing the StdLib package in your application's\r
180 .inf file is all that is needed to link your application to the standard\r
181 libraries.\r
182 \r
183 Unless explicitly stated as allowed, EADK components should not be added as\r
184 components of a DSC file which builds a platform's core firmware.  There are\r
185 incompatibilities in build flags and requirements that will conflict with the\r
186 requirements of the core firmware.  EADK components should be built using a\r
187 separate DSC file then, if absolutely necessary, included as binary components\r
188 of other DSC files.\r
189 \r
190 USAGE\r
191 =====\r
192 This implementation of the Standard C Library is comprised of 16 separate\r
193 libraries in addition to the standard header files. Nine of the libraries are\r
194 associated with use of one of the standard headers; thus, if the header is used\r
195 in an application, it must be linked with the associated library.  Three\r
196 libraries are used to provide the Console and File-system device abstractions.\r
197 The libraries and associated header files are described in the following table.\r
198 \r
199  Library\r
200   Class      Header File(s)    Notes\r
201 ----------  ----------------  -------------------------------------------------\r
202 LibC        -- Use Always --  This library is always required.\r
203 LibCtype    ctype.h, wctype.h Character classification and mapping\r
204 LibLocale   locale.h          Localization types, macros, and functions\r
205 LibMath     math.h            Mathematical functions, types, and macros\r
206 LibStdio    stdio.h           Standard Input and Output functions, types, and\r
207                               macros\r
208 LibStdLib   stdlib.h          General Utilities for numeric conversion, random\r
209                               num., etc.\r
210 LibString   string.h          String copying, concatenation, comparison,\r
211                               & search\r
212 LibSignal   signal.h          Functions and types for handling run-time\r
213                               conditions\r
214 LibTime     time.h            Time and Date types, macros, and functions\r
215 LibUefi     sys/EfiSysCall.h  Provides the UEFI system interface and\r
216                               "System Calls"\r
217 LibWchar    wchar.h           Extended multibyte and wide character utilities\r
218 LibNetUtil                    Network address and number manipulation utilities\r
219 DevConsole                    Automatically provided File I/O abstractions for\r
220                               the UEFI Console device.  No need to list this\r
221                               library class in your INF file(s).\r
222 DevShell    Add if desired    File I/O abstractions using UEFI shell\r
223                               facilities.  Add this to the application's main\r
224                               INF file if file-system access needed.\r
225 DevUtility  -- Do Not Use --  Utility functions used internally by the Device abstractions\r
226 LibGdtoa    -- Do Not Use --  This library is used internally and should not\r
227                               need to be explicitly specified by an\r
228                               application.  It must be defined as one of the\r
229                               available library classes in the application's\r
230                               DSC file.\r
231 \r
232                          Table 1:  Standard Libraries\r
233                          ============================\r
234 \r
235 The DevConsole and DevShell libraries provide device I/O functionality and are treated\r
236 specially.  DevConsole is automatically included so there is no need to reference it in your\r
237 application's DSC or INF files.  DevShell must be listed, in your application's INF file in the\r
238 [LibraryClasses] section, if your application does file I/O.\r
239 \r
240 These libraries must be fully described in the [LibraryClasses] section of the\r
241 application package's DSC file. Then, each individual application needs to\r
242 specify which libraries to link to by specifying the Library Class, from the\r
243 above table, in the [LibraryClasses] section of the application's INF file. The\r
244 AppPkg.dsc, StdLib.dsc, and Enquire.inf files provide good examples of this.\r
245 More details are in the CONFIGURATION section, below.\r
246 \r
247 In order to simplify this process, the [LibraryClasses] definitions, and others, are\r
248 specified in the StdLib.inc file.  If this file is included in the DSC file, usually at the\r
249 end, then other DSC file changes or additions are unnecessary.  This is further described in\r
250 the CONFIGURATION section, below.\r
251 \r
252 Within the source files of the application, use of the Standard headers and\r
253 library functions follow standard C programming practices as formalized by\r
254 ISO/IEC 9899:1990, with Addendum 1, (C 95) C language specification.\r
255 \r
256 \r
257 BUILD CONFIGURATION\r
258 ===================\r
259 DSC Files\r
260 ---------\r
261 \r
262 All EDK II packages which build applications that use the standard libraries\r
263 must include some "boilerplate" text in the package's .dsc file.  To make it\r
264 easier, and to reduce cut-and-paste errors, the "boilerplate" text has been\r
265 consolidated into a single file, StdLib/StdLib.inc, which can be included in\r
266 your .dsc file using the !include directive.  The provided AppPkg.dsc and\r
267 StdLib.dsc files do this on their last line.\r
268 \r
269 The "boilerplate" text can be included using a !include directive in the\r
270 package's .dsc file.  The provided AppPkg.dsc and StdLib.dsc files include\r
271 the following "boilerplate" text:\r
272 \r
273   ##############################################################################\r
274   #\r
275   # Specify whether we are running in an emulation environment, or not.\r
276   # Define EMULATE if we are, else keep the DEFINE commented out.\r
277   #\r
278   # DEFINE  EMULATE = 1\r
279 \r
280   ##############################################################################\r
281   #\r
282   #  Include Boilerplate text required for building with the Standard Libraries.\r
283   #\r
284   ##############################################################################\r
285   !include StdLib/StdLib.inc\r
286 \r
287                       Figure 1: "Boilerplate" Inclusion\r
288                       =================================\r
289 \r
290 The EMULATE macro must be defined if one desires to do source-level debugging within one of\r
291 the emulated environments such as NT32Pkg or UnixPkg.\r
292 \r
293 The final boilerplate line, in Figure 1, includes the StdLib.inc file.\r
294 Each section of StdLib/StdLib.inc is described below.\r
295 \r
296 If desired, all of the Socket applications, in AppPkg, can be built by including Sockets.inc:\r
297 \r
298   !include AppPkg/Applications/Sockets/Sockets.inc\r
299 \r
300               Figure 2: Socket Applications "Boilerplate" Inclusion\r
301               =====================================================\r
302 \r
303 \r
304 Descriptions of the Library Classes comprising the Standard Libraries,\r
305 as shown in Figure 3: Library Class Descriptions, are provided.\r
306 \r
307   [LibraryClasses]\r
308     #\r
309     # C Standard Libraries\r
310     #\r
311     LibC|StdLib/LibC/LibC.inf\r
312     LibCType|StdLib/LibC/Ctype/Ctype.inf\r
313     LibLocale|StdLib/LibC/Locale/Locale.inf\r
314     LibMath|StdLib/LibC/Math/Math.inf\r
315     LibSignal|StdLib/LibC/Signal/Signal.inf\r
316     LibStdio|StdLib/LibC/Stdio/Stdio.inf\r
317     LibStdLib|StdLib/LibC/StdLib/StdLib.inf\r
318     LibString|StdLib/LibC/String/String.inf\r
319     LibTime|StdLib/LibC/Time/Time.inf\r
320     LibUefi|StdLib/LibC/Uefi/Uefi.inf\r
321     LibWchar|StdLib/LibC/Wchar/Wchar.inf\r
322 \r
323   # Common Utilities for Networking Libraries\r
324     LibNetUtil|StdLib/LibC/NetUtil/NetUtil.inf\r
325 \r
326   # Additional libraries for POSIX functionality.\r
327     LibErr|StdLib/PosixLib/Err/LibErr.inf\r
328     LibGen|StdLib/PosixLib/Gen/LibGen.inf\r
329     LibGlob|StdLib/PosixLib/Glob/LibGlob.inf\r
330     LibStringlist|StdLib/PosixLib/Stringlist/LibStringlist.inf\r
331 \r
332   # Libraries for device abstractions within the Standard C Library\r
333   # Applications should not directly access any functions defined in these libraries.\r
334     LibGdtoa|StdLib/LibC/gdtoa/gdtoa.inf\r
335     DevConsole|StdLib/LibC/Uefi/Devices/daConsole.inf\r
336     DevShell|StdLib/LibC/Uefi/Devices/daShell.inf\r
337     DevUtility|StdLib/LibC/Uefi/Devices/daUtility.inf\r
338 \r
339   [LibraryClasses.ARM.UEFI_APPLICATION]\r
340     NULL|ArmPkg/Library/CompilerIntrinsicsLib/CompilerIntrinsicsLib.inf\r
341 \r
342                      Figure 3: Library Class Descriptions\r
343                      ====================================\r
344 \r
345 \r
346 The directives in Figure 4: Package Component Descriptions will create\r
347 instances of the BaseLib and BaseMemoryLib library classes that are built\r
348 with Link-time-Code-Generation disabled.  This is necessary when using the\r
349 Microsoft tool chains in order to allow the library's functions to be\r
350 resolved during the second pass of the linker during Link-Time-Code-Generation\r
351 of the application.\r
352 \r
353 A DXE driver version of the Socket library is also built.\r
354 \r
355   [Components]\r
356   # BaseLib and BaseMemoryLib need to be built with the /GL- switch\r
357   # when using the Microsoft tool chains.  This is required so that\r
358   # the library functions can be resolved during the second pass of\r
359   # the linker during link-time-code-generation.\r
360   #\r
361     MdePkg/Library/BaseLib/BaseLib.inf {\r
362       <BuildOptions>\r
363         MSFT:*_*_*_CC_FLAGS = /X /Zc:wchar_t /GL-\r
364     }\r
365     MdePkg/Library/BaseMemoryLib/BaseMemoryLib.inf {\r
366       <BuildOptions>\r
367         MSFT:*_*_*_CC_FLAGS = /X /Zc:wchar_t /GL-\r
368     }\r
369 \r
370   ##########\r
371   #  Socket Layer\r
372   ##########\r
373     StdLib/SocketDxe/SocketDxe.inf\r
374 \r
375                     Figure 4: Package Component Descriptions\r
376                     ========================================\r
377 \r
378 \r
379 Each compiler assumes, by default, that it will be used with standard libraries\r
380 and headers provided by the compiler vendor.  Many of these assumptions are\r
381 incorrect for the UEFI environment.  By including a BuildOptions section, as\r
382 shown in Figure 5: Package Build Options, these assumptions can be\r
383 tailored for compatibility with UEFI and the EDK II Standard Libraries.\r
384 \r
385 Note that the set of BuildOptions used is determined by the state of the EMULATE macro.\r
386 \r
387   [BuildOptions]\r
388   !ifndef $(EMULATE)\r
389     # These Build Options are used when building the Standard Libraries to be run\r
390     # on real hardware.\r
391     INTEL:*_*_IA32_CC_FLAGS  = /Qfreestanding\r
392      MSFT:*_*_IA32_CC_FLAGS  = /X /Zc:wchar_t\r
393       GCC:*_*_IA32_CC_FLAGS  = -nostdinc -nostdlib\r
394 \r
395   !else\r
396     # The Build Options, below, are only used when building the Standard Libraries\r
397     # to be run under an emulation environment.\r
398     # They disable optimization which facillitates debugging under the Emulation environment.\r
399     INTEL:*_*_IA32_CC_FLAGS  = /Od\r
400      MSFT:*_*_IA32_CC_FLAGS  = /Od\r
401       GCC:*_*_IA32_CC_FLAGS  = -O0\r
402 \r
403                         Figure 5: Package Build Options\r
404                         ===============================\r
405 \r
406 \r
407 INF Files\r
408 =========\r
409 The INF files for most modules will not require special directives in order to\r
410 support the Standard Libraries.  The two sections which require attention: LibraryClasses\r
411 and BuildOptions, are described below.\r
412 \r
413   [LibraryClasses]\r
414     UefiLib\r
415     LibC\r
416     LibString\r
417     LibStdio\r
418     DevShell\r
419 \r
420                       Figure 6: Module Library Classes\r
421                       ================================\r
422 \r
423 \r
424 Modules of type UEFI_APPLICATION that perform file I/O must include library\r
425 class DevShell.  Including this library class will allow file operations to be\r
426 handled by the UEFI Shell.  Without this class, only Console I/O is supported.\r
427 \r
428 \r
429 An application's INF file might need to include a [BuildOptions] section\r
430 specifying additional compiler and linker flags necessary to allow the\r
431 application to be built. Usually, this section is not needed.  When building\r
432 code from external sources, though, it may be necessary to disable some\r
433 warnings or enable/disable some compiler features.\r
434 \r
435  [BuildOptions]\r
436   INTEL:*_*_*_CC_FLAGS          = /Qdiag-disable:181,186\r
437    MSFT:*_*_*_CC_FLAGS          = /Oi- /wd4018 /wd4131\r
438     GCC:*_*_IPF_SYMRENAME_FLAGS = --redefine-syms=Rename.txt\r
439 \r
440                         Figure 7: Module Build Options\r
441                         ==============================\r
442 \r
443 \r
444 TARGET-SYSTEM INSTALLATION\r
445 ==========================\r
446 Applications that use file system features or the Socket library depend upon\r
447 the existence of a specific directory tree structure on the same volume that\r
448 the application was loaded from.  This tree structure is described below:\r
449 \r
450     /EFI                      Root of the UEFI system area.\r
451      |- /Tools                Directory containing applications.\r
452      |- /Boot                 UEFI specified Boot directory.\r
453      |- /StdLib               Root of the Standard Libraries sub-tree.\r
454          |- /etc              Configuration files used by libraries.\r
455          |- /tmp              Temporary files created by tmpfile(), etc.\r
456 \r
457 \r
458 The /Efi/StdLib/etc directory must be manually populated from the StdLib/Efi/etc source\r
459 directory.\r
460 \r
461 IMPLEMENTATION-Specific Features\r
462 ================================\r
463 It is very strongly recommended that applications not use the long or\r
464 unsigned long types. The size of these types varies between compilers and is one\r
465 of the less portable aspects of C. Instead, one should use the UEFI defined\r
466 types whenever possible. Use of these types, listed below for reference,\r
467 ensures that the declared objects have unambiguous, explicitly declared, sizes\r
468 and characteristics.\r
469 \r
470         UINT64   INT64     UINT32   INT32   UINT16   CHAR16\r
471         INT16    BOOLEAN   UINT8    CHAR8   INT8\r
472         UINTN    INTN                       PHYSICALADDRESS\r
473 \r
474 There are similar types declared in sys/types.h and related files.\r
475 \r
476 The types UINTN and INTN have the native width of the target processor\r
477 architecture. Thus, INTN on IA32 has a width of 32 bits while INTN on X64 and\r
478 IPF has a width of 64 bits.\r
479 \r
480 For maximum portability, data objects intended to hold addresses should be\r
481 declared with type intptr_t or uintptr_t. These types, declared in\r
482 sys/stdint.h, can be used to create objects capable of holding pointers. Note\r
483 that these types will generate different sized objects on different processor\r
484 architectures.  If a constant size across all processors and compilers is\r
485 needed, use type PHYSICAL_ADDRESS.\r
486 \r
487 Though not specifically required by the ISO/IEC 9899 standard, this\r
488 implementation of the Standard C Library provides the following system calls\r
489 which are declared in sys/EfiSysCall.h and/or unistd.h.\r
490 \r
491           close   creat    chmod    dup      dup2\r
492           fcntl   fstat    getcwd   ioctl    isatty\r
493           lseek   lstat    mkdir    open     poll\r
494           read    rename   rmdir    stat     unlink   write\r
495 \r
496 The open function will accept file names of "stdin:", "stdout:", and "stderr:"\r
497 which cause the respective streams specified in the UEFI System Table to be\r
498 opened.  Normally, these are associated with the console device.  When the\r
499 application is first started, these streams are automatically opened on File\r
500 Descriptors 0, 1, and 2 respectively.\r
501 \r
502                             # # #\r