mksum.c

Go to the documentation of this file.

/*= -*- c-basic-offset: 4; indent-tabs-mode: nil; -*-
 *
 * librsync -- library for network deltas
 *
 * Copyright 1999-2001, 2014, 2015 by Martin Pool <mbp@sourcefrog.net>
 * Copyright (C) 1999 by Andrew Tridgell <tridge@samba.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
/** \file mksum.c
 * Generate file signatures.
 *
 * Generating checksums is pretty easy, since we can always just process
 * whatever data is available. When a whole block has arrived, or we've reached
 * the end of the file, we write the checksum out. */
 
#include "config.h"             /* IWYU pragma: keep */
#include <stdlib.h>
#include "librsync.h"
#include "job.h"
#include "sumset.h"
#include "scoop.h"
#include "netint.h"
#include "trace.h"
#include "util.h"
 
/* Possible state functions for signature generation. */
static rs_result rs_sig_s_header(rs_job_t *);
static rs_result rs_sig_s_generate(rs_job_t *);
 
/** State of trying to send the signature header. \private */
static rs_result rs_sig_s_header(rs_job_t *job)
{
    rs_signature_t *sig = job->signature;
    rs_result result;
 
    if ((result =
         rs_signature_init(sig, job->sig_magic, job->sig_block_len,
                           job->sig_strong_len, 0)) != RS_DONE)
        return result;
    rs_squirt_n4(job, sig->magic);
    rs_squirt_n4(job, sig->block_len);
    rs_squirt_n4(job, sig->strong_sum_len);
    rs_trace("sent header (magic %#x, block len = %d, strong sum len = %d)",
             sig->magic, sig->block_len, sig->strong_sum_len);
    job->stats.block_len = sig->block_len;
 
    job->statefn = rs_sig_s_generate;
    return RS_RUNNING;
}
 
/** Generate the checksums for a block and write it out. Called when we
 * already know we have enough data in memory at \p block. \private */
static rs_result rs_sig_do_block(rs_job_t *job, const void *block, size_t len)
{
    rs_signature_t *sig = job->signature;
    rs_weak_sum_t weak_sum;
    rs_strong_sum_t strong_sum;
 
    weak_sum = rs_signature_calc_weak_sum(sig, block, len);
    rs_signature_calc_strong_sum(sig, block, len, &strong_sum);
    rs_squirt_n4(job, weak_sum);
    rs_tube_write(job, strong_sum, sig->strong_sum_len);
    if (rs_trace_enabled()) {
        char strong_sum_hex[RS_MAX_STRONG_SUM_LENGTH * 2 + 1];
        rs_hexify(strong_sum_hex, strong_sum, sig->strong_sum_len);
        rs_trace("sent block: weak=" FMT_WEAKSUM ", strong=%s", weak_sum,
                 strong_sum_hex);
    }
    job->stats.sig_blocks++;
    return RS_RUNNING;
}
 
/** State of reading a block and trying to generate its sum. \private */
static rs_result rs_sig_s_generate(rs_job_t *job)
{
    rs_result result;
    size_t len;
    void *block;
 
    /* must get a whole block, otherwise try again */
    len = job->signature->block_len;
    result = rs_scoop_read(job, len, &block);
    /* If we are near EOF, get whatever is left. */
    if (result == RS_INPUT_ENDED)
        result = rs_scoop_read_rest(job, &len, &block);
    if (result == RS_INPUT_ENDED) {
        return RS_DONE;
    } else if (result != RS_DONE) {
        rs_trace("generate stopped: %s", rs_strerror(result));
        return result;
    }
    rs_trace("got " FMT_SIZE " byte block", len);
    return rs_sig_do_block(job, block, len);
}
 
rs_job_t *rs_sig_begin(size_t block_len, size_t strong_len,
                       rs_magic_number sig_magic)
{
    rs_job_t *job;
 
    job = rs_job_new("signature", rs_sig_s_header);
    job->signature = rs_alloc_struct(rs_signature_t);
    job->job_owns_sig = 1;
    job->sig_magic = sig_magic;
    job->sig_block_len = (int)block_len;
    job->sig_strong_len = (int)strong_len;
    return job;
}