This repository has been archived by the owner on Sep 22, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
/
tuples.h
1319 lines (1161 loc) · 59.3 KB
/
tuples.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
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
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2016-2018 libfptu authors: please see AUTHORS file.
*
* This file is part of libfptu, aka "Fast Positive Tuples".
*
* libfptu is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* libfptu 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with libfptu. If not, see <http://www.gnu.org/licenses/>.
*/
/*
* libfptu = { Fast Positive Tuples, aka Позитивные Кортежи }
*
* The kind of lightweight linearized tuples, which are extremely handy
* to machining, including cases with shared memory.
* Please see README.md at https://github.com/leo-yuriev/libfptu
*
* The Future will Positive. Всё будет хорошо.
*
* "Позитивные Кортежи" дают легковесное линейное представление небольших
* JSON-подобных структур в экстремально удобной для машины форме,
* в том числе при размещении в разделяемой памяти.
*/
#pragma once
#ifndef FAST_POSITIVE_TUPLES_H
#define FAST_POSITIVE_TUPLES_H
#define FPTU_VERSION_MAJOR 0
#define FPTU_VERSION_MINOR 0
#include "fast_positive/config.h"
#include "fast_positive/defs.h"
#if defined(fptu_EXPORTS)
#define FPTU_API __dll_export
#elif LIBFPTU_STATIC
#define FPTU_API
#else
#define FPTU_API __dll_import
#endif /* fptu_EXPORTS */
#ifdef _MSC_VER
#pragma warning(push)
#if _MSC_VER < 1900
#pragma warning(disable : 4350) /* behavior change: 'std::_Wrap_alloc... */
#endif
#pragma warning(disable : 4514) /* 'xyz': unreferenced inline function \
has been removed */
#pragma warning(disable : 4710) /* 'xyz': function not inlined */
#pragma warning(disable : 4711) /* function 'xyz' selected for \
automatic inline expansion */
#pragma warning(disable : 4061) /* enumerator 'abc' in switch of enum 'xyz' is \
not explicitly handled by a case label */
#pragma warning(disable : 4201) /* nonstandard extension used : \
nameless struct / union */
#pragma warning(disable : 4127) /* conditional expression is constant */
#pragma warning(push, 1)
#ifndef _STL_WARNING_LEVEL
#define _STL_WARNING_LEVEL 3 /* Avoid warnings inside nasty MSVC STL code */
#endif
#pragma warning(disable : 4548) /* expression before comma has no effect; \
expected expression with side - effect */
#pragma warning(disable : 4530) /* C++ exception handler used, but unwind \
semantics are not enabled. Specify /EHsc */
#pragma warning(disable : 4577) /* 'noexcept' used with no exception handling \
mode specified; termination on exception \
is not guaranteed. Specify /EHsc */
#endif /* _MSC_VER (warnings) */
#include <errno.h> // for error codes
#include <float.h> // for FLT_EVAL_METHOD and float_t
#include <math.h> // for NaNs
#include <string.h> // for strlen()
#include <time.h> // for struct timespec, struct timeval
#ifdef HAVE_SYS_UIO_H
#include <sys/uio.h> // for struct iovec
#elif !defined(HAVE_STRUCT_IOVEC)
struct iovec {
void *iov_base; /* Starting address */
size_t iov_len; /* Number of bytes to transfer */
};
#define HAVE_STRUCT_IOVEC
#endif
#ifdef __cplusplus
#include <limits> // for numeric_limits<>
#include <string> // for std::string
extern "C" {
#endif
#ifdef _MSC_VER
#pragma warning(pop)
#endif
//----------------------------------------------------------------------------
/* Опции конфигурации управляющие внутренним поведением libfptu, т.е
* их изменение требует пересборки библиотеки.
*
* Чуть позже эти определения передедут в fptu_config.h */
// TBD
//----------------------------------------------------------------------------
/* Общие перечисления и структуры */
/* Коды ошибок.
* Список будет пополнен, а описания уточнены. */
enum fptu_error {
FPTU_SUCCESS = 0,
FPTU_OK = FPTU_SUCCESS,
#if defined(_WIN32) || defined(_WIN64)
FPTU_ENOFIELD = 0x00000650 /* ERROR_INVALID_FIELD */,
FPTU_EINVAL = 0x00000057 /* ERROR_INVALID_PARAMETER */,
FPTU_ENOSPACE = 0x00000540 /* ERROR_ALLOTTED_SPACE_EXCEEDED */,
#else
#ifdef ENOKEY
FPTU_ENOFIELD = ENOKEY /* Required key not available */,
#else
FPTU_ENOFIELD = ENOENT /* No such file or directory (POSIX) */,
#endif
FPTU_EINVAL = EINVAL /* Invalid argument (POSIX) */,
FPTU_ENOSPACE = ENOBUFS /* No buffer space available (POSIX) */,
/* OVERFLOW - Value too large to be stored in data type (POSIX) */
#endif
};
#pragma pack(push, 1)
/* Внутренний тип для хранения размера полей переменной длины. */
typedef union fptu_varlen {
struct {
uint16_t brutto; /* брутто-размер в 4-байтовых юнитах,
* всегда больше или равен 1. */
union {
uint16_t opaque_bytes;
uint16_t array_length;
uint16_t tuple_items;
};
};
uint32_t flat;
} fptu_varlen;
#ifdef __cplusplus
enum fptu_type : int32_t;
#endif
typedef union fptu_payload fptu_payload;
/* Поле кортежа.
*
* Фактически это дескриптор поля, в котором записаны: тип данных,
* номер колонки и смещение к данным. */
typedef union /*FPTU_API*/ fptu_field {
struct {
uint16_t ct; /* тип и "номер колонки". */
uint16_t offset; /* смещение к данным относительно заголовка, либо
непосредственно данные для uint16_t. */
};
uint32_t header;
uint32_t body[1]; /* в body[0] расположен дескриптор/заголовок,
* а начиная с body[offset] данные. */
#ifdef __cplusplus
static inline uint_fast16_t colnum(uint_fast16_t packed_ct);
static inline fptu_type type(uint_fast16_t packed_ct);
inline uint_fast16_t colnum() const;
inline fptu_type type() const;
inline uint_fast16_t get_payload_uint16() const;
inline const fptu_payload *payload() const;
#endif
} fptu_field;
/* Внутренний тип соответствующий 32-битной ячейке с данными. */
typedef union fptu_unit {
fptu_field field;
fptu_varlen varlen;
uint32_t data;
} fptu_unit;
/* Представление времени.
*
* В формате фиксированной точки 32-dot-32:
* - В старшей "целой" части секунды по UTC, буквально как выдает time(),
* но без знака. Это отодвигает проблему 2038-го года на 2106,
* требуя взамен аккуратности при вычитании.
* - В младшей "дробной" части неполные секунды в 1/2**32 долях.
*
* Эта форма унифицирована с "Positive Hyper100re" и одновременно достаточно
* удобна в использовании. Поэтому настоятельно рекомендуется использовать
* именно её, особенно для хранения и передачи данных. */
typedef union /*FPTU_API*/ fptu_time {
uint64_t fixedpoint;
struct {
#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
uint32_t fractional;
uint32_t utc;
#else
uint32_t utc;
uint32_t fractional;
#endif
};
#ifdef __cplusplus
static FPTU_API uint_fast32_t ns2fractional(uint_fast32_t);
static FPTU_API uint_fast32_t fractional2ns(uint_fast32_t);
static FPTU_API uint_fast32_t us2fractional(uint_fast32_t);
static FPTU_API uint_fast32_t fractional2us(uint_fast32_t);
static FPTU_API uint_fast32_t ms2fractional(uint_fast32_t);
static FPTU_API uint_fast32_t fractional2ms(uint_fast32_t);
#ifdef HAVE_TIMESPEC_TV_NSEC
/* LY: Clang не позволяет возвращать из C-linkage функции структуру,
* у которой есть какие-либо конструкторы C++. Поэтому необходимо отказаться
* либо от возможности использовать libfptu из C, либо от Clang,
* либо от конструкторов (они и пострадали). */
static FPTU_API fptu_time from_timespec(const struct timespec &ts) {
fptu_time result = {((uint64_t)ts.tv_sec << 32) |
ns2fractional((uint_fast32_t)ts.tv_nsec)};
return result;
}
#endif /* HAVE_TIMESPEC_TV_NSEC */
#ifdef HAVE_TIMEVAL_TV_USEC
static FPTU_API fptu_time from_timeval(const struct timeval &tv) {
fptu_time result = {((uint64_t)tv.tv_sec << 32) |
us2fractional((uint_fast32_t)tv.tv_usec)};
return result;
}
#endif /* HAVE_TIMEVAL_TV_USEC */
#ifdef _FILETIME_
static FPTU_API fptu_time from_filetime(FILETIME *pFileTime) {
uint64_t ns100 =
((uint64_t)pFileTime->dwHighDateTime << 32) + pFileTime->dwLowDateTime;
return from_100ns(
ns100 - UINT64_C(/* UTC offset from 1601-01-01 */ 116444736000000000));
}
#endif /* _FILETIME_ */
#endif
} fptu_time;
#pragma pack(pop)
/* Представление сериализованной формы кортежа.
*
* Фактические это просто системная структура iovec, т.е. указатель
* на буфер с данными и размер этих данных в байтах. Системный тип struct
* iovec выбран для совместимости с функциями readv(), writev() и т.п.
* Другими словами, это просто "оболочка", а сами данные кортежа должны быть
* где-то размещены. */
typedef union fptu_ro {
struct {
const fptu_unit *units;
size_t total_bytes;
};
struct iovec sys;
} fptu_ro;
/* Изменяемая форма кортежа.
* Является плоским буфером, в начале которого расположены служебные поля.
*
* Инициализируется функциями fptu_init(), fptu_alloc() и fptu_fetch(). */
typedef struct fptu_rw {
unsigned head; /* Индекс дозаписи дескрипторов, растет к началу буфера,
указывает на первый занятый элемент. */
unsigned tail; /* Индекс для дозаписи данных, растет к концу буфера,
указываент на первый не занятый элемент. */
unsigned junk; /* Счетчик мусорных 32-битных элементов, которые
образовались при удалении/обновлении. */
unsigned pivot; /* Индекс опорной точки, от которой растут "голова" и
"хвоcт", указывает на терминатор заголовка. */
unsigned end; /* Конец выделенного буфера, т.е. units[end] не наше. */
/* TODO: Автоматическое расширение буфера.
fptu_unit implace[1]; // начало данных если память выделяет одним куском.
fptu_unit *units; // указатель на данные, который указывает
// либо на inplace, либо на "автоматический" буфер
*/
fptu_unit units[1];
} fptu_rw;
/* Основные ограничения, константы и их производные. */
enum fptu_bits {
// базовые лимиты и параметры
fptu_bits = 16u, // ширина счетчиков
fptu_typeid_bits = 5u, // ширина типа в идентификаторе поля
fptu_ct_reserve_bits = 1u, // резерв в идентификаторе поля
fptu_unit_size = 4u, // размер одного юнита
// количество служебных (зарезервированных) бит в заголовке кортежа,
// для признаков сортированности и отсутствия повторяющихся полей
fptu_lx_bits = 2u,
// производные константы и параметры
// log2(fptu_unit_size)
fptu_unit_shift = 2u,
// базовый лимит значений
fptu_limit = (UINT32_C(1) << fptu_bits) - 1u,
// максимальный суммарный размер сериализованного представления кортежа,
fptu_max_tuple_bytes = fptu_limit * fptu_unit_size,
// ширина тега-номера поля/колонки
fptu_co_bits = fptu_bits - fptu_typeid_bits - fptu_ct_reserve_bits,
// маска для получения типа из идентификатора поля/колонки
fptu_ty_mask = (UINT32_C(1) << fptu_typeid_bits) - 1u,
// маска резервных битов в идентификаторе поля/колонки
fptu_fr_mask = ((UINT32_C(1) << fptu_ct_reserve_bits) - 1u)
<< fptu_typeid_bits,
// сдвиг для получения тега-номера из идентификатора поля/колонки
fptu_co_shift = fptu_typeid_bits + fptu_ct_reserve_bits,
// значение тега-номера для удаленных полей/колонок
fptu_co_dead = (UINT32_C(1) << fptu_co_bits) - 1u,
// максимальный тег-номер поля/колонки
fptu_max_cols = fptu_co_dead - 1u,
// кол-во бит доступных для хранения размера массива дескрипторов полей
fptu_lt_bits = fptu_bits - fptu_lx_bits,
// маска для выделения служебных бит из заголовка кортежа
fptu_lx_mask = ((UINT32_C(1) << fptu_lx_bits) - 1u) << fptu_lt_bits,
// маска для получения размера массива дескрипторов из заголовка кортежа
fptu_lt_mask = (UINT32_C(1) << fptu_lt_bits) - 1u,
// максимальное кол-во полей/колонок в одном кортеже
fptu_max_fields = fptu_lt_mask,
// максимальный размер поля/колонки
fptu_max_field_bytes = fptu_limit,
// максимальный размер произвольной последовательности байт
fptu_max_opaque_bytes = fptu_max_field_bytes - fptu_unit_size,
// максимальное кол-во элементов в массиве,
// так чтобы при любом базовом типе не превышались другие лимиты
fptu_max_array_len = fptu_max_opaque_bytes / 32,
// буфер достаточного размера для любого кортежа
fptu_buffer_enough =
sizeof(fptu_rw) + fptu_max_tuple_bytes + fptu_max_fields * fptu_unit_size,
// предельный размер, превышение которого считается ошибкой
fptu_buffer_limit = fptu_max_tuple_bytes * 2
};
/* Типы полей.
*
* Следует обратить внимание, что fptu_farray является флагом,
* а значения начиная с fptu_filter используются как маски для
* поиска/фильтрации полей (и видимо будут выделены в отдельный enum). */
typedef enum fptu_type
#ifdef __cplusplus
: int32_t
#endif
{
// fixed length, without ex-data (descriptor only)
fptu_null = 0,
fptu_uint16 = 1,
// fixed length with ex-data (at least 4 byte after the pivot)
fptu_int32 = 2,
fptu_uint32 = 3,
fptu_fp32 = 4, // 32-bit float-point, e.g. float
fptu_int64 = 5,
fptu_uint64 = 6,
fptu_fp64 = 7, // 64-bit float-point, e.g. double
fptu_datetime = 8, // date-time as fixed-point, compatible with UTC
fptu_96 = 9, // opaque 12-bytes (subject to change)
fptu_128 = 10, // opaque 16-bytes (uuid, ipv6, etc).
fptu_160 = 11, // opaque 20-bytes (sha1).
fptu_256 = 12, // opaque 32-bytes (sha256).
// variable length, e.g. length and payload inside ex-data
fptu_cstr = 13, // utf-8 с-string, zero terminated
// with additional length
fptu_opaque = 14, // opaque octet string
fptu_nested = 15, // nested tuple
fptu_farray = 16, // flag
fptu_typeid_max = (INT32_C(1) << fptu_typeid_bits) - 1,
// pseudo types for lookup and filtering
fptu_filter = INT32_C(1) << (fptu_null | fptu_farray),
fptu_any = INT32_C(-1), // match any type
fptu_any_int = fptu_filter | (INT32_C(1) << fptu_int32) |
(INT32_C(1) << fptu_int64), // match int32/int64
fptu_any_uint = fptu_filter | (INT32_C(1) << fptu_uint16) |
(INT32_C(1) << fptu_uint32) |
(INT32_C(1) << fptu_uint64), // match uint16/uint32/uint64
fptu_any_fp = fptu_filter | (INT32_C(1) << fptu_fp32) |
(INT32_C(1) << fptu_fp64), // match fp32/fp64
fptu_any_number = fptu_any_int | fptu_any_uint | fptu_any_fp,
// aliases
fptu_16 = fptu_uint16,
fptu_32 = fptu_uint32,
fptu_64 = fptu_uint64,
fptu_bool = fptu_uint16,
fptu_enum = fptu_uint16,
fptu_char = fptu_uint16,
fptu_wchar = fptu_uint16,
fptu_ipv4 = fptu_uint32,
fptu_uuid = fptu_128,
fptu_ipv6 = fptu_128,
fptu_md5 = fptu_128,
fptu_sha1 = fptu_160,
fptu_sha256 = fptu_256,
fptu_wstring = fptu_opaque
} fptu_type;
/* Возвращает текущее время в правильной форме.
*
* Аргумент grain_ns задает желаемую точность в наносекундах, в зависимости от
* которой будет использован CLOCK_REALTIME, либо CLOCK_REALTIME_COARSE.
*
* Положительные значения grain_ns, включая нуль, трактуются как наносекунды.
*
* Отрицательные же означают количество младших бит, которые НЕ требуются в
* результате и будут обнулены. Таким образом, отрицательные значения grain_ns
* позволяют запросить текущее время, одновременно с "резервированием" младших
* бит результата под специфические нужды.
*
* В конечном счете это позволяет существенно экономить на системных вызовах
* и/или обращении к аппаратуре. В том числе не выполнять системный вызов,
* а ограничиться использованием механизма vdso (прямое чтение из открытой
* страницы данных ядра). В зависимости от запрошенной точности,
* доступной аппаратуры и актуальном режиме работы ядра, экономия может
* составить до сотен и даже тысяч раз.
*
* Следует понимать, что реальная точность зависит от актуальной конфигурации
* аппаратуры и ядра ОС. Проще говоря, запрос текущего времени с grain_ns = 1
* достаточно абсурден и вовсе не гарантирует такой точности результата. */
FPTU_API fptu_time fptu_now(int grain_ns);
FPTU_API fptu_time fptu_now_fine(void);
FPTU_API fptu_time fptu_now_coarse(void);
//----------------------------------------------------------------------------
#ifdef HAVE_nanf
#define FPTU_DENIL_FP32 nanf("")
#elif defined(SNANF)
#define FPTU_DENIL_FP32 SNANF
#elif defined(SNAN)
#define FPTU_DENIL_FP32 ((float)SNAN)
#elif defined(NANF)
#define FPTU_DENIL_FP32 (NANF)
#elif defined(NAN)
#define FPTU_DENIL_FP32 ((float)NAN)
#else
#define FPTU_DENIL_FP32 ((float)(0.0 / 0.0))
#endif
#ifdef HAVE_nan
#define FPTU_DENIL_FP64 nan("")
#elif defined(SNAN)
#define FPTU_DENIL_FP64 ((float)SNAN)
#elif defined(NAN)
#define FPTU_DENIL_FP64 ((double)NAN)
#else
#define FPTU_DENIL_FP64 ((double)(0.0 / 0.0))
#endif
#define FPTU_DENIL_UINT16 UINT16_MAX
#define FPTU_DENIL_INT32 INT32_MIN
#define FPTU_DENIL_UINT32 UINT32_MAX
#define FPTU_DENIL_INT64 INT64_MIN
#define FPTU_DENIL_UINT64 UINT64_MAX
#define FPTU_DENIL_TIME_BIN (0)
#ifdef __GNUC__
#define FPTU_DENIL_TIME \
({ \
const fptu_time __fptu_time_denil = {FPTU_DENIL_TIME_BIN}; \
__fptu_time_denil; \
})
#else
static __inline fptu_time fptu_time_denil(void) {
const fptu_time denil = {FPTU_DENIL_TIME_BIN};
return denil;
}
#define FPTU_DENIL_TIME fptu_time_denil()
#endif
#define FPTU_DENIL_CSTR nullptr
#define FPTU_DENIL_FIXBIN nullptr
//----------------------------------------------------------------------------
/* Возвращает минимальный размер буфера, который необходим для размещения
* кортежа с указанным кол-вом полей и данных. */
FPTU_API size_t fptu_space(size_t items, size_t data_bytes);
/* Инициализирует в буфере кортеж, резервируя (отступая) место достаточное
* для добавления до items_limit полей. Оставшееся место будет
* использоваться для размещения данных.
*
* Возвращает указатель на созданный в буфере объект, либо nullptr, если
* заданы неверные параметры или размер буфера недостаточен. */
FPTU_API fptu_rw *fptu_init(void *buffer_space, size_t buffer_bytes,
size_t items_limit);
/* Выделяет через malloc() и инициализирует кортеж достаточный для
* размещения заданного кол-ва полей и данных.
*
* Возвращает адрес объекта, который необходимо free() по окончании
* использования. Либо nullptr при неверных параметрах или нехватке памяти. */
FPTU_API fptu_rw *fptu_alloc(size_t items_limit, size_t data_bytes);
/* Очищает ранее инициализированный кортеж.
* В случае успеха возвращает ноль, иначе код ошибки. */
FPTU_API int fptu_clear(fptu_rw *pt);
/* Возвращает кол-во свободных слотов для добавления дескрипторов
* полей в заголовок кортежа. */
FPTU_API size_t fptu_space4items(const fptu_rw *pt);
/* Возвращает остаток места доступного для размещения данных. */
FPTU_API size_t fptu_space4data(const fptu_rw *pt);
/* Возвращает объем мусора в байтах, который станет доступным для
* добавления полей и данных после fptu_shrink(). */
FPTU_API size_t fptu_junkspace(const fptu_rw *pt);
/* Проверяет сериализованную форму кортежа на корректность.
*
* Возвращает nullptr если ошибок не обнаружено, либо указатель на константную
* строку с краткой информацией о проблеме (нарушенное условие). */
FPTU_API const char *fptu_check_ro(fptu_ro ro);
/* Проверяет модифицируемую форму кортежа на корректность.
*
* Возвращает nullptr если ошибок не обнаружено, либо указатель на константную
* строку с краткой информацией о проблеме (нарушенное условие). */
FPTU_API const char *fptu_check(const fptu_rw *pt);
/* Возвращает сериализованную форму кортежа, которая находится внутри
* модифицируемой. Дефрагментация не выполняется, поэтому сериализованная
* форма может содержать лишний мусор, см fptu_junkspace().
*
* Возвращаемый результат валиден до изменения или разрушения исходной
* модифицируемой формы кортежа. */
FPTU_API fptu_ro fptu_take_noshrink(const fptu_rw *pt);
/* Строит в указанном буфере модифицируемую форму кортежа из сериализованной.
* Проверка корректности данных в сериализованной форме не производится.
* Сериализованная форма не модифицируется и не требуется после возврата из
* функции.
* Аргумент more_items резервирует кол-во полей, которые можно будет добавить
* в создаваемую модифицируемую форму.
*
* Возвращает указатель на созданный в буфере объект, либо nullptr, если
* заданы неверные параметры или размер буфера недостаточен. */
FPTU_API fptu_rw *fptu_fetch(fptu_ro ro, void *buffer_space,
size_t buffer_bytes, unsigned more_items);
/* Проверяет содержимое сериализованной формы на корректность. Одновременно
* возвращает размер буфера, который потребуется для модифицируемой формы,
* с учетом добавляемых more_items полей и more_payload данных.
*
* При неверных параметрах или некорректных данных возвращает 0 и записывает
* в error информацию об ошибке (указатель на константную строку
* с краткой информацией о проблеме). */
FPTU_API size_t fptu_check_and_get_buffer_size(fptu_ro ro, unsigned more_items,
unsigned more_payload,
const char **error);
FPTU_API size_t fptu_get_buffer_size(fptu_ro ro, unsigned more_items,
unsigned more_payload);
/* Производит дефрагментацию модифицируемой формы кортежа.
* Возвращает true если была произведена дефрагментация, что можно
* использовать как признак инвалидации итераторов. */
FPTU_API bool fptu_shrink(fptu_rw *pt);
/* Производит дефрагментацию модифицируемой формы кортежа при наличии
* пустот/мусора после удаления полей.
* Возвращает true если была произведена дефрагментация, что можно
* использовать как признак инвалидации итераторов. */
static __inline bool fptu_cond_shrink(fptu_rw *pt) {
return pt->junk != 0 && fptu_shrink(pt);
}
/* Возвращает сериализованную форму кортежа, которая находится внутри
* модифицируемой. При необходимости автоматически производится
* дефрагментация.
* Возвращаемый результат валиден до изменения или разрушения исходной
* модифицируемой формы кортежа. */
static __inline fptu_ro fptu_take(fptu_rw *pt) {
fptu_cond_shrink(pt);
return fptu_take_noshrink(pt);
}
/* Если в аргументе type_or_filter взведен бит fptu_filter,
* то type_or_filter интерпретируется как битовая маска типов.
* Соответственно, будут удалены все поля с заданным column и попадающие
* в маску типов. Например, если type_or_filter равен fptu_any_fp,
* то удаляются все fptu_fp32 и fptu_fp64.
*
* Возвращается кол-во удаленных полей (больше либо равно нулю),
* либо отрицательный код ошибки. */
FPTU_API int fptu_erase(fptu_rw *pt, unsigned column, int type_or_filter);
FPTU_API void fptu_erase_field(fptu_rw *pt, fptu_field *pf);
//----------------------------------------------------------------------------
FPTU_API extern const char fptu_empty_cstr[];
FPTU_API extern const uint8_t fptu_internal_map_t2b[];
FPTU_API extern const uint8_t fptu_internal_map_t2u[];
/* Вставка или обновление существующего поля.
*
* В случае коллекций, когда в кортеже более одного поля с соответствующим
* типом и номером), будет обновлен первый найденный экземпляр. Но так как
* в общем случае физический порядок полей не определен, следует считать что
* функция обновит произвольный экземпляр поля. Поэтому для манипулирования
* коллекциями следует использовать fptu_erase() и/или fput_field_set_xyz().
*/
FPTU_API int fptu_upsert_null(fptu_rw *pt, unsigned column);
FPTU_API int fptu_upsert_uint16(fptu_rw *pt, unsigned column,
uint_fast16_t value);
FPTU_API int fptu_upsert_int32(fptu_rw *pt, unsigned column,
int_fast32_t value);
FPTU_API int fptu_upsert_uint32(fptu_rw *pt, unsigned column,
uint_fast32_t value);
FPTU_API int fptu_upsert_int64(fptu_rw *pt, unsigned column,
int_fast64_t value);
FPTU_API int fptu_upsert_uint64(fptu_rw *pt, unsigned column,
uint_fast64_t value);
FPTU_API int fptu_upsert_fp64(fptu_rw *pt, unsigned column, double_t value);
FPTU_API int fptu_upsert_fp32(fptu_rw *pt, unsigned column, float_t value);
FPTU_API int fptu_upsert_datetime(fptu_rw *pt, unsigned column,
const fptu_time);
FPTU_API int fptu_upsert_96(fptu_rw *pt, unsigned column, const void *data);
FPTU_API int fptu_upsert_128(fptu_rw *pt, unsigned column, const void *data);
FPTU_API int fptu_upsert_160(fptu_rw *pt, unsigned column, const void *data);
FPTU_API int fptu_upsert_256(fptu_rw *pt, unsigned column, const void *data);
FPTU_API int fptu_upsert_string(fptu_rw *pt, unsigned column, const char *text,
size_t length);
static __inline int fptu_upsert_cstr(fptu_rw *pt, unsigned column,
const char *value) {
if (value == nullptr)
value = fptu_empty_cstr;
return fptu_upsert_string(pt, column, value, strlen(value));
}
FPTU_API int fptu_upsert_opaque(fptu_rw *pt, unsigned column, const void *value,
size_t bytes);
FPTU_API int fptu_upsert_opaque_iov(fptu_rw *pt, unsigned column,
const struct iovec value);
FPTU_API int fptu_upsert_nested(fptu_rw *pt, unsigned column, fptu_ro ro);
// TODO
// FPTU_API int fptu_upsert_array_uint16(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const uint16_t* array_data);
// FPTU_API int fptu_upsert_array_int32(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const int32_t* array_data);
// FPTU_API int fptu_upsert_array_uint32(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const uint32_t* array_data);
// FPTU_API int fptu_upsert_array_int64(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const int64_t* array_data);
// FPTU_API int fptu_upsert_array_uint64(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const uint64_t* array_data);
// FPTU_API int fptu_upsert_array_cstr(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const char* array_data[]);
// FPTU_API int fptu_upsert_array_nested(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const char* array_data[]);
//----------------------------------------------------------------------------
// Добавление ещё одного поля, для поддержки коллекций.
FPTU_API int fptu_insert_uint16(fptu_rw *pt, unsigned column,
uint_fast16_t value);
FPTU_API int fptu_insert_int32(fptu_rw *pt, unsigned column,
int_fast32_t value);
FPTU_API int fptu_insert_uint32(fptu_rw *pt, unsigned column,
uint_fast32_t value);
FPTU_API int fptu_insert_int64(fptu_rw *pt, unsigned column,
int_fast64_t value);
FPTU_API int fptu_insert_uint64(fptu_rw *pt, unsigned column,
uint_fast64_t value);
FPTU_API int fptu_insert_fp64(fptu_rw *pt, unsigned column, double_t value);
FPTU_API int fptu_insert_fp32(fptu_rw *pt, unsigned column, float_t value);
FPTU_API int fptu_insert_datetime(fptu_rw *pt, unsigned column,
const fptu_time);
FPTU_API int fptu_insert_96(fptu_rw *pt, unsigned column, const void *data);
FPTU_API int fptu_insert_128(fptu_rw *pt, unsigned column, const void *data);
FPTU_API int fptu_insert_160(fptu_rw *pt, unsigned column, const void *data);
FPTU_API int fptu_insert_256(fptu_rw *pt, unsigned column, const void *data);
FPTU_API int fptu_insert_string(fptu_rw *pt, unsigned column, const char *text,
size_t length);
static __inline int fptu_insert_cstr(fptu_rw *pt, unsigned column,
const char *value) {
if (value == nullptr)
value = fptu_empty_cstr;
return fptu_insert_string(pt, column, value, strlen(value));
}
FPTU_API int fptu_insert_opaque(fptu_rw *pt, unsigned column, const void *value,
size_t bytes);
FPTU_API int fptu_insert_opaque_iov(fptu_rw *pt, unsigned column,
const struct iovec value);
FPTU_API int fptu_insert_nested(fptu_rw *pt, unsigned column, fptu_ro ro);
// TODO
// FPTU_API int fptu_insert_array_uint16(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const uint16_t* array_data);
// FPTU_API int fptu_insert_array_int32(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const int32_t* array_data);
// FPTU_API int fptu_insert_array_uint32(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const uint32_t* array_data);
// FPTU_API int fptu_insert_array_int64(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const int64_t* array_data);
// FPTU_API int fptu_insert_array_uint64(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const uint64_t* array_data);
// FPTU_API int fptu_insert_array_str(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const char* array_data[]);
//----------------------------------------------------------------------------
// Обновление существующего поля (первого найденного для коллекций).
FPTU_API int fptu_update_uint16(fptu_rw *pt, unsigned column,
uint_fast16_t value);
FPTU_API int fptu_update_int32(fptu_rw *pt, unsigned column,
int_fast32_t value);
FPTU_API int fptu_update_uint32(fptu_rw *pt, unsigned column,
uint_fast32_t value);
FPTU_API int fptu_update_int64(fptu_rw *pt, unsigned column,
int_fast64_t value);
FPTU_API int fptu_update_uint64(fptu_rw *pt, unsigned column,
uint_fast64_t value);
FPTU_API int fptu_update_fp64(fptu_rw *pt, unsigned column, double_t value);
FPTU_API int fptu_update_fp32(fptu_rw *pt, unsigned column, float_t value);
FPTU_API int fptu_update_datetime(fptu_rw *pt, unsigned column,
const fptu_time);
FPTU_API int fptu_update_96(fptu_rw *pt, unsigned column, const void *data);
FPTU_API int fptu_update_128(fptu_rw *pt, unsigned column, const void *data);
FPTU_API int fptu_update_160(fptu_rw *pt, unsigned column, const void *data);
FPTU_API int fptu_update_256(fptu_rw *pt, unsigned column, const void *data);
FPTU_API int fptu_update_string(fptu_rw *pt, unsigned column, const char *text,
size_t length);
static __inline int fptu_update_cstr(fptu_rw *pt, unsigned column,
const char *value) {
if (value == nullptr)
value = fptu_empty_cstr;
return fptu_update_string(pt, column, value, strlen(value));
}
FPTU_API int fptu_update_opaque(fptu_rw *pt, unsigned column, const void *value,
size_t bytes);
FPTU_API int fptu_update_opaque_iov(fptu_rw *pt, unsigned column,
const struct iovec value);
FPTU_API int fptu_update_nested(fptu_rw *pt, unsigned column, fptu_ro ro);
// TODO
// FPTU_API int fptu_update_array_uint16(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const uint16_t* array_data);
// FPTU_API int fptu_update_array_int32(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const int32_t* array_data);
// FPTU_API int fptu_update_array_uint32(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const uint32_t* array_data);
// FPTU_API int fptu_update_array_int64(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const int64_t* array_data);
// FPTU_API int fptu_update_array_uint64(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const uint64_t* array_data);
// FPTU_API int fptu_update_array_cstr(fptu_rw* pt, uint_fast16_t ct, size_t
// array_length,
// const char* array_data[]);
//----------------------------------------------------------------------------
/* Возвращает первое поле попадающее под критерий выбора, либо nullptr.
* Семантика type_or_filter указана в описании fptu_erase(). */
FPTU_API const fptu_field *fptu_lookup_ro(fptu_ro ro, unsigned column,
int type_or_filter);
FPTU_API fptu_field *fptu_lookup(fptu_rw *pt, unsigned column,
int type_or_filter);
/* Возвращает "итераторы" по кортежу, в виде указателей.
* Гарантируется что begin меньше, либо равно end.
* В возвращаемом диапазоне могут буть удаленные поля,
* для которых fptu_field_column() возвращает отрицательное значение. */
FPTU_API const fptu_field *fptu_begin_ro(fptu_ro ro);
FPTU_API const fptu_field *fptu_end_ro(fptu_ro ro);
FPTU_API const fptu_field *fptu_begin_rw(const fptu_rw *pt);
FPTU_API const fptu_field *fptu_end_rw(const fptu_rw *pt);
/* Итерация полей кортежа с заданным условие отбора, при этом
* удаленные поля пропускаются.
* Семантика type_or_filter указана в описании fptu_erase(). */
FPTU_API const fptu_field *fptu_first(const fptu_field *begin,
const fptu_field *end, unsigned column,
int type_or_filter);
FPTU_API const fptu_field *fptu_next(const fptu_field *from,
const fptu_field *end, unsigned column,
int type_or_filter);
/* Итерация полей кортежа с заданным внешним фильтром, при этом
* удаленные поля пропускаются. */
typedef bool fptu_field_filter(const fptu_field *, void *context, void *param);
FPTU_API const fptu_field *fptu_first_ex(const fptu_field *begin,
const fptu_field *end,
fptu_field_filter filter,
void *context, void *param);
FPTU_API const fptu_field *fptu_next_ex(const fptu_field *begin,
const fptu_field *end,
fptu_field_filter filter, void *context,
void *param);
/* Подсчет количества полей по заданному номеру колонки и типу,
* либо маски типов.
* Семантика type_or_filter указана в описании fptu_erase(). */
FPTU_API size_t fptu_field_count(const fptu_rw *pt, unsigned column,
int type_or_filter);
FPTU_API size_t fptu_field_count_ro(fptu_ro ro, unsigned column,
int type_or_filter);
/* Подсчет количества полей задаваемой функцией-фильтром. */
FPTU_API size_t fptu_field_count_ex(const fptu_rw *pt, fptu_field_filter filter,
void *context, void *param);
FPTU_API size_t fptu_field_count_ro_ex(fptu_ro ro, fptu_field_filter filter,
void *context, void *param);
FPTU_API fptu_type fptu_field_type(const fptu_field *pf);
FPTU_API int fptu_field_column(const fptu_field *pf);
FPTU_API struct iovec fptu_field_as_iovec(const fptu_field *pf);
FPTU_API uint_fast16_t fptu_field_uint16(const fptu_field *pf);
FPTU_API int_fast32_t fptu_field_int32(const fptu_field *pf);
FPTU_API uint_fast32_t fptu_field_uint32(const fptu_field *pf);
FPTU_API int_fast64_t fptu_field_int64(const fptu_field *pf);
FPTU_API uint_fast64_t fptu_field_uint64(const fptu_field *pf);
FPTU_API double_t fptu_field_fp64(const fptu_field *pf);
FPTU_API float_t fptu_field_fp32(const fptu_field *pf);
FPTU_API fptu_time fptu_field_datetime(const fptu_field *pf);
FPTU_API const uint8_t *fptu_field_96(const fptu_field *pf);
FPTU_API const uint8_t *fptu_field_128(const fptu_field *pf);
FPTU_API const uint8_t *fptu_field_160(const fptu_field *pf);
FPTU_API const uint8_t *fptu_field_256(const fptu_field *pf);
FPTU_API const char *fptu_field_cstr(const fptu_field *pf);
FPTU_API struct iovec fptu_field_opaque(const fptu_field *pf);
FPTU_API fptu_ro fptu_field_nested(const fptu_field *pf);
FPTU_API uint_fast16_t fptu_get_uint16(fptu_ro ro, unsigned column, int *error);
FPTU_API int_fast32_t fptu_get_int32(fptu_ro ro, unsigned column, int *error);
FPTU_API uint_fast32_t fptu_get_uint32(fptu_ro ro, unsigned column, int *error);
FPTU_API int_fast64_t fptu_get_int64(fptu_ro ro, unsigned column, int *error);
FPTU_API uint_fast64_t fptu_get_uint64(fptu_ro ro, unsigned column, int *error);
FPTU_API double_t fptu_get_fp64(fptu_ro ro, unsigned column, int *error);
FPTU_API float_t fptu_get_fp32(fptu_ro ro, unsigned column, int *error);
FPTU_API fptu_time fptu_get_datetime(fptu_ro ro, unsigned column, int *error);
FPTU_API int_fast64_t fptu_get_sint(fptu_ro ro, unsigned column, int *error);
FPTU_API uint_fast64_t fptu_get_uint(fptu_ro ro, unsigned column, int *error);
FPTU_API double_t fptu_get_fp(fptu_ro ro, unsigned column, int *error);
FPTU_API const uint8_t *fptu_get_96(fptu_ro ro, unsigned column, int *error);
FPTU_API const uint8_t *fptu_get_128(fptu_ro ro, unsigned column, int *error);
FPTU_API const uint8_t *fptu_get_160(fptu_ro ro, unsigned column, int *error);
FPTU_API const uint8_t *fptu_get_256(fptu_ro ro, unsigned column, int *error);
FPTU_API const char *fptu_get_cstr(fptu_ro ro, unsigned column, int *error);
FPTU_API struct iovec fptu_get_opaque(fptu_ro ro, unsigned column, int *error);
FPTU_API fptu_ro fptu_get_nested(fptu_ro ro, unsigned column, int *error);
// TODO: fptu_field_array(), fptu_get_array()
// typedef struct FPTU_API fptu_array {
// size_t size;
// union {
// uint16_t uint16[2];
// int32_t int32[1];
// uint32_t uint32[1];
// int64_t int64[1];
// uint64_t uint64[1];
// double fp64[1];
// float fp32[1];
// const char *cstr[1];
// fptu_ro nested[1];
// struct iovec opaque[1];
// };
//} fptu_array;
//----------------------------------------------------------------------------
/* Определения и примитивы для сравнения. */
typedef enum fptu_lge {
fptu_ic = 1, // incomparable
fptu_eq = 2, // left == right
fptu_lt = 4, // left < right
fptu_gt = 8, // left > right
fptu_ne = fptu_lt | fptu_gt | fptu_ic, // left != right
fptu_le = fptu_lt | fptu_eq, // left <= right
fptu_ge = fptu_gt | fptu_eq // left >= right
} fptu_lge;
FPTU_API fptu_lge fptu_cmp_96(fptu_ro ro, unsigned column,
const uint8_t *value);
FPTU_API fptu_lge fptu_cmp_128(fptu_ro ro, unsigned column,
const uint8_t *value);
FPTU_API fptu_lge fptu_cmp_160(fptu_ro ro, unsigned column,
const uint8_t *value);
FPTU_API fptu_lge fptu_cmp_256(fptu_ro ro, unsigned column,
const uint8_t *value);
FPTU_API fptu_lge fptu_cmp_opaque(fptu_ro ro, unsigned column,
const void *value, size_t bytes);
FPTU_API fptu_lge fptu_cmp_opaque_iov(fptu_ro ro, unsigned column,
const struct iovec value);
FPTU_API fptu_lge fptu_cmp_binary(const void *left_data, size_t left_len,
const void *right_data, size_t right_len);
FPTU_API fptu_lge fptu_cmp_fields(const fptu_field *left,
const fptu_field *right);
FPTU_API fptu_lge fptu_cmp_tuples(fptu_ro left, fptu_ro right);
FPTU_API const char *fptu_type_name(const fptu_type);
//----------------------------------------------------------------------------
/* Некоторые внутренние служебные функции.
* Доступны для специальных случаев, в том числе для тестов. */
FPTU_API bool fptu_is_ordered(const fptu_field *begin, const fptu_field *end);
FPTU_API uint16_t *fptu_tags(uint16_t *const first,
const fptu_field *const begin,
const fptu_field *const end);
FPTU_API bool fptu_is_under_valgrind(void);
typedef struct fptu_version_info {
uint8_t major;
uint8_t minor;
uint16_t release;
uint32_t revision;
struct {
const char *datetime;
const char *tree;
const char *commit;
const char *describe;
} git;
} fptu_version_info;
typedef struct fptu_build_info {
const char *datetime;
const char *target;
const char *cmake_options;
const char *compiler;
const char *compile_flags;
} fptu_build_info;
#if HAVE_FPTU_VERSIONINFO
extern FPTU_API const fptu_version_info fptu_version;
#endif /* HAVE_FPTU_VERSIONINFO */
extern FPTU_API const fptu_build_info fptu_build;
//----------------------------------------------------------------------------
/* Сервисные функции (будет пополнятся). */
union fptu_payload {
uint32_t u32;
int32_t i32;
uint64_t u64;
int64_t i64;
fptu_time dt;
float fp32;
double fp64;
char cstr[4];
uint8_t fixbin[8];