masterdump.c revision 199958
1/* 2 * Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC") 3 * Copyright (C) 1999-2003 Internet Software Consortium. 4 * 5 * Permission to use, copy, modify, and/or distribute this software for any 6 * purpose with or without fee is hereby granted, provided that the above 7 * copyright notice and this permission notice appear in all copies. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 11 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 15 * PERFORMANCE OF THIS SOFTWARE. 16 */ 17 18/* $Id: masterdump.c,v 1.94.50.2.12.1 2009/11/18 23:58:04 marka Exp $ */ 19 20/*! \file */ 21 22#include <config.h> 23 24#include <stdlib.h> 25 26#include <isc/event.h> 27#include <isc/file.h> 28#include <isc/magic.h> 29#include <isc/mem.h> 30#include <isc/print.h> 31#include <isc/stdio.h> 32#include <isc/string.h> 33#include <isc/task.h> 34#include <isc/time.h> 35#include <isc/util.h> 36 37#include <dns/db.h> 38#include <dns/dbiterator.h> 39#include <dns/events.h> 40#include <dns/fixedname.h> 41#include <dns/lib.h> 42#include <dns/log.h> 43#include <dns/master.h> 44#include <dns/masterdump.h> 45#include <dns/rdata.h> 46#include <dns/rdataclass.h> 47#include <dns/rdataset.h> 48#include <dns/rdatasetiter.h> 49#include <dns/rdatatype.h> 50#include <dns/result.h> 51#include <dns/time.h> 52#include <dns/ttl.h> 53 54#define DNS_DCTX_MAGIC ISC_MAGIC('D', 'c', 't', 'x') 55#define DNS_DCTX_VALID(d) ISC_MAGIC_VALID(d, DNS_DCTX_MAGIC) 56 57#define RETERR(x) do { \ 58 isc_result_t _r = (x); \ 59 if (_r != ISC_R_SUCCESS) \ 60 return (_r); \ 61 } while (0) 62 63struct dns_master_style { 64 unsigned int flags; /* DNS_STYLEFLAG_* */ 65 unsigned int ttl_column; 66 unsigned int class_column; 67 unsigned int type_column; 68 unsigned int rdata_column; 69 unsigned int line_length; 70 unsigned int tab_width; 71}; 72 73/*% 74 * The maximum length of the newline+indentation that is output 75 * when inserting a line break in an RR. This effectively puts an 76 * upper limits on the value of "rdata_column", because if it is 77 * very large, the tabs and spaces needed to reach it will not fit. 78 */ 79#define DNS_TOTEXT_LINEBREAK_MAXLEN 100 80 81/*% 82 * Context structure for a masterfile dump in progress. 83 */ 84typedef struct dns_totext_ctx { 85 dns_master_style_t style; 86 isc_boolean_t class_printed; 87 char * linebreak; 88 char linebreak_buf[DNS_TOTEXT_LINEBREAK_MAXLEN]; 89 dns_name_t * origin; 90 dns_name_t * neworigin; 91 dns_fixedname_t origin_fixname; 92 isc_uint32_t current_ttl; 93 isc_boolean_t current_ttl_valid; 94} dns_totext_ctx_t; 95 96LIBDNS_EXTERNAL_DATA const dns_master_style_t 97dns_master_style_default = { 98 DNS_STYLEFLAG_OMIT_OWNER | 99 DNS_STYLEFLAG_OMIT_CLASS | 100 DNS_STYLEFLAG_REL_OWNER | 101 DNS_STYLEFLAG_REL_DATA | 102 DNS_STYLEFLAG_OMIT_TTL | 103 DNS_STYLEFLAG_TTL | 104 DNS_STYLEFLAG_COMMENT | 105 DNS_STYLEFLAG_MULTILINE, 106 24, 24, 24, 32, 80, 8 107}; 108 109LIBDNS_EXTERNAL_DATA const dns_master_style_t 110dns_master_style_full = { 111 DNS_STYLEFLAG_COMMENT | 112 DNS_STYLEFLAG_RESIGN, 113 46, 46, 46, 64, 120, 8 114}; 115 116LIBDNS_EXTERNAL_DATA const dns_master_style_t 117dns_master_style_explicitttl = { 118 DNS_STYLEFLAG_OMIT_OWNER | 119 DNS_STYLEFLAG_OMIT_CLASS | 120 DNS_STYLEFLAG_REL_OWNER | 121 DNS_STYLEFLAG_REL_DATA | 122 DNS_STYLEFLAG_COMMENT | 123 DNS_STYLEFLAG_MULTILINE, 124 24, 32, 32, 40, 80, 8 125}; 126 127LIBDNS_EXTERNAL_DATA const dns_master_style_t 128dns_master_style_cache = { 129 DNS_STYLEFLAG_OMIT_OWNER | 130 DNS_STYLEFLAG_OMIT_CLASS | 131 DNS_STYLEFLAG_MULTILINE | 132 DNS_STYLEFLAG_TRUST | 133 DNS_STYLEFLAG_NCACHE, 134 24, 32, 32, 40, 80, 8 135}; 136 137LIBDNS_EXTERNAL_DATA const dns_master_style_t 138dns_master_style_simple = { 139 0, 140 24, 32, 32, 40, 80, 8 141}; 142 143/*% 144 * A style suitable for dns_rdataset_totext(). 145 */ 146LIBDNS_EXTERNAL_DATA const dns_master_style_t 147dns_master_style_debug = { 148 DNS_STYLEFLAG_REL_OWNER, 149 24, 32, 40, 48, 80, 8 150}; 151 152 153#define N_SPACES 10 154static char spaces[N_SPACES+1] = " "; 155 156#define N_TABS 10 157static char tabs[N_TABS+1] = "\t\t\t\t\t\t\t\t\t\t"; 158 159struct dns_dumpctx { 160 unsigned int magic; 161 isc_mem_t *mctx; 162 isc_mutex_t lock; 163 unsigned int references; 164 isc_boolean_t canceled; 165 isc_boolean_t first; 166 isc_boolean_t do_date; 167 isc_stdtime_t now; 168 FILE *f; 169 dns_db_t *db; 170 dns_dbversion_t *version; 171 dns_dbiterator_t *dbiter; 172 dns_totext_ctx_t tctx; 173 isc_task_t *task; 174 dns_dumpdonefunc_t done; 175 void *done_arg; 176 unsigned int nodes; 177 /* dns_master_dumpinc() */ 178 char *file; 179 char *tmpfile; 180 dns_masterformat_t format; 181 isc_result_t (*dumpsets)(isc_mem_t *mctx, dns_name_t *name, 182 dns_rdatasetiter_t *rdsiter, 183 dns_totext_ctx_t *ctx, 184 isc_buffer_t *buffer, FILE *f); 185}; 186 187#define NXDOMAIN(x) (((x)->attributes & DNS_RDATASETATTR_NXDOMAIN) != 0) 188 189/*% 190 * Output tabs and spaces to go from column '*current' to 191 * column 'to', and update '*current' to reflect the new 192 * current column. 193 */ 194static isc_result_t 195indent(unsigned int *current, unsigned int to, int tabwidth, 196 isc_buffer_t *target) 197{ 198 isc_region_t r; 199 unsigned char *p; 200 unsigned int from; 201 int ntabs, nspaces, t; 202 203 from = *current; 204 205 if (to < from + 1) 206 to = from + 1; 207 208 ntabs = to / tabwidth - from / tabwidth; 209 if (ntabs < 0) 210 ntabs = 0; 211 212 if (ntabs > 0) { 213 isc_buffer_availableregion(target, &r); 214 if (r.length < (unsigned) ntabs) 215 return (ISC_R_NOSPACE); 216 p = r.base; 217 218 t = ntabs; 219 while (t) { 220 int n = t; 221 if (n > N_TABS) 222 n = N_TABS; 223 memcpy(p, tabs, n); 224 p += n; 225 t -= n; 226 } 227 isc_buffer_add(target, ntabs); 228 from = (to / tabwidth) * tabwidth; 229 } 230 231 nspaces = to - from; 232 INSIST(nspaces >= 0); 233 234 isc_buffer_availableregion(target, &r); 235 if (r.length < (unsigned) nspaces) 236 return (ISC_R_NOSPACE); 237 p = r.base; 238 239 t = nspaces; 240 while (t) { 241 int n = t; 242 if (n > N_SPACES) 243 n = N_SPACES; 244 memcpy(p, spaces, n); 245 p += n; 246 t -= n; 247 } 248 isc_buffer_add(target, nspaces); 249 250 *current = to; 251 return (ISC_R_SUCCESS); 252} 253 254static isc_result_t 255totext_ctx_init(const dns_master_style_t *style, dns_totext_ctx_t *ctx) { 256 isc_result_t result; 257 258 REQUIRE(style->tab_width != 0); 259 260 ctx->style = *style; 261 ctx->class_printed = ISC_FALSE; 262 263 dns_fixedname_init(&ctx->origin_fixname); 264 265 /* 266 * Set up the line break string if needed. 267 */ 268 if ((ctx->style.flags & DNS_STYLEFLAG_MULTILINE) != 0) { 269 isc_buffer_t buf; 270 isc_region_t r; 271 unsigned int col = 0; 272 273 isc_buffer_init(&buf, ctx->linebreak_buf, 274 sizeof(ctx->linebreak_buf)); 275 276 isc_buffer_availableregion(&buf, &r); 277 if (r.length < 1) 278 return (DNS_R_TEXTTOOLONG); 279 r.base[0] = '\n'; 280 isc_buffer_add(&buf, 1); 281 282 result = indent(&col, ctx->style.rdata_column, 283 ctx->style.tab_width, &buf); 284 /* 285 * Do not return ISC_R_NOSPACE if the line break string 286 * buffer is too small, because that would just make 287 * dump_rdataset() retry indefinitely with ever 288 * bigger target buffers. That's a different buffer, 289 * so it won't help. Use DNS_R_TEXTTOOLONG as a substitute. 290 */ 291 if (result == ISC_R_NOSPACE) 292 return (DNS_R_TEXTTOOLONG); 293 if (result != ISC_R_SUCCESS) 294 return (result); 295 296 isc_buffer_availableregion(&buf, &r); 297 if (r.length < 1) 298 return (DNS_R_TEXTTOOLONG); 299 r.base[0] = '\0'; 300 isc_buffer_add(&buf, 1); 301 ctx->linebreak = ctx->linebreak_buf; 302 } else { 303 ctx->linebreak = NULL; 304 } 305 306 ctx->origin = NULL; 307 ctx->neworigin = NULL; 308 ctx->current_ttl = 0; 309 ctx->current_ttl_valid = ISC_FALSE; 310 311 return (ISC_R_SUCCESS); 312} 313 314#define INDENT_TO(col) \ 315 do { \ 316 if ((result = indent(&column, ctx->style.col, \ 317 ctx->style.tab_width, target)) \ 318 != ISC_R_SUCCESS) \ 319 return (result); \ 320 } while (0) 321 322 323static isc_result_t 324str_totext(const char *source, isc_buffer_t *target) { 325 unsigned int l; 326 isc_region_t region; 327 328 isc_buffer_availableregion(target, ®ion); 329 l = strlen(source); 330 331 if (l > region.length) 332 return (ISC_R_NOSPACE); 333 334 memcpy(region.base, source, l); 335 isc_buffer_add(target, l); 336 return (ISC_R_SUCCESS); 337} 338 339/* 340 * Convert 'rdataset' to master file text format according to 'ctx', 341 * storing the result in 'target'. If 'owner_name' is NULL, it 342 * is omitted; otherwise 'owner_name' must be valid and have at least 343 * one label. 344 */ 345 346static isc_result_t 347rdataset_totext(dns_rdataset_t *rdataset, 348 dns_name_t *owner_name, 349 dns_totext_ctx_t *ctx, 350 isc_boolean_t omit_final_dot, 351 isc_buffer_t *target) 352{ 353 isc_result_t result; 354 unsigned int column; 355 isc_boolean_t first = ISC_TRUE; 356 isc_uint32_t current_ttl; 357 isc_boolean_t current_ttl_valid; 358 dns_rdatatype_t type; 359 360 REQUIRE(DNS_RDATASET_VALID(rdataset)); 361 362 rdataset->attributes |= DNS_RDATASETATTR_LOADORDER; 363 result = dns_rdataset_first(rdataset); 364 REQUIRE(result == ISC_R_SUCCESS); 365 366 current_ttl = ctx->current_ttl; 367 current_ttl_valid = ctx->current_ttl_valid; 368 369 do { 370 column = 0; 371 372 /* 373 * Owner name. 374 */ 375 if (owner_name != NULL && 376 ! ((ctx->style.flags & DNS_STYLEFLAG_OMIT_OWNER) != 0 && 377 !first)) 378 { 379 unsigned int name_start = target->used; 380 RETERR(dns_name_totext(owner_name, 381 omit_final_dot, 382 target)); 383 column += target->used - name_start; 384 } 385 386 /* 387 * TTL. 388 */ 389 if ((ctx->style.flags & DNS_STYLEFLAG_NO_TTL) == 0 && 390 !((ctx->style.flags & DNS_STYLEFLAG_OMIT_TTL) != 0 && 391 current_ttl_valid && 392 rdataset->ttl == current_ttl)) 393 { 394 char ttlbuf[64]; 395 isc_region_t r; 396 unsigned int length; 397 398 INDENT_TO(ttl_column); 399 length = snprintf(ttlbuf, sizeof(ttlbuf), "%u", 400 rdataset->ttl); 401 INSIST(length <= sizeof(ttlbuf)); 402 isc_buffer_availableregion(target, &r); 403 if (r.length < length) 404 return (ISC_R_NOSPACE); 405 memcpy(r.base, ttlbuf, length); 406 isc_buffer_add(target, length); 407 column += length; 408 409 /* 410 * If the $TTL directive is not in use, the TTL we 411 * just printed becomes the default for subsequent RRs. 412 */ 413 if ((ctx->style.flags & DNS_STYLEFLAG_TTL) == 0) { 414 current_ttl = rdataset->ttl; 415 current_ttl_valid = ISC_TRUE; 416 } 417 } 418 419 /* 420 * Class. 421 */ 422 if ((ctx->style.flags & DNS_STYLEFLAG_NO_CLASS) == 0 && 423 ((ctx->style.flags & DNS_STYLEFLAG_OMIT_CLASS) == 0 || 424 ctx->class_printed == ISC_FALSE)) 425 { 426 unsigned int class_start; 427 INDENT_TO(class_column); 428 class_start = target->used; 429 result = dns_rdataclass_totext(rdataset->rdclass, 430 target); 431 if (result != ISC_R_SUCCESS) 432 return (result); 433 column += (target->used - class_start); 434 } 435 436 /* 437 * Type. 438 */ 439 440 if (rdataset->type == 0) { 441 type = rdataset->covers; 442 } else { 443 type = rdataset->type; 444 } 445 446 { 447 unsigned int type_start; 448 INDENT_TO(type_column); 449 type_start = target->used; 450 if (rdataset->type == 0) 451 RETERR(str_totext("\\-", target)); 452 result = dns_rdatatype_totext(type, target); 453 if (result != ISC_R_SUCCESS) 454 return (result); 455 column += (target->used - type_start); 456 } 457 458 /* 459 * Rdata. 460 */ 461 INDENT_TO(rdata_column); 462 if (rdataset->type == 0) { 463 if (NXDOMAIN(rdataset)) 464 RETERR(str_totext(";-$NXDOMAIN\n", target)); 465 else 466 RETERR(str_totext(";-$NXRRSET\n", target)); 467 } else { 468 dns_rdata_t rdata = DNS_RDATA_INIT; 469 isc_region_t r; 470 471 dns_rdataset_current(rdataset, &rdata); 472 473 RETERR(dns_rdata_tofmttext(&rdata, 474 ctx->origin, 475 ctx->style.flags, 476 ctx->style.line_length - 477 ctx->style.rdata_column, 478 ctx->linebreak, 479 target)); 480 481 isc_buffer_availableregion(target, &r); 482 if (r.length < 1) 483 return (ISC_R_NOSPACE); 484 r.base[0] = '\n'; 485 isc_buffer_add(target, 1); 486 } 487 488 first = ISC_FALSE; 489 result = dns_rdataset_next(rdataset); 490 } while (result == ISC_R_SUCCESS); 491 492 if (result != ISC_R_NOMORE) 493 return (result); 494 495 /* 496 * Update the ctx state to reflect what we just printed. 497 * This is done last, only when we are sure we will return 498 * success, because this function may be called multiple 499 * times with increasing buffer sizes until it succeeds, 500 * and failed attempts must not update the state prematurely. 501 */ 502 ctx->class_printed = ISC_TRUE; 503 ctx->current_ttl= current_ttl; 504 ctx->current_ttl_valid = current_ttl_valid; 505 506 return (ISC_R_SUCCESS); 507} 508 509/* 510 * Print the name, type, and class of an empty rdataset, 511 * such as those used to represent the question section 512 * of a DNS message. 513 */ 514static isc_result_t 515question_totext(dns_rdataset_t *rdataset, 516 dns_name_t *owner_name, 517 dns_totext_ctx_t *ctx, 518 isc_boolean_t omit_final_dot, 519 isc_buffer_t *target) 520{ 521 unsigned int column; 522 isc_result_t result; 523 isc_region_t r; 524 525 REQUIRE(DNS_RDATASET_VALID(rdataset)); 526 result = dns_rdataset_first(rdataset); 527 REQUIRE(result == ISC_R_NOMORE); 528 529 column = 0; 530 531 /* Owner name */ 532 { 533 unsigned int name_start = target->used; 534 RETERR(dns_name_totext(owner_name, 535 omit_final_dot, 536 target)); 537 column += target->used - name_start; 538 } 539 540 /* Class */ 541 { 542 unsigned int class_start; 543 INDENT_TO(class_column); 544 class_start = target->used; 545 result = dns_rdataclass_totext(rdataset->rdclass, target); 546 if (result != ISC_R_SUCCESS) 547 return (result); 548 column += (target->used - class_start); 549 } 550 551 /* Type */ 552 { 553 unsigned int type_start; 554 INDENT_TO(type_column); 555 type_start = target->used; 556 result = dns_rdatatype_totext(rdataset->type, target); 557 if (result != ISC_R_SUCCESS) 558 return (result); 559 column += (target->used - type_start); 560 } 561 562 isc_buffer_availableregion(target, &r); 563 if (r.length < 1) 564 return (ISC_R_NOSPACE); 565 r.base[0] = '\n'; 566 isc_buffer_add(target, 1); 567 568 return (ISC_R_SUCCESS); 569} 570 571isc_result_t 572dns_rdataset_totext(dns_rdataset_t *rdataset, 573 dns_name_t *owner_name, 574 isc_boolean_t omit_final_dot, 575 isc_boolean_t question, 576 isc_buffer_t *target) 577{ 578 dns_totext_ctx_t ctx; 579 isc_result_t result; 580 result = totext_ctx_init(&dns_master_style_debug, &ctx); 581 if (result != ISC_R_SUCCESS) { 582 UNEXPECTED_ERROR(__FILE__, __LINE__, 583 "could not set master file style"); 584 return (ISC_R_UNEXPECTED); 585 } 586 587 /* 588 * The caller might want to give us an empty owner 589 * name (e.g. if they are outputting into a master 590 * file and this rdataset has the same name as the 591 * previous one.) 592 */ 593 if (dns_name_countlabels(owner_name) == 0) 594 owner_name = NULL; 595 596 if (question) 597 return (question_totext(rdataset, owner_name, &ctx, 598 omit_final_dot, target)); 599 else 600 return (rdataset_totext(rdataset, owner_name, &ctx, 601 omit_final_dot, target)); 602} 603 604isc_result_t 605dns_master_rdatasettotext(dns_name_t *owner_name, 606 dns_rdataset_t *rdataset, 607 const dns_master_style_t *style, 608 isc_buffer_t *target) 609{ 610 dns_totext_ctx_t ctx; 611 isc_result_t result; 612 result = totext_ctx_init(style, &ctx); 613 if (result != ISC_R_SUCCESS) { 614 UNEXPECTED_ERROR(__FILE__, __LINE__, 615 "could not set master file style"); 616 return (ISC_R_UNEXPECTED); 617 } 618 619 return (rdataset_totext(rdataset, owner_name, &ctx, 620 ISC_FALSE, target)); 621} 622 623isc_result_t 624dns_master_questiontotext(dns_name_t *owner_name, 625 dns_rdataset_t *rdataset, 626 const dns_master_style_t *style, 627 isc_buffer_t *target) 628{ 629 dns_totext_ctx_t ctx; 630 isc_result_t result; 631 result = totext_ctx_init(style, &ctx); 632 if (result != ISC_R_SUCCESS) { 633 UNEXPECTED_ERROR(__FILE__, __LINE__, 634 "could not set master file style"); 635 return (ISC_R_UNEXPECTED); 636 } 637 638 return (question_totext(rdataset, owner_name, &ctx, 639 ISC_FALSE, target)); 640} 641 642/* 643 * Print an rdataset. 'buffer' is a scratch buffer, which must have been 644 * dynamically allocated by the caller. It must be large enough to 645 * hold the result from dns_ttl_totext(). If more than that is needed, 646 * the buffer will be grown automatically. 647 */ 648 649static isc_result_t 650dump_rdataset(isc_mem_t *mctx, dns_name_t *name, dns_rdataset_t *rdataset, 651 dns_totext_ctx_t *ctx, 652 isc_buffer_t *buffer, FILE *f) 653{ 654 isc_region_t r; 655 isc_result_t result; 656 657 REQUIRE(buffer->length > 0); 658 659 /* 660 * Output a $TTL directive if needed. 661 */ 662 663 if ((ctx->style.flags & DNS_STYLEFLAG_TTL) != 0) { 664 if (ctx->current_ttl_valid == ISC_FALSE || 665 ctx->current_ttl != rdataset->ttl) 666 { 667 if ((ctx->style.flags & DNS_STYLEFLAG_COMMENT) != 0) 668 { 669 isc_buffer_clear(buffer); 670 result = dns_ttl_totext(rdataset->ttl, 671 ISC_TRUE, buffer); 672 INSIST(result == ISC_R_SUCCESS); 673 isc_buffer_usedregion(buffer, &r); 674 fprintf(f, "$TTL %u\t; %.*s\n", rdataset->ttl, 675 (int) r.length, (char *) r.base); 676 } else { 677 fprintf(f, "$TTL %u\n", rdataset->ttl); 678 } 679 ctx->current_ttl = rdataset->ttl; 680 ctx->current_ttl_valid = ISC_TRUE; 681 } 682 } 683 684 isc_buffer_clear(buffer); 685 686 /* 687 * Generate the text representation of the rdataset into 688 * the buffer. If the buffer is too small, grow it. 689 */ 690 for (;;) { 691 int newlength; 692 void *newmem; 693 result = rdataset_totext(rdataset, name, ctx, 694 ISC_FALSE, buffer); 695 if (result != ISC_R_NOSPACE) 696 break; 697 698 newlength = buffer->length * 2; 699 newmem = isc_mem_get(mctx, newlength); 700 if (newmem == NULL) 701 return (ISC_R_NOMEMORY); 702 isc_mem_put(mctx, buffer->base, buffer->length); 703 isc_buffer_init(buffer, newmem, newlength); 704 } 705 if (result != ISC_R_SUCCESS) 706 return (result); 707 708 /* 709 * Write the buffer contents to the master file. 710 */ 711 isc_buffer_usedregion(buffer, &r); 712 result = isc_stdio_write(r.base, 1, (size_t)r.length, f, NULL); 713 714 if (result != ISC_R_SUCCESS) { 715 UNEXPECTED_ERROR(__FILE__, __LINE__, 716 "master file write failed: %s", 717 isc_result_totext(result)); 718 return (result); 719 } 720 721 return (ISC_R_SUCCESS); 722} 723 724/* 725 * Define the order in which rdatasets should be printed in zone 726 * files. We will print SOA and NS records before others, SIGs 727 * immediately following the things they sign, and order everything 728 * else by RR number. This is all just for aesthetics and 729 * compatibility with buggy software that expects the SOA to be first; 730 * the DNS specifications allow any order. 731 */ 732 733static int 734dump_order(const dns_rdataset_t *rds) { 735 int t; 736 int sig; 737 if (rds->type == dns_rdatatype_rrsig) { 738 t = rds->covers; 739 sig = 1; 740 } else { 741 t = rds->type; 742 sig = 0; 743 } 744 switch (t) { 745 case dns_rdatatype_soa: 746 t = 0; 747 break; 748 case dns_rdatatype_ns: 749 t = 1; 750 break; 751 default: 752 t += 2; 753 break; 754 } 755 return (t << 1) + sig; 756} 757 758static int 759dump_order_compare(const void *a, const void *b) { 760 return (dump_order(*((const dns_rdataset_t * const *) a)) - 761 dump_order(*((const dns_rdataset_t * const *) b))); 762} 763 764/* 765 * Dump all the rdatasets of a domain name to a master file. We make 766 * a "best effort" attempt to sort the RRsets in a nice order, but if 767 * there are more than MAXSORT RRsets, we punt and only sort them in 768 * groups of MAXSORT. This is not expected to ever happen in practice 769 * since much less than 64 RR types have been registered with the 770 * IANA, so far, and the output will be correct (though not 771 * aesthetically pleasing) even if it does happen. 772 */ 773 774#define MAXSORT 64 775 776static const char *trustnames[] = { 777 "none", 778 "pending-additional", 779 "pending-answer", 780 "additional", 781 "glue", 782 "answer", 783 "authauthority", 784 "authanswer", 785 "secure", 786 "local" /* aka ultimate */ 787}; 788 789const char * 790dns_trust_totext(dns_trust_t trust) { 791 if (trust >= sizeof(trustnames)/sizeof(*trustnames)) 792 return ("bad"); 793 return (trustnames[trust]); 794} 795 796static isc_result_t 797dump_rdatasets_text(isc_mem_t *mctx, dns_name_t *name, 798 dns_rdatasetiter_t *rdsiter, dns_totext_ctx_t *ctx, 799 isc_buffer_t *buffer, FILE *f) 800{ 801 isc_result_t itresult, dumpresult; 802 isc_region_t r; 803 dns_rdataset_t rdatasets[MAXSORT]; 804 dns_rdataset_t *sorted[MAXSORT]; 805 int i, n; 806 807 itresult = dns_rdatasetiter_first(rdsiter); 808 dumpresult = ISC_R_SUCCESS; 809 810 if (itresult == ISC_R_SUCCESS && ctx->neworigin != NULL) { 811 isc_buffer_clear(buffer); 812 itresult = dns_name_totext(ctx->neworigin, ISC_FALSE, buffer); 813 RUNTIME_CHECK(itresult == ISC_R_SUCCESS); 814 isc_buffer_usedregion(buffer, &r); 815 fprintf(f, "$ORIGIN %.*s\n", (int) r.length, (char *) r.base); 816 ctx->neworigin = NULL; 817 } 818 819 again: 820 for (i = 0; 821 itresult == ISC_R_SUCCESS && i < MAXSORT; 822 itresult = dns_rdatasetiter_next(rdsiter), i++) { 823 dns_rdataset_init(&rdatasets[i]); 824 dns_rdatasetiter_current(rdsiter, &rdatasets[i]); 825 sorted[i] = &rdatasets[i]; 826 } 827 n = i; 828 INSIST(n <= MAXSORT); 829 830 qsort(sorted, n, sizeof(sorted[0]), dump_order_compare); 831 832 for (i = 0; i < n; i++) { 833 dns_rdataset_t *rds = sorted[i]; 834 if (ctx->style.flags & DNS_STYLEFLAG_TRUST) { 835 unsigned int trust = rds->trust; 836 INSIST(trust < (sizeof(trustnames) / 837 sizeof(trustnames[0]))); 838 fprintf(f, "; %s\n", trustnames[trust]); 839 } 840 if (rds->type == 0 && 841 (ctx->style.flags & DNS_STYLEFLAG_NCACHE) == 0) { 842 /* Omit negative cache entries */ 843 } else { 844 isc_result_t result = 845 dump_rdataset(mctx, name, rds, ctx, 846 buffer, f); 847 if (result != ISC_R_SUCCESS) 848 dumpresult = result; 849 if ((ctx->style.flags & DNS_STYLEFLAG_OMIT_OWNER) != 0) 850 name = NULL; 851 } 852 if (ctx->style.flags & DNS_STYLEFLAG_RESIGN && 853 rds->attributes & DNS_RDATASETATTR_RESIGN) { 854 isc_buffer_t b; 855 char buf[sizeof("YYYYMMDDHHMMSS")]; 856 memset(buf, 0, sizeof(buf)); 857 isc_buffer_init(&b, buf, sizeof(buf) - 1); 858 dns_time64_totext((isc_uint64_t)rds->resign, &b); 859 fprintf(f, "; resign=%s\n", buf); 860 } 861 dns_rdataset_disassociate(rds); 862 } 863 864 if (dumpresult != ISC_R_SUCCESS) 865 return (dumpresult); 866 867 /* 868 * If we got more data than could be sorted at once, 869 * go handle the rest. 870 */ 871 if (itresult == ISC_R_SUCCESS) 872 goto again; 873 874 if (itresult == ISC_R_NOMORE) 875 itresult = ISC_R_SUCCESS; 876 877 return (itresult); 878} 879 880/* 881 * Dump given RRsets in the "raw" format. 882 */ 883static isc_result_t 884dump_rdataset_raw(isc_mem_t *mctx, dns_name_t *name, dns_rdataset_t *rdataset, 885 isc_buffer_t *buffer, FILE *f) 886{ 887 isc_result_t result; 888 isc_uint32_t totallen; 889 isc_uint16_t dlen; 890 isc_region_t r, r_hdr; 891 892 REQUIRE(buffer->length > 0); 893 REQUIRE(DNS_RDATASET_VALID(rdataset)); 894 895 restart: 896 totallen = 0; 897 result = dns_rdataset_first(rdataset); 898 REQUIRE(result == ISC_R_SUCCESS); 899 900 isc_buffer_clear(buffer); 901 902 /* 903 * Common header and owner name (length followed by name) 904 * These fields should be in a moderate length, so we assume we 905 * can store all of them in the initial buffer. 906 */ 907 isc_buffer_availableregion(buffer, &r_hdr); 908 INSIST(r_hdr.length >= sizeof(dns_masterrawrdataset_t)); 909 isc_buffer_putuint32(buffer, totallen); /* XXX: leave space */ 910 isc_buffer_putuint16(buffer, rdataset->rdclass); /* 16-bit class */ 911 isc_buffer_putuint16(buffer, rdataset->type); /* 16-bit type */ 912 isc_buffer_putuint16(buffer, rdataset->covers); /* same as type */ 913 isc_buffer_putuint32(buffer, rdataset->ttl); /* 32-bit TTL */ 914 isc_buffer_putuint32(buffer, dns_rdataset_count(rdataset)); 915 totallen = isc_buffer_usedlength(buffer); 916 INSIST(totallen <= sizeof(dns_masterrawrdataset_t)); 917 918 dns_name_toregion(name, &r); 919 INSIST(isc_buffer_availablelength(buffer) >= 920 (sizeof(dlen) + r.length)); 921 dlen = (isc_uint16_t)r.length; 922 isc_buffer_putuint16(buffer, dlen); 923 isc_buffer_copyregion(buffer, &r); 924 totallen += sizeof(dlen) + r.length; 925 926 do { 927 dns_rdata_t rdata = DNS_RDATA_INIT; 928 isc_region_t r; 929 930 dns_rdataset_current(rdataset, &rdata); 931 dns_rdata_toregion(&rdata, &r); 932 INSIST(r.length <= 0xffffU); 933 dlen = (isc_uint16_t)r.length; 934 935 /* 936 * Copy the rdata into the buffer. If the buffer is too small, 937 * grow it. This should be rare, so we'll simply restart the 938 * entire procedure (or should we copy the old data and 939 * continue?). 940 */ 941 if (isc_buffer_availablelength(buffer) < 942 sizeof(dlen) + r.length) { 943 int newlength; 944 void *newmem; 945 946 newlength = buffer->length * 2; 947 newmem = isc_mem_get(mctx, newlength); 948 if (newmem == NULL) 949 return (ISC_R_NOMEMORY); 950 isc_mem_put(mctx, buffer->base, buffer->length); 951 isc_buffer_init(buffer, newmem, newlength); 952 goto restart; 953 } 954 isc_buffer_putuint16(buffer, dlen); 955 isc_buffer_copyregion(buffer, &r); 956 totallen += sizeof(dlen) + r.length; 957 958 result = dns_rdataset_next(rdataset); 959 } while (result == ISC_R_SUCCESS); 960 961 if (result != ISC_R_NOMORE) 962 return (result); 963 964 /* 965 * Fill in the total length field. 966 * XXX: this is a bit tricky. Since we have already "used" the space 967 * for the total length in the buffer, we first remember the entire 968 * buffer length in the region, "rewind", and then write the value. 969 */ 970 isc_buffer_usedregion(buffer, &r); 971 isc_buffer_clear(buffer); 972 isc_buffer_putuint32(buffer, totallen); 973 INSIST(isc_buffer_usedlength(buffer) < totallen); 974 975 /* 976 * Write the buffer contents to the raw master file. 977 */ 978 result = isc_stdio_write(r.base, 1, (size_t)r.length, f, NULL); 979 980 if (result != ISC_R_SUCCESS) { 981 UNEXPECTED_ERROR(__FILE__, __LINE__, 982 "raw master file write failed: %s", 983 isc_result_totext(result)); 984 return (result); 985 } 986 987 return (result); 988} 989 990static isc_result_t 991dump_rdatasets_raw(isc_mem_t *mctx, dns_name_t *name, 992 dns_rdatasetiter_t *rdsiter, dns_totext_ctx_t *ctx, 993 isc_buffer_t *buffer, FILE *f) 994{ 995 isc_result_t result; 996 dns_rdataset_t rdataset; 997 998 for (result = dns_rdatasetiter_first(rdsiter); 999 result == ISC_R_SUCCESS; 1000 result = dns_rdatasetiter_next(rdsiter)) { 1001 1002 dns_rdataset_init(&rdataset); 1003 dns_rdatasetiter_current(rdsiter, &rdataset); 1004 1005 if (rdataset.type == 0 && 1006 (ctx->style.flags & DNS_STYLEFLAG_NCACHE) == 0) { 1007 /* Omit negative cache entries */ 1008 } else { 1009 result = dump_rdataset_raw(mctx, name, &rdataset, 1010 buffer, f); 1011 } 1012 dns_rdataset_disassociate(&rdataset); 1013 } 1014 1015 if (result == ISC_R_NOMORE) 1016 result = ISC_R_SUCCESS; 1017 1018 return (result); 1019} 1020 1021/* 1022 * Initial size of text conversion buffer. The buffer is used 1023 * for several purposes: converting origin names, rdatasets, 1024 * $DATE timestamps, and comment strings for $TTL directives. 1025 * 1026 * When converting rdatasets, it is dynamically resized, but 1027 * when converting origins, timestamps, etc it is not. Therefore, 1028 * the initial size must large enough to hold the longest possible 1029 * text representation of any domain name (for $ORIGIN). 1030 */ 1031static const int initial_buffer_length = 1200; 1032 1033static isc_result_t 1034dumptostreaminc(dns_dumpctx_t *dctx); 1035 1036static void 1037dumpctx_destroy(dns_dumpctx_t *dctx) { 1038 1039 dctx->magic = 0; 1040 DESTROYLOCK(&dctx->lock); 1041 dns_dbiterator_destroy(&dctx->dbiter); 1042 if (dctx->version != NULL) 1043 dns_db_closeversion(dctx->db, &dctx->version, ISC_FALSE); 1044 dns_db_detach(&dctx->db); 1045 if (dctx->task != NULL) 1046 isc_task_detach(&dctx->task); 1047 if (dctx->file != NULL) 1048 isc_mem_free(dctx->mctx, dctx->file); 1049 if (dctx->tmpfile != NULL) 1050 isc_mem_free(dctx->mctx, dctx->tmpfile); 1051 isc_mem_putanddetach(&dctx->mctx, dctx, sizeof(*dctx)); 1052} 1053 1054void 1055dns_dumpctx_attach(dns_dumpctx_t *source, dns_dumpctx_t **target) { 1056 1057 REQUIRE(DNS_DCTX_VALID(source)); 1058 REQUIRE(target != NULL && *target == NULL); 1059 1060 LOCK(&source->lock); 1061 INSIST(source->references > 0); 1062 source->references++; 1063 INSIST(source->references != 0); /* Overflow? */ 1064 UNLOCK(&source->lock); 1065 1066 *target = source; 1067} 1068 1069void 1070dns_dumpctx_detach(dns_dumpctx_t **dctxp) { 1071 dns_dumpctx_t *dctx; 1072 isc_boolean_t need_destroy = ISC_FALSE; 1073 1074 REQUIRE(dctxp != NULL); 1075 dctx = *dctxp; 1076 REQUIRE(DNS_DCTX_VALID(dctx)); 1077 1078 *dctxp = NULL; 1079 1080 LOCK(&dctx->lock); 1081 INSIST(dctx->references != 0); 1082 dctx->references--; 1083 if (dctx->references == 0) 1084 need_destroy = ISC_TRUE; 1085 UNLOCK(&dctx->lock); 1086 if (need_destroy) 1087 dumpctx_destroy(dctx); 1088} 1089 1090dns_dbversion_t * 1091dns_dumpctx_version(dns_dumpctx_t *dctx) { 1092 REQUIRE(DNS_DCTX_VALID(dctx)); 1093 return (dctx->version); 1094} 1095 1096dns_db_t * 1097dns_dumpctx_db(dns_dumpctx_t *dctx) { 1098 REQUIRE(DNS_DCTX_VALID(dctx)); 1099 return (dctx->db); 1100} 1101 1102void 1103dns_dumpctx_cancel(dns_dumpctx_t *dctx) { 1104 REQUIRE(DNS_DCTX_VALID(dctx)); 1105 1106 LOCK(&dctx->lock); 1107 dctx->canceled = ISC_TRUE; 1108 UNLOCK(&dctx->lock); 1109} 1110 1111static isc_result_t 1112closeandrename(FILE *f, isc_result_t result, const char *temp, const char *file) 1113{ 1114 isc_result_t tresult; 1115 isc_boolean_t logit = ISC_TF(result == ISC_R_SUCCESS); 1116 1117 if (result == ISC_R_SUCCESS) 1118 result = isc_stdio_sync(f); 1119 if (result != ISC_R_SUCCESS && logit) { 1120 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL, 1121 DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR, 1122 "dumping master file: %s: fsync: %s", 1123 temp, isc_result_totext(result)); 1124 logit = ISC_FALSE; 1125 } 1126 tresult = isc_stdio_close(f); 1127 if (result == ISC_R_SUCCESS) 1128 result = tresult; 1129 if (result != ISC_R_SUCCESS && logit) { 1130 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL, 1131 DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR, 1132 "dumping master file: %s: fclose: %s", 1133 temp, isc_result_totext(result)); 1134 logit = ISC_FALSE; 1135 } 1136 if (result == ISC_R_SUCCESS) 1137 result = isc_file_rename(temp, file); 1138 else 1139 (void)isc_file_remove(temp); 1140 if (result != ISC_R_SUCCESS && logit) { 1141 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL, 1142 DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR, 1143 "dumping master file: rename: %s: %s", 1144 file, isc_result_totext(result)); 1145 } 1146 return (result); 1147} 1148 1149static void 1150dump_quantum(isc_task_t *task, isc_event_t *event) { 1151 isc_result_t result; 1152 isc_result_t tresult; 1153 dns_dumpctx_t *dctx; 1154 1155 REQUIRE(event != NULL); 1156 dctx = event->ev_arg; 1157 REQUIRE(DNS_DCTX_VALID(dctx)); 1158 if (dctx->canceled) 1159 result = ISC_R_CANCELED; 1160 else 1161 result = dumptostreaminc(dctx); 1162 if (result == DNS_R_CONTINUE) { 1163 event->ev_arg = dctx; 1164 isc_task_send(task, &event); 1165 return; 1166 } 1167 1168 if (dctx->file != NULL) { 1169 tresult = closeandrename(dctx->f, result, 1170 dctx->tmpfile, dctx->file); 1171 if (tresult != ISC_R_SUCCESS && result == ISC_R_SUCCESS) 1172 result = tresult; 1173 } 1174 (dctx->done)(dctx->done_arg, result); 1175 isc_event_free(&event); 1176 dns_dumpctx_detach(&dctx); 1177} 1178 1179static isc_result_t 1180task_send(dns_dumpctx_t *dctx) { 1181 isc_event_t *event; 1182 1183 event = isc_event_allocate(dctx->mctx, NULL, DNS_EVENT_DUMPQUANTUM, 1184 dump_quantum, dctx, sizeof(*event)); 1185 if (event == NULL) 1186 return (ISC_R_NOMEMORY); 1187 isc_task_send(dctx->task, &event); 1188 return (ISC_R_SUCCESS); 1189} 1190 1191static isc_result_t 1192dumpctx_create(isc_mem_t *mctx, dns_db_t *db, dns_dbversion_t *version, 1193 const dns_master_style_t *style, FILE *f, dns_dumpctx_t **dctxp, 1194 dns_masterformat_t format) 1195{ 1196 dns_dumpctx_t *dctx; 1197 isc_result_t result; 1198 unsigned int options; 1199 1200 dctx = isc_mem_get(mctx, sizeof(*dctx)); 1201 if (dctx == NULL) 1202 return (ISC_R_NOMEMORY); 1203 1204 dctx->mctx = NULL; 1205 dctx->f = f; 1206 dctx->dbiter = NULL; 1207 dctx->db = NULL; 1208 dctx->version = NULL; 1209 dctx->done = NULL; 1210 dctx->done_arg = NULL; 1211 dctx->task = NULL; 1212 dctx->nodes = 0; 1213 dctx->first = ISC_TRUE; 1214 dctx->canceled = ISC_FALSE; 1215 dctx->file = NULL; 1216 dctx->tmpfile = NULL; 1217 dctx->format = format; 1218 1219 switch (format) { 1220 case dns_masterformat_text: 1221 dctx->dumpsets = dump_rdatasets_text; 1222 break; 1223 case dns_masterformat_raw: 1224 dctx->dumpsets = dump_rdatasets_raw; 1225 break; 1226 default: 1227 INSIST(0); 1228 break; 1229 } 1230 1231 result = totext_ctx_init(style, &dctx->tctx); 1232 if (result != ISC_R_SUCCESS) { 1233 UNEXPECTED_ERROR(__FILE__, __LINE__, 1234 "could not set master file style"); 1235 goto cleanup; 1236 } 1237 1238 isc_stdtime_get(&dctx->now); 1239 dns_db_attach(db, &dctx->db); 1240 1241 dctx->do_date = dns_db_iscache(dctx->db); 1242 1243 if (dctx->format == dns_masterformat_text && 1244 (dctx->tctx.style.flags & DNS_STYLEFLAG_REL_OWNER) != 0) { 1245 options = DNS_DB_RELATIVENAMES; 1246 } else 1247 options = 0; 1248 result = dns_db_createiterator(dctx->db, options, &dctx->dbiter); 1249 if (result != ISC_R_SUCCESS) 1250 goto cleanup; 1251 1252 result = isc_mutex_init(&dctx->lock); 1253 if (result != ISC_R_SUCCESS) 1254 goto cleanup; 1255 if (version != NULL) 1256 dns_db_attachversion(dctx->db, version, &dctx->version); 1257 else if (!dns_db_iscache(db)) 1258 dns_db_currentversion(dctx->db, &dctx->version); 1259 isc_mem_attach(mctx, &dctx->mctx); 1260 dctx->references = 1; 1261 dctx->magic = DNS_DCTX_MAGIC; 1262 *dctxp = dctx; 1263 return (ISC_R_SUCCESS); 1264 1265 cleanup: 1266 if (dctx->dbiter != NULL) 1267 dns_dbiterator_destroy(&dctx->dbiter); 1268 if (dctx->db != NULL) 1269 dns_db_detach(&dctx->db); 1270 if (dctx != NULL) 1271 isc_mem_put(mctx, dctx, sizeof(*dctx)); 1272 return (result); 1273} 1274 1275static isc_result_t 1276dumptostreaminc(dns_dumpctx_t *dctx) { 1277 isc_result_t result; 1278 isc_buffer_t buffer; 1279 char *bufmem; 1280 isc_region_t r; 1281 dns_name_t *name; 1282 dns_fixedname_t fixname; 1283 unsigned int nodes; 1284 dns_masterrawheader_t rawheader; 1285 isc_uint32_t now32; 1286 isc_time_t start; 1287 1288 bufmem = isc_mem_get(dctx->mctx, initial_buffer_length); 1289 if (bufmem == NULL) 1290 return (ISC_R_NOMEMORY); 1291 1292 isc_buffer_init(&buffer, bufmem, initial_buffer_length); 1293 1294 dns_fixedname_init(&fixname); 1295 name = dns_fixedname_name(&fixname); 1296 1297 if (dctx->first) { 1298 switch (dctx->format) { 1299 case dns_masterformat_text: 1300 /* 1301 * If the database has cache semantics, output an 1302 * RFC2540 $DATE directive so that the TTLs can be 1303 * adjusted when it is reloaded. For zones it is not 1304 * really needed, and it would make the file 1305 * incompatible with pre-RFC2540 software, so we omit 1306 * it in the zone case. 1307 */ 1308 if (dctx->do_date) { 1309 result = dns_time32_totext(dctx->now, &buffer); 1310 RUNTIME_CHECK(result == ISC_R_SUCCESS); 1311 isc_buffer_usedregion(&buffer, &r); 1312 fprintf(dctx->f, "$DATE %.*s\n", 1313 (int) r.length, (char *) r.base); 1314 } 1315 break; 1316 case dns_masterformat_raw: 1317 r.base = (unsigned char *)&rawheader; 1318 r.length = sizeof(rawheader); 1319 isc_buffer_region(&buffer, &r); 1320 isc_buffer_putuint32(&buffer, dns_masterformat_raw); 1321 isc_buffer_putuint32(&buffer, DNS_RAWFORMAT_VERSION); 1322 if (sizeof(now32) != sizeof(dctx->now)) { 1323 /* 1324 * We assume isc_stdtime_t is a 32-bit integer, 1325 * which should be the case on most cases. 1326 * If it turns out to be uncommon, we'll need 1327 * to bump the version number and revise the 1328 * header format. 1329 */ 1330 isc_log_write(dns_lctx, 1331 ISC_LOGCATEGORY_GENERAL, 1332 DNS_LOGMODULE_MASTERDUMP, 1333 ISC_LOG_INFO, 1334 "dumping master file in raw " 1335 "format: stdtime is not 32bits"); 1336 now32 = 0; 1337 } else 1338 now32 = dctx->now; 1339 isc_buffer_putuint32(&buffer, now32); 1340 INSIST(isc_buffer_usedlength(&buffer) <= 1341 sizeof(rawheader)); 1342 result = isc_stdio_write(buffer.base, 1, 1343 isc_buffer_usedlength(&buffer), 1344 dctx->f, NULL); 1345 if (result != ISC_R_SUCCESS) 1346 return (result); 1347 isc_buffer_clear(&buffer); 1348 break; 1349 default: 1350 INSIST(0); 1351 } 1352 1353 result = dns_dbiterator_first(dctx->dbiter); 1354 dctx->first = ISC_FALSE; 1355 } else 1356 result = ISC_R_SUCCESS; 1357 1358 nodes = dctx->nodes; 1359 isc_time_now(&start); 1360 while (result == ISC_R_SUCCESS && (dctx->nodes == 0 || nodes--)) { 1361 dns_rdatasetiter_t *rdsiter = NULL; 1362 dns_dbnode_t *node = NULL; 1363 1364 result = dns_dbiterator_current(dctx->dbiter, &node, name); 1365 if (result != ISC_R_SUCCESS && result != DNS_R_NEWORIGIN) 1366 break; 1367 if (result == DNS_R_NEWORIGIN) { 1368 dns_name_t *origin = 1369 dns_fixedname_name(&dctx->tctx.origin_fixname); 1370 result = dns_dbiterator_origin(dctx->dbiter, origin); 1371 RUNTIME_CHECK(result == ISC_R_SUCCESS); 1372 if ((dctx->tctx.style.flags & DNS_STYLEFLAG_REL_DATA) != 0) 1373 dctx->tctx.origin = origin; 1374 dctx->tctx.neworigin = origin; 1375 } 1376 result = dns_db_allrdatasets(dctx->db, node, dctx->version, 1377 dctx->now, &rdsiter); 1378 if (result != ISC_R_SUCCESS) { 1379 dns_db_detachnode(dctx->db, &node); 1380 goto fail; 1381 } 1382 result = (dctx->dumpsets)(dctx->mctx, name, rdsiter, 1383 &dctx->tctx, &buffer, dctx->f); 1384 dns_rdatasetiter_destroy(&rdsiter); 1385 if (result != ISC_R_SUCCESS) { 1386 dns_db_detachnode(dctx->db, &node); 1387 goto fail; 1388 } 1389 dns_db_detachnode(dctx->db, &node); 1390 result = dns_dbiterator_next(dctx->dbiter); 1391 } 1392 1393 /* 1394 * Work out how many nodes can be written in the time between 1395 * two requests to the nameserver. Smooth the resulting number and 1396 * use it as a estimate for the number of nodes to be written in the 1397 * next iteration. 1398 */ 1399 if (dctx->nodes != 0 && result == ISC_R_SUCCESS) { 1400 unsigned int pps = dns_pps; /* packets per second */ 1401 unsigned int interval; 1402 isc_uint64_t usecs; 1403 isc_time_t end; 1404 1405 isc_time_now(&end); 1406 if (pps < 100) 1407 pps = 100; 1408 interval = 1000000 / pps; /* interval in usecs */ 1409 if (interval == 0) 1410 interval = 1; 1411 usecs = isc_time_microdiff(&end, &start); 1412 if (usecs == 0) { 1413 dctx->nodes = dctx->nodes * 2; 1414 if (dctx->nodes > 1000) 1415 dctx->nodes = 1000; 1416 } else { 1417 nodes = dctx->nodes * interval; 1418 nodes /= (unsigned int)usecs; 1419 if (nodes == 0) 1420 nodes = 1; 1421 else if (nodes > 1000) 1422 nodes = 1000; 1423 1424 /* Smooth and assign. */ 1425 dctx->nodes = (nodes + dctx->nodes * 7) / 8; 1426 1427 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL, 1428 DNS_LOGMODULE_MASTERDUMP, 1429 ISC_LOG_DEBUG(1), 1430 "dumptostreaminc(%p) new nodes -> %d\n", 1431 dctx, dctx->nodes); 1432 } 1433 result = DNS_R_CONTINUE; 1434 } else if (result == ISC_R_NOMORE) 1435 result = ISC_R_SUCCESS; 1436 fail: 1437 RUNTIME_CHECK(dns_dbiterator_pause(dctx->dbiter) == ISC_R_SUCCESS); 1438 isc_mem_put(dctx->mctx, buffer.base, buffer.length); 1439 return (result); 1440} 1441 1442isc_result_t 1443dns_master_dumptostreaminc(isc_mem_t *mctx, dns_db_t *db, 1444 dns_dbversion_t *version, 1445 const dns_master_style_t *style, 1446 FILE *f, isc_task_t *task, 1447 dns_dumpdonefunc_t done, void *done_arg, 1448 dns_dumpctx_t **dctxp) 1449{ 1450 dns_dumpctx_t *dctx = NULL; 1451 isc_result_t result; 1452 1453 REQUIRE(task != NULL); 1454 REQUIRE(f != NULL); 1455 REQUIRE(done != NULL); 1456 1457 result = dumpctx_create(mctx, db, version, style, f, &dctx, 1458 dns_masterformat_text); 1459 if (result != ISC_R_SUCCESS) 1460 return (result); 1461 isc_task_attach(task, &dctx->task); 1462 dctx->done = done; 1463 dctx->done_arg = done_arg; 1464 dctx->nodes = 100; 1465 1466 result = task_send(dctx); 1467 if (result == ISC_R_SUCCESS) { 1468 dns_dumpctx_attach(dctx, dctxp); 1469 return (DNS_R_CONTINUE); 1470 } 1471 1472 dns_dumpctx_detach(&dctx); 1473 return (result); 1474} 1475 1476/* 1477 * Dump an entire database into a master file. 1478 */ 1479isc_result_t 1480dns_master_dumptostream(isc_mem_t *mctx, dns_db_t *db, 1481 dns_dbversion_t *version, 1482 const dns_master_style_t *style, 1483 FILE *f) 1484{ 1485 return (dns_master_dumptostream2(mctx, db, version, style, 1486 dns_masterformat_text, f)); 1487} 1488 1489isc_result_t 1490dns_master_dumptostream2(isc_mem_t *mctx, dns_db_t *db, 1491 dns_dbversion_t *version, 1492 const dns_master_style_t *style, 1493 dns_masterformat_t format, FILE *f) 1494{ 1495 dns_dumpctx_t *dctx = NULL; 1496 isc_result_t result; 1497 1498 result = dumpctx_create(mctx, db, version, style, f, &dctx, format); 1499 if (result != ISC_R_SUCCESS) 1500 return (result); 1501 1502 result = dumptostreaminc(dctx); 1503 INSIST(result != DNS_R_CONTINUE); 1504 dns_dumpctx_detach(&dctx); 1505 return (result); 1506} 1507 1508static isc_result_t 1509opentmp(isc_mem_t *mctx, const char *file, char **tempp, FILE **fp) { 1510 FILE *f = NULL; 1511 isc_result_t result; 1512 char *tempname = NULL; 1513 int tempnamelen; 1514 1515 tempnamelen = strlen(file) + 20; 1516 tempname = isc_mem_allocate(mctx, tempnamelen); 1517 if (tempname == NULL) 1518 return (ISC_R_NOMEMORY); 1519 1520 result = isc_file_mktemplate(file, tempname, tempnamelen); 1521 if (result != ISC_R_SUCCESS) 1522 goto cleanup; 1523 1524 result = isc_file_openunique(tempname, &f); 1525 if (result != ISC_R_SUCCESS) { 1526 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL, 1527 DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR, 1528 "dumping master file: %s: open: %s", 1529 tempname, isc_result_totext(result)); 1530 goto cleanup; 1531 } 1532 *tempp = tempname; 1533 *fp = f; 1534 return (ISC_R_SUCCESS); 1535 1536cleanup: 1537 isc_mem_free(mctx, tempname); 1538 return (result); 1539} 1540 1541isc_result_t 1542dns_master_dumpinc(isc_mem_t *mctx, dns_db_t *db, dns_dbversion_t *version, 1543 const dns_master_style_t *style, const char *filename, 1544 isc_task_t *task, dns_dumpdonefunc_t done, void *done_arg, 1545 dns_dumpctx_t **dctxp) 1546{ 1547 return (dns_master_dumpinc2(mctx, db, version, style, filename, task, 1548 done, done_arg, dctxp, 1549 dns_masterformat_text)); 1550} 1551 1552isc_result_t 1553dns_master_dumpinc2(isc_mem_t *mctx, dns_db_t *db, dns_dbversion_t *version, 1554 const dns_master_style_t *style, const char *filename, 1555 isc_task_t *task, dns_dumpdonefunc_t done, void *done_arg, 1556 dns_dumpctx_t **dctxp, dns_masterformat_t format) 1557{ 1558 FILE *f = NULL; 1559 isc_result_t result; 1560 char *tempname = NULL; 1561 char *file = NULL; 1562 dns_dumpctx_t *dctx = NULL; 1563 1564 file = isc_mem_strdup(mctx, filename); 1565 if (file == NULL) 1566 return (ISC_R_NOMEMORY); 1567 1568 result = opentmp(mctx, filename, &tempname, &f); 1569 if (result != ISC_R_SUCCESS) 1570 goto cleanup; 1571 1572 result = dumpctx_create(mctx, db, version, style, f, &dctx, format); 1573 if (result != ISC_R_SUCCESS) { 1574 (void)isc_stdio_close(f); 1575 (void)isc_file_remove(tempname); 1576 goto cleanup; 1577 } 1578 1579 isc_task_attach(task, &dctx->task); 1580 dctx->done = done; 1581 dctx->done_arg = done_arg; 1582 dctx->nodes = 100; 1583 dctx->file = file; 1584 file = NULL; 1585 dctx->tmpfile = tempname; 1586 tempname = NULL; 1587 1588 result = task_send(dctx); 1589 if (result == ISC_R_SUCCESS) { 1590 dns_dumpctx_attach(dctx, dctxp); 1591 return (DNS_R_CONTINUE); 1592 } 1593 1594 cleanup: 1595 if (dctx != NULL) 1596 dns_dumpctx_detach(&dctx); 1597 if (file != NULL) 1598 isc_mem_free(mctx, file); 1599 if (tempname != NULL) 1600 isc_mem_free(mctx, tempname); 1601 return (result); 1602} 1603 1604isc_result_t 1605dns_master_dump(isc_mem_t *mctx, dns_db_t *db, dns_dbversion_t *version, 1606 const dns_master_style_t *style, const char *filename) 1607{ 1608 return (dns_master_dump2(mctx, db, version, style, filename, 1609 dns_masterformat_text)); 1610} 1611 1612isc_result_t 1613dns_master_dump2(isc_mem_t *mctx, dns_db_t *db, dns_dbversion_t *version, 1614 const dns_master_style_t *style, const char *filename, 1615 dns_masterformat_t format) 1616{ 1617 FILE *f = NULL; 1618 isc_result_t result; 1619 char *tempname; 1620 dns_dumpctx_t *dctx = NULL; 1621 1622 result = opentmp(mctx, filename, &tempname, &f); 1623 if (result != ISC_R_SUCCESS) 1624 return (result); 1625 1626 result = dumpctx_create(mctx, db, version, style, f, &dctx, format); 1627 if (result != ISC_R_SUCCESS) 1628 goto cleanup; 1629 1630 result = dumptostreaminc(dctx); 1631 INSIST(result != DNS_R_CONTINUE); 1632 dns_dumpctx_detach(&dctx); 1633 1634 result = closeandrename(f, result, tempname, filename); 1635 1636 cleanup: 1637 isc_mem_free(mctx, tempname); 1638 return (result); 1639} 1640 1641/* 1642 * Dump a database node into a master file. 1643 * XXX: this function assumes the text format. 1644 */ 1645isc_result_t 1646dns_master_dumpnodetostream(isc_mem_t *mctx, dns_db_t *db, 1647 dns_dbversion_t *version, 1648 dns_dbnode_t *node, dns_name_t *name, 1649 const dns_master_style_t *style, 1650 FILE *f) 1651{ 1652 isc_result_t result; 1653 isc_buffer_t buffer; 1654 char *bufmem; 1655 isc_stdtime_t now; 1656 dns_totext_ctx_t ctx; 1657 dns_rdatasetiter_t *rdsiter = NULL; 1658 1659 result = totext_ctx_init(style, &ctx); 1660 if (result != ISC_R_SUCCESS) { 1661 UNEXPECTED_ERROR(__FILE__, __LINE__, 1662 "could not set master file style"); 1663 return (ISC_R_UNEXPECTED); 1664 } 1665 1666 isc_stdtime_get(&now); 1667 1668 bufmem = isc_mem_get(mctx, initial_buffer_length); 1669 if (bufmem == NULL) 1670 return (ISC_R_NOMEMORY); 1671 1672 isc_buffer_init(&buffer, bufmem, initial_buffer_length); 1673 1674 result = dns_db_allrdatasets(db, node, version, now, &rdsiter); 1675 if (result != ISC_R_SUCCESS) 1676 goto failure; 1677 result = dump_rdatasets_text(mctx, name, rdsiter, &ctx, &buffer, f); 1678 if (result != ISC_R_SUCCESS) 1679 goto failure; 1680 dns_rdatasetiter_destroy(&rdsiter); 1681 1682 result = ISC_R_SUCCESS; 1683 1684 failure: 1685 isc_mem_put(mctx, buffer.base, buffer.length); 1686 return (result); 1687} 1688 1689isc_result_t 1690dns_master_dumpnode(isc_mem_t *mctx, dns_db_t *db, dns_dbversion_t *version, 1691 dns_dbnode_t *node, dns_name_t *name, 1692 const dns_master_style_t *style, const char *filename) 1693{ 1694 FILE *f = NULL; 1695 isc_result_t result; 1696 1697 result = isc_stdio_open(filename, "w", &f); 1698 if (result != ISC_R_SUCCESS) { 1699 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL, 1700 DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR, 1701 "dumping node to file: %s: open: %s", filename, 1702 isc_result_totext(result)); 1703 return (ISC_R_UNEXPECTED); 1704 } 1705 1706 result = dns_master_dumpnodetostream(mctx, db, version, node, name, 1707 style, f); 1708 1709 result = isc_stdio_close(f); 1710 if (result != ISC_R_SUCCESS) { 1711 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL, 1712 DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR, 1713 "dumping master file: %s: close: %s", filename, 1714 isc_result_totext(result)); 1715 return (ISC_R_UNEXPECTED); 1716 } 1717 1718 return (result); 1719} 1720 1721isc_result_t 1722dns_master_stylecreate(dns_master_style_t **stylep, unsigned int flags, 1723 unsigned int ttl_column, unsigned int class_column, 1724 unsigned int type_column, unsigned int rdata_column, 1725 unsigned int line_length, unsigned int tab_width, 1726 isc_mem_t *mctx) 1727{ 1728 dns_master_style_t *style; 1729 1730 REQUIRE(stylep != NULL && *stylep == NULL); 1731 style = isc_mem_get(mctx, sizeof(*style)); 1732 if (style == NULL) 1733 return (ISC_R_NOMEMORY); 1734 1735 style->flags = flags; 1736 style->ttl_column = ttl_column; 1737 style->class_column = class_column; 1738 style->type_column = type_column; 1739 style->rdata_column = rdata_column; 1740 style->line_length = line_length; 1741 style->tab_width = tab_width; 1742 1743 *stylep = style; 1744 return (ISC_R_SUCCESS); 1745} 1746 1747void 1748dns_master_styledestroy(dns_master_style_t **stylep, isc_mem_t *mctx) { 1749 dns_master_style_t *style; 1750 1751 REQUIRE(stylep != NULL && *stylep != NULL); 1752 style = *stylep; 1753 *stylep = NULL; 1754 isc_mem_put(mctx, style, sizeof(*style)); 1755} 1756