[adns] / src / general.c

/*
 * general.c
 * - diagnostic functions
 * - vbuf handling
 */
/*
 *  This file is part of adns, which is Copyright (C) 1997-1999 Ian Jackson
 *  
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2, or (at your option)
 *  any later version.
 *  
 *  This program 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 General Public License for more details.
 *  
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software Foundation,
 *  Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 
 */

#include <stdlib.h>

#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>

#include "internal.h"

/* Core diagnostic functions */

void adns__vdiag(adns_state ads, const char *pfx, adns_initflags prevent,
		 int serv, adns_query qu, const char *fmt, va_list al) {
  const char *bef, *aft;
  vbuf vb;
  
  if (!ads->diagfile ||
      (!(ads->iflags & adns_if_debug) && (!prevent || (ads->iflags & prevent))))
    return;

  fprintf(ads->diagfile,"adns%s: ",pfx);

  vfprintf(ads->diagfile,fmt,al);

  bef= " (";
  aft= "\n";

  if (qu && qu->query_dgram) {
    adns__vbuf_init(&vb);
    fprintf(ads->diagfile,"%sQNAME=%s, QTYPE=%s",
	    bef,
	    adns__diag_domain(qu->ads,-1,0, &vb,
			      qu->query_dgram,qu->query_dglen,DNS_HDRSIZE),
	    qu->typei ? qu->typei->rrtname : "<unknown>");
    if (qu->typei && qu->typei->fmtname)
      fprintf(ads->diagfile,"(%s)",qu->typei->fmtname);
    bef=", "; aft=")\n";
  }
  
  if (serv>=0) {
    fprintf(ads->diagfile,"%sNS=%s",bef,inet_ntoa(ads->servers[serv].addr));
    bef=", "; aft=")\n";
  }

  fputs(aft,ads->diagfile);
}

void adns__debug(adns_state ads, int serv, adns_query qu, const char *fmt, ...) {
  va_list al;

  va_start(al,fmt);
  adns__vdiag(ads," debug",0,serv,qu,fmt,al);
  va_end(al);
}

void adns__warn(adns_state ads, int serv, adns_query qu, const char *fmt, ...) {
  va_list al;

  va_start(al,fmt);
  adns__vdiag(ads," warning",adns_if_noerrprint|adns_if_noserverwarn,serv,qu,fmt,al);
  va_end(al);
}

void adns__diag(adns_state ads, int serv, adns_query qu, const char *fmt, ...) {
  va_list al;

  va_start(al,fmt);
  adns__vdiag(ads,"",adns_if_noerrprint,serv,qu,fmt,al);
  va_end(al);
}

/* vbuf functions */

void adns__vbuf_init(vbuf *vb) {
  vb->used= vb->avail= 0; vb->buf= 0;
}

int adns__vbuf_ensure(vbuf *vb, int want) {
  void *nb;
  
  if (vb->avail >= want) return 1;
  nb= realloc(vb->buf,want); if (!nb) return 0;
  vb->buf= nb;
  vb->avail= want;
  return 1;
}
  
void adns__vbuf_appendq(vbuf *vb, const byte *data, int len) {
  memcpy(vb->buf+vb->used,data,len);
  vb->used+= len;
}

int adns__vbuf_append(vbuf *vb, const byte *data, int len) {
  int newlen;
  void *nb;

  newlen= vb->used+len;
  if (vb->avail < newlen) {
    if (newlen<20) newlen= 20;
    newlen <<= 1;
    nb= realloc(vb->buf,newlen);
    if (!nb) { newlen= vb->used+len; nb= realloc(vb->buf,newlen); }
    if (!nb) return 0;
    vb->buf= nb;
    vb->avail= newlen;
  }
  adns__vbuf_appendq(vb,data,len);
  return 1;
}

int adns__vbuf_appendstr(vbuf *vb, const char *data) {
  int l;
  l= strlen(data);
  return adns__vbuf_append(vb,data,l);
}

