Skip to content

Commit

Permalink
Fix output format of bbackupobjdump
Browse files Browse the repository at this point in the history 
Use C++ streams for output everywhere, for consistency and to avoid mismatches
in how output is formatted (some BOX_TRACEd, some not).
  • Loading branch information
@qris
qris committed Jan 30, 2018
1 parent 905f73e commit 38ee18a
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 38 deletions.
7 changes: 4 additions & 3 deletions bin/bbackupobjdump/bbackupobjdump.cpp
View file
Expand Up @@ -11,6 +11,7 @@

#include <cstdio>
#include <cstring>
#include <iostream>

#include "MainHelper.h"
#include "FileStream.h"
Expand Down Expand Up @@ -46,7 +47,7 @@ int main(int argc, const char *argv[])
if(file.Read(&signature, sizeof(signature)) != sizeof(signature))
{
// Too short, can't read signature from it
return false;
return 0;
}
// Seek back to beginning
file.Seek(0, IOStream::SeekType_Absolute);
Expand All @@ -58,14 +59,14 @@ int main(int argc, const char *argv[])
#ifndef BOX_DISABLE_BACKWARDS_COMPATIBILITY_BACKUPSTOREFILE
case OBJECTMAGIC_FILE_MAGIC_VALUE_V0:
#endif
BackupStoreFile::DumpFile(stdout, false, file);
BackupStoreFile::DumpFile(std::cout, false, file);
break;

