[segment] Add "Requested memory not available" error message
[people/oremanj/gpxe.git] / src / hci / strerror.c
1 #include <errno.h>
2 #include <string.h>
3 #include <stdio.h>
4 #include <gpxe/errortab.h>
5
6 /** @file
7  *
8  * Error descriptions.
9  *
10  * The error numbers used by Etherboot are a superset of those defined
11  * by the PXE specification version 2.1.  See errno.h for a listing of
12  * the error values.
13  *
14  * To save space in ROM images, error string tables are optional.  Use
15  * the ERRORMSG_XXX options in config.h to select which error string
16  * tables you want to include.  If an error string table is omitted,
17  * strerror() will simply return the text "Error 0x<errno>".
18  *
19  */
20
21 /**
22  * Find error description
23  *
24  * @v errno             Error number
25  * @v mask              Mask of bits that we care about
26  * @ret errortab        Error description, or NULL
27  */
28 static struct errortab * find_error ( int errno, int mask ) {
29         struct errortab *errortab;
30
31         for_each_table_entry ( errortab, ERRORTAB ) {
32                 if ( ( ( errortab->errno ^ errno ) & mask ) == 0 )
33                         return errortab;
34         }
35
36         return NULL;
37 }
38
39 /**
40  * Find closest error description
41  *
42  * @v errno             Error number
43  * @ret errortab        Error description, or NULL
44  *
45  * 
46  */
47 static struct errortab * find_closest_error ( int errno ) {
48         struct errortab *errortab;
49
50         /* First, look for an exact match */
51         if ( ( errortab = find_error ( errno, 0x7fffffff ) ) != NULL )
52                 return errortab;
53
54         /* Second, try masking off the gPXE-specific bit and seeing if
55          * we have an entry for the generic POSIX error message.
56          */
57         if ( ( errortab = find_error ( errno, 0x4f0000ff ) ) != NULL )
58                 return errortab;
59
60         return NULL;
61 }
62
63 /**
64  * Retrieve string representation of error number.
65  *
66  * @v errno/rc          Error number or return status code
67  * @ret strerror        Pointer to error text
68  *
69  * If the error is not found in the linked-in error tables, generates
70  * a generic "Error 0x<errno>" message.
71  *
72  * The pointer returned by strerror() is valid only until the next
73  * call to strerror().
74  *
75  */
76 const char * strerror ( int errno ) {
77         static char errbuf[64];
78         struct errortab *errortab;
79
80         /* Allow for strerror(rc) as well as strerror(errno) */
81         if ( errno < 0 )
82                 errno = -errno;
83
84         /* Find the error description, if one exists */
85         errortab = find_closest_error ( errno );
86
87         /* Construct the error message */
88         if ( errortab ) {
89                 snprintf ( errbuf, sizeof ( errbuf ), "%s (%#08x)",
90                            errortab->text, errno );
91         } else {
92                 snprintf ( errbuf, sizeof ( errbuf ), "Error %#08x", errno );
93         }
94
95         return errbuf;
96 }
97
98 /* Do not include ERRFILE portion in the numbers in the error table */
99 #undef ERRFILE
100 #define ERRFILE 0
101
102 /** The most common errors */
103 struct errortab common_errors[] __errortab = {
104         { 0, "No error" },
105         { EACCES, "Permission denied" },
106         { ECANCELED, "Operation cancelled" },
107         { ECONNRESET, "Connection reset" },
108         { EINVAL, "Invalid argument" },
109         { EIO, "Input/output error" },
110         { ENETUNREACH, "Network unreachable" },
111         { ENODEV, "No such device" },
112         { ENOENT, "File not found" },
113         { ENOEXEC, "Not an executable image" },
114         { ENOMEM, "Out of memory" },
115         { ENOSPC, "No space left on device" },
116         { ENOTSUP, "Not supported" },
117         { EPERM, "Operation not permitted" },
118         { ERANGE, "Out of range" },
119         { ETIMEDOUT, "Connection timed out" },
120 };