void adns__vbuf_free(vbuf *vb) {
  free(vb->buf);
  adns__vbuf_init(vb);
}

/* Additional diagnostic functions */

const char *adns__diag_domain(adns_state ads, int serv, adns_query qu,
			      vbuf *vb, const byte *dgram, int dglen, int cbyte) {
  adns_status st;

  st= adns__parse_domain(ads,serv,qu,vb, pdf_quoteok, dgram,dglen,&cbyte,dglen);
  if (st == adns_s_nomemory) {
    return "<cannot report domain... out of memory>";
  }
  if (st) {
    vb->used= 0;
    if (!(adns__vbuf_appendstr(vb,"<bad format... ") &&
	  adns__vbuf_appendstr(vb,adns_strerror(st)) &&
	  adns__vbuf_appendstr(vb,">") &&
	  adns__vbuf_append(vb,"",1))) {
      return "<cannot report bad format... out of memory>";
    }
  }
  if (!vb->used) {
    adns__vbuf_appendstr(vb,"<truncated ...>");
    adns__vbuf_append(vb,"",1);
  }
  return vb->buf;
}

adns_status adns_rr_info(adns_rrtype type,
			 const char **rrtname_r, const char **fmtname_r,
			 int *len_r,
			 const void *datap, char **data_r) {
  const typeinfo *typei;
  vbuf vb;
  adns_status st;

  typei= adns__findtype(type);
  if (!typei) return adns_s_unknownrrtype;

  if (rrtname_r) *rrtname_r= typei->rrtname;
  if (fmtname_r) *fmtname_r= typei->fmtname;
  if (len_r) *len_r= typei->rrsz;

  if (!datap) return adns_s_ok;
  
  adns__vbuf_init(&vb);
  st= typei->convstring(&vb,datap);
  if (st) goto x_freevb;
  if (!adns__vbuf_append(&vb,"",1)) { st= adns_s_nomemory; goto x_freevb; }
  assert(strlen(vb.buf) == vb.used-1);
  *data_r= realloc(vb.buf,vb.used);
  if (!*data_r) *data_r= vb.buf;
  return adns_s_ok;

 x_freevb:
  adns__vbuf_free(&vb);
  return st;
}

#define SINFO(n,s) { adns_s_##n, #n, s }

static const struct sinfo {
  adns_status st;
  const char *abbrev;
  const char *string;
} sinfos[]= {
  SINFO(  ok,                  "OK"                                            ),

  SINFO(  nomemory,            "Out of memory"                                 ),
  SINFO(  unknownrrtype,       "Query not implemented in DNS library"          ),
  SINFO(  systemfail,          "General resolver or system failure"            ),

  SINFO(  timeout,             "DNS query timed out"                           ),
  SINFO(  allservfail,         "All nameservers failed"                        ),
  SINFO(  norecurse,           "Recursion denied by nameserver"                ),
  SINFO(  invalidresponse,     "Nameserver sent bad response"                  ),
  SINFO(  unknownformat,       "Nameserver used unknown format"                ),

  SINFO(  rcodeservfail,       "Nameserver reports failure"                    ),
  SINFO(  rcodeformaterror,    "Query not understood by nameserver"            ),
  SINFO(  rcodenotimplemented, "Query not implemented by nameserver"           ),
  SINFO(  rcoderefused,        "Query refused by nameserver"                   ),
  SINFO(  rcodeunknown,        "Nameserver sent unknown response code"         ),
  
  SINFO(  inconsistent,        "Inconsistent resource records in DNS"          ),
  SINFO(  prohibitedcname,     "DNS alias found where canonical name wanted"   ),
  SINFO(  answerdomaininvalid, "Found syntactically invalid domain name"       ),
  SINFO(  answerdomaintoolong, "Found overly-long domain name"                 ),
  SINFO(  invaliddata,         "Found invalid DNS data"                        ),

  SINFO(  querydomainwrong,    "Domain invalid for particular DNS query type"  ),
  SINFO(  querydomaininvalid,  "Domain name is syntactically invalid"          ),
  SINFO(  querydomaintoolong,  "Domain name is too long"                       ),

  SINFO(  nxdomain,            "No such domain"                                ),
  SINFO(  nodata,              "No such data"                                  ),
};

