Annotation of libaitsync/inc/aitsync.h, revision 1.2

1.1       misho       1: /*************************************************************************
                      2: * (C) 2010 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
                      3: *  by Michael Pounov <misho@openbsd-bg.org>
                      4: *
                      5: * $Author: misho $
1.2     ! misho       6: * $Id: aitsync.h,v 1.1.1.1.2.3 2011/05/09 14:35:55 misho Exp $
1.1       misho       7: *
1.2     ! misho       8: **************************************************************************
        !             9: The ELWIX and AITNET software is distributed under the following
        !            10: terms:
        !            11: 
        !            12: All of the documentation and software included in the ELWIX and AITNET
        !            13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
        !            14: 
        !            15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
        !            16:        by Michael Pounov <misho@elwix.org>.  All rights reserved.
        !            17: 
        !            18: Redistribution and use in source and binary forms, with or without
        !            19: modification, are permitted provided that the following conditions
        !            20: are met:
        !            21: 1. Redistributions of source code must retain the above copyright
        !            22:    notice, this list of conditions and the following disclaimer.
        !            23: 2. Redistributions in binary form must reproduce the above copyright
        !            24:    notice, this list of conditions and the following disclaimer in the
        !            25:    documentation and/or other materials provided with the distribution.
        !            26: 3. All advertising materials mentioning features or use of this software
        !            27:    must display the following acknowledgement:
        !            28: This product includes software developed by Michael Pounov <misho@elwix.org>
        !            29: ELWIX - Embedded LightWeight unIX and its contributors.
        !            30: 4. Neither the name of AITNET nor the names of its contributors
        !            31:    may be used to endorse or promote products derived from this software
        !            32:    without specific prior written permission.
        !            33: 
        !            34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
        !            35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        !            36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
        !            37: ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
        !            38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        !            39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
        !            40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
        !            41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
        !            42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
        !            43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
        !            44: SUCH DAMAGE.
        !            45: */
1.1       misho      46: #ifndef __AITSYNC_H
                     47: #define __AITSYNC_H
                     48: 
                     49: 
                     50: #include <sys/types.h>
                     51: #include <openssl/md5.h>
                     52: 
                     53: 
                     54: #define CHUNK_MAX      2048
                     55: #define DLTSYNC_MAGIC  0xD34DC0D3
                     56: #define SIGSYNC_MAGIC  0xDEADBEEF
                     57: 
1.2     ! misho      58: #ifndef STRSIZ
        !            59: #define STRSIZ         256
        !            60: #endif
        !            61: 
1.1       misho      62: 
                     63: typedef struct tagSyncChunk {
                     64:        u_int sc_magic;
                     65:        u_long sc_id;
                     66:        off_t sc_off;
                     67:        size_t sc_len;
                     68:        u_int sc_roll;
                     69:        u_char sc_cksum[MD5_DIGEST_LENGTH];
                     70: } sync_chunk_t;
                     71: 
                     72: 
1.2     ! misho      73: struct tagDirName {
        !            74:        u_char  ch;
        !            75:        u_short tag;
        !            76:        u_int   hash;
        !            77:        char    name[MAXPATHLEN];
        !            78:        char    extra[STRSIZ];
        !            79: };
        !            80: 
        !            81: 
1.1       misho      82: // -------------------------------------------------------
                     83: // sync_GetErrno() Get error code of last operation
                     84: inline int sync_GetErrno();
                     85: // sync_GetError() Get error text of last operation
                     86: inline const char *sync_GetError();
                     87: // -------------------------------------------------------
                     88: 
                     89: /*
                     90:  * syncSignature() Calculate and create signature for diff
                     91:  * @csInput = Input patched file name for calculating check sums
                     92:  * @csSig = Output Signature file name
1.2     ! misho      93:  * @compress = 2 compress signatures output, 0 not compressed
1.1       misho      94:  * return: -1 error, 0 ok
                     95:  */
1.2     ! misho      96: int syncSignature(const char *csInput, const char *csSig, int compress);
1.1       misho      97: 
                     98: /*
                     99:  * syncDelta() Create Delta patch file
                    100:  * @csInput = Input original source file name for make delta patch file
                    101:  * @csSig = Input Signature file name
                    102:  * @csDelta = Output Delta patch file name
1.2     ! misho     103:  * @compress = 3 everything compress, 2 compressed signatures, 1 compress delta output, 0 not compressed
1.1       misho     104:  * return: -1 error, 0 ok, create delta patch, 1 ok, no differences and not create patch
                    105:  */
                    106: int syncDelta(const char *csInput, const char *csSig, const char *csDelta, int compress);
                    107: 
                    108: /*
                    109:  * syncPatch() Apply delta patch file to target
                    110:  * @csInput = Input target file name for patch
                    111:  * @csDelta = Input Delta patch file name
                    112:  * @csPatch = After applied patch create new alternate target file, if != NULL
1.2     ! misho     113:  * @compress = 1 compress delta input, 0 not compressed
1.1       misho     114:  * return: -1 error, 0 ok, create delta patch, 1 ok, no differences and not create patch
                    115:  */
                    116: int syncPatch(const char *csInput, const char *csDelta, const char *csPatch, int compress);
                    117: 
                    118: 
1.2     ! misho     119: /*
        !           120:  * sync_dircmp() Compare directories
        !           121:  * @csDir1 = Directory 1
        !           122:  * @csDir2 = Directory 2
        !           123:  * return: -1 error, 0 is equal or 1 different
        !           124:  */
        !           125: int sync_dircmp(const char *csDir1, const char *csDir2);
        !           126: /*
        !           127:  * sync_dirCSum() Calculate checksum of directory
        !           128:  * @csDir = Directory
        !           129:  * @md = Message digest allocated memory, must be free after use!
        !           130:  * return: -1 error or !=-1 ok
        !           131:  */
        !           132: int sync_dirCSum(const char *csDir, u_char **md);
        !           133: /*
        !           134:  * sync_dircmpList() Compare directories or directory and file list
        !           135:  * @csDir1 = Directory 1
        !           136:  * @csDir2 = Directory 2 or File list, if "-" get input from console
        !           137:  * @lm = Long mode options, 1 long output
        !           138:  * @list = Output diff list, after use must be free!
        !           139:  * return: -1 error, 0 is equal or >0 count of returned list items
        !           140:  */
        !           141: int sync_dircmpList(const char *csDir1, const char *csDir2, int lm, struct tagDirName **list);
        !           142: 
        !           143: 
1.1       misho     144: #endif

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>