xref: /original-bsd/include/arpa/nameser.h (revision e59fb703)
1 /*
2  * Copyright (c) 1983, 1989 Regents of the University of California.
3  * All rights reserved.
4  *
5  * %sccs.include.redist.c%
6  *
7  *	@(#)nameser.h	5.25 (Berkeley) 04/03/91
8  */
9 
10 #ifndef _NAMESER_H_
11 #define	_NAMESER_H_
12 
13 /*
14  * Define constants based on rfc883
15  */
16 #define PACKETSZ	512		/* maximum packet size */
17 #define MAXDNAME	256		/* maximum domain name */
18 #define MAXCDNAME	255		/* maximum compressed domain name */
19 #define MAXLABEL	63		/* maximum length of domain label */
20 	/* Number of bytes of fixed size data in query structure */
21 #define QFIXEDSZ	4
22 	/* number of bytes of fixed size data in resource record */
23 #define RRFIXEDSZ	10
24 
25 /*
26  * Internet nameserver port number
27  */
28 #define NAMESERVER_PORT	53
29 
30 /*
31  * Currently defined opcodes
32  */
33 #define QUERY		0x0		/* standard query */
34 #define IQUERY		0x1		/* inverse query */
35 #define STATUS		0x2		/* nameserver status query */
36 /*#define xxx		0x3		/* 0x3 reserved */
37 	/* non standard */
38 #define UPDATEA		0x9		/* add resource record */
39 #define UPDATED		0xa		/* delete a specific resource record */
40 #define UPDATEDA	0xb		/* delete all nemed resource record */
41 #define UPDATEM		0xc		/* modify a specific resource record */
42 #define UPDATEMA	0xd		/* modify all named resource record */
43 
44 #define ZONEINIT	0xe		/* initial zone transfer */
45 #define ZONEREF		0xf		/* incremental zone referesh */
46 
47 /*
48  * Currently defined response codes
49  */
50 #define NOERROR		0		/* no error */
51 #define FORMERR		1		/* format error */
52 #define SERVFAIL	2		/* server failure */
53 #define NXDOMAIN	3		/* non existent domain */
54 #define NOTIMP		4		/* not implemented */
55 #define REFUSED		5		/* query refused */
56 	/* non standard */
57 #define NOCHANGE	0xf		/* update failed to change db */
58 
59 /*
60  * Type values for resources and queries
61  */
62 #define T_A		1		/* host address */
63 #define T_NS		2		/* authoritative server */
64 #define T_MD		3		/* mail destination */
65 #define T_MF		4		/* mail forwarder */
66 #define T_CNAME		5		/* connonical name */
67 #define T_SOA		6		/* start of authority zone */
68 #define T_MB		7		/* mailbox domain name */
69 #define T_MG		8		/* mail group member */
70 #define T_MR		9		/* mail rename name */
71 #define T_NULL		10		/* null resource record */
72 #define T_WKS		11		/* well known service */
73 #define T_PTR		12		/* domain name pointer */
74 #define T_HINFO		13		/* host information */
75 #define T_MINFO		14		/* mailbox information */
76 #define T_MX		15		/* mail routing information */
77 #define T_TXT		16		/* text strings */
78 	/* non standard */
79 #define T_UINFO		100		/* user (finger) information */
80 #define T_UID		101		/* user ID */
81 #define T_GID		102		/* group ID */
82 #define T_UNSPEC	103		/* Unspecified format (binary data) */
83 	/* Query type values which do not appear in resource records */
84 #define T_AXFR		252		/* transfer zone of authority */
85 #define T_MAILB		253		/* transfer mailbox records */
86 #define T_MAILA		254		/* transfer mail agent records */
87 #define T_ANY		255		/* wildcard match */
88 
89 /*
90  * Values for class field
91  */
92 
93 #define C_IN		1		/* the arpa internet */
94 #define C_CHAOS		3		/* for chaos net at MIT */
95 #define C_HS		4		/* for Hesiod name server at MIT */
96 	/* Query class values which do not appear in resource records */
97 #define C_ANY		255		/* wildcard match */
98 
99 /*
100  * Status return codes for T_UNSPEC conversion routines
101  */
102 #define CONV_SUCCESS 0
103 #define CONV_OVERFLOW -1
104 #define CONV_BADFMT -2
105 #define CONV_BADCKSUM -3
106 #define CONV_BADBUFLEN -4
107 
108 #ifndef BYTE_ORDER
109 #define	LITTLE_ENDIAN	1234	/* least-significant byte first (vax) */
110 #define	BIG_ENDIAN	4321	/* most-significant byte first (IBM, net) */
111 #define	PDP_ENDIAN	3412	/* LSB first in word, MSW first in long (pdp) */
112 
113 #if defined(vax) || defined(ns32000) || defined(sun386) || defined(MIPSEL) || \
114     defined(BIT_ZERO_ON_RIGHT)
115 #define BYTE_ORDER	LITTLE_ENDIAN
116 
117 #endif
118 #if defined(sel) || defined(pyr) || defined(mc68000) || defined(sparc) || \
119     defined(is68k) || defined(tahoe) || defined(ibm032) || defined(ibm370) || \
120     defined(MIPSEB) || defined (BIT_ZERO_ON_LEFT)
121 #define BYTE_ORDER	BIG_ENDIAN
122 #endif
123 #endif /* BYTE_ORDER */
124 
125 #ifndef BYTE_ORDER
126 	/* you must determine what the correct bit order is for your compiler */
127 	UNDEFINED_BIT_ORDER;
128 #endif
129 /*
130  * Structure for query header, the order of the fields is machine and
131  * compiler dependent, in our case, the bits within a byte are assignd
132  * least significant first, while the order of transmition is most
133  * significant first.  This requires a somewhat confusing rearrangement.
134  */
135 
136 typedef struct {
137 	u_short	id;		/* query identification number */
138 #if BYTE_ORDER == BIG_ENDIAN
139 			/* fields in third byte */
140 	u_char	qr:1;		/* response flag */
141 	u_char	opcode:4;	/* purpose of message */
142 	u_char	aa:1;		/* authoritive answer */
143 	u_char	tc:1;		/* truncated message */
144 	u_char	rd:1;		/* recursion desired */
145 			/* fields in fourth byte */
146 	u_char	ra:1;		/* recursion available */
147 	u_char	pr:1;		/* primary server required (non standard) */
148 	u_char	unused:2;	/* unused bits */
149 	u_char	rcode:4;	/* response code */
150 #endif
151 #if BYTE_ORDER == LITTLE_ENDIAN || BYTE_ORDER == PDP_ENDIAN
152 			/* fields in third byte */
153 	u_char	rd:1;		/* recursion desired */
154 	u_char	tc:1;		/* truncated message */
155 	u_char	aa:1;		/* authoritive answer */
156 	u_char	opcode:4;	/* purpose of message */
157 	u_char	qr:1;		/* response flag */
158 			/* fields in fourth byte */
159 	u_char	rcode:4;	/* response code */
160 	u_char	unused:2;	/* unused bits */
161 	u_char	pr:1;		/* primary server required (non standard) */
162 	u_char	ra:1;		/* recursion available */
163 #endif
164 			/* remaining bytes */
165 	u_short	qdcount;	/* number of question entries */
166 	u_short	ancount;	/* number of answer entries */
167 	u_short	nscount;	/* number of authority entries */
168 	u_short	arcount;	/* number of resource entries */
169 } HEADER;
170 
171 /*
172  * Defines for handling compressed domain names
173  */
174 #define INDIR_MASK	0xc0
175 
176 /*
177  * Structure for passing resource records around.
178  */
179 struct rrec {
180 	short	r_zone;			/* zone number */
181 	short	r_class;		/* class number */
182 	short	r_type;			/* type number */
183 	u_long	r_ttl;			/* time to live */
184 	int	r_size;			/* size of data area */
185 	char	*r_data;		/* pointer to data */
186 };
187 
188 extern	u_short	_getshort();
189 extern	u_long	_getlong();
190 
191 /*
192  * Inline versions of get/put short/long.
193  * Pointer is advanced; we assume that both arguments
194  * are lvalues and will already be in registers.
195  * cp MUST be u_char *.
196  */
197 #define GETSHORT(s, cp) { \
198 	(s) = *(cp)++ << 8; \
199 	(s) |= *(cp)++; \
200 }
201 
202 #define GETLONG(l, cp) { \
203 	(l) = *(cp)++ << 8; \
204 	(l) |= *(cp)++; (l) <<= 8; \
205 	(l) |= *(cp)++; (l) <<= 8; \
206 	(l) |= *(cp)++; \
207 }
208 
209 
210 #define PUTSHORT(s, cp) { \
211 	*(cp)++ = (s) >> 8; \
212 	*(cp)++ = (s); \
213 }
214 
215 /*
216  * Warning: PUTLONG destroys its first argument.
217  */
218 #define PUTLONG(l, cp) { \
219 	(cp)[3] = l; \
220 	(cp)[2] = (l >>= 8); \
221 	(cp)[1] = (l >>= 8); \
222 	(cp)[0] = l >> 8; \
223 	(cp) += sizeof(u_long); \
224 }
225 
226 #endif /* !_NAMESER_H_ */
227