contrib/bind9/lib/dns/masterdump.c

   1 /*
   2  * Copyright (C) 2004-2009, 2011  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.10 2011-06-09 00:16:34 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
  63 struct 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  */
  84 typedef 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
  96 LIBDNS_EXTERNAL_DATA const dns_master_style_t
  97 dns_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
 109 LIBDNS_EXTERNAL_DATA const dns_master_style_t
 110 dns_master_style_full = {
 111         DNS_STYLEFLAG_COMMENT |
 112         DNS_STYLEFLAG_RESIGN,
 113         46, 46, 46, 64, 120, 8
 114 };
 115
 116 LIBDNS_EXTERNAL_DATA const dns_master_style_t
 117 dns_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
 127 LIBDNS_EXTERNAL_DATA const dns_master_style_t
 128 dns_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
 137 LIBDNS_EXTERNAL_DATA const dns_master_style_t
 138 dns_master_style_simple = {
 139         0,
 140         24, 32, 32, 40, 80, 8
 141 };
 142
 143 /*%
 144  * A style suitable for dns_rdataset_totext().
 145  */
 146 LIBDNS_EXTERNAL_DATA const dns_master_style_t
 147 dns_master_style_debug = {
 148         DNS_STYLEFLAG_REL_OWNER,
 149         24, 32, 40, 48, 80, 8
 150 };
 151
 152
 153 #define N_SPACES 10
 154 static char spaces[N_SPACES+1] = "          ";
 155
 156 #define N_TABS 10
 157 static char tabs[N_TABS+1] = "\t\t\t\t\t\t\t\t\t\t";
 158
 159 struct 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  */
 194 static isc_result_t
 195 indent(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
 254 static isc_result_t
 255 totext_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
 323 static isc_result_t
 324 str_totext(const char *source, isc_buffer_t *target) {
 325         unsigned int l;
 326         isc_region_t region;
 327
 328         isc_buffer_availableregion(target, &region);
 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
 346 static isc_result_t
 347 rdataset_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         unsigned int type_start;
 360
 361         REQUIRE(DNS_RDATASET_VALID(rdataset));
 362
 363         rdataset->attributes |= DNS_RDATASETATTR_LOADORDER;
 364         result = dns_rdataset_first(rdataset);
 365         REQUIRE(result == ISC_R_SUCCESS);
 366
 367         current_ttl = ctx->current_ttl;
 368         current_ttl_valid = ctx->current_ttl_valid;
 369
 370         do {
 371                 column = 0;
 372
 373                 /*
 374                  * Owner name.
 375                  */
 376                 if (owner_name != NULL &&
 377                     ! ((ctx->style.flags & DNS_STYLEFLAG_OMIT_OWNER) != 0 &&
 378                        !first))
 379                 {
 380                         unsigned int name_start = target->used;
 381                         RETERR(dns_name_totext(owner_name,
 382                                                omit_final_dot,
 383                                                target));
 384                         column += target->used - name_start;
 385                 }
 386
 387                 /*
 388                  * TTL.
 389                  */
 390                 if ((ctx->style.flags & DNS_STYLEFLAG_NO_TTL) == 0 &&
 391                     !((ctx->style.flags & DNS_STYLEFLAG_OMIT_TTL) != 0 &&
 392                       current_ttl_valid &&
 393                       rdataset->ttl == current_ttl))
 394                 {
 395                         char ttlbuf[64];
 396                         isc_region_t r;
 397                         unsigned int length;
 398
 399                         INDENT_TO(ttl_column);
 400                         length = snprintf(ttlbuf, sizeof(ttlbuf), "%u",
 401                                           rdataset->ttl);
 402                         INSIST(length <= sizeof(ttlbuf));
 403                         isc_buffer_availableregion(target, &r);
 404                         if (r.length < length)
 405                                 return (ISC_R_NOSPACE);
 406                         memcpy(r.base, ttlbuf, length);
 407                         isc_buffer_add(target, length);
 408                         column += length;
 409
 410                         /*
 411                          * If the $TTL directive is not in use, the TTL we
 412                          * just printed becomes the default for subsequent RRs.
 413                          */
 414                         if ((ctx->style.flags & DNS_STYLEFLAG_TTL) == 0) {
 415                                 current_ttl = rdataset->ttl;
 416                                 current_ttl_valid = ISC_TRUE;
 417                         }
 418                 }
 419
 420                 /*
 421                  * Class.
 422                  */
 423                 if ((ctx->style.flags & DNS_STYLEFLAG_NO_CLASS) == 0 &&
 424                     ((ctx->style.flags & DNS_STYLEFLAG_OMIT_CLASS) == 0 ||
 425                      ctx->class_printed == ISC_FALSE))
 426                 {
 427                         unsigned int class_start;
 428                         INDENT_TO(class_column);
 429                         class_start = target->used;
 430                         result = dns_rdataclass_totext(rdataset->rdclass,
 431                                                        target);
 432                         if (result != ISC_R_SUCCESS)
 433                                 return (result);
 434                         column += (target->used - class_start);
 435                 }
 436
 437                 /*
 438                  * Type.
 439                  */
 440
 441                 if ((rdataset->attributes & DNS_RDATASETATTR_NEGATIVE) != 0) {
 442                         type = rdataset->covers;
 443                 } else {
 444                         type = rdataset->type;
 445                 }
 446
 447                 INDENT_TO(type_column);
 448                 type_start = target->used;
 449                 if ((rdataset->attributes & DNS_RDATASETATTR_NEGATIVE) != 0)
 450                         RETERR(str_totext("\\-", target));
 451                 result = dns_rdatatype_totext(type, target);
 452                 if (result != ISC_R_SUCCESS)
 453                         return (result);
 454                 column += (target->used - type_start);
 455
 456                 /*
 457                  * Rdata.
 458                  */
 459                 INDENT_TO(rdata_column);
 460                 if ((rdataset->attributes & DNS_RDATASETATTR_NEGATIVE) != 0) {
 461                         if (NXDOMAIN(rdataset))
 462                                 RETERR(str_totext(";-$NXDOMAIN\n", target));
 463                         else
 464                                 RETERR(str_totext(";-$NXRRSET\n", target));
 465                 } else {
 466                         dns_rdata_t rdata = DNS_RDATA_INIT;
 467                         isc_region_t r;
 468
 469                         dns_rdataset_current(rdataset, &rdata);
 470
 471                         RETERR(dns_rdata_tofmttext(&rdata,
 472                                                    ctx->origin,
 473                                                    ctx->style.flags,
 474                                                    ctx->style.line_length -
 475                                                        ctx->style.rdata_column,
 476                                                    ctx->linebreak,
 477                                                    target));
 478
 479                         isc_buffer_availableregion(target, &r);
 480                         if (r.length < 1)
 481                                 return (ISC_R_NOSPACE);
 482                         r.base[0] = '\n';
 483                         isc_buffer_add(target, 1);
 484                 }
 485
 486                 first = ISC_FALSE;
 487                 result = dns_rdataset_next(rdataset);
 488         } while (result == ISC_R_SUCCESS);
 489
 490         if (result != ISC_R_NOMORE)
 491                 return (result);
 492
 493         /*
 494          * Update the ctx state to reflect what we just printed.
 495          * This is done last, only when we are sure we will return
 496          * success, because this function may be called multiple
 497          * times with increasing buffer sizes until it succeeds,
 498          * and failed attempts must not update the state prematurely.
 499          */
 500         ctx->class_printed = ISC_TRUE;
 501         ctx->current_ttl= current_ttl;
 502         ctx->current_ttl_valid = current_ttl_valid;
 503
 504         return (ISC_R_SUCCESS);
 505 }
 506
 507 /*
 508  * Print the name, type, and class of an empty rdataset,
 509  * such as those used to represent the question section
 510  * of a DNS message.
 511  */
 512 static isc_result_t
 513 question_totext(dns_rdataset_t *rdataset,
 514                 dns_name_t *owner_name,
 515                 dns_totext_ctx_t *ctx,
 516                 isc_boolean_t omit_final_dot,
 517                 isc_buffer_t *target)
 518 {
 519         unsigned int column;
 520         isc_result_t result;
 521         isc_region_t r;
 522
 523         REQUIRE(DNS_RDATASET_VALID(rdataset));
 524         result = dns_rdataset_first(rdataset);
 525         REQUIRE(result == ISC_R_NOMORE);
 526
 527         column = 0;
 528
 529         /* Owner name */
 530         {
 531                 unsigned int name_start = target->used;
 532                 RETERR(dns_name_totext(owner_name,
 533                                        omit_final_dot,
 534                                        target));
 535                 column += target->used - name_start;
 536         }
 537
 538         /* Class */
 539         {
 540                 unsigned int class_start;
 541                 INDENT_TO(class_column);
 542                 class_start = target->used;
 543                 result = dns_rdataclass_totext(rdataset->rdclass, target);
 544                 if (result != ISC_R_SUCCESS)
 545                         return (result);
 546                 column += (target->used - class_start);
 547         }
 548
 549         /* Type */
 550         {
 551                 unsigned int type_start;
 552                 INDENT_TO(type_column);
 553                 type_start = target->used;
 554                 result = dns_rdatatype_totext(rdataset->type, target);
 555                 if (result != ISC_R_SUCCESS)
 556                         return (result);
 557                 column += (target->used - type_start);
 558         }
 559
 560         isc_buffer_availableregion(target, &r);
 561         if (r.length < 1)
 562                 return (ISC_R_NOSPACE);
 563         r.base[0] = '\n';
 564         isc_buffer_add(target, 1);
 565
 566         return (ISC_R_SUCCESS);
 567 }
 568
 569 isc_result_t
 570 dns_rdataset_totext(dns_rdataset_t *rdataset,
 571                     dns_name_t *owner_name,
 572                     isc_boolean_t omit_final_dot,
 573                     isc_boolean_t question,
 574                     isc_buffer_t *target)
 575 {
 576         dns_totext_ctx_t ctx;
 577         isc_result_t result;
 578         result = totext_ctx_init(&dns_master_style_debug, &ctx);
 579         if (result != ISC_R_SUCCESS) {
 580                 UNEXPECTED_ERROR(__FILE__, __LINE__,
 581                                  "could not set master file style");
 582                 return (ISC_R_UNEXPECTED);
 583         }
 584
 585         /*
 586          * The caller might want to give us an empty owner
 587          * name (e.g. if they are outputting into a master
 588          * file and this rdataset has the same name as the
 589          * previous one.)
 590          */
 591         if (dns_name_countlabels(owner_name) == 0)
 592                 owner_name = NULL;
 593
 594         if (question)
 595                 return (question_totext(rdataset, owner_name, &ctx,
 596                                         omit_final_dot, target));
 597         else
 598                 return (rdataset_totext(rdataset, owner_name, &ctx,
 599                                         omit_final_dot, target));
 600 }
 601
 602 isc_result_t
 603 dns_master_rdatasettotext(dns_name_t *owner_name,
 604                           dns_rdataset_t *rdataset,
 605                           const dns_master_style_t *style,
 606                           isc_buffer_t *target)
 607 {
 608         dns_totext_ctx_t ctx;
 609         isc_result_t result;
 610         result = totext_ctx_init(style, &ctx);
 611         if (result != ISC_R_SUCCESS) {
 612                 UNEXPECTED_ERROR(__FILE__, __LINE__,
 613                                  "could not set master file style");
 614                 return (ISC_R_UNEXPECTED);
 615         }
 616
 617         return (rdataset_totext(rdataset, owner_name, &ctx,
 618                                 ISC_FALSE, target));
 619 }
 620
 621 isc_result_t
 622 dns_master_questiontotext(dns_name_t *owner_name,
 623                           dns_rdataset_t *rdataset,
 624                           const dns_master_style_t *style,
 625                           isc_buffer_t *target)
 626 {
 627         dns_totext_ctx_t ctx;
 628         isc_result_t result;
 629         result = totext_ctx_init(style, &ctx);
 630         if (result != ISC_R_SUCCESS) {
 631                 UNEXPECTED_ERROR(__FILE__, __LINE__,
 632                                  "could not set master file style");
 633                 return (ISC_R_UNEXPECTED);
 634         }
 635
 636         return (question_totext(rdataset, owner_name, &ctx,
 637                                 ISC_FALSE, target));
 638 }
 639
 640 /*
 641  * Print an rdataset.  'buffer' is a scratch buffer, which must have been
 642  * dynamically allocated by the caller.  It must be large enough to
 643  * hold the result from dns_ttl_totext().  If more than that is needed,
 644  * the buffer will be grown automatically.
 645  */
 646
 647 static isc_result_t
 648 dump_rdataset(isc_mem_t *mctx, dns_name_t *name, dns_rdataset_t *rdataset,
 649               dns_totext_ctx_t *ctx,
 650               isc_buffer_t *buffer, FILE *f)
 651 {
 652         isc_region_t r;
 653         isc_result_t result;
 654
 655         REQUIRE(buffer->length > 0);
 656
 657         /*
 658          * Output a $TTL directive if needed.
 659          */
 660
 661         if ((ctx->style.flags & DNS_STYLEFLAG_TTL) != 0) {
 662                 if (ctx->current_ttl_valid == ISC_FALSE ||
 663                     ctx->current_ttl != rdataset->ttl)
 664                 {
 665                         if ((ctx->style.flags & DNS_STYLEFLAG_COMMENT) != 0)
 666                         {
 667                                 isc_buffer_clear(buffer);
 668                                 result = dns_ttl_totext(rdataset->ttl,
 669                                                         ISC_TRUE, buffer);
 670                                 INSIST(result == ISC_R_SUCCESS);
 671                                 isc_buffer_usedregion(buffer, &r);
 672                                 fprintf(f, "$TTL %u\t; %.*s\n", rdataset->ttl,
 673                                         (int) r.length, (char *) r.base);
 674                         } else {
 675                                 fprintf(f, "$TTL %u\n", rdataset->ttl);
 676                         }
 677                         ctx->current_ttl = rdataset->ttl;
 678                         ctx->current_ttl_valid = ISC_TRUE;
 679                 }
 680         }
 681
 682         isc_buffer_clear(buffer);
 683
 684         /*
 685          * Generate the text representation of the rdataset into
 686          * the buffer.  If the buffer is too small, grow it.
 687          */
 688         for (;;) {
 689                 int newlength;
 690                 void *newmem;
 691                 result = rdataset_totext(rdataset, name, ctx,
 692                                          ISC_FALSE, buffer);
 693                 if (result != ISC_R_NOSPACE)
 694                         break;
 695
 696                 newlength = buffer->length * 2;
 697                 newmem = isc_mem_get(mctx, newlength);
 698                 if (newmem == NULL)
 699                         return (ISC_R_NOMEMORY);
 700                 isc_mem_put(mctx, buffer->base, buffer->length);
 701                 isc_buffer_init(buffer, newmem, newlength);
 702         }
 703         if (result != ISC_R_SUCCESS)
 704                 return (result);
 705
 706         /*
 707          * Write the buffer contents to the master file.
 708          */
 709         isc_buffer_usedregion(buffer, &r);
 710         result = isc_stdio_write(r.base, 1, (size_t)r.length, f, NULL);
 711
 712         if (result != ISC_R_SUCCESS) {
 713                 UNEXPECTED_ERROR(__FILE__, __LINE__,
 714                                  "master file write failed: %s",
 715                                  isc_result_totext(result));
 716                 return (result);
 717         }
 718
 719         return (ISC_R_SUCCESS);
 720 }
 721
 722 /*
 723  * Define the order in which rdatasets should be printed in zone
 724  * files.  We will print SOA and NS records before others, SIGs
 725  * immediately following the things they sign, and order everything
 726  * else by RR number.  This is all just for aesthetics and
 727  * compatibility with buggy software that expects the SOA to be first;
 728  * the DNS specifications allow any order.
 729  */
 730
 731 static int
 732 dump_order(const dns_rdataset_t *rds) {
 733         int t;
 734         int sig;
 735         if (rds->type == dns_rdatatype_rrsig) {
 736                 t = rds->covers;
 737                 sig = 1;
 738         } else {
 739                 t = rds->type;
 740                 sig = 0;
 741         }
 742         switch (t) {
 743         case dns_rdatatype_soa:
 744                 t = 0;
 745                 break;
 746         case dns_rdatatype_ns:
 747                 t = 1;
 748                 break;
 749         default:
 750                 t += 2;
 751                 break;
 752         }
 753         return (t << 1) + sig;
 754 }
 755
 756 static int
 757 dump_order_compare(const void *a, const void *b) {
 758         return (dump_order(*((const dns_rdataset_t * const *) a)) -
 759                 dump_order(*((const dns_rdataset_t * const *) b)));
 760 }
 761
 762 /*
 763  * Dump all the rdatasets of a domain name to a master file.  We make
 764  * a "best effort" attempt to sort the RRsets in a nice order, but if
 765  * there are more than MAXSORT RRsets, we punt and only sort them in
 766  * groups of MAXSORT.  This is not expected to ever happen in practice
 767  * since much less than 64 RR types have been registered with the
 768  * IANA, so far, and the output will be correct (though not
 769  * aesthetically pleasing) even if it does happen.
 770  */
 771
 772 #define MAXSORT 64
 773
 774 static isc_result_t
 775 dump_rdatasets_text(isc_mem_t *mctx, dns_name_t *name,
 776                     dns_rdatasetiter_t *rdsiter, dns_totext_ctx_t *ctx,
 777                     isc_buffer_t *buffer, FILE *f)
 778 {
 779         isc_result_t itresult, dumpresult;
 780         isc_region_t r;
 781         dns_rdataset_t rdatasets[MAXSORT];
 782         dns_rdataset_t *sorted[MAXSORT];
 783         int i, n;
 784
 785         itresult = dns_rdatasetiter_first(rdsiter);
 786         dumpresult = ISC_R_SUCCESS;
 787
 788         if (itresult == ISC_R_SUCCESS && ctx->neworigin != NULL) {
 789                 isc_buffer_clear(buffer);
 790                 itresult = dns_name_totext(ctx->neworigin, ISC_FALSE, buffer);
 791                 RUNTIME_CHECK(itresult == ISC_R_SUCCESS);
 792                 isc_buffer_usedregion(buffer, &r);
 793                 fprintf(f, "$ORIGIN %.*s\n", (int) r.length, (char *) r.base);
 794                 ctx->neworigin = NULL;
 795         }
 796
 797  again:
 798         for (i = 0;
 799              itresult == ISC_R_SUCCESS && i < MAXSORT;
 800              itresult = dns_rdatasetiter_next(rdsiter), i++) {
 801                 dns_rdataset_init(&rdatasets[i]);
 802                 dns_rdatasetiter_current(rdsiter, &rdatasets[i]);
 803                 sorted[i] = &rdatasets[i];
 804         }
 805         n = i;
 806         INSIST(n <= MAXSORT);
 807
 808         qsort(sorted, n, sizeof(sorted[0]), dump_order_compare);
 809
 810         for (i = 0; i < n; i++) {
 811                 dns_rdataset_t *rds = sorted[i];
 812                 if (ctx->style.flags & DNS_STYLEFLAG_TRUST)
 813                         fprintf(f, "; %s\n", dns_trust_totext(rds->trust));
 814                 if (((rds->attributes & DNS_RDATASETATTR_NEGATIVE) != 0) &&
 815                     (ctx->style.flags & DNS_STYLEFLAG_NCACHE) == 0) {
 816                         /* Omit negative cache entries */
 817                 } else {
 818                         isc_result_t result =
 819                                 dump_rdataset(mctx, name, rds, ctx,
 820                                                buffer, f);
 821                         if (result != ISC_R_SUCCESS)
 822                                 dumpresult = result;
 823                         if ((ctx->style.flags & DNS_STYLEFLAG_OMIT_OWNER) != 0)
 824                                 name = NULL;
 825                 }
 826                 if (ctx->style.flags & DNS_STYLEFLAG_RESIGN &&
 827                     rds->attributes & DNS_RDATASETATTR_RESIGN) {
 828                         isc_buffer_t b;
 829                         char buf[sizeof("YYYYMMDDHHMMSS")];
 830                         memset(buf, 0, sizeof(buf));
 831                         isc_buffer_init(&b, buf, sizeof(buf) - 1);
 832                         dns_time64_totext((isc_uint64_t)rds->resign, &b);
 833                         fprintf(f, "; resign=%s\n", buf);
 834                 }
 835                 dns_rdataset_disassociate(rds);
 836         }
 837
 838         if (dumpresult != ISC_R_SUCCESS)
 839                 return (dumpresult);
 840
 841         /*
 842          * If we got more data than could be sorted at once,
 843          * go handle the rest.
 844          */
 845         if (itresult == ISC_R_SUCCESS)
 846                 goto again;
 847
 848         if (itresult == ISC_R_NOMORE)
 849                 itresult = ISC_R_SUCCESS;
 850
 851         return (itresult);
 852 }
 853
 854 /*
 855  * Dump given RRsets in the "raw" format.
 856  */
 857 static isc_result_t
 858 dump_rdataset_raw(isc_mem_t *mctx, dns_name_t *name, dns_rdataset_t *rdataset,
 859                   isc_buffer_t *buffer, FILE *f)
 860 {
 861         isc_result_t result;
 862         isc_uint32_t totallen;
 863         isc_uint16_t dlen;
 864         isc_region_t r, r_hdr;
 865
 866         REQUIRE(buffer->length > 0);
 867         REQUIRE(DNS_RDATASET_VALID(rdataset));
 868
 869  restart:
 870         totallen = 0;
 871         result = dns_rdataset_first(rdataset);
 872         REQUIRE(result == ISC_R_SUCCESS);
 873
 874         isc_buffer_clear(buffer);
 875
 876         /*
 877          * Common header and owner name (length followed by name)
 878          * These fields should be in a moderate length, so we assume we
 879          * can store all of them in the initial buffer.
 880          */
 881         isc_buffer_availableregion(buffer, &r_hdr);
 882         INSIST(r_hdr.length >= sizeof(dns_masterrawrdataset_t));
 883         isc_buffer_putuint32(buffer, totallen); /* XXX: leave space */
 884         isc_buffer_putuint16(buffer, rdataset->rdclass); /* 16-bit class */
 885         isc_buffer_putuint16(buffer, rdataset->type); /* 16-bit type */
 886         isc_buffer_putuint16(buffer, rdataset->covers); /* same as type */
 887         isc_buffer_putuint32(buffer, rdataset->ttl); /* 32-bit TTL */
 888         isc_buffer_putuint32(buffer, dns_rdataset_count(rdataset));
 889         totallen = isc_buffer_usedlength(buffer);
 890         INSIST(totallen <= sizeof(dns_masterrawrdataset_t));
 891
 892         dns_name_toregion(name, &r);
 893         INSIST(isc_buffer_availablelength(buffer) >=
 894                (sizeof(dlen) + r.length));
 895         dlen = (isc_uint16_t)r.length;
 896         isc_buffer_putuint16(buffer, dlen);
 897         isc_buffer_copyregion(buffer, &r);
 898         totallen += sizeof(dlen) + r.length;
 899
 900         do {
 901                 dns_rdata_t rdata = DNS_RDATA_INIT;
 902                 isc_region_t r;
 903
 904                 dns_rdataset_current(rdataset, &rdata);
 905                 dns_rdata_toregion(&rdata, &r);
 906                 INSIST(r.length <= 0xffffU);
 907                 dlen = (isc_uint16_t)r.length;
 908
 909                 /*
 910                  * Copy the rdata into the buffer.  If the buffer is too small,
 911                  * grow it.  This should be rare, so we'll simply restart the
 912                  * entire procedure (or should we copy the old data and
 913                  * continue?).
 914                  */
 915                 if (isc_buffer_availablelength(buffer) <
 916                                                  sizeof(dlen) + r.length) {
 917                         int newlength;
 918                         void *newmem;
 919
 920                         newlength = buffer->length * 2;
 921                         newmem = isc_mem_get(mctx, newlength);
 922                         if (newmem == NULL)
 923                                 return (ISC_R_NOMEMORY);
 924                         isc_mem_put(mctx, buffer->base, buffer->length);
 925                         isc_buffer_init(buffer, newmem, newlength);
 926                         goto restart;
 927                 }
 928                 isc_buffer_putuint16(buffer, dlen);
 929                 isc_buffer_copyregion(buffer, &r);
 930                 totallen += sizeof(dlen) + r.length;
 931
 932                 result = dns_rdataset_next(rdataset);
 933         } while (result == ISC_R_SUCCESS);
 934
 935         if (result != ISC_R_NOMORE)
 936                 return (result);
 937
 938         /*
 939          * Fill in the total length field.
 940          * XXX: this is a bit tricky.  Since we have already "used" the space
 941          * for the total length in the buffer, we first remember the entire
 942          * buffer length in the region, "rewind", and then write the value.
 943          */
 944         isc_buffer_usedregion(buffer, &r);
 945         isc_buffer_clear(buffer);
 946         isc_buffer_putuint32(buffer, totallen);
 947         INSIST(isc_buffer_usedlength(buffer) < totallen);
 948
 949         /*
 950          * Write the buffer contents to the raw master file.
 951          */
 952         result = isc_stdio_write(r.base, 1, (size_t)r.length, f, NULL);
 953
 954         if (result != ISC_R_SUCCESS) {
 955                 UNEXPECTED_ERROR(__FILE__, __LINE__,
 956                                  "raw master file write failed: %s",
 957                                  isc_result_totext(result));
 958                 return (result);
 959         }
 960
 961         return (result);
 962 }
 963
 964 static isc_result_t
 965 dump_rdatasets_raw(isc_mem_t *mctx, dns_name_t *name,
 966                    dns_rdatasetiter_t *rdsiter, dns_totext_ctx_t *ctx,
 967                    isc_buffer_t *buffer, FILE *f)
 968 {
 969         isc_result_t result;
 970         dns_rdataset_t rdataset;
 971
 972         for (result = dns_rdatasetiter_first(rdsiter);
 973              result == ISC_R_SUCCESS;
 974              result = dns_rdatasetiter_next(rdsiter)) {
 975
 976                 dns_rdataset_init(&rdataset);
 977                 dns_rdatasetiter_current(rdsiter, &rdataset);
 978
 979                 if (((rdataset.attributes & DNS_RDATASETATTR_NEGATIVE) != 0) &&
 980                     (ctx->style.flags & DNS_STYLEFLAG_NCACHE) == 0) {
 981                         /* Omit negative cache entries */
 982                 } else {
 983                         result = dump_rdataset_raw(mctx, name, &rdataset,
 984                                                    buffer, f);
 985                 }
 986                 dns_rdataset_disassociate(&rdataset);
 987                 if (result != ISC_R_SUCCESS)
 988                         return (result);
 989         }
 990
 991         if (result == ISC_R_NOMORE)
 992                 result = ISC_R_SUCCESS;
 993
 994         return (result);
 995 }
 996
 997 /*
 998  * Initial size of text conversion buffer.  The buffer is used
 999  * for several purposes: converting origin names, rdatasets,
1000  * $DATE timestamps, and comment strings for $TTL directives.
1001  *
1002  * When converting rdatasets, it is dynamically resized, but
1003  * when converting origins, timestamps, etc it is not.  Therefore,
1004  * the initial size must large enough to hold the longest possible
1005  * text representation of any domain name (for $ORIGIN).
1006  */
1007 static const int initial_buffer_length = 1200;
1008
1009 static isc_result_t
1010 dumptostreaminc(dns_dumpctx_t *dctx);
1011
1012 static void
1013 dumpctx_destroy(dns_dumpctx_t *dctx) {
1014
1015         dctx->magic = 0;
1016         DESTROYLOCK(&dctx->lock);
1017         dns_dbiterator_destroy(&dctx->dbiter);
1018         if (dctx->version != NULL)
1019                 dns_db_closeversion(dctx->db, &dctx->version, ISC_FALSE);
1020         dns_db_detach(&dctx->db);
1021         if (dctx->task != NULL)
1022                 isc_task_detach(&dctx->task);
1023         if (dctx->file != NULL)
1024                 isc_mem_free(dctx->mctx, dctx->file);
1025         if (dctx->tmpfile != NULL)
1026                 isc_mem_free(dctx->mctx, dctx->tmpfile);
1027         isc_mem_putanddetach(&dctx->mctx, dctx, sizeof(*dctx));
1028 }
1029
1030 void
1031 dns_dumpctx_attach(dns_dumpctx_t *source, dns_dumpctx_t **target) {
1032
1033         REQUIRE(DNS_DCTX_VALID(source));
1034         REQUIRE(target != NULL && *target == NULL);
1035
1036         LOCK(&source->lock);
1037         INSIST(source->references > 0);
1038         source->references++;
1039         INSIST(source->references != 0);        /* Overflow? */
1040         UNLOCK(&source->lock);
1041
1042         *target = source;
1043 }
1044
1045 void
1046 dns_dumpctx_detach(dns_dumpctx_t **dctxp) {
1047         dns_dumpctx_t *dctx;
1048         isc_boolean_t need_destroy = ISC_FALSE;
1049
1050         REQUIRE(dctxp != NULL);
1051         dctx = *dctxp;
1052         REQUIRE(DNS_DCTX_VALID(dctx));
1053
1054         *dctxp = NULL;
1055
1056         LOCK(&dctx->lock);
1057         INSIST(dctx->references != 0);
1058         dctx->references--;
1059         if (dctx->references == 0)
1060                 need_destroy = ISC_TRUE;
1061         UNLOCK(&dctx->lock);
1062         if (need_destroy)
1063                 dumpctx_destroy(dctx);
1064 }
1065
1066 dns_dbversion_t *
1067 dns_dumpctx_version(dns_dumpctx_t *dctx) {
1068         REQUIRE(DNS_DCTX_VALID(dctx));
1069         return (dctx->version);
1070 }
1071
1072 dns_db_t *
1073 dns_dumpctx_db(dns_dumpctx_t *dctx) {
1074         REQUIRE(DNS_DCTX_VALID(dctx));
1075         return (dctx->db);
1076 }
1077
1078 void
1079 dns_dumpctx_cancel(dns_dumpctx_t *dctx) {
1080         REQUIRE(DNS_DCTX_VALID(dctx));
1081
1082         LOCK(&dctx->lock);
1083         dctx->canceled = ISC_TRUE;
1084         UNLOCK(&dctx->lock);
1085 }
1086
1087 static isc_result_t
1088 closeandrename(FILE *f, isc_result_t result, const char *temp, const char *file)
1089 {
1090         isc_result_t tresult;
1091         isc_boolean_t logit = ISC_TF(result == ISC_R_SUCCESS);
1092
1093         if (result == ISC_R_SUCCESS)
1094                 result = isc_stdio_sync(f);
1095         if (result != ISC_R_SUCCESS && logit) {
1096                 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL,
1097                               DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR,
1098                               "dumping master file: %s: fsync: %s",
1099                               temp, isc_result_totext(result));
1100                 logit = ISC_FALSE;
1101         }
1102         tresult = isc_stdio_close(f);
1103         if (result == ISC_R_SUCCESS)
1104                 result = tresult;
1105         if (result != ISC_R_SUCCESS && logit) {
1106                 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL,
1107                               DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR,
1108                               "dumping master file: %s: fclose: %s",
1109                               temp, isc_result_totext(result));
1110                 logit = ISC_FALSE;
1111         }
1112         if (result == ISC_R_SUCCESS)
1113                 result = isc_file_rename(temp, file);
1114         else
1115                 (void)isc_file_remove(temp);
1116         if (result != ISC_R_SUCCESS && logit) {
1117                 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL,
1118                               DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR,
1119                               "dumping master file: rename: %s: %s",
1120                               file, isc_result_totext(result));
1121         }
1122         return (result);
1123 }
1124
1125 static void
1126 dump_quantum(isc_task_t *task, isc_event_t *event) {
1127         isc_result_t result;
1128         isc_result_t tresult;
1129         dns_dumpctx_t *dctx;
1130
1131         REQUIRE(event != NULL);
1132         dctx = event->ev_arg;
1133         REQUIRE(DNS_DCTX_VALID(dctx));
1134         if (dctx->canceled)
1135                 result = ISC_R_CANCELED;
1136         else
1137                 result = dumptostreaminc(dctx);
1138         if (result == DNS_R_CONTINUE) {
1139                 event->ev_arg = dctx;
1140                 isc_task_send(task, &event);
1141                 return;
1142         }
1143
1144         if (dctx->file != NULL) {
1145                 tresult = closeandrename(dctx->f, result,
1146                                          dctx->tmpfile, dctx->file);
1147                 if (tresult != ISC_R_SUCCESS && result == ISC_R_SUCCESS)
1148                         result = tresult;
1149         }
1150         (dctx->done)(dctx->done_arg, result);
1151         isc_event_free(&event);
1152         dns_dumpctx_detach(&dctx);
1153 }
1154
1155 static isc_result_t
1156 task_send(dns_dumpctx_t *dctx) {
1157         isc_event_t *event;
1158
1159         event = isc_event_allocate(dctx->mctx, NULL, DNS_EVENT_DUMPQUANTUM,
1160                                    dump_quantum, dctx, sizeof(*event));
1161         if (event == NULL)
1162                 return (ISC_R_NOMEMORY);
1163         isc_task_send(dctx->task, &event);
1164         return (ISC_R_SUCCESS);
1165 }
1166
1167 static isc_result_t
1168 dumpctx_create(isc_mem_t *mctx, dns_db_t *db, dns_dbversion_t *version,
1169                const dns_master_style_t *style, FILE *f, dns_dumpctx_t **dctxp,
1170                dns_masterformat_t format)
1171 {
1172         dns_dumpctx_t *dctx;
1173         isc_result_t result;
1174         unsigned int options;
1175
1176         dctx = isc_mem_get(mctx, sizeof(*dctx));
1177         if (dctx == NULL)
1178                 return (ISC_R_NOMEMORY);
1179
1180         dctx->mctx = NULL;
1181         dctx->f = f;
1182         dctx->dbiter = NULL;
1183         dctx->db = NULL;
1184         dctx->version = NULL;
1185         dctx->done = NULL;
1186         dctx->done_arg = NULL;
1187         dctx->task = NULL;
1188         dctx->nodes = 0;
1189         dctx->first = ISC_TRUE;
1190         dctx->canceled = ISC_FALSE;
1191         dctx->file = NULL;
1192         dctx->tmpfile = NULL;
1193         dctx->format = format;
1194
1195         switch (format) {
1196         case dns_masterformat_text:
1197                 dctx->dumpsets = dump_rdatasets_text;
1198                 break;
1199         case dns_masterformat_raw:
1200                 dctx->dumpsets = dump_rdatasets_raw;
1201                 break;
1202         default:
1203                 INSIST(0);
1204                 break;
1205         }
1206
1207         result = totext_ctx_init(style, &dctx->tctx);
1208         if (result != ISC_R_SUCCESS) {
1209                 UNEXPECTED_ERROR(__FILE__, __LINE__,
1210                                  "could not set master file style");
1211                 goto cleanup;
1212         }
1213
1214         isc_stdtime_get(&dctx->now);
1215         dns_db_attach(db, &dctx->db);
1216
1217         dctx->do_date = dns_db_iscache(dctx->db);
1218
1219         if (dctx->format == dns_masterformat_text &&
1220             (dctx->tctx.style.flags & DNS_STYLEFLAG_REL_OWNER) != 0) {
1221                 options = DNS_DB_RELATIVENAMES;
1222         } else
1223                 options = 0;
1224         result = dns_db_createiterator(dctx->db, options, &dctx->dbiter);
1225         if (result != ISC_R_SUCCESS)
1226                 goto cleanup;
1227
1228         result = isc_mutex_init(&dctx->lock);
1229         if (result != ISC_R_SUCCESS)
1230                 goto cleanup;
1231         if (version != NULL)
1232                 dns_db_attachversion(dctx->db, version, &dctx->version);
1233         else if (!dns_db_iscache(db))
1234                 dns_db_currentversion(dctx->db, &dctx->version);
1235         isc_mem_attach(mctx, &dctx->mctx);
1236         dctx->references = 1;
1237         dctx->magic = DNS_DCTX_MAGIC;
1238         *dctxp = dctx;
1239         return (ISC_R_SUCCESS);
1240
1241  cleanup:
1242         if (dctx->dbiter != NULL)
1243                 dns_dbiterator_destroy(&dctx->dbiter);
1244         if (dctx->db != NULL)
1245                 dns_db_detach(&dctx->db);
1246         if (dctx != NULL)
1247                 isc_mem_put(mctx, dctx, sizeof(*dctx));
1248         return (result);
1249 }
1250
1251 static isc_result_t
1252 dumptostreaminc(dns_dumpctx_t *dctx) {
1253         isc_result_t result;
1254         isc_buffer_t buffer;
1255         char *bufmem;
1256         isc_region_t r;
1257         dns_name_t *name;
1258         dns_fixedname_t fixname;
1259         unsigned int nodes;
1260         dns_masterrawheader_t rawheader;
1261         isc_uint32_t now32;
1262         isc_time_t start;
1263
1264         bufmem = isc_mem_get(dctx->mctx, initial_buffer_length);
1265         if (bufmem == NULL)
1266                 return (ISC_R_NOMEMORY);
1267
1268         isc_buffer_init(&buffer, bufmem, initial_buffer_length);
1269
1270         dns_fixedname_init(&fixname);
1271         name = dns_fixedname_name(&fixname);
1272
1273         if (dctx->first) {
1274                 switch (dctx->format) {
1275                 case dns_masterformat_text:
1276                         /*
1277                          * If the database has cache semantics, output an
1278                          * RFC2540 $DATE directive so that the TTLs can be
1279                          * adjusted when it is reloaded.  For zones it is not
1280                          * really needed, and it would make the file
1281                          * incompatible with pre-RFC2540 software, so we omit
1282                          * it in the zone case.
1283                          */
1284                         if (dctx->do_date) {
1285                                 result = dns_time32_totext(dctx->now, &buffer);
1286                                 RUNTIME_CHECK(result == ISC_R_SUCCESS);
1287                                 isc_buffer_usedregion(&buffer, &r);
1288                                 fprintf(dctx->f, "$DATE %.*s\n",
1289                                         (int) r.length, (char *) r.base);
1290                         }
1291                         break;
1292                 case dns_masterformat_raw:
1293                         r.base = (unsigned char *)&rawheader;
1294                         r.length = sizeof(rawheader);
1295                         isc_buffer_region(&buffer, &r);
1296                         isc_buffer_putuint32(&buffer, dns_masterformat_raw);
1297                         isc_buffer_putuint32(&buffer, DNS_RAWFORMAT_VERSION);
1298 #if !defined(STDTIME_ON_32BITS) || (STDTIME_ON_32BITS + 0) != 1
1299                         /*
1300                          * We assume isc_stdtime_t is a 32-bit integer,
1301                          * which should be the case on most cases.
1302                          * If it turns out to be uncommon, we'll need
1303                          * to bump the version number and revise the
1304                          * header format.
1305                          */
1306                         isc_log_write(dns_lctx,
1307                                       ISC_LOGCATEGORY_GENERAL,
1308                                       DNS_LOGMODULE_MASTERDUMP,
1309                                       ISC_LOG_INFO,
1310                                       "dumping master file in raw "
1311                                       "format: stdtime is not 32bits");
1312                         now32 = 0;
1313 #else
1314                         now32 = dctx->now;
1315 #endif
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
1419 isc_result_t
1420 dns_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  */
1456 isc_result_t
1457 dns_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
1466 isc_result_t
1467 dns_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
1485 static isc_result_t
1486 opentmp(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
1513 cleanup:
1514         isc_mem_free(mctx, tempname);
1515         return (result);
1516 }
1517
1518 isc_result_t
1519 dns_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
1529 isc_result_t
1530 dns_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
1581 isc_result_t
1582 dns_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
1589 isc_result_t
1590 dns_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  */
1622 isc_result_t
1623 dns_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
1666 isc_result_t
1667 dns_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         if (result != ISC_R_SUCCESS) {
1686                 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL,
1687                               DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR,
1688                               "dumping master file: %s: dump: %s", filename,
1689                               isc_result_totext(result));
1690                 (void)isc_stdio_close(f);
1691                 return (ISC_R_UNEXPECTED);
1692         }
1693
1694         result = isc_stdio_close(f);
1695         if (result != ISC_R_SUCCESS) {
1696                 isc_log_write(dns_lctx, ISC_LOGCATEGORY_GENERAL,
1697                               DNS_LOGMODULE_MASTERDUMP, ISC_LOG_ERROR,
1698                               "dumping master file: %s: close: %s", filename,
1699                               isc_result_totext(result));
1700                 return (ISC_R_UNEXPECTED);
1701         }
1702
1703         return (result);
1704 }
1705
1706 isc_result_t
1707 dns_master_stylecreate(dns_master_style_t **stylep, unsigned int flags,
1708                        unsigned int ttl_column, unsigned int class_column,
1709                        unsigned int type_column, unsigned int rdata_column,
1710                        unsigned int line_length, unsigned int tab_width,
1711                        isc_mem_t *mctx)
1712 {
1713         dns_master_style_t *style;
1714
1715         REQUIRE(stylep != NULL && *stylep == NULL);
1716         style = isc_mem_get(mctx, sizeof(*style));
1717         if (style == NULL)
1718                 return (ISC_R_NOMEMORY);
1719
1720         style->flags = flags;
1721         style->ttl_column = ttl_column;
1722         style->class_column = class_column;
1723         style->type_column = type_column;
1724         style->rdata_column = rdata_column;
1725         style->line_length = line_length;
1726         style->tab_width = tab_width;
1727
1728         *stylep = style;
1729         return (ISC_R_SUCCESS);
1730 }
1731
1732 void
1733 dns_master_styledestroy(dns_master_style_t **stylep, isc_mem_t *mctx) {
1734         dns_master_style_t *style;
1735
1736         REQUIRE(stylep != NULL && *stylep != NULL);
1737         style = *stylep;
1738         *stylep = NULL;
1739         isc_mem_put(mctx, style, sizeof(*style));
1740 }