static int si_compar(const void *key, const void *elem) {
  const adns_status *st= key;
  const struct sinfo *si= elem;

  return *st < si->st ? -1 : *st > si->st ? 1 : 0;
}

static const struct sinfo *findsinfo(adns_status st) {
  return bsearch(&st,sinfos,sizeof(sinfos)/sizeof(*sinfos),sizeof(*sinfos),si_compar);
}

const char *adns_strerror(adns_status st) {
  const struct sinfo *si;

  si= findsinfo(st);
  return si->string;
}

const char *adns_errabbrev(adns_status st) {
  const struct sinfo *si;

  si= findsinfo(st);
  return si->abbrev;
}

void adns__isort(void *array, int nobjs, int sz, void *tempbuf,
		 int (*needswap)(void *context, const void *a, const void *b),
		 void *context) {
  byte *data= array;
  int i, place;

  for (i=0; i<nobjs; i++) {
    for (place= i;
	 place>0 && needswap(context, data + (place-1)*sz, data + i*sz);
	 place--);
    if (place != i) {
      memcpy(tempbuf, data + i*sz, sz);
      memmove(data + (place+1)*sz, data + place*sz, (i-place)*sz);
      memcpy(data + place*sz, tempbuf, sz);
    }
  }
}

/* SIGPIPE protection. */

void adns__sigpipe_protect(adns_state ads) {
  sigset_t toblock;
  struct sigaction sa;
  int r;

  if (ads->iflags & adns_if_nosigpipe) return;

  sigfillset(&toblock);
  sigdelset(&toblock,SIGPIPE);

  sa.sa_handler= SIG_IGN;
  sigfillset(&sa.sa_mask);
  sa.sa_flags= 0;
  
  r= sigprocmask(SIG_SETMASK,&toblock,&ads->stdsigmask); assert(!r);
  r= sigaction(SIGPIPE,&sa,&ads->stdsigpipe); assert(!r);
}

void adns__sigpipe_unprotect(adns_state ads) {
  int r;

  if (ads->iflags & adns_if_nosigpipe) return;

  r= sigaction(SIGPIPE,&ads->stdsigpipe,0); assert(!r);
  r= sigprocmask(SIG_SETMASK,&ads->stdsigmask,0); assert(!r);
}
Commit	Line	Data
e576be50	1	/*
	2	* general.c
	3	* - diagnostic functions
	4	* - vbuf handling
	5	*/
	6	/*
a719a4be	7	* This file is part of adns, which is Copyright (C) 1997-1999 Ian Jackson
e576be50	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2, or (at your option)
	12	* any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software Foundation,
	21	* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	22	*/
	23
