masterdump.c revision 222395
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.3.18.1 2011-05-27 00:19:19 each 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 isc_result_t 777dump_rdatasets_text(isc_mem_t *mctx, dns_name_t *name, 778 dns_rdatasetiter_t *rdsiter, dns_totext_ctx_t *ctx, 779 isc_buffer_t *buffer, FILE *f) 780{ 781 isc_result_t itresult, dumpresult; 782 isc_region_t r; 783 dns_rdataset_t rdatasets[MAXSORT]; 784 dns_rdataset_t *sorted[MAXSORT]; 785 int i, n; 786 787 itresult = dns_rdatasetiter_first(rdsiter); 788 dumpresult = ISC_R_SUCCESS; 789 790 if (itresult == ISC_R_SUCCESS && ctx->neworigin != NULL) { 791 isc_buffer_clear(buffer); 792 itresult = dns_name_totext(ctx->neworigin, ISC_FALSE, buffer); 793 RUNTIME_CHECK(itresult == ISC_R_SUCCESS); 794 isc_buffer_usedregion(buffer, &r); 795 fprintf(f, "$ORIGIN %.*s\n", (int) r.length, (char *) r.base); 796 ctx->neworigin = NULL; 797 } 798 799 again: 800 for (i = 0; 801 itresult == ISC_R_SUCCESS && i < MAXSORT; 802 itresult = dns_rdatasetiter_next(rdsiter), i++) { 803 dns_rdataset_init(&rdatasets[i]); 804 dns_rdatasetiter_current(rdsiter, &rdatasets[i]); 805 sorted[i] = &rdatasets[i]; 806 } 807 n = i; 808 INSIST(n <= MAXSORT); 809 810 qsort(sorted, n, sizeof(sorted[0]), dump_order_compare); 811 812 for (i = 0; i < n; i++) { 813 dns_rdataset_t *rds = sorted[i]; 814 if (ctx->style.flags & DNS_STYLEFLAG_TRUST) { 815 fprintf(f, "; %s\n", dns_trust_totext(rds->trust)); 816 } 817 if (rds->type == 0 && 818 (ctx->style.flags & DNS_STYLEFLAG_NCACHE) == 0) { 819 /* Omit negative cache entries */ 820 } else { 821 isc_result_t result = 822 dump_rdataset(mctx, name, rds, ctx, 823 buffer, f); 824 if (result != ISC_R_SUCCESS) 825 dumpresult = result; 826 if ((ctx->style.flags & DNS_STYLEFLAG_OMIT_OWNER) != 0) 827 name = NULL; 828 } 829 if (ctx->style.flags & DNS_STYLEFLAG_RESIGN && 830 rds->attributes & DNS_RDATASETATTR_RESIGN) { 831 isc_buffer_t b; 832 char buf[sizeof("YYYYMMDDHHMMSS")]; 833 memset(buf, 0, sizeof(buf)); 834 isc_buffer_init(&b, buf, sizeof(buf) - 1); 835 dns_time64_totext((isc_uint64_t)rds->resign, &b); 836 fprintf(f, "; resign=%s\n", buf); 837 } 838 dns_rdataset_disassociate(rds); 839 } 840 841 if (dumpresult != ISC_R_SUCCESS) 842 return (dumpresult); 843 844 /* 845 * If we got more data than could be sorted at once, 846 * go handle the rest. 847 */ 848 if (itresult == ISC_R_SUCCESS) 849 goto again; 850 851 if (itresult == ISC_R_NOMORE) 852 itresult = ISC_R_SUCCESS; 853 854 return (itresult); 855} 856 857/* 858 * Dump given RRsets in the "raw" format. 859 */ 860static isc_result_t 861dump_rdataset_raw(isc_mem_t *mctx, dns_name_t *name, dns_rdataset_t *rdataset, 862 isc_buffer_t *buffer, FILE *f) 863{ 864 isc_result_t result; 865 isc_uint32_t totallen; 866 isc_uint16_t dlen; 867 isc_region_t r, r_hdr; 868 869 REQUIRE(buffer->length > 0); 870 REQUIRE(DNS_RDATASET_VALID(rdataset)); 871 872 restart: 873 totallen = 0; 874 result = dns_rdataset_first(rdataset); 875 REQUIRE(result == ISC_R_SUCCESS); 876 877 isc_buffer_clear(buffer); 878 879 /* 880 * Common header and owner name (length followed by name) 881 * These fields should be in a moderate length, so we assume we 882 * can store all of them in the initial buffer. 883 */ 884 isc_buffer_availableregion(buffer, &r_hdr); 885 INSIST(r_hdr.length >= sizeof(dns_masterrawrdataset_t)); 886 isc_buffer_putuint32(buffer, totallen); /* XXX: leave space */ 887 isc_buffer_putuint16(buffer, rdataset->rdclass); /* 16-bit class */ 888 isc_buffer_putuint16(buffer, rdataset->type); /* 16-bit type */ 889 isc_buffer_putuint16(buffer, rdataset->covers); /* same as type */ 890 isc_buffer_putuint32(buffer, rdataset->ttl); /* 32-bit TTL */ 891 isc_buffer_putuint32(buffer, dns_rdataset_count(rdataset)); 892 totallen = isc_buffer_usedlength(buffer); 893 INSIST(totallen <= sizeof(dns_masterrawrdataset_t)); 894 895 dns_name_toregion(name, &r); 896 INSIST(isc_buffer_availablelength(buffer) >= 897 (sizeof(dlen) + r.length)); 898 dlen = (isc_uint16_t)r.length; 899 isc_buffer_putuint16(buffer, dlen); 900 isc_buffer_copyregion(buffer, &r); 901 totallen += sizeof(dlen) + r.length; 902 903 do { 904 dns_rdata_t rdata = DNS_RDATA_INIT; 905 isc_region_t r; 906 907 dns_rdataset_current(rdataset, &rdata); 908 dns_rdata_toregion(&rdata, &r); 909 INSIST(r.length <= 0xffffU); 910 dlen = (isc_uint16_t)r.length; 911 912 /* 913 * Copy the rdata into the buffer. If the buffer is too small, 914 * grow it. This should be rare, so we'll simply restart the 915 * entire procedure (or should we copy the old data and 916 * continue?). 917 */ 918 if (isc_buffer_availablelength(buffer) < 919 sizeof(dlen) + r.length) { 920 int newlength; 921 void *newmem; 922 923 newlength = buffer->length * 2; 924 newmem = isc_mem_get(mctx, newlength); 925 if (newmem == NULL) 926 return (ISC_R_NOMEMORY); 927 isc_mem_put(mctx, buffer->base, buffer->length); 928 isc_buffer_init(buffer, newmem, newlength); 929 goto restart; 930 } 931 isc_buffer_putuint16(buffer, dlen); 932 isc_buffer_copyregion(buffer, &r); 933 totallen += sizeof(dlen) + r.length; 934 935 result = dns_rdataset_next(rdataset); 936 } while (result == ISC_R_SUCCESS); 937 938 if (result != ISC_R_NOMORE) 939 return (result); 940 941 /* 942 * Fill in the total length field. 943 * XXX: this is a bit tricky. Since we have already "used" the space 944 * for the total length in the buffer, we first remember the entire 945 * buffer length in the region, "rewind", and then write the value. 946 */ 947 isc_buffer_usedregion(buffer, &r); 948 isc_buffer_clear(buffer); 949 isc_buffer_putuint32(buffer, totallen); 950 INSIST(isc_buffer_usedlength(buffer) < totallen); 951 952 /* 953 * Write the buffer contents to the raw master file. 954 */ 955 result = isc_stdio_write(r.base, 1, (size_t)r.length, f, NULL); 956 957 if (result != ISC_R_SUCCESS) { 958 UNEXPECTED_ERROR(__FILE__, __LINE__, 959 "raw master file write failed: %s", 960 isc_result_totext(result)); 961 return (result); 962 } 963 964 return (result); 965} 966 967static isc_result_t 968dump_rdatasets_raw(isc_mem_t *mctx, dns_name_t *name, 969 dns_rdatasetiter_t *rdsiter, dns_totext_ctx_t *ctx, 970 isc_buffer_t *buffer, FILE *f) 971{ 972 isc_result_t result; 973 dns_rdataset_t rdataset; 974 975 for (result = dns_rdatasetiter_first(rdsiter); 976 result == ISC_R_SUCCESS; 977 result = dns_rdatasetiter_next(rdsiter)) { 978 979 dns_rdataset_init(&rdataset); 980 dns_rdatasetiter_current(rdsiter, &rdataset); 981 982 if (rdataset.type == 0 && 983 (ctx->style.flags & DNS_STYLEFLAG_NCACHE) == 0) { 984 /* Omit negative cache entries */ 985 } else { 986 result = dump_rdataset_raw(mctx, name, &rdataset, 987 buffer, f); 988 } 989 dns_rdataset_disassociate(&rdataset); 990 } 991 992 if (result == ISC_R_NOMORE) 993 result = ISC_R_SUCCESS; 994 995 return (result); 996} 997 998/* 999 * Initial size of text conversion buffer. The buffer is used 1000 * for several purposes: converting origin names, rdatasets, 1001 * $DATE timestamps, and comment strings for $TTL directives. 1002 * 1003 * When converting rdatasets, it is dynamically resized, but 1004 * when converting origins, timestamps, etc it is not. Therefore, 1005 * the initial size must large enough to hold the longest possible 1006 * text representation of any domain name (for $ORIGIN). 1007 */ 1008static const int initial_buffer_length = 1200; 1009 1010static isc_result_t 1011dumptostreaminc(dns_dumpctx_t *dctx); 1012 1013static void 1014dumpctx_destroy(dns_dumpctx_t *dctx) { 1015 1016 dctx->magic = 0; 1017 DESTROYLOCK(&dctx->lock); 1018 dns_dbiterator_destroy(&dctx->dbiter); 1019 if (dctx->version != NULL) 1020 dns_db_closeversion(dctx->db, &dctx->version, ISC_FALSE); 1021 dns_db_detach(&dctx->db); 1022 if (dctx->task != NULL) 1023 isc_task_detach(&dctx->task); 1024 if (dctx->file != NULL) 1025 isc_mem_free(dctx->mctx, dctx->file); 1026 if (dctx->tmpfile != NULL) 1027 isc_mem_free(dctx->mctx, dctx->tmpfile); 1028 isc_mem_putanddetach(&dctx->mctx, dctx, sizeof(*dctx)); 1029} 1030 1031void 1032dns_dumpctx_attach(dns_dumpctx_t *source, dns_dumpctx_t **target) { 1033 1034 REQUIRE(DNS_DCTX_VALID(source)); 1035 REQUIRE(target != NULL && *target == NULL); 1036 1037 LOCK(&source->lock); 1038 INSIST(source->references > 0); 1039 source->references++; 1040 INSIST(source->references != 0); /* Overflow? */ 1041 UNLOCK(&source->lock); 1042 1043 *target = source; 1044} 1045 1046void 1047dns_dumpctx_detach(dns_dumpctx_t **dctxp) { 1048 dns_dumpctx_t *dctx; 1049 isc_boolean_t need_destroy = ISC_FALSE; 1050 1051 REQUIRE(dctxp != NULL); 1052 dctx = *dctxp; 1053 REQUIRE(DNS_DCTX_VALID(dctx)); 1054 1055 *dctxp = NULL; 1056 1057 LOCK(&dctx->lock); 1058 INSIST(dctx->references != 0); 1059 dctx->references--; 1060 if (dctx->references == 0) 1061 need_destroy = ISC_TRUE; 1062 UNLOCK(&dctx->lock); 1063 if (need_destroy) 1064 dumpctx_destroy(dctx); 1065} 1066 1067dns_dbversion_t * 1068dns_dumpctx_version(dns_dumpctx_t *dctx) { 1069 REQUIRE(DNS_DCTX_VALID(dctx)); 1070 return (dctx->version); 1071} 1072 1073dns_db_t * 1074dns_dumpctx_db(dns_dumpctx_t *dctx) { 1075 REQUIRE(DNS_DCTX_VALID(dctx)); 1076 return (dctx->db); 1077} 1078 1079void 1080dns_dumpctx_cancel(dns_dumpctx_t *dctx) { 1081 REQUIRE(DNS_DCTX_VALID(dctx)); 1082 1083 LOCK(&dctx->lock); 1084 dctx->canceled = ISC_TRUE; 1085 UNLOCK(&dctx->lock); 1086} 1087 1088static isc_result_t 1089closeandrename(FILE *f, isc_result_t result, const char *temp, const char *file) 1090{ 1091 isc_result_t tresult; 1092 isc_boolean_t logit = ISC_TF(result == ISC_R_SUCCESS); 1093 1094 if (result == ISC_R_SUCCESS) 1095 result = isc_stdio_sync(f); 1096 if (result != ISC_R_SUCCESS && logit) { 1097 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL, 1098 DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR, 1099 "dumping master file: %s: fsync: %s", 1100 temp, isc_result_totext(result)); 1101 logit = ISC_FALSE; 1102 } 1103 tresult = isc_stdio_close(f); 1104 if (result == ISC_R_SUCCESS) 1105 result = tresult; 1106 if (result != ISC_R_SUCCESS && logit) { 1107 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL, 1108 DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR, 1109 "dumping master file: %s: fclose: %s", 1110 temp, isc_result_totext(result)); 1111 logit = ISC_FALSE; 1112 } 1113 if (result == ISC_R_SUCCESS) 1114 result = isc_file_rename(temp, file); 1115 else 1116 (void)isc_file_remove(temp); 1117 if (result != ISC_R_SUCCESS && logit) { 1118 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL, 1119 DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR, 1120 "dumping master file: rename: %s: %s", 1121 file, isc_result_totext(result)); 1122 } 1123 return (result); 1124} 1125 1126static void 1127dump_quantum(isc_task_t *task, isc_event_t *event) { 1128 isc_result_t result; 1129 isc_result_t tresult; 1130 dns_dumpctx_t *dctx; 1131 1132 REQUIRE(event != NULL); 1133 dctx = event->ev_arg; 1134 REQUIRE(DNS_DCTX_VALID(dctx)); 1135 if (dctx->canceled) 1136 result = ISC_R_CANCELED; 1137 else 1138 result = dumptostreaminc(dctx); 1139 if (result == DNS_R_CONTINUE) { 1140 event->ev_arg = dctx; 1141 isc_task_send(task, &event); 1142 return; 1143 } 1144 1145 if (dctx->file != NULL) { 1146 tresult = closeandrename(dctx->f, result, 1147 dctx->tmpfile, dctx->file); 1148 if (tresult != ISC_R_SUCCESS && result == ISC_R_SUCCESS) 1149 result = tresult; 1150 } 1151 (dctx->done)(dctx->done_arg, result); 1152 isc_event_free(&event); 1153 dns_dumpctx_detach(&dctx); 1154} 1155 1156static isc_result_t 1157task_send(dns_dumpctx_t *dctx) { 1158 isc_event_t *event; 1159 1160 event = isc_event_allocate(dctx->mctx, NULL, DNS_EVENT_DUMPQUANTUM, 1161 dump_quantum, dctx, sizeof(*event)); 1162 if (event == NULL) 1163 return (ISC_R_NOMEMORY); 1164 isc_task_send(dctx->task, &event); 1165 return (ISC_R_SUCCESS); 1166} 1167 1168static isc_result_t 1169dumpctx_create(isc_mem_t *mctx, dns_db_t *db, dns_dbversion_t *version, 1170 const dns_master_style_t *style, FILE *f, dns_dumpctx_t **dctxp, 1171 dns_masterformat_t format) 1172{ 1173 dns_dumpctx_t *dctx; 1174 isc_result_t result; 1175 unsigned int options; 1176 1177 dctx = isc_mem_get(mctx, sizeof(*dctx)); 1178 if (dctx == NULL) 1179 return (ISC_R_NOMEMORY); 1180 1181 dctx->mctx = NULL; 1182 dctx->f = f; 1183 dctx->dbiter = NULL; 1184 dctx->db = NULL; 1185 dctx->version = NULL; 1186 dctx->done = NULL; 1187 dctx->done_arg = NULL; 1188 dctx->task = NULL; 1189 dctx->nodes = 0; 1190 dctx->first = ISC_TRUE; 1191 dctx->canceled = ISC_FALSE; 1192 dctx->file = NULL; 1193 dctx->tmpfile = NULL; 1194 dctx->format = format; 1195 1196 switch (format) { 1197 case dns_masterformat_text: 1198 dctx->dumpsets = dump_rdatasets_text; 1199 break; 1200 case dns_masterformat_raw: 1201 dctx->dumpsets = dump_rdatasets_raw; 1202 break; 1203 default: 1204 INSIST(0); 1205 break; 1206 } 1207 1208 result = totext_ctx_init(style, &dctx->tctx); 1209 if (result != ISC_R_SUCCESS) { 1210 UNEXPECTED_ERROR(__FILE__, __LINE__, 1211 "could not set master file style"); 1212 goto cleanup; 1213 } 1214 1215 isc_stdtime_get(&dctx->now); 1216 dns_db_attach(db, &dctx->db); 1217 1218 dctx->do_date = dns_db_iscache(dctx->db); 1219 1220 if (dctx->format == dns_masterformat_text && 1221 (dctx->tctx.style.flags & DNS_STYLEFLAG_REL_OWNER) != 0) { 1222 options = DNS_DB_RELATIVENAMES; 1223 } else 1224 options = 0; 1225 result = dns_db_createiterator(dctx->db, options, &dctx->dbiter); 1226 if (result != ISC_R_SUCCESS) 1227 goto cleanup; 1228 1229 result = isc_mutex_init(&dctx->lock); 1230 if (result != ISC_R_SUCCESS) 1231 goto cleanup; 1232 if (version != NULL) 1233 dns_db_attachversion(dctx->db, version, &dctx->version); 1234 else if (!dns_db_iscache(db)) 1235 dns_db_currentversion(dctx->db, &dctx->version); 1236 isc_mem_attach(mctx, &dctx->mctx); 1237 dctx->references = 1; 1238 dctx->magic = DNS_DCTX_MAGIC; 1239 *dctxp = dctx; 1240 return (ISC_R_SUCCESS); 1241 1242 cleanup: 1243 if (dctx->dbiter != NULL) 1244 dns_dbiterator_destroy(&dctx->dbiter); 1245 if (dctx->db != NULL) 1246 dns_db_detach(&dctx->db); 1247 if (dctx != NULL) 1248 isc_mem_put(mctx, dctx, sizeof(*dctx)); 1249 return (result); 1250} 1251 1252static isc_result_t 1253dumptostreaminc(dns_dumpctx_t *dctx) { 1254 isc_result_t result; 1255 isc_buffer_t buffer; 1256 char *bufmem; 1257 isc_region_t r; 1258 dns_name_t *name; 1259 dns_fixedname_t fixname; 1260 unsigned int nodes; 1261 dns_masterrawheader_t rawheader; 1262 isc_uint32_t now32; 1263 isc_time_t start; 1264 1265 bufmem = isc_mem_get(dctx->mctx, initial_buffer_length); 1266 if (bufmem == NULL) 1267 return (ISC_R_NOMEMORY); 1268 1269 isc_buffer_init(&buffer, bufmem, initial_buffer_length); 1270 1271 dns_fixedname_init(&fixname); 1272 name = dns_fixedname_name(&fixname); 1273 1274 if (dctx->first) { 1275 switch (dctx->format) { 1276 case dns_masterformat_text: 1277 /* 1278 * If the database has cache semantics, output an 1279 * RFC2540 $DATE directive so that the TTLs can be 1280 * adjusted when it is reloaded. For zones it is not 1281 * really needed, and it would make the file 1282 * incompatible with pre-RFC2540 software, so we omit 1283 * it in the zone case. 1284 */ 1285 if (dctx->do_date) { 1286 result = dns_time32_totext(dctx->now, &buffer); 1287 RUNTIME_CHECK(result == ISC_R_SUCCESS); 1288 isc_buffer_usedregion(&buffer, &r); 1289 fprintf(dctx->f, "$DATE %.*s\n", 1290 (int) r.length, (char *) r.base); 1291 } 1292 break; 1293 case dns_masterformat_raw: 1294 r.base = (unsigned char *)&rawheader; 1295 r.length = sizeof(rawheader); 1296 isc_buffer_region(&buffer, &r); 1297 isc_buffer_putuint32(&buffer, dns_masterformat_raw); 1298 isc_buffer_putuint32(&buffer, DNS_RAWFORMAT_VERSION); 1299 if (sizeof(now32) != sizeof(dctx->now)) { 1300 /* 1301 * We assume isc_stdtime_t is a 32-bit integer, 1302 * which should be the case on most cases. 1303 * If it turns out to be uncommon, we'll need 1304 * to bump the version number and revise the 1305 * header format. 1306 */ 1307 isc_log_write(dns_lctx, 1308 ISC_LOGCATEGORY_GENERAL, 1309 DNS_LOGMODULE_MASTERDUMP, 1310 ISC_LOG_INFO, 1311 "dumping master file in raw " 1312 "format: stdtime is not 32bits"); 1313 now32 = 0; 1314 } else 1315 now32 = dctx->now; 1316 isc_buffer_putuint32(&buffer, now32); 1317 INSIST(isc_buffer_usedlength(&buffer) <= 1318 sizeof(rawheader)); 1319 result = isc_stdio_write(buffer.base, 1, 1320 isc_buffer_usedlength(&buffer), 1321 dctx->f, NULL); 1322 if (result != ISC_R_SUCCESS) 1323 return (result); 1324 isc_buffer_clear(&buffer); 1325 break; 1326 default: 1327 INSIST(0); 1328 } 1329 1330 result = dns_dbiterator_first(dctx->dbiter); 1331 dctx->first = ISC_FALSE; 1332 } else 1333 result = ISC_R_SUCCESS; 1334 1335 nodes = dctx->nodes; 1336 isc_time_now(&start); 1337 while (result == ISC_R_SUCCESS && (dctx->nodes == 0 || nodes--)) { 1338 dns_rdatasetiter_t *rdsiter = NULL; 1339 dns_dbnode_t *node = NULL; 1340 1341 result = dns_dbiterator_current(dctx->dbiter, &node, name); 1342 if (result != ISC_R_SUCCESS && result != DNS_R_NEWORIGIN) 1343 break; 1344 if (result == DNS_R_NEWORIGIN) { 1345 dns_name_t *origin = 1346 dns_fixedname_name(&dctx->tctx.origin_fixname); 1347 result = dns_dbiterator_origin(dctx->dbiter, origin); 1348 RUNTIME_CHECK(result == ISC_R_SUCCESS); 1349 if ((dctx->tctx.style.flags & DNS_STYLEFLAG_REL_DATA) != 0) 1350 dctx->tctx.origin = origin; 1351 dctx->tctx.neworigin = origin; 1352 } 1353 result = dns_db_allrdatasets(dctx->db, node, dctx->version, 1354 dctx->now, &rdsiter); 1355 if (result != ISC_R_SUCCESS) { 1356 dns_db_detachnode(dctx->db, &node); 1357 goto fail; 1358 } 1359 result = (dctx->dumpsets)(dctx->mctx, name, rdsiter, 1360 &dctx->tctx, &buffer, dctx->f); 1361 dns_rdatasetiter_destroy(&rdsiter); 1362 if (result != ISC_R_SUCCESS) { 1363 dns_db_detachnode(dctx->db, &node); 1364 goto fail; 1365 } 1366 dns_db_detachnode(dctx->db, &node); 1367 result = dns_dbiterator_next(dctx->dbiter); 1368 } 1369 1370 /* 1371 * Work out how many nodes can be written in the time between 1372 * two requests to the nameserver. Smooth the resulting number and 1373 * use it as a estimate for the number of nodes to be written in the 1374 * next iteration. 1375 */ 1376 if (dctx->nodes != 0 && result == ISC_R_SUCCESS) { 1377 unsigned int pps = dns_pps; /* packets per second */ 1378 unsigned int interval; 1379 isc_uint64_t usecs; 1380 isc_time_t end; 1381 1382 isc_time_now(&end); 1383 if (pps < 100) 1384 pps = 100; 1385 interval = 1000000 / pps; /* interval in usecs */ 1386 if (interval == 0) 1387 interval = 1; 1388 usecs = isc_time_microdiff(&end, &start); 1389 if (usecs == 0) { 1390 dctx->nodes = dctx->nodes * 2; 1391 if (dctx->nodes > 1000) 1392 dctx->nodes = 1000; 1393 } else { 1394 nodes = dctx->nodes * interval; 1395 nodes /= (unsigned int)usecs; 1396 if (nodes == 0) 1397 nodes = 1; 1398 else if (nodes > 1000) 1399 nodes = 1000; 1400 1401 /* Smooth and assign. */ 1402 dctx->nodes = (nodes + dctx->nodes * 7) / 8; 1403 1404 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL, 1405 DNS_LOGMODULE_MASTERDUMP, 1406 ISC_LOG_DEBUG(1), 1407 "dumptostreaminc(%p) new nodes -> %d\n", 1408 dctx, dctx->nodes); 1409 } 1410 result = DNS_R_CONTINUE; 1411 } else if (result == ISC_R_NOMORE) 1412 result = ISC_R_SUCCESS; 1413 fail: 1414 RUNTIME_CHECK(dns_dbiterator_pause(dctx->dbiter) == ISC_R_SUCCESS); 1415 isc_mem_put(dctx->mctx, buffer.base, buffer.length); 1416 return (result); 1417} 1418 1419isc_result_t 1420dns_master_dumptostreaminc(isc_mem_t *mctx, dns_db_t *db, 1421 dns_dbversion_t *version, 1422 const dns_master_style_t *style, 1423 FILE *f, isc_task_t *task, 1424 dns_dumpdonefunc_t done, void *done_arg, 1425 dns_dumpctx_t **dctxp) 1426{ 1427 dns_dumpctx_t *dctx = NULL; 1428 isc_result_t result; 1429 1430 REQUIRE(task != NULL); 1431 REQUIRE(f != NULL); 1432 REQUIRE(done != NULL); 1433 1434 result = dumpctx_create(mctx, db, version, style, f, &dctx, 1435 dns_masterformat_text); 1436 if (result != ISC_R_SUCCESS) 1437 return (result); 1438 isc_task_attach(task, &dctx->task); 1439 dctx->done = done; 1440 dctx->done_arg = done_arg; 1441 dctx->nodes = 100; 1442 1443 result = task_send(dctx); 1444 if (result == ISC_R_SUCCESS) { 1445 dns_dumpctx_attach(dctx, dctxp); 1446 return (DNS_R_CONTINUE); 1447 } 1448 1449 dns_dumpctx_detach(&dctx); 1450 return (result); 1451} 1452 1453/* 1454 * Dump an entire database into a master file. 1455 */ 1456isc_result_t 1457dns_master_dumptostream(isc_mem_t *mctx, dns_db_t *db, 1458 dns_dbversion_t *version, 1459 const dns_master_style_t *style, 1460 FILE *f) 1461{ 1462 return (dns_master_dumptostream2(mctx, db, version, style, 1463 dns_masterformat_text, f)); 1464} 1465 1466isc_result_t 1467dns_master_dumptostream2(isc_mem_t *mctx, dns_db_t *db, 1468 dns_dbversion_t *version, 1469 const dns_master_style_t *style, 1470 dns_masterformat_t format, FILE *f) 1471{ 1472 dns_dumpctx_t *dctx = NULL; 1473 isc_result_t result; 1474 1475 result = dumpctx_create(mctx, db, version, style, f, &dctx, format); 1476 if (result != ISC_R_SUCCESS) 1477 return (result); 1478 1479 result = dumptostreaminc(dctx); 1480 INSIST(result != DNS_R_CONTINUE); 1481 dns_dumpctx_detach(&dctx); 1482 return (result); 1483} 1484 1485static isc_result_t 1486opentmp(isc_mem_t *mctx, const char *file, char **tempp, FILE **fp) { 1487 FILE *f = NULL; 1488 isc_result_t result; 1489 char *tempname = NULL; 1490 int tempnamelen; 1491 1492 tempnamelen = strlen(file) + 20; 1493 tempname = isc_mem_allocate(mctx, tempnamelen); 1494 if (tempname == NULL) 1495 return (ISC_R_NOMEMORY); 1496 1497 result = isc_file_mktemplate(file, tempname, tempnamelen); 1498 if (result != ISC_R_SUCCESS) 1499 goto cleanup; 1500 1501 result = isc_file_openunique(tempname, &f); 1502 if (result != ISC_R_SUCCESS) { 1503 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL, 1504 DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR, 1505 "dumping master file: %s: open: %s", 1506 tempname, isc_result_totext(result)); 1507 goto cleanup; 1508 } 1509 *tempp = tempname; 1510 *fp = f; 1511 return (ISC_R_SUCCESS); 1512 1513cleanup: 1514 isc_mem_free(mctx, tempname); 1515 return (result); 1516} 1517 1518isc_result_t 1519dns_master_dumpinc(isc_mem_t *mctx, dns_db_t *db, dns_dbversion_t *version, 1520 const dns_master_style_t *style, const char *filename, 1521 isc_task_t *task, dns_dumpdonefunc_t done, void *done_arg, 1522 dns_dumpctx_t **dctxp) 1523{ 1524 return (dns_master_dumpinc2(mctx, db, version, style, filename, task, 1525 done, done_arg, dctxp, 1526 dns_masterformat_text)); 1527} 1528 1529isc_result_t 1530dns_master_dumpinc2(isc_mem_t *mctx, dns_db_t *db, dns_dbversion_t *version, 1531 const dns_master_style_t *style, const char *filename, 1532 isc_task_t *task, dns_dumpdonefunc_t done, void *done_arg, 1533 dns_dumpctx_t **dctxp, dns_masterformat_t format) 1534{ 1535 FILE *f = NULL; 1536 isc_result_t result; 1537 char *tempname = NULL; 1538 char *file = NULL; 1539 dns_dumpctx_t *dctx = NULL; 1540 1541 file = isc_mem_strdup(mctx, filename); 1542 if (file == NULL) 1543 return (ISC_R_NOMEMORY); 1544 1545 result = opentmp(mctx, filename, &tempname, &f); 1546 if (result != ISC_R_SUCCESS) 1547 goto cleanup; 1548 1549 result = dumpctx_create(mctx, db, version, style, f, &dctx, format); 1550 if (result != ISC_R_SUCCESS) { 1551 (void)isc_stdio_close(f); 1552 (void)isc_file_remove(tempname); 1553 goto cleanup; 1554 } 1555 1556 isc_task_attach(task, &dctx->task); 1557 dctx->done = done; 1558 dctx->done_arg = done_arg; 1559 dctx->nodes = 100; 1560 dctx->file = file; 1561 file = NULL; 1562 dctx->tmpfile = tempname; 1563 tempname = NULL; 1564 1565 result = task_send(dctx); 1566 if (result == ISC_R_SUCCESS) { 1567 dns_dumpctx_attach(dctx, dctxp); 1568 return (DNS_R_CONTINUE); 1569 } 1570 1571 cleanup: 1572 if (dctx != NULL) 1573 dns_dumpctx_detach(&dctx); 1574 if (file != NULL) 1575 isc_mem_free(mctx, file); 1576 if (tempname != NULL) 1577 isc_mem_free(mctx, tempname); 1578 return (result); 1579} 1580 1581isc_result_t 1582dns_master_dump(isc_mem_t *mctx, dns_db_t *db, dns_dbversion_t *version, 1583 const dns_master_style_t *style, const char *filename) 1584{ 1585 return (dns_master_dump2(mctx, db, version, style, filename, 1586 dns_masterformat_text)); 1587} 1588 1589isc_result_t 1590dns_master_dump2(isc_mem_t *mctx, dns_db_t *db, dns_dbversion_t *version, 1591 const dns_master_style_t *style, const char *filename, 1592 dns_masterformat_t format) 1593{ 1594 FILE *f = NULL; 1595 isc_result_t result; 1596 char *tempname; 1597 dns_dumpctx_t *dctx = NULL; 1598 1599 result = opentmp(mctx, filename, &tempname, &f); 1600 if (result != ISC_R_SUCCESS) 1601 return (result); 1602 1603 result = dumpctx_create(mctx, db, version, style, f, &dctx, format); 1604 if (result != ISC_R_SUCCESS) 1605 goto cleanup; 1606 1607 result = dumptostreaminc(dctx); 1608 INSIST(result != DNS_R_CONTINUE); 1609 dns_dumpctx_detach(&dctx); 1610 1611 result = closeandrename(f, result, tempname, filename); 1612 1613 cleanup: 1614 isc_mem_free(mctx, tempname); 1615 return (result); 1616} 1617 1618/* 1619 * Dump a database node into a master file. 1620 * XXX: this function assumes the text format. 1621 */ 1622isc_result_t 1623dns_master_dumpnodetostream(isc_mem_t *mctx, dns_db_t *db, 1624 dns_dbversion_t *version, 1625 dns_dbnode_t *node, dns_name_t *name, 1626 const dns_master_style_t *style, 1627 FILE *f) 1628{ 1629 isc_result_t result; 1630 isc_buffer_t buffer; 1631 char *bufmem; 1632 isc_stdtime_t now; 1633 dns_totext_ctx_t ctx; 1634 dns_rdatasetiter_t *rdsiter = NULL; 1635 1636 result = totext_ctx_init(style, &ctx); 1637 if (result != ISC_R_SUCCESS) { 1638 UNEXPECTED_ERROR(__FILE__, __LINE__, 1639 "could not set master file style"); 1640 return (ISC_R_UNEXPECTED); 1641 } 1642 1643 isc_stdtime_get(&now); 1644 1645 bufmem = isc_mem_get(mctx, initial_buffer_length); 1646 if (bufmem == NULL) 1647 return (ISC_R_NOMEMORY); 1648 1649 isc_buffer_init(&buffer, bufmem, initial_buffer_length); 1650 1651 result = dns_db_allrdatasets(db, node, version, now, &rdsiter); 1652 if (result != ISC_R_SUCCESS) 1653 goto failure; 1654 result = dump_rdatasets_text(mctx, name, rdsiter, &ctx, &buffer, f); 1655 if (result != ISC_R_SUCCESS) 1656 goto failure; 1657 dns_rdatasetiter_destroy(&rdsiter); 1658 1659 result = ISC_R_SUCCESS; 1660 1661 failure: 1662 isc_mem_put(mctx, buffer.base, buffer.length); 1663 return (result); 1664} 1665 1666isc_result_t 1667dns_master_dumpnode(isc_mem_t *mctx, dns_db_t *db, dns_dbversion_t *version, 1668 dns_dbnode_t *node, dns_name_t *name, 1669 const dns_master_style_t *style, const char *filename) 1670{ 1671 FILE *f = NULL; 1672 isc_result_t result; 1673 1674 result = isc_stdio_open(filename, "w", &f); 1675 if (result != ISC_R_SUCCESS) { 1676 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL, 1677 DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR, 1678 "dumping node to file: %s: open: %s", filename, 1679 isc_result_totext(result)); 1680 return (ISC_R_UNEXPECTED); 1681 } 1682 1683 result = dns_master_dumpnodetostream(mctx, db, version, node, name, 1684 style, f); 1685 1686 result = isc_stdio_close(f); 1687 if (result != ISC_R_SUCCESS) { 1688 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL, 1689 DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR, 1690 "dumping master file: %s: close: %s", filename, 1691 isc_result_totext(result)); 1692 return (ISC_R_UNEXPECTED); 1693 } 1694 1695 return (result); 1696} 1697 1698isc_result_t 1699dns_master_stylecreate(dns_master_style_t **stylep, unsigned int flags, 1700 unsigned int ttl_column, unsigned int class_column, 1701 unsigned int type_column, unsigned int rdata_column, 1702 unsigned int line_length, unsigned int tab_width, 1703 isc_mem_t *mctx) 1704{ 1705 dns_master_style_t *style; 1706 1707 REQUIRE(stylep != NULL && *stylep == NULL); 1708 style = isc_mem_get(mctx, sizeof(*style)); 1709 if (style == NULL) 1710 return (ISC_R_NOMEMORY); 1711 1712 style->flags = flags; 1713 style->ttl_column = ttl_column; 1714 style->class_column = class_column; 1715 style->type_column = type_column; 1716 style->rdata_column = rdata_column; 1717 style->line_length = line_length; 1718 style->tab_width = tab_width; 1719 1720 *stylep = style; 1721 return (ISC_R_SUCCESS); 1722} 1723 1724void 1725dns_master_styledestroy(dns_master_style_t **stylep, isc_mem_t *mctx) { 1726 dns_master_style_t *style; 1727 1728 REQUIRE(stylep != NULL && *stylep != NULL); 1729 style = *stylep; 1730 *stylep = NULL; 1731 isc_mem_put(mctx, style, sizeof(*style)); 1732} 1733