summary refs log tree commit diff
path: root/sysdeps/mach/hurd/errnos.awk
blob: bc69e06bf6b90c031cf7addcba2cd0410cdf1d2e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# Copyright (C) 1991-2018 Free Software Foundation, Inc.
# This file is part of the GNU C Library.

# The GNU C Library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.

# The GNU C Library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.

# You should have received a copy of the GNU Lesser General Public
# License along with the GNU C Library; if not, see
# <http://www.gnu.org/licenses/>.

# errno.texinfo contains lines like:
# @errno{ENOSYS, 123, Function not implemented}

BEGIN {
    print "/* This file generated by errnos.awk from";
    for (i = 1; i < ARGC; i++)
      {
	arg = ARGV[i];
	sub(/.*(manual|include)\//, "", arg)
	print "     " arg;
      }
    print "   Do not edit this file; edit errnos.awk and regenerate it.  */";
    print "";
    print "#ifndef _BITS_ERRNO_H";
    print "#define _BITS_ERRNO_H 1";
    print "";
    print "#if !defined _ERRNO_H";
    print "# error \"Never include <bits/errno.h> directly; use <errno.h> instead.\"";
    print "#endif";

    maxerrno = 0;
    maxerrlen = 0;
    in_mach_errors = "";
    seq = 0;
  }

/^@errno\{/ \
  {
    e = substr($1, 8, length($1)-8)
    if (length(e) > maxerrlen)
      maxerrlen = length(e);
    if (e == "EWOULDBLOCK")
      {
	econsts[seq] = e;
	errnos[seq] = "EAGAIN";
	seq++;
	next;
      }

    errno = substr($2, 1, length($2)-1) + 0;
    if (errno == 0)
      next;
    if (errno > 0x3ffff)
      {
	printf("%s:%d: errno value %d too large for the Hurd\n",
	       FILENAME, NR, errno) >> "/dev/stderr";
	exit 1;
      }
    if (errno > maxerrno)
      maxerrno = errno;

    etext = "";
    for (i = 3; i <= NF; ++i)
      etext = etext " " $i;
    etext = substr(etext, 2, length(etext)-2);

    econsts[seq] = e;
    errnos[seq] = sprintf("0x%08x", 0x40000000 + errno);
    etexts[seq] = etext;
    seq++;
    next;
  }

NF == 3 && $1 == "#define" && $2 == "MACH_SEND_IN_PROGRESS" \
  {
    in_mach_errors = FILENAME;
    annot[seq++] = "\n/* Errors from <mach/message.h>.  */";
  }
NF == 3 && $1 == "#define" && $2 == "KERN_SUCCESS" \
  {
    in_mach_errors = FILENAME;
    annot[seq++] = "\n/* Errors from <mach/kern_return.h>.  */";
    next;
  }

in_mach_errors != "" && $2 == "MACH_IPC_COMPAT" \
  {
    in_mach_errors = "";
  }

# FIXME: mach/message.h and mach/kern_return.h do include error
# descriptions which we could slurp, but some of them are very long,
# we would need to word-wrap them.
in_mach_errors == FILENAME && NF == 3 && $1 == "#define" \
  {
    e = "E" $2;
    if (length(e) > maxerrlen)
      maxerrlen = length(e);
    econsts[seq] = e;
    errnos[seq] = $3;
    etexts[seq] = "";
    seq++;
  }

$1 == "#define" && $2 == "_MACH_MIG_ERRORS_H_" \
  {
    in_mig_errors = 1;
    annot[seq++] = "\n/* Errors from <mach/mig_errors.h>.  */";
    next;
  }
in_mig_errors && $1 == "#endif" && $3 == "_MACH_MIG_ERRORS_H_" \
  {
    in_mig_errors = 0;
  }

(in_mig_errors && $1 == "#define" && $3 <= -300) || \
(in_device_errors && $1 == "#define" && /D_/ && NF > 3) \
  {
    etext = "";
    for (i = 5; i < NF; ++i)
      etext = etext " " $i;

    e = "E" $2;
    if (length(e) > maxerrlen)
      maxerrlen = length(e);
    econsts[seq] = e;
    errnos[seq] = $3;
    etexts[seq] = substr(etext, 2, length(etext)-1);
    seq++;
  }

$1 == "#define" && $2 == "D_SUCCESS" \
  {
    in_device_errors = 1;
    annot[seq++] = "\n/* Errors from <device/device_types.h>.  */";
    next;
  }
in_device_errors && $1 == "#endif" \
  {
    in_device_errors = 0;
  }

function print_errno_enum(maxseq)
{
  print "";
  print "#ifndef __ASSEMBLER__";
  print "";
  print "enum __error_t_codes";
  print "{";
  print "  /* The value zero always means success and it is perfectly fine";
  print "     for code to use 0 explicitly (or implicitly, e.g. via Boolean";
  print "     coercion.)  Having an enum entry for zero both makes the";
  print "     debugger print the name for error_t-typed zero values, and";
  print "     prevents the compiler from issuing warnings about 'case 0:'";
  print "     in a switch on an error_t-typed value.  */";
  printf("  %-*s = 0,\n", maxerrlen, "ESUCCESS");

  print "";
  print "  /* The Hurd uses Mach error system 0x10, subsystem 0. */";
  for (i = 0; i < maxseq; i++)
    {
      if (i in annot)
	print annot[i];
      else if (i in etexts && etexts[i] != "")
	printf("  %-*s = %s,\t/* %s */\n",
	       maxerrlen, econsts[i], errnos[i], etexts[i]);
      else if (errnos[i] != "EAGAIN")
	printf("  %-*s = %s,\n", maxerrlen, econsts[i], errnos[i]);
    }

  print "";
  print "  /* Because the C standard requires that errno have type 'int',"
  print "     this enumeration must be a signed type.  */";
  print "  __FORCE_ERROR_T_CODES_SIGNED = -1";
  print "};";
  print "";
  print "/* User-visible type of error codes.  It is ok to use 'int' or";
  print "   'kern_return_t' for these, but with 'error_t' the debugger prints";
  print "   symbolic values.  */";
  print "# if !defined __error_t_defined && defined __USE_GNU";
  print "#  define __error_t_defined 1";
  print "typedef enum __error_t_codes error_t;"
  print "# endif";
  print "";
  print "#endif /* not __ASSEMBLER__ */";
}

function print_errno_defines(maxseq)
{
  print "";
  print "/* The C standard requires that all of the E-constants be"
  print "   defined as macros.  */"
  print "";
  for (i = 0; i < maxseq; i++)
    {
      if (i in annot)
	print annot[i];
      else
	printf("#define %-*s %s\n", maxerrlen, econsts[i], errnos[i]);
    }
  print "";
  printf("#define _HURD_ERRNOS %d\n", maxerrno+1);
}

END \
  {
    print_errno_enum(seq);
    print_errno_defines(seq);

    print "";
    print "#endif /* bits/errno.h.  */";
  }