3955725c	24	#include <stdlib.h>
3955725c	25
0f091044	26	#include <sys/types.h>
eec1d9c8	27	#include <sys/socket.h>
eec1d9c8	28	#include <netinet/in.h>
3955725c	29	#include <arpa/inet.h>
3955725c	30
e576be50	31	#include "internal.h"
	32
	33	/* Core diagnostic functions */
	34
	35	void adns__vdiag(adns_state ads, const char *pfx, adns_initflags prevent,
3955725c	36	int serv, adns_query qu, const char *fmt, va_list al) {
e576be50	37	const char bef, aft;
e576be50	38	vbuf vb;
36369543	39
	40	if (!ads->diagfile \|\|
	41	(!(ads->iflags & adns_if_debug) && (!prevent \|\| (ads->iflags & prevent))))
	42	return;
e576be50	43
36369543	44	fprintf(ads->diagfile,"adns%s: ",pfx);
e576be50	45
36369543	46	vfprintf(ads->diagfile,fmt,al);
e576be50	47
	48	bef= " (";
	49	aft= "\n";
	50
	51	if (qu && qu->query_dgram) {
	52	adns__vbuf_init(&vb);
36369543	53	fprintf(ads->diagfile,"%sQNAME=%s, QTYPE=%s",
e576be50	54	bef,
828d89bd	55	adns__diag_domain(qu->ads,-1,0, &vb,
3955725c	56	qu->query_dgram,qu->query_dglen,DNS_HDRSIZE),
86e7b8d9	57	qu->typei ? qu->typei->rrtname : "<unknown>");
86e7b8d9	58	if (qu->typei && qu->typei->fmtname)
36369543	59	fprintf(ads->diagfile,"(%s)",qu->typei->fmtname);
e576be50	60	bef=", "; aft=")\n";
	61	}
	62
	63	if (serv>=0) {
36369543	64	fprintf(ads->diagfile,"%sNS=%s",bef,inet_ntoa(ads->servers[serv].addr));
e576be50	65	bef=", "; aft=")\n";
	66	}
	67
36369543	68	fputs(aft,ads->diagfile);
e576be50	69	}
	70
	71	void adns__debug(adns_state ads, int serv, adns_query qu, const char *fmt, ...) {
	72	va_list al;
	73
	74	va_start(al,fmt);
	75	adns__vdiag(ads," debug",0,serv,qu,fmt,al);
	76	va_end(al);
	77	}
	78
	79	void adns__warn(adns_state ads, int serv, adns_query qu, const char *fmt, ...) {
	80	va_list al;
	81
	82	va_start(al,fmt);
	83	adns__vdiag(ads," warning",adns_if_noerrprint\|adns_if_noserverwarn,serv,qu,fmt,al);
	84	va_end(al);
	85	}
	86
	87	void adns__diag(adns_state ads, int serv, adns_query qu, const char *fmt, ...) {
	88	va_list al;
	89
	90	va_start(al,fmt);
	91	adns__vdiag(ads,"",adns_if_noerrprint,serv,qu,fmt,al);
	92	va_end(al);
	93	}
	94
	95	/* vbuf functions */
	96
	97	void adns__vbuf_init(vbuf *vb) {
	98	vb->used= vb->avail= 0; vb->buf= 0;
	99	}
	100
	101	int adns__vbuf_ensure(vbuf *vb, int want) {
	102	void *nb;
	103
	104	if (vb->avail >= want) return 1;
	105	nb= realloc(vb->buf,want); if (!nb) return 0;
	106	vb->buf= nb;
	107	vb->avail= want;
	108	return 1;
	109	}
	110
	111	void adns__vbuf_appendq(vbuf vb, const byte data, int len) {
	112	memcpy(vb->buf+vb->used,data,len);
	113	vb->used+= len;
	114	}
	115
	116	int adns__vbuf_append(vbuf vb, const byte data, int len) {
	117	int newlen;
	118	void *nb;
	119
	120	newlen= vb->used+len;
	121	if (vb->avail < newlen) {
a49a6d7b	122	if (newlen<20) newlen= 20;
e576be50	123	newlen <<= 1;
e576be50	124	nb= realloc(vb->buf,newlen);
a49a6d7b	125	if (!nb) { newlen= vb->used+len; nb= realloc(vb->buf,newlen); }
e576be50	126	if (!nb) return 0;
	127	vb->buf= nb;
	128	vb->avail= newlen;
	129	}
	130	adns__vbuf_appendq(vb,data,len);
	131	return 1;
	132	}
	133
f759e52e	134	int adns__vbuf_appendstr(vbuf vb, const char data) {
f759e52e	135	int l;
9557e604	136	l= strlen(data);
f759e52e	137	return adns__vbuf_append(vb,data,l);
	138	}
	139
