kinsamanka@3778: /*
kinsamanka@3778: This file is part of Beremiz, a Integrated Development Environment for
kinsamanka@3778: programming IEC 61131-3 automates supporting plcopen standard and CanFestival.
kinsamanka@3778:
kinsamanka@3778: See COPYING.runtime
kinsamanka@3778:
kinsamanka@3778: Copyright (C) 2018: Sergey Surkov <surkov.sv@summatechnology.ru>
kinsamanka@3778: Copyright (C) 2018: Andrey Skvortsov <andrej.skvortzov@gmail.com>
kinsamanka@3778:
kinsamanka@3778: */
kinsamanka@3778:
kinsamanka@3778: #ifndef HAVE_RETAIN
kinsamanka@3778: #include <stdio.h>
kinsamanka@3778: #include <stdint.h>
kinsamanka@3778: #include <unistd.h>
kinsamanka@3778: #include "iec_types.h"
kinsamanka@3778:
kinsamanka@3778: int GetRetainSize(void);
kinsamanka@3778:
kinsamanka@3778: /* Retain buffer. */
kinsamanka@3778: FILE *retain_buffer;
kinsamanka@3778: const char rb_file[] = "retain_buffer_file";
kinsamanka@3778: const char rb_file_bckp[] = "retain_buffer_file.bak";
kinsamanka@3778:
kinsamanka@3778: /* Retain header struct. */
kinsamanka@3778: struct retain_info_t {
kinsamanka@3778: uint32_t retain_size;
kinsamanka@3778: uint32_t hash_size;
kinsamanka@3778: uint8_t *hash;
kinsamanka@3778: uint32_t header_offset;
kinsamanka@3778: uint32_t header_crc;
kinsamanka@3778: };
kinsamanka@3778:
kinsamanka@3778: /* Init retain info structure. */
kinsamanka@3778: struct retain_info_t retain_info;
kinsamanka@3778:
kinsamanka@3778: /* CRC lookup table and initial state. */
kinsamanka@3778: static const uint32_t crc32_table[256] = {
kinsamanka@3778: 0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA, 0x076DC419, 0x706AF48F,
kinsamanka@3778: 0xE963A535, 0x9E6495A3,
kinsamanka@3778: 0x0EDB8832, 0x79DCB8A4, 0xE0D5E91E, 0x97D2D988, 0x09B64C2B, 0x7EB17CBD,
kinsamanka@3778: 0xE7B82D07, 0x90BF1D91,
kinsamanka@3778: 0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE, 0x1ADAD47D, 0x6DDDE4EB,
kinsamanka@3778: 0xF4D4B551, 0x83D385C7,
kinsamanka@3778: 0x136C9856, 0x646BA8C0, 0xFD62F97A, 0x8A65C9EC, 0x14015C4F, 0x63066CD9,
kinsamanka@3778: 0xFA0F3D63, 0x8D080DF5,
kinsamanka@3778: 0x3B6E20C8, 0x4C69105E, 0xD56041E4, 0xA2677172, 0x3C03E4D1, 0x4B04D447,
kinsamanka@3778: 0xD20D85FD, 0xA50AB56B,
kinsamanka@3778: 0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940, 0x32D86CE3, 0x45DF5C75,
kinsamanka@3778: 0xDCD60DCF, 0xABD13D59,
kinsamanka@3778: 0x26D930AC, 0x51DE003A, 0xC8D75180, 0xBFD06116, 0x21B4F4B5, 0x56B3C423,
kinsamanka@3778: 0xCFBA9599, 0xB8BDA50F,
kinsamanka@3778: 0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924, 0x2F6F7C87, 0x58684C11,
kinsamanka@3778: 0xC1611DAB, 0xB6662D3D,
kinsamanka@3778: 0x76DC4190, 0x01DB7106, 0x98D220BC, 0xEFD5102A, 0x71B18589, 0x06B6B51F,
kinsamanka@3778: 0x9FBFE4A5, 0xE8B8D433,
kinsamanka@3778: 0x7807C9A2, 0x0F00F934, 0x9609A88E, 0xE10E9818, 0x7F6A0DBB, 0x086D3D2D,
kinsamanka@3778: 0x91646C97, 0xE6635C01,
kinsamanka@3778: 0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E, 0x6C0695ED, 0x1B01A57B,
kinsamanka@3778: 0x8208F4C1, 0xF50FC457,
kinsamanka@3778: 0x65B0D9C6, 0x12B7E950, 0x8BBEB8EA, 0xFCB9887C, 0x62DD1DDF, 0x15DA2D49,
kinsamanka@3778: 0x8CD37CF3, 0xFBD44C65,
kinsamanka@3778: 0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2, 0x4ADFA541, 0x3DD895D7,
kinsamanka@3778: 0xA4D1C46D, 0xD3D6F4FB,
kinsamanka@3778: 0x4369E96A, 0x346ED9FC, 0xAD678846, 0xDA60B8D0, 0x44042D73, 0x33031DE5,
kinsamanka@3778: 0xAA0A4C5F, 0xDD0D7CC9,
kinsamanka@3778: 0x5005713C, 0x270241AA, 0xBE0B1010, 0xC90C2086, 0x5768B525, 0x206F85B3,
kinsamanka@3778: 0xB966D409, 0xCE61E49F,
kinsamanka@3778: 0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4, 0x59B33D17, 0x2EB40D81,
kinsamanka@3778: 0xB7BD5C3B, 0xC0BA6CAD,
kinsamanka@3778: 0xEDB88320, 0x9ABFB3B6, 0x03B6E20C, 0x74B1D29A, 0xEAD54739, 0x9DD277AF,
kinsamanka@3778: 0x04DB2615, 0x73DC1683,
kinsamanka@3778: 0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8, 0xE40ECF0B, 0x9309FF9D,
kinsamanka@3778: 0x0A00AE27, 0x7D079EB1,
kinsamanka@3778: 0xF00F9344, 0x8708A3D2, 0x1E01F268, 0x6906C2FE, 0xF762575D, 0x806567CB,
kinsamanka@3778: 0x196C3671, 0x6E6B06E7,
kinsamanka@3778: 0xFED41B76, 0x89D32BE0, 0x10DA7A5A, 0x67DD4ACC, 0xF9B9DF6F, 0x8EBEEFF9,
kinsamanka@3778: 0x17B7BE43, 0x60B08ED5,
kinsamanka@3778: 0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252, 0xD1BB67F1, 0xA6BC5767,
kinsamanka@3778: 0x3FB506DD, 0x48B2364B,
kinsamanka@3778: 0xD80D2BDA, 0xAF0A1B4C, 0x36034AF6, 0x41047A60, 0xDF60EFC3, 0xA867DF55,
kinsamanka@3778: 0x316E8EEF, 0x4669BE79,
kinsamanka@3778: 0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236, 0xCC0C7795, 0xBB0B4703,
kinsamanka@3778: 0x220216B9, 0x5505262F,
kinsamanka@3778: 0xC5BA3BBE, 0xB2BD0B28, 0x2BB45A92, 0x5CB36A04, 0xC2D7FFA7, 0xB5D0CF31,
kinsamanka@3778: 0x2CD99E8B, 0x5BDEAE1D,
kinsamanka@3778: 0x9B64C2B0, 0xEC63F226, 0x756AA39C, 0x026D930A, 0x9C0906A9, 0xEB0E363F,
kinsamanka@3778: 0x72076785, 0x05005713,
kinsamanka@3778: 0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38, 0x92D28E9B, 0xE5D5BE0D,
kinsamanka@3778: 0x7CDCEFB7, 0x0BDBDF21,
kinsamanka@3778: 0x86D3D2D4, 0xF1D4E242, 0x68DDB3F8, 0x1FDA836E, 0x81BE16CD, 0xF6B9265B,
kinsamanka@3778: 0x6FB077E1, 0x18B74777,
kinsamanka@3778: 0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C, 0x8F659EFF, 0xF862AE69,
kinsamanka@3778: 0x616BFFD3, 0x166CCF45,
kinsamanka@3778: 0xA00AE278, 0xD70DD2EE, 0x4E048354, 0x3903B3C2, 0xA7672661, 0xD06016F7,
kinsamanka@3778: 0x4969474D, 0x3E6E77DB,
kinsamanka@3778: 0xAED16A4A, 0xD9D65ADC, 0x40DF0B66, 0x37D83BF0, 0xA9BCAE53, 0xDEBB9EC5,
kinsamanka@3778: 0x47B2CF7F, 0x30B5FFE9,
kinsamanka@3778: 0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6, 0xBAD03605, 0xCDD70693,
kinsamanka@3778: 0x54DE5729, 0x23D967BF,
kinsamanka@3778: 0xB3667A2E, 0xC4614AB8, 0x5D681B02, 0x2A6F2B94, 0xB40BBE37, 0xC30C8EA1,
kinsamanka@3778: 0x5A05DF1B, 0x2D02EF8D,
kinsamanka@3778: };
kinsamanka@3778:
kinsamanka@3778: uint32_t retain_crc;
kinsamanka@3778:
kinsamanka@3778: /* Calculate CRC32 for len bytes from pointer buf with init starting value. */
kinsamanka@3778: uint32_t GenerateCRC32Sum(const void *buf, unsigned int len, uint32_t init)
kinsamanka@3778: {
kinsamanka@3778: uint32_t crc = ~init;
kinsamanka@3778: unsigned char *current = (unsigned char *)buf;
kinsamanka@3778: while (len--)
kinsamanka@3778: crc = crc32_table[(crc ^ *current++) & 0xFF] ^ (crc >> 8);
kinsamanka@3778: return ~crc;
kinsamanka@3778: }
kinsamanka@3778:
kinsamanka@3778: /* Calc CRC32 for retain file byte by byte. */
kinsamanka@3778: int CheckFileCRC(FILE * file_buffer)
kinsamanka@3778: {
kinsamanka@3778: /* Set the magic constant for one-pass CRC calc according to ZIP CRC32. */
kinsamanka@3778: const uint32_t magic_number = 0x2144df1c;
kinsamanka@3778:
kinsamanka@3778: /* CRC initial state. */
kinsamanka@3778: uint32_t calc_crc32 = 0;
kinsamanka@3778: char data_block = 0;
kinsamanka@3778:
kinsamanka@3778: while (!feof(file_buffer)) {
kinsamanka@3778: if (fread(&data_block, sizeof(data_block), 1, file_buffer))
kinsamanka@3778: calc_crc32 =
kinsamanka@3778: GenerateCRC32Sum(&data_block, sizeof(char), calc_crc32);
kinsamanka@3778: }
kinsamanka@3778:
kinsamanka@3778: /* Compare crc result with a magic number. */
kinsamanka@3778: return (calc_crc32 == magic_number) ? 1 : 0;
kinsamanka@3778: }
kinsamanka@3778:
kinsamanka@3778: /* Compare current hash with hash from file byte by byte. */
kinsamanka@3778: int CheckFilehash(void)
kinsamanka@3778: {
kinsamanka@3778: int k, ret;
kinsamanka@3778: int offset = sizeof(retain_info.retain_size);
kinsamanka@3778:
kinsamanka@3778: rewind(retain_buffer);
kinsamanka@3778: fseek(retain_buffer, offset, SEEK_SET);
kinsamanka@3778:
kinsamanka@3778: uint32_t size;
kinsamanka@3778: ret = fread(&size, sizeof(size), 1, retain_buffer);
kinsamanka@3778: if (size != retain_info.hash_size)
kinsamanka@3778: return 0;
kinsamanka@3778:
kinsamanka@3778: for (k = 0; k < retain_info.hash_size; k++) {
kinsamanka@3778: uint8_t file_digit;
kinsamanka@3778: ret = fread(&file_digit, sizeof(char), 1, retain_buffer);
kinsamanka@3778: if (file_digit != *(retain_info.hash + k))
kinsamanka@3778: return 0;
kinsamanka@3778: }
kinsamanka@3778:
kinsamanka@3778: return 1;
kinsamanka@3778: }
kinsamanka@3778:
kinsamanka@3778: void InitRetain(void)
kinsamanka@3778: {
kinsamanka@3778: int i;
kinsamanka@3778:
kinsamanka@3778: /* Get retain size in bytes */
kinsamanka@3778: retain_info.retain_size = GetRetainSize();
kinsamanka@3778:
kinsamanka@3778: /* Hash stored in retain file as array of char in hex digits
kinsamanka@3778: (that's why we divide strlen in two). */
kinsamanka@3778: retain_info.hash_size = PLC_ID ? strlen(PLC_ID) / 2 : 0;
kinsamanka@3778: //retain_info.hash_size = 0;
kinsamanka@3778: retain_info.hash = malloc(retain_info.hash_size);
kinsamanka@3778:
kinsamanka@3778: /* Transform hash string into byte sequence. */
kinsamanka@3778: for (i = 0; i < retain_info.hash_size; i++) {
kinsamanka@3778: int byte = 0;
kinsamanka@3778: sscanf((PLC_ID + i * 2), "%02X", &byte);
kinsamanka@3778: retain_info.hash[i] = byte;
kinsamanka@3778: }
kinsamanka@3778:
kinsamanka@3778: /* Calc header offset. */
kinsamanka@3778: retain_info.header_offset = sizeof(retain_info.retain_size) +
kinsamanka@3778: sizeof(retain_info.hash_size) + retain_info.hash_size;
kinsamanka@3778:
kinsamanka@3778: /* Set header CRC initial state. */
kinsamanka@3778: retain_info.header_crc = 0;
kinsamanka@3778:
kinsamanka@3778: /* Calc crc for header. */
kinsamanka@3778: retain_info.header_crc = GenerateCRC32Sum(&retain_info.retain_size,
kinsamanka@3778: sizeof(retain_info.retain_size),
kinsamanka@3778: retain_info.header_crc);
kinsamanka@3778:
kinsamanka@3778: retain_info.header_crc = GenerateCRC32Sum(&retain_info.hash_size,
kinsamanka@3778: sizeof(retain_info.hash_size),
kinsamanka@3778: retain_info.header_crc);
kinsamanka@3778:
kinsamanka@3778: retain_info.header_crc = GenerateCRC32Sum(retain_info.hash,
kinsamanka@3778: retain_info.hash_size,
kinsamanka@3778: retain_info.header_crc);
kinsamanka@3778: }
kinsamanka@3778:
kinsamanka@3778: void CleanupRetain(void)
kinsamanka@3778: {
kinsamanka@3778: /* Free hash memory. */
kinsamanka@3778: free(retain_info.hash);
kinsamanka@3778: }
kinsamanka@3778:
kinsamanka@3778: int CheckRetainFile(const char *file)
kinsamanka@3778: {
kinsamanka@3778: retain_buffer = fopen(file, "rb");
kinsamanka@3778: if (retain_buffer) {
kinsamanka@3778: /* Check CRC32 and hash. */
kinsamanka@3778: if (CheckFileCRC(retain_buffer))
kinsamanka@3778: if (CheckFilehash())
kinsamanka@3778: return 1;
kinsamanka@3778: fclose(retain_buffer);
kinsamanka@3778: retain_buffer = NULL;
kinsamanka@3778: }
kinsamanka@3778: return 0;
kinsamanka@3778: }
kinsamanka@3778:
kinsamanka@3778: int CheckRetainBuffer(void)
kinsamanka@3778: {
kinsamanka@3778: retain_buffer = NULL;
kinsamanka@3778: if (!retain_info.retain_size)
kinsamanka@3778: return 1;
kinsamanka@3778:
kinsamanka@3778: /* Check latest retain file. */
kinsamanka@3778: if (CheckRetainFile(rb_file))
kinsamanka@3778: return 1;
kinsamanka@3778:
kinsamanka@3778: /* Check if we have backup. */
kinsamanka@3778: if (CheckRetainFile(rb_file_bckp))
kinsamanka@3778: return 1;
kinsamanka@3778:
kinsamanka@3778: /* We don't have any valid retain buffer - nothing to remind. */
kinsamanka@3778: return 0;
kinsamanka@3778: }
kinsamanka@3778:
kinsamanka@3778: #ifndef FILE_RETAIN_SAVE_PERIOD_S
kinsamanka@3778: #define FILE_RETAIN_SAVE_PERIOD_S 1.0
kinsamanka@3778: #endif
kinsamanka@3778:
kinsamanka@3778: static double CalcDiffSeconds(IEC_TIME * t1, IEC_TIME * t2)
kinsamanka@3778: {
kinsamanka@3778: IEC_TIME dt = {
kinsamanka@3778: t1->tv_sec - t2->tv_sec,
kinsamanka@3778: t1->tv_nsec - t2->tv_nsec
kinsamanka@3778: };
kinsamanka@3778:
kinsamanka@3778: if ((dt.tv_nsec < -1000000000) || ((dt.tv_sec > 0) && (dt.tv_nsec < 0))) {
kinsamanka@3778: dt.tv_sec--;
kinsamanka@3778: dt.tv_nsec += 1000000000;
kinsamanka@3778: }
kinsamanka@3778: if ((dt.tv_nsec > +1000000000) || ((dt.tv_sec < 0) && (dt.tv_nsec > 0))) {
kinsamanka@3778: dt.tv_sec++;
kinsamanka@3778: dt.tv_nsec -= 1000000000;
kinsamanka@3778: }
kinsamanka@3778: return dt.tv_sec + 1e-9 * dt.tv_nsec;
kinsamanka@3778: }
kinsamanka@3778:
kinsamanka@3778: int RetainSaveNeeded(void)
kinsamanka@3778: {
kinsamanka@3778: int ret = 0;
kinsamanka@3778: static IEC_TIME last_save;
kinsamanka@3778: IEC_TIME now;
kinsamanka@3778: double diff_s;
kinsamanka@3778:
kinsamanka@3778: /* no retain */
kinsamanka@3778: if (!retain_info.retain_size)
kinsamanka@3778: return 0;
kinsamanka@3778:
kinsamanka@3778: /* periodic retain flush to avoid high I/O load */
kinsamanka@3778: PLC_GetTime(&now);
kinsamanka@3778:
kinsamanka@3778: diff_s = CalcDiffSeconds(&now, &last_save);
kinsamanka@3778:
kinsamanka@3778: if ((diff_s > FILE_RETAIN_SAVE_PERIOD_S) || ForceSaveRetainReq()) {
kinsamanka@3778: ret = 1;
kinsamanka@3778: last_save = now;
kinsamanka@3778: }
kinsamanka@3778: return ret;
kinsamanka@3778: }
kinsamanka@3778:
kinsamanka@3778: void ValidateRetainBuffer(void)
kinsamanka@3778: {
kinsamanka@3778: if (!retain_buffer)
kinsamanka@3778: return;
kinsamanka@3778:
kinsamanka@3778: /* Add retain data CRC to the end of buffer file. */
kinsamanka@3778: fseek(retain_buffer, 0, SEEK_END);
kinsamanka@3778: fwrite(&retain_crc, sizeof(uint32_t), 1, retain_buffer);
kinsamanka@3778:
kinsamanka@3778: /* Sync file buffer and close file. */
kinsamanka@3778: #ifdef __WIN32
kinsamanka@3778: fflush(retain_buffer);
kinsamanka@3778: #else
kinsamanka@3778: fsync(fileno(retain_buffer));
kinsamanka@3778: #endif
kinsamanka@3778:
kinsamanka@3778: fclose(retain_buffer);
kinsamanka@3778: retain_buffer = NULL;
kinsamanka@3778: }
kinsamanka@3778:
kinsamanka@3778: void InValidateRetainBuffer(void)
kinsamanka@3778: {
kinsamanka@3778: if (!RetainSaveNeeded())
kinsamanka@3778: return;
kinsamanka@3778:
kinsamanka@3778: /* Rename old retain file into *.bak if it exists. */
kinsamanka@3778: rename(rb_file, rb_file_bckp);
kinsamanka@3778:
kinsamanka@3778: /* Set file CRC initial value. */
kinsamanka@3778: retain_crc = retain_info.header_crc;
kinsamanka@3778:
kinsamanka@3778: /* Create new retain file. */
kinsamanka@3778: retain_buffer = fopen(rb_file, "wb+");
kinsamanka@3778: if (!retain_buffer) {
kinsamanka@3778: fprintf(stderr, "Failed to create retain file : %s\n", rb_file);
kinsamanka@3778: return;
kinsamanka@3778: }
kinsamanka@3778:
kinsamanka@3778: /* Write header to the new file. */
kinsamanka@3778: fwrite(&retain_info.retain_size,
kinsamanka@3778: sizeof(retain_info.retain_size), 1, retain_buffer);
kinsamanka@3778: fwrite(&retain_info.hash_size,
kinsamanka@3778: sizeof(retain_info.hash_size), 1, retain_buffer);
kinsamanka@3778: fwrite(retain_info.hash,
kinsamanka@3778: sizeof(char), retain_info.hash_size, retain_buffer);
kinsamanka@3778: }
kinsamanka@3778:
kinsamanka@3778: void Retain(unsigned int offset, unsigned int count, void *p)
kinsamanka@3778: {
kinsamanka@3778: if (!retain_buffer)
kinsamanka@3778: return;
kinsamanka@3778:
kinsamanka@3778: /* Generate CRC 32 for each data block. */
kinsamanka@3778: retain_crc = GenerateCRC32Sum(p, count, retain_crc);
kinsamanka@3778:
kinsamanka@3778: /* Save current var in file. */
kinsamanka@3778: fseek(retain_buffer, retain_info.header_offset + offset, SEEK_SET);
kinsamanka@3778: fwrite(p, count, 1, retain_buffer);
kinsamanka@3778: }
kinsamanka@3778:
kinsamanka@3778: void Remind(unsigned int offset, unsigned int count, void *p)
kinsamanka@3778: {
kinsamanka@3778: int ret;
kinsamanka@3778: /* Remind variable from file. */
kinsamanka@3778: fseek(retain_buffer, retain_info.header_offset + offset, SEEK_SET);
kinsamanka@3778: ret = fread((void *)p, count, 1, retain_buffer);
kinsamanka@3778: }
kinsamanka@3778: #endif // !HAVE_RETAIN