84c3424aa8496f587099947052aa5f9acbea8838
[gpxe.git] / src / core / errno.c
1 #include <errno.h>
2 #include <console.h>
3 #include <gpxe/errortab.h>
4
5 /** @file
6  *
7  * Error codes and descriptions.
8  *
9  * This file provides the global variable #errno and the function
10  * strerror().  These function much like their standard C library
11  * equivalents.
12  *
13  * The error numbers used by Etherboot are a superset of those defined
14  * by the PXE specification version 2.1.  See errno.h for a listing of
15  * the error values.
16  *
17  * To save space in ROM images, error string tables are optional.  Use
18  * the ERRORMSG_XXX options in config.h to select which error string
19  * tables you want to include.  If an error string table is omitted,
20  * strerror() will simply return the text "Error 0x<errno>".
21  *
22  */
23
24 /**
25  * Global "last error" number.
26  *
27  * This is valid only when a function has just returned indicating a
28  * failure.
29  *
30  */
31 int errno;
32
33 static struct errortab errortab_start[0] __table_start(errortab);
34 static struct errortab errortab_end[0] __table_end(errortab);
35
36 /**
37  * Retrieve string representation of error number.
38  *
39  * @v errno             Error number
40  * @ret strerror        Pointer to error text
41  *
42  * If the error is not found in the linked-in error tables, generates
43  * a generic "Error 0x<errno>" message.
44  *
45  * The pointer returned by strerror() is valid only until the next
46  * call to strerror().
47  *
48  */
49 const char * strerror ( int errno ) {
50         static char *generic_message = "Error 0x0000";
51         struct errortab *errortab;
52
53         for ( errortab = errortab_start ; errortab < errortab_end ;
54               errortab++ ) {
55                 if ( errortab->errno == errno )
56                         return errortab->text;
57         }
58
59         sprintf ( generic_message + 8, "%hx", errno );
60         return generic_message;
61 }