a49a6d7b	140	void adns__vbuf_free(vbuf *vb) {
	141	free(vb->buf);
	142	adns__vbuf_init(vb);
	143	}
	144
e576be50	145	/* Additional diagnostic functions */
e576be50	146
828d89bd	147	const char *adns__diag_domain(adns_state ads, int serv, adns_query qu,
828d89bd	148	vbuf vb, const byte dgram, int dglen, int cbyte) {
e576be50	149	adns_status st;
e576be50	150
828d89bd	151	st= adns__parse_domain(ads,serv,qu,vb, pdf_quoteok, dgram,dglen,&cbyte,dglen);
ea1e31e3	152	if (st == adns_s_nomemory) {
e576be50	153	return "<cannot report domain... out of memory>";
	154	}
	155	if (st) {
	156	vb->used= 0;
	157	if (!(adns__vbuf_appendstr(vb,"<bad format... ") &&
	158	adns__vbuf_appendstr(vb,adns_strerror(st)) &&
	159	adns__vbuf_appendstr(vb,">") &&
	160	adns__vbuf_append(vb,"",1))) {
	161	return "<cannot report bad format... out of memory>";
	162	}
	163	}
3955725c	164	if (!vb->used) {
e576be50	165	adns__vbuf_appendstr(vb,"<truncated ...>");
	166	adns__vbuf_append(vb,"",1);
	167	}
	168	return vb->buf;
	169	}
86e7b8d9	170
	171	adns_status adns_rr_info(adns_rrtype type,
	172	const char rrtname_r, const char fmtname_r,
	173	int *len_r,
	174	const void datap, char *data_r) {
	175	const typeinfo *typei;
	176	vbuf vb;
	177	adns_status st;
	178
	179	typei= adns__findtype(type);
ea1e31e3	180	if (!typei) return adns_s_unknownrrtype;
86e7b8d9	181
	182	if (rrtname_r) *rrtname_r= typei->rrtname;
	183	if (fmtname_r) *fmtname_r= typei->fmtname;
	184	if (len_r) *len_r= typei->rrsz;
	185
	186	if (!datap) return adns_s_ok;
	187
	188	adns__vbuf_init(&vb);
	189	st= typei->convstring(&vb,datap);
	190	if (st) goto x_freevb;
ea1e31e3	191	if (!adns__vbuf_append(&vb,"",1)) { st= adns_s_nomemory; goto x_freevb; }
86e7b8d9	192	assert(strlen(vb.buf) == vb.used-1);
	193	*data_r= realloc(vb.buf,vb.used);
	194	if (!data_r) data_r= vb.buf;
	195	return adns_s_ok;
	196
	197	x_freevb:
	198	adns__vbuf_free(&vb);
	199	return st;
	200	}
	201