case OBJECTMAGIC_DIR_MAGIC_VALUE:
{
BackupStoreDirectory dir;
dir.ReadFromStream(file, IOStream::TimeOutInfinite);
dir.Dump(stdout, false);
dir.Dump(std::cout, false);
if(dir.CheckAndFix())
{
::printf("Directory didn't pass checking\n");
Expand Down
2 changes: 1 addition & 1 deletion lib/backupstore/BackupStoreDirectory.h
View file
Expand Up @@ -476,7 +476,7 @@ class BackupStoreDirectory
// Don't use these functions in normal code!
void TESTONLY_SetObjectID(int64_t ObjectID) {mObjectID = ObjectID;}
// Debug and diagnostics
void Dump(void *clibFileHandle, bool ToTrace); // first arg is FILE *, but avoid including stdio.h everywhere
void Dump(std::ostream& Output, bool ToTrace);

private:
int64_t mRevisionID;
Expand Down
2 changes: 1 addition & 1 deletion lib/backupstore/BackupStoreFile.h
View file
Expand Up @@ -317,7 +317,7 @@ class BackupStoreFile
#endif

// For decoding encoded files
static void DumpFile(void *clibFileHandle, bool ToTrace, IOStream &rFile);
static void DumpFile(std::ostream& Output, bool ToTrace, IOStream &rFile);
};

#include "MemLeakFindOff.h"
Expand Down
65 changes: 35 additions & 30 deletions lib/backupstore/BackupStoreObjectDump.cpp
View file
Expand Up @@ -32,7 +32,7 @@
// Created: 3/5/04
//
// --------------------------------------------------------------------------
static void OutputLine(FILE *file, bool ToTrace, const char *format, ...)
static void OutputLine(std::ostream* pOutput, bool ToTrace, const char *format, ...)
{
char text[512];
int r = 0;
Expand All @@ -41,10 +41,11 @@ static void OutputLine(FILE *file, bool ToTrace, const char *format, ...)
r = vsnprintf(text, sizeof(text), format, ap);
va_end(ap);

if(file != 0)
if(pOutput != 0)
{
::fprintf(file, "%s", text);
(*pOutput) << text << "\n";
}

if(ToTrace)
{
BOX_TRACE(text);
Expand All @@ -61,11 +62,9 @@ static void OutputLine(FILE *file, bool ToTrace, const char *format, ...)
// Created: 3/5/04
//
// --------------------------------------------------------------------------
void BackupStoreDirectory::Dump(void *clibFileHandle, bool ToTrace)
void BackupStoreDirectory::Dump(std::ostream& output, bool ToTrace)
{
FILE *file = (FILE*)clibFileHandle;

OutputLine(file, ToTrace, "Directory object.\nObject ID: %llx\nContainer ID: %llx\nNumber entries: %d\n"\
OutputLine(&output, ToTrace, "Directory object.\nObject ID: %llx\nContainer ID: %llx\nNumber entries: %d\n"\
"Attributes mod time: %llx\nAttributes size: %d\n", mObjectID, mContainerID, mEntries.size(),
mAttributesModTime, mAttributes.GetSize());

Expand All @@ -74,7 +73,9 @@ void BackupStoreDirectory::Dump(void *clibFileHandle, bool ToTrace)
int nameNumI = 0;

// Dump items
OutputLine(file, ToTrace, "Items:\nID Size AttrHash AtSz NSz NIdx Flags\n");
OutputLine(&output, ToTrace, "Items:");
OutputLine(&output, ToTrace, "ID Size AttrHash AtSz NSz NIdx Flags");
OutputLine(&output, ToTrace, "====== ==== ================ ==== === ==== =====");
for(std::vector<Entry*>::const_iterator i(mEntries.begin()); i != mEntries.end(); ++i)
{
// Choose file name index number for this file
Expand Down Expand Up @@ -114,11 +115,11 @@ void BackupStoreDirectory::Dump(void *clibFileHandle, bool ToTrace)
// Output item
int16_t f = (*i)->GetFlags();
#ifdef WIN32
OutputLine(file, ToTrace,
"%06I64x %4I64d %016I64x %4d %3d %4d%s%s%s%s%s%s\n",
OutputLine(&output, ToTrace,
"%06I64x %4I64d %016I64x %4d %3d %4d%s%s%s%s%s%s",
#else
OutputLine(file, ToTrace,
"%06llx %4lld %016llx %4d %3d %4d%s%s%s%s%s%s\n",
OutputLine(&output, ToTrace,
"%06llx %4lld %016llx %4d %3d %4d%s%s%s%s%s%s",
#endif
(*i)->GetObjectID(),
(*i)->GetSizeInBlocks(),
Expand All @@ -144,10 +145,8 @@ void BackupStoreDirectory::Dump(void *clibFileHandle, bool ToTrace)
// Created: 4/5/04
//
// --------------------------------------------------------------------------
void BackupStoreFile::DumpFile(void *clibFileHandle, bool ToTrace, IOStream &rFile)
void BackupStoreFile::DumpFile(std::ostream& output, bool ToTrace, IOStream &rFile)
{
FILE *file = (FILE*)clibFileHandle;

// Read header
file_StreamFormat hdr;
if(!rFile.ReadFullBuffer(&hdr, sizeof(hdr),
Expand All @@ -161,24 +160,23 @@ void BackupStoreFile::DumpFile(void *clibFileHandle, bool ToTrace, IOStream &rFi
if(hdr.mMagicValue != (int32_t)htonl(OBJECTMAGIC_FILE_MAGIC_VALUE_V1)
&& hdr.mMagicValue != (int32_t)htonl(OBJECTMAGIC_FILE_MAGIC_VALUE_V0))
{
OutputLine(file, ToTrace, "File header doesn't have the correct magic, aborting dump\n");
OutputLine(&output, ToTrace, "File header doesn't have the correct magic, aborting dump");
return;
}

OutputLine(file, ToTrace, "File object.\nContainer ID: %llx\nModification time: %llx\n"\
"Max block clear size: %d\nOptions: %08x\nNum blocks: %d\n", box_ntoh64(hdr.mContainerID),
OutputLine(&output, ToTrace, "File object.\nContainer ID: %llx\nModification time: %llx\n"\
"Max block clear size: %d\nOptions: %08x\nNum blocks: %d", box_ntoh64(hdr.mContainerID),
box_ntoh64(hdr.mModificationTime), ntohl(hdr.mMaxBlockClearSize), ntohl(hdr.mOptions),
box_ntoh64(hdr.mNumBlocks));

// Read the next two objects
BackupStoreFilename fn;
fn.ReadFromStream(rFile, IOStream::TimeOutInfinite);
OutputLine(file, ToTrace, "Filename size: %d\n",
fn.GetEncodedFilename().size());
OutputLine(&output, ToTrace, "Filename size: %d", fn.GetEncodedFilename().size());

BackupClientFileAttributes attr;
attr.ReadFromStream(rFile, IOStream::TimeOutInfinite);
OutputLine(file, ToTrace, "Attributes size: %d\n", attr.GetSize());
OutputLine(&output, ToTrace, "Attributes size: %d", attr.GetSize());

// Dump the blocks
rFile.Seek(0, IOStream::SeekType_Absolute);
Expand All @@ -190,38 +188,45 @@ void BackupStoreFile::DumpFile(void *clibFileHandle, bool ToTrace, IOStream &rFi
if(bhdr.mMagicValue != (int32_t)htonl(OBJECTMAGIC_FILE_BLOCKS_MAGIC_VALUE_V1)
&& bhdr.mMagicValue != (int32_t)htonl(OBJECTMAGIC_FILE_BLOCKS_MAGIC_VALUE_V0))
{
OutputLine(file, ToTrace, "WARNING: Block header doesn't have the correct magic\n");
OutputLine(&output, ToTrace, "WARNING: Block header doesn't have the correct magic");
}
// number of blocks
int64_t nblocks = box_ntoh64(bhdr.mNumBlocks);
OutputLine(file, ToTrace, "Other file ID (for block refs): %llx\nNum blocks (in blk hdr): %lld\n",
OutputLine(&output, ToTrace, "Other file ID (for block refs): %llx\nNum blocks (in blk hdr): %lld",
box_ntoh64(bhdr.mOtherFileID), nblocks);

// Dump info about each block
OutputLine(file, ToTrace, "======== ===== ==========\n Index Where EncSz/Idx\n");
OutputLine(&output, ToTrace, "Index Where EncSz/Idx");
OutputLine(&output, ToTrace, "======== ===== ==========");
int64_t nnew = 0, nold = 0;
for(int64_t b = 0; b < nblocks; ++b)
{
file_BlockIndexEntry en;
if(!rFile.ReadFullBuffer(&en, sizeof(en), 0))
{
OutputLine(file, ToTrace, "Didn't manage to read block %lld from file\n", b);
OutputLine(&output, ToTrace, "Didn't manage to read block %lld from file\n", b);
continue;
}
int64_t s = box_ntoh64(en.mEncodedSize);
if(s > 0)
{
nnew++;
BOX_TRACE(std::setw(8) << b << " this s=" <<
std::setw(8) << s);
output << b << " this s=" << std::setw(8) << s;
if(ToTrace)
{
BOX_TRACE(std::setw(8) << b << " this s=" << std::setw(8) << s);
}
}
else
{
nold++;
BOX_TRACE(std::setw(8) << b << " other i=" <<
std::setw(8) << 0 - s);
output << std::setw(8) << b << " other i=" << std::setw(8) << 0 - s;
if(ToTrace)
{
BOX_TRACE(std::setw(8) << b << " other i=" << std::setw(8) << 0 - s);
}
}
}
BOX_TRACE("======== ===== ==========");
OutputLine(&output, ToTrace, "======== ===== ==========");
}

8 changes: 5 additions & 3 deletions test/backupstorepatch/testbackupstorepatch.cpp
View file
Expand Up @@ -13,6 +13,8 @@
#include <string.h>
#include <signal.h>

#include <iostream>

#include "BackupAccountControl.h"
#include "BackupClientCryptoKeys.h"
#include "BackupClientFileAttributes.h"
Expand Down Expand Up @@ -259,7 +261,7 @@ void test_depends_in_dirs()
TEST_THAT(en->GetDependsNewer() == ((i == 3)?4:0));
TEST_THAT(en->GetDependsOlder() == 0);
}
dir2.Dump(0, true);
dir2.Dump(std::cout, true);
// Test that numbers go in and out as required
for(int i = 2; i <= 5; ++i)
{
Expand All @@ -278,7 +280,7 @@ void test_depends_in_dirs()
BackupStoreDirectory dir3;
FileStream in("testfiles/dir.2");
dir3.ReadFromStream(in, SHORT_TIMEOUT);
dir3.Dump(0, true);
dir3.Dump(std::cout, true);
for(int i = 2; i <= 5; ++i)
{
BackupStoreDirectory::Entry *en = dir2.FindEntryByID(i);
Expand Down Expand Up @@ -528,7 +530,7 @@ int test(int argc, const char *argv[])

std::auto_ptr<RaidFileRead> dirStream(RaidFileRead::Open(0, "backup/01234567/o01"));
dir.ReadFromStream(*dirStream, SHORT_TIMEOUT);
dir.Dump(0, true);
dir.Dump(std::cout, true);

// Find the test_files entry for the file that was just deleted:
int just_deleted = deleteIndex == 0 ? -1 : test_file_remove_order[deleteIndex - 1];
Expand Down

0 comments on commit 38ee18a

Please sign in to comment.