[Contribs] Add command-line utility for looking up gPXE error codes.
[people/lynusvaz/gpxe.git] / contrib / errcode / errcode.py
1 #!/usr/bin/env python
2 import sys
3
4 try:
5     import errcodedb
6 except ImportError:
7     sys.stderr.write('Please run this first: ./build_errcodedb.py >errcodedb.py\n')
8     sys.exit(1)
9
10 def to_pxenv_status(errno):
11     return errno & 0xff
12
13 def to_uniq(errno):
14     return (errno >> 8) & 0x1f
15
16 def to_errfile(errno):
17     return (errno >> 13) & 0x7ff
18
19 def to_posix_errno(errno):
20     return (errno >> 24) & 0x7f
21
22 def lookup_errno_component(defines, selector, component):
23     for key, val in defines.iteritems():
24         if selector(val) == component:
25             return key
26     return '0x%x' % component
27
28 class Errno(object):
29     def __init__(self, errno):
30         self.pxenv_status = to_pxenv_status(errno)
31         self.uniq = to_uniq(errno)
32         self.errfile = to_errfile(errno)
33         self.posix_errno = to_posix_errno(errno)
34
35     def rawstr(self):
36         return 'pxenv_status=0x%x uniq=%d errfile=0x%x posix_errno=0x%x' % (self.pxenv_status, self.uniq, self.errfile, self.posix_errno)
37
38     def prettystr(self):
39         return 'pxenv_status=%s uniq=%d errfile=%s posix_errno=%s' % (
40                 lookup_errno_component(errcodedb.pxenv_status, to_pxenv_status, self.pxenv_status),
41                 self.uniq,
42                 lookup_errno_component(errcodedb.errfile, to_errfile, self.errfile),
43                 lookup_errno_component(errcodedb.posix_errno, to_posix_errno, self.posix_errno)
44                 )
45
46     def __str__(self):
47         return self.prettystr()
48
49 def usage():
50     sys.stderr.write('usage: %s ERROR_NUMBER\n' % sys.argv[0])
51     sys.exit(1)
52
53 if __name__ == '__main__':
54     if len(sys.argv) != 2:
55         usage()
56
57     try:
58         errno = int(sys.argv[1], 16)
59     except ValueError:
60         usage()
61
62     print Errno(errno)
63     sys.exit(0)