9da4a044	202	#define SINFO(n,s) { adns_s_##n, #n, s }
86e7b8d9	203
	204	static const struct sinfo {
	205	adns_status st;
9da4a044	206	const char *abbrev;
86e7b8d9	207	const char *string;
86e7b8d9	208	} sinfos[]= {
ea1e31e3	209	SINFO( ok, "OK" ),
	210
	211	SINFO( nomemory, "Out of memory" ),
	212	SINFO( unknownrrtype, "Query not implemented in DNS library" ),
54f4a80a	213	SINFO( systemfail, "General resolver or system failure" ),
ea1e31e3	214
	215	SINFO( timeout, "DNS query timed out" ),
	216	SINFO( allservfail, "All nameservers failed" ),
	217	SINFO( norecurse, "Recursion denied by nameserver" ),
	218	SINFO( invalidresponse, "Nameserver sent bad response" ),
	219	SINFO( unknownformat, "Nameserver used unknown format" ),
	220
	221	SINFO( rcodeservfail, "Nameserver reports failure" ),
	222	SINFO( rcodeformaterror, "Query not understood by nameserver" ),
	223	SINFO( rcodenotimplemented, "Query not implemented by nameserver" ),
	224	SINFO( rcoderefused, "Query refused by nameserver" ),
	225	SINFO( rcodeunknown, "Nameserver sent unknown response code" ),
	226
	227	SINFO( inconsistent, "Inconsistent resource records in DNS" ),
3fe9d965	228	SINFO( prohibitedcname, "DNS alias found where canonical name wanted" ),
ea1e31e3	229	SINFO( answerdomaininvalid, "Found syntactically invalid domain name" ),
	230	SINFO( answerdomaintoolong, "Found overly-long domain name" ),
	231	SINFO( invaliddata, "Found invalid DNS data" ),
	232
	233	SINFO( querydomainwrong, "Domain invalid for particular DNS query type" ),
	234	SINFO( querydomaininvalid, "Domain name is syntactically invalid" ),
	235	SINFO( querydomaintoolong, "Domain name is too long" ),
	236
	237	SINFO( nxdomain, "No such domain" ),
	238	SINFO( nodata, "No such data" ),
86e7b8d9	239	};
	240
	241	static int si_compar(const void key, const void elem) {
	242	const adns_status *st= key;
	243	const struct sinfo *si= elem;
	244
	245	return st < si->st ? -1 : st > si->st ? 1 : 0;
	246	}
	247
9da4a044	248	static const struct sinfo *findsinfo(adns_status st) {
	249	return bsearch(&st,sinfos,sizeof(sinfos)/sizeof(sinfos),sizeof(sinfos),si_compar);
	250	}
	251
e576be50	252	const char *adns_strerror(adns_status st) {
9da4a044	253	const struct sinfo *si;
86e7b8d9	254
9da4a044	255	si= findsinfo(st);
	256	return si->string;
	257	}
	258
	259	const char *adns_errabbrev(adns_status st) {
86e7b8d9	260	const struct sinfo *si;
86e7b8d9	261
9da4a044	262	si= findsinfo(st);
9da4a044	263	return si->abbrev;
e576be50	264	}
88372443	265
88372443	266	void adns__isort(void array, int nobjs, int sz, void tempbuf,
09957b1c	267	int (needswap)(void context, const void a, const void b),
09957b1c	268	void *context) {
88372443	269	byte *data= array;
	270	int i, place;
	271
	272	for (i=0; i<nobjs; i++) {
09957b1c	273	for (place= i;
	274	place>0 && needswap(context, data + (place-1)sz, data + isz);
	275	place--);
88372443	276	if (place != i) {
	277	memcpy(tempbuf, data + i*sz, sz);
	278	memmove(data + (place+1)sz, data + placesz, (i-place)*sz);
	279	memcpy(data + place*sz, tempbuf, sz);
	280	}
	281	}
	282	}
ac868fa8	283
	284	/* SIGPIPE protection. */
	285
	286	void adns__sigpipe_protect(adns_state ads) {
	287	sigset_t toblock;
	288	struct sigaction sa;
	289	int r;
	290
	291	if (ads->iflags & adns_if_nosigpipe) return;
	292
	293	sigfillset(&toblock);
	294	sigdelset(&toblock,SIGPIPE);
	295
	296	sa.sa_handler= SIG_IGN;
	297	sigfillset(&sa.sa_mask);
	298	sa.sa_flags= 0;
	299
	300	r= sigprocmask(SIG_SETMASK,&toblock,&ads->stdsigmask); assert(!r);
	301	r= sigaction(SIGPIPE,&sa,&ads->stdsigpipe); assert(!r);
	302	}
	303
	304	void adns__sigpipe_unprotect(adns_state ads) {
	305	int r;
	306
	307	if (ads->iflags & adns_if_nosigpipe) return;
	308
	309	r= sigaction(SIGPIPE,&ads->stdsigpipe,0); assert(!r);
	310	r= sigprocmask(SIG_SETMASK,&ads->stdsigmask,0); assert(!r);
	311	}