From 88032efa98571b31058fb269d1979b84c59e3503 Mon Sep 17 00:00:00 2001 From: Kern Sibbald Date: Fri, 26 Feb 2010 11:59:00 +0100 Subject: [PATCH] Tweak comments --- bacula/src/filed/backup.c | 39 ++++++++++--------- bacula/src/filed/job.c | 80 +++++++++++++++++++-------------------- 2 files changed, 59 insertions(+), 60 deletions(-) diff --git a/bacula/src/filed/backup.c b/bacula/src/filed/backup.c index d9753d00c8..c033342b8f 100644 --- a/bacula/src/filed/backup.c +++ b/bacula/src/filed/backup.c @@ -1,7 +1,7 @@ /* Bacula® - The Network Backup Solution - Copyright (C) 2000-2009 Free Software Foundation Europe e.V. + Copyright (C) 2000-2010 Free Software Foundation Europe e.V. The main author of Bacula is Kern Sibbald, with contributions from many others, a complete list can be found in the file AUTHORS. @@ -31,8 +31,6 @@ * * Kern Sibbald, March MM * - * Version $Id$ - * */ #include "bacula.h" @@ -64,7 +62,7 @@ static bool crypto_session_start(JCR *jcr); static void crypto_session_end(JCR *jcr); static bool crypto_session_send(JCR *jcr, BSOCK *sd); -/* +/** * Find all the requested files and send them * to the Storage daemon. * @@ -104,7 +102,8 @@ bool blast_data_to_storage_daemon(JCR *jcr, char *addr) } jcr->buf_size = sd->msglen; - /* Adjust for compression so that output buffer is + /** + * Adjust for compression so that output buffer is * 12 bytes + 0.1% larger than input buffer plus 18 bytes. * This gives a bit extra plus room for the sparse addr if any. * Note, we adjust the read size to be smaller so that the @@ -216,7 +215,7 @@ static bool crypto_session_start(JCR *jcr) { crypto_cipher_t cipher = CRYPTO_CIPHER_AES_128_CBC; - /* + /** * Create encryption session data and a cached, DER-encoded session data * structure. We use a single session key for each backup, so we'll encode * the session data only once. @@ -287,7 +286,7 @@ static bool crypto_session_send(JCR *jcr, BSOCK *sd) } -/* +/** * Called here by find() for each file included. * This is a callback. The original is find_files() above. * @@ -425,7 +424,7 @@ int save_file(JCR *jcr, FF_PKT *ff_pkt, bool top_level) /* Digests and encryption are only useful if there's file data */ if (has_file_data) { - /* + /** * Setup for digest handling. If this fails, the digest will be set to NULL * and not used. Note, the digest (file hash) can be any one of the four * algorithms below. @@ -459,7 +458,7 @@ int save_file(JCR *jcr, FF_PKT *ff_pkt, bool top_level) stream_to_ascii(digest_stream)); } - /* + /** * Set up signature digest handling. If this fails, the signature digest * will be set to NULL and not used. */ @@ -750,7 +749,7 @@ bail_out: return rtnstat; } -/* +/** * Send data read from an already open file descriptor. * * We return 1 on sucess and 0 on errors. @@ -802,7 +801,7 @@ static int send_data(JCR *jcr, int stream, FF_PKT *ff_pkt, DIGEST *digest, wbuf = jcr->compress_buf; /* compressed output here */ cipher_input = (uint8_t *)jcr->compress_buf; /* encrypt compressed data */ - /* + /** * Only change zlib parameters if there is no pending operation. * This should never happen as deflatereset is called after each * deflate. @@ -835,7 +834,7 @@ static int send_data(JCR *jcr, int stream, FF_PKT *ff_pkt, DIGEST *digest, goto err; } - /* + /** * Grow the crypto buffer, if necessary. * crypto_cipher_update() will buffer up to (cipher_block_size - 1). * We grow crypto_buf to the maximum number of blocks that @@ -849,7 +848,7 @@ static int send_data(JCR *jcr, int stream, FF_PKT *ff_pkt, DIGEST *digest, wbuf = jcr->crypto.crypto_buf; /* Encrypted, possibly compressed output here. */ } - /* + /** * Send Data header to Storage daemon * */ @@ -862,7 +861,7 @@ static int send_data(JCR *jcr, int stream, FF_PKT *ff_pkt, DIGEST *digest, } Dmsg1(300, ">stored: datahdr %s\n", sd->msg); - /* + /** * Make space at beginning of buffer for fileAddr because this * same buffer will be used for writing if compression is off. */ @@ -884,7 +883,7 @@ static int send_data(JCR *jcr, int stream, FF_PKT *ff_pkt, DIGEST *digest, rsize = (rsize/512) * 512; #endif - /* + /** * Read the file data */ while ((sd->msglen=(uint32_t)bread(&ff_pkt->bfd, rbuf, rsize)) > 0) { @@ -956,7 +955,7 @@ static int send_data(JCR *jcr, int stream, FF_PKT *ff_pkt, DIGEST *digest, cipher_input_len = compress_len; } #endif - /* + /** * Note, here we prepend the current record length to the beginning * of the encrypted data. This is because both sparse and compression * restore handling want records returned to them with exactly the @@ -1176,7 +1175,7 @@ bool encode_and_send_attributes(JCR *jcr, FF_PKT *ff_pkt, int &data_stream) return true; } -/* +/** * Do in place strip of path */ static bool do_strip(int count, char *in) @@ -1213,7 +1212,7 @@ static bool do_strip(int count, char *in) return stripped==count && numsep>count; } -/* +/** * If requested strip leading components of the path so that we can * save file as if it came from a subdirectory. This is most useful * for dealing with snapshots, by removing the snapshot directory, or @@ -1238,7 +1237,7 @@ void strip_path(FF_PKT *ff_pkt) sm_check(__FILE__, __LINE__, true); } - /* + /** * Strip path. If it doesn't succeed put it back. If * it does, and there is a different link string, * attempt to strip the link. If it fails, back them @@ -1250,7 +1249,7 @@ void strip_path(FF_PKT *ff_pkt) unstrip_path(ff_pkt); goto rtn; } - /* Strip links but not symlinks */ + /** Strip links but not symlinks */ if (ff_pkt->type != FT_LNK && ff_pkt->fname != ff_pkt->link) { if (!do_strip(ff_pkt->strip_path, ff_pkt->link)) { unstrip_path(ff_pkt); diff --git a/bacula/src/filed/job.c b/bacula/src/filed/job.c index 3e193dea86..cf42130fa5 100644 --- a/bacula/src/filed/job.c +++ b/bacula/src/filed/job.c @@ -1,7 +1,7 @@ /* Bacula® - The Network Backup Solution - Copyright (C) 2000-2009 Free Software Foundation Europe e.V. + Copyright (C) 2000-2010 Free Software Foundation Europe e.V. The main author of Bacula is Kern Sibbald, with contributions from many others, a complete list can be found in the file AUTHORS. @@ -30,8 +30,6 @@ * * Kern Sibbald, October MM * - * Version $Id$ - * */ #include "bacula.h" @@ -44,7 +42,7 @@ static pthread_mutex_t vss_mutex = PTHREAD_MUTEX_INITIALIZER; static int enable_vss = 0; #endif -/* +/** * As Windows saves ACLs as part of the standard backup stream * we just pretend here that is has implicit acl support. */ @@ -101,7 +99,7 @@ struct s_cmds { int monitoraccess; /* specify if monitors have access to this function */ }; -/* +/** * The following are the recognized commands from the Director. */ static struct s_cmds cmds[] = { @@ -187,7 +185,7 @@ static char read_open[] = "read open session = %s %ld %ld %ld %ld %ld %ld\n"; static char read_data[] = "read data %d\n"; static char read_close[] = "read close session %d\n"; -/* +/** * Accept requests from a Director * * NOTE! We are running as a separate thread @@ -393,7 +391,7 @@ void *handle_client_request(void *dirp) return NULL; } -/* +/** * Hello from Director he must identify himself and provide his * password. */ @@ -408,7 +406,7 @@ static int hello_cmd(JCR *jcr) return 1; } -/* +/** * Cancel a Job */ static int cancel_cmd(JCR *jcr) @@ -439,7 +437,7 @@ static int cancel_cmd(JCR *jcr) } -/* +/** * Set debug level as requested by the Director * */ @@ -478,7 +476,7 @@ static int estimate_cmd(JCR *jcr) return 1; } -/* +/** * Get JobId and Storage Daemon Authorization key from Director */ static int job_cmd(JCR *jcr) @@ -664,7 +662,7 @@ static findFOPTS *start_options(FF_PKT *ff) } -/* +/** * Add fname to include/exclude fileset list. First check for * | and < and if necessary perform command. */ @@ -774,7 +772,7 @@ static void add_fileset(JCR *jcr, const char *item) return; } - /* + /** * The switch tests the code for validity. * The subcode is always good if it is a space, otherwise we must confirm. * We set state to state_error first assuming the subcode is invalid, @@ -1008,7 +1006,7 @@ static bool term_fileset(JCR *jcr) } -/* +/** * As an optimization, we should do this during * "compile" time in filed/job.c, and keep only a bit mask * and the Verify options. @@ -1172,7 +1170,7 @@ static void set_options(findFOPTS *fo, const char *opts) } -/* +/** * Director is passing his Fileset */ static int fileset_cmd(JCR *jcr) @@ -1213,9 +1211,11 @@ static void free_bootstrap(JCR *jcr) static pthread_mutex_t bsr_mutex = PTHREAD_MUTEX_INITIALIZER; static uint32_t bsr_uniq = 0; -/* +/** * The Director sends us the bootstrap file, which * we will in turn pass to the SD. + * Deprecated. The bsr is now sent directly from the + * Director to the SD. */ static int bootstrap_cmd(JCR *jcr) { @@ -1260,7 +1260,7 @@ static int bootstrap_cmd(JCR *jcr) } -/* +/** * Get backup level from Director * */ @@ -1378,8 +1378,9 @@ bail_out: return 0; } -/* +/** * Get session parameters from Director -- this is for a Restore command + * This is deprecated. It is now passed via the bsr. */ static int session_cmd(JCR *jcr) { @@ -1413,7 +1414,8 @@ static void set_storage_auth_key(JCR *jcr, char *key) jcr->store_bsock = NULL; } - /* We can be contacting multiple storage daemons. + /** + * We can be contacting multiple storage daemons. * So, make sure that any old jcr->sd_auth_key is cleaned up. */ if (jcr->sd_auth_key) { @@ -1428,7 +1430,7 @@ static void set_storage_auth_key(JCR *jcr, char *key) jcr->sd_auth_key = bstrdup(key); } -/* +/** * Get address of storage daemon from Director * */ @@ -1444,11 +1446,9 @@ static int storage_cmd(JCR *jcr) Dmsg1(100, "StorageCmd: %s", dir->msg); sd_auth_key.check_size(dir->msglen); if (sscanf(dir->msg, storaddr, &jcr->stored_addr, &stored_port, - &enable_ssl, sd_auth_key.c_str()) != 4) - { + &enable_ssl, sd_auth_key.c_str()) != 4) { if (sscanf(dir->msg, storaddr_v1, &jcr->stored_addr, - &stored_port, &enable_ssl) != 3) - { + &stored_port, &enable_ssl) != 3) { pm_strcpy(jcr->errmsg, dir->msg); Jmsg(jcr, M_FATAL, 0, _("Bad storage command: %s"), jcr->errmsg); goto bail_out; @@ -1497,7 +1497,7 @@ bail_out: } -/* +/** * Do a backup. */ static int backup_cmd(JCR *jcr) @@ -1518,7 +1518,7 @@ static int backup_cmd(JCR *jcr) } #endif - /* + /** * Validate some options given to the backup make sense for the compiled in * options of this filed. */ @@ -1544,12 +1544,12 @@ static int backup_cmd(JCR *jcr) dir->fsend(OKbackup); Dmsg1(110, "filed>dird: %s", dir->msg); - /* + /** * Send Append Open Session to Storage daemon */ sd->fsend(append_open); Dmsg1(110, ">stored: %s", sd->msg); - /* + /** * Expect to receive back the Ticket number */ if (bget_msg(sd) >= 0) { @@ -1564,13 +1564,13 @@ static int backup_cmd(JCR *jcr) goto cleanup; } - /* + /** * Send Append data command to Storage daemon */ sd->fsend(append_data, jcr->Ticket); Dmsg1(110, ">stored: %s", sd->msg); - /* + /** * Expect to get OK data */ Dmsg1(110, "msg); @@ -1619,7 +1619,7 @@ static int backup_cmd(JCR *jcr) } #endif - /* + /** * Send Files to Storage daemon */ Dmsg1(110, "begin blast ff=%p\n", (FF_PKT *)jcr->ff); @@ -1635,7 +1635,7 @@ static int backup_cmd(JCR *jcr) bnet_suppress_error_messages(sd, 1); goto cleanup; /* bail out now */ } - /* + /** * Expect to get response to append_data from Storage daemon */ if (!response(jcr, sd, OK_append, "Append Data")) { @@ -1643,7 +1643,7 @@ static int backup_cmd(JCR *jcr) goto cleanup; } - /* + /** * Send Append End Data to Storage daemon */ sd->fsend(append_end, jcr->Ticket); @@ -1653,7 +1653,7 @@ static int backup_cmd(JCR *jcr) goto cleanup; } - /* + /** * Send Append Close to Storage daemon */ sd->fsend(append_close, jcr->Ticket); @@ -1698,7 +1698,7 @@ cleanup: return 0; /* return and stop command loop */ } -/* +/** * Do a Verify for Director * */ @@ -1775,7 +1775,7 @@ static int verify_cmd(JCR *jcr) return 0; /* return and terminate command loop */ } -/* +/** * Do a Restore for Director * */ @@ -1788,7 +1788,7 @@ static int restore_cmd(JCR *jcr) int prefix_links; char replace; - /* + /** * Scan WHERE (base directory for restore) from command */ Dmsg0(150, "restore command\n"); @@ -1844,7 +1844,7 @@ static int restore_cmd(JCR *jcr) set_jcr_job_status(jcr, JS_Running); - /* + /** * Do restore of files and data */ start_dir_heartbeat(jcr); @@ -1858,7 +1858,7 @@ static int restore_cmd(JCR *jcr) bnet_suppress_error_messages(sd, 1); } - /* + /** * Send Close session command to Storage daemon */ sd->fsend(read_close, jcr->Ticket); @@ -1950,7 +1950,7 @@ static int open_sd_read_session(JCR *jcr) return 1; } -/* +/** * Destroy the Job Control Record and associated * resources (sockets). */ @@ -1972,7 +1972,7 @@ static void filed_free_jcr(JCR *jcr) return; } -/* +/** * Get response from Storage daemon to a command we * sent. Check that the response is OK. * -- 2.39.5