Class: OpenC3::Crc64

Inherits:
Crc show all
Defined in:
lib/openc3/utilities/crc.rb,
ext/openc3/ext/crc/crc.c

Overview

Calculates 64-bit CRCs over a buffer of data.

Constant Summary collapse

DEFAULT_POLY =

CRC-64-ECMA default polynomial

0x42F0E1EBA9EA3693
DEFAULT_SEED =

Default Seed for 64-bit CRC

0xFFFFFFFFFFFFFFFF

Constants inherited from Crc

OpenC3::Crc::BIT_REVERSE_TABLE

Instance Attribute Summary

Attributes inherited from Crc

#poly, #reflect, #seed, #table, #xor

Instance Method Summary collapse

Methods inherited from Crc

#bit_reverse_16, #bit_reverse_32, #bit_reverse_64, #bit_reverse_8

Constructor Details

#initialize(poly = DEFAULT_POLY, seed = DEFAULT_SEED, xor = true, reflect = true) ⇒ Crc64

Creates a 64 bit CRC algorithm instance. By default it is initialzed to use the algorithm.

Parameters:

  • poly (Integer) (defaults to: DEFAULT_POLY) —

    Polynomial to use when calculating the CRC

  • seed (Integer) (defaults to: DEFAULT_SEED) —

    Seed value to start the calculation

  • xor (Boolean) (defaults to: true) —

    Whether to XOR the CRC result with 0xFFFF

  • reflect (Boolean) (defaults to: true) —

    Whether to bit reverse each byte of data before calculating the CRC



272
273
274
275
276
277
 
# File 'lib/openc3/utilities/crc.rb', line 272

def initialize(poly = DEFAULT_POLY,
               seed = DEFAULT_SEED,
               xor = true,
               reflect = true)
  super(poly, seed, xor, reflect)
end

Instance Method Details

#calc(*args) ⇒ Object Also known as: calculate_crc64

Calculate a 64-bit CRC



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'ext/openc3/ext/crc/crc.c', line 258

static VALUE crc64_calculate(int argc, VALUE *argv, VALUE self)
{
  volatile VALUE param_data = Qnil;
  volatile VALUE param_seed = Qnil;
  unsigned char *data = NULL;
  unsigned long long *table = NULL;
  int i = 0;
  long length = 0;
  unsigned long long crc = 0;

  switch (argc)
  {
  case 1:
    Check_Type(argv[0], T_STRING);
    param_data = argv[0];
    param_seed = rb_ivar_get(self, id_ivar_seed);
    break;
  case 2:
    Check_Type(argv[0], T_STRING);
    param_data = argv[0];
    if (argv[1] == Qnil)
    {
      param_seed = rb_ivar_get(self, id_ivar_seed);
    }
    else
    {
      param_seed = argv[1];
    }
    break;
  default:
    /* Invalid number of arguments given */
    rb_raise(rb_eArgError, "wrong number of arguments (%d for 1..2)", argc);
    break;
  };

  crc = NUM2ULL(param_seed);
  data = (unsigned char *)RSTRING_PTR(param_data);
  length = RSTRING_LEN(param_data);
  table = (unsigned long long *)RSTRING_PTR(rb_ivar_get(self, id_ivar_table));

  if (RTEST(rb_ivar_get(self, id_ivar_reflect)))
  {
    for (i = 0; i < length; i++)
    {
      crc = (crc << 8) ^ table[((crc >> 56) ^ bit_reverse_8(data[i])) & 0x00000000000000FFULL];
    }

    if (RTEST(rb_ivar_get(self, id_ivar_xor)))
    {
      return ULL2NUM(bit_reverse_64(crc ^ 0xFFFFFFFFFFFFFFFFULL));
    }
    else
    {
      return ULL2NUM(bit_reverse_64(crc));
    }
  }
  else
  {
    for (i = 0; i < length; i++)
    {
      crc = (crc << 8) ^ table[((crc >> 56) ^ data[i]) & 0x00000000000000FFULL];
    }

    if (RTEST(rb_ivar_get(self, id_ivar_xor)))
    {
      return ULL2NUM(crc ^ 0xFFFFFFFFFFFFFFFFULL);
    }
    else
    {
      return ULL2NUM(crc);
    }
  }
}