Tarantool development patches archive
 help / color / mirror / Atom feed
From: Timur Safin via Tarantool-patches <tarantool-patches@dev.tarantool.org>
To: imun@tarantool.org, v.shpilevoy@tarantool.org
Cc: tarantool-patches@dev.tarantool.org
Subject: [Tarantool-patches] [PATCH v4 0/7] Initial datetime support
Date: Fri, 13 Aug 2021 01:33:39 +0300	[thread overview]
Message-ID: <cover.1628805259.git.tsafin@tarantool.org> (raw)

* Version #4 changes:

A lot.

  - Got rid of closures usage here and there. Benchmarks revealed there is 
    20x speed difference of hash with closure handlers to the case when we 
    check keys using sequence of simple ifs.
    And despite the fact that it looks ugler, we have updated all places which
    used to use closures - so much performance impact does not worth it;

  - c-dt library now is accompanied with corresponding unit-tests;

  - due to a new (old) way of exporting public symbols, which is now used by 
    Tarantool build, we have modified c-dt sources to use approach similar 
    to that used by xxhash (or ICU) - "namespaces" for public symbols.
    If there is DT_NAMESPACE macro (e.g. DT_NAMESPACE=tnt_) defined at the 
    moment of compilation we rename all relevant public symbols to 
    use that "namespace" as prefix
	#define dt_from_rdn DT_NAME(DT_NAMESPACE, dt_from_rdn)

    C sources continue to use original name (now as a macro), but in Lua ffi
    we have to use renamed symbol - `tnt_dt_from_rdn`.

  - We have separated code which implement MessagePack related funcionality
    from generic (i.e. stringization) support for datetime types.
    Stringization is in `src/core/datetime.c`, but MessagePack support is in 

  - `ctime` and `asctime` now use reentrant versions (i.e. `ctime_r` instead of 
    `ctime`, and `asctime_r` instead of `asctime`). This allows us to avoid 
    nasty problem with GC where it was possible to corrupt returned 
    static buffer regardless the fact that it was immediately passed
    to `ffi.string`. 
    `test/app-tap/gh-5632-6050-6259-gc-buf-reuse.test.lua` updated to check our 
    new api `datetime.ctime`, and `datetime.asctime`. 

  - Introduced MessagePack unit-test which check C implementation (mp 
    encode/decode, mp_snprint, mp_fprint) 

  - Some special efforts have been taken to make sure we deal correctly 
    with datetime stamps which were before Unix Epoch (1970-01-01), i.e. 
    for negative stamps or timezones against epoch.

  - And last, but not the least: in addition to usual getters like 
    `timestamp`, `nanoseconds`, `epoch`, we have introduced function 
    modifiers `to_utc()` or `to_tz(offset)` which allow to manipulate with 
    datetime timezone `.offset` field. Actually it does not do much now 
    (only reattributing object with different offset, but not changed 
    actual timestamp, which is UTC normalized). But different timestamp 
    modifies textual representation, which simplify debugging.

* Version #3 changes:

  - renamed `struct datetime_t` to `struct datetime`, and `struct 
    datetime_interval_t` to `struct datetime_interval`;
  - significantly reworked arguments checks in module api entries;
  - fixed datetime comparisons;
  - changed hints calculation to take into account fractional part;
  - provided more comments here and there;

NB! There are MacOSX problems due to GLIBC specific code used (as Vlad
    has already pointed out) - so additional patch, making it more 
    cross-compatible coming here soon...

* Version #2 changes:

  - fixed problem with overloaded '-' and '+' operations for datetime 
  - fixed messagepack serialization problems;
  - heavily documented MessagePack serialization schema in the code;
  - introduced working implementation of datetime hints for storage engines;
  - made interval related names be more consistent, renamed durations and period 
    to intervals, i.e. t_datetime_duration to datetime_interval_t, 
    duration_* to interval_*, period to interval;
  - properly implemented all reasonable cases of datetime+interval 
  - moved all initialization code to utils.c;
  - renamed core/mp_datetime.c to core/datetime.c because it makes more
    sense now;

* Version #1 - initial RFC

In brief

This patchset implements datetime lua support in box, with serialization 
to messagepack, yaml, json and lua mode. Also it contains storage 
engines' indices implementation for datetime type introduced.

* Current implementation is heavily influenced by Sci-Lua lua-time module
  e.g. you could find very similar approach for handling of operations
  with year or month long intervals (which should be handled differently than
  usual intervals of seconds, or days).

* But internally we actually use Christian Hanson' c-dt module
  (though it has been modified slightly for cleaner integration
  into our cmake-based build process).

Datetime Module API

Small draft of documentation for our `datetime` module API has been
extracted to the discussion topic there - 
We try to update documentation there once any relevant change introdcued 
to the implementaton.

Messagepack serialization schema

In short it looks like:
- now we introduce new MP_EXT extension type #4;
- we may save 1 required and 2 optional fields for datetime field;

In all gory details it's explained in MessagePack serialization schema depicted here:



Timur Safin (7):
  build: add Christian Hansen c-dt to the build
  lua: built-in module datetime
  lua, datetime: display datetime
  box, datetime: messagepack support for datetime
  box, datetime: datetime comparison for indices
  lua, datetime: time intervals support
  datetime: changelog for datetime module

 .gitmodules                                   |   3 +
 CMakeLists.txt                                |   8 +
 .../gh-5941-datetime-type-support.md          |   4 +
 cmake/BuildCDT.cmake                          |  10 +
 extra/exports                                 |  34 +
 src/CMakeLists.txt                            |   5 +-
 src/box/field_def.c                           |  53 +-
 src/box/field_def.h                           |   4 +
 src/box/lua/serialize_lua.c                   |   7 +-
 src/box/memtx_space.c                         |   3 +-
 src/box/msgpack.c                             |   7 +-
 src/box/tuple_compare.cc                      |  77 ++
 src/box/vinyl.c                               |   3 +-
 src/lib/core/CMakeLists.txt                   |   5 +-
 src/lib/core/datetime.c                       | 176 ++++
 src/lib/core/datetime.h                       | 115 +++
 src/lib/core/mp_datetime.c                    | 189 ++++
 src/lib/core/mp_datetime.h                    |  89 ++
 src/lib/core/mp_extension_types.h             |   1 +
 src/lib/mpstream/mpstream.c                   |  11 +
 src/lib/mpstream/mpstream.h                   |   4 +
 src/lua/datetime.lua                          | 880 ++++++++++++++++++
 src/lua/init.c                                |   4 +-
 src/lua/msgpack.c                             |  12 +
 src/lua/msgpackffi.lua                        |  18 +
 src/lua/serializer.c                          |   4 +
 src/lua/serializer.h                          |   2 +
 src/lua/utils.c                               |  28 +-
 src/lua/utils.h                               |  12 +
 test/app-tap/datetime.test.lua                | 370 ++++++++
 .../gh-5632-6050-6259-gc-buf-reuse.test.lua   |  74 +-
 test/engine/datetime.result                   |  77 ++
 test/engine/datetime.test.lua                 |  35 +
 test/unit/CMakeLists.txt                      |   3 +-
 test/unit/datetime.c                          | 379 ++++++++
 test/unit/datetime.result                     | 358 +++++++
 third_party/c-dt                              |   1 +
 third_party/lua-cjson/lua_cjson.c             |   8 +
 third_party/lua-yaml/lyaml.cc                 |   6 +-
 39 files changed, 3051 insertions(+), 28 deletions(-)
 create mode 100644 changelogs/unreleased/gh-5941-datetime-type-support.md
 create mode 100644 cmake/BuildCDT.cmake
 create mode 100644 src/lib/core/datetime.c
 create mode 100644 src/lib/core/datetime.h
 create mode 100644 src/lib/core/mp_datetime.c
 create mode 100644 src/lib/core/mp_datetime.h
 create mode 100644 src/lua/datetime.lua
 create mode 100755 test/app-tap/datetime.test.lua
 create mode 100644 test/engine/datetime.result
 create mode 100644 test/engine/datetime.test.lua
 create mode 100644 test/unit/datetime.c
 create mode 100644 test/unit/datetime.result
 create mode 160000 third_party/c-dt


             reply	other threads:[~2021-08-12 22:34 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-12 22:33 Timur Safin via Tarantool-patches [this message]
2021-08-12 22:33 ` [Tarantool-patches] [PATCH v4 1/7] build: add Christian Hansen c-dt to the build Timur Safin via Tarantool-patches
2021-08-12 22:33 ` [Tarantool-patches] [PATCH v4 2/7] lua: built-in module datetime Timur Safin via Tarantool-patches
2021-08-12 22:33 ` [Tarantool-patches] [PATCH v4 3/7] lua, datetime: display datetime Timur Safin via Tarantool-patches
2021-08-12 22:33 ` [Tarantool-patches] [PATCH v4 4/7] box, datetime: messagepack support for datetime Timur Safin via Tarantool-patches
2021-08-12 23:03   ` Safin Timur via Tarantool-patches
2021-08-12 22:33 ` [Tarantool-patches] [PATCH v4 5/7] box, datetime: datetime comparison for indices Timur Safin via Tarantool-patches
2021-08-12 22:33 ` [Tarantool-patches] [PATCH v4 6/7] lua, datetime: time intervals support Timur Safin via Tarantool-patches
2021-08-12 22:33 ` [Tarantool-patches] [PATCH v4 7/7] datetime: changelog for datetime module Timur Safin via Tarantool-patches

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cover.1628805259.git.tsafin@tarantool.org \
    --to=tarantool-patches@dev.tarantool.org \
    --cc=imun@tarantool.org \
    --cc=tsafin@tarantool.org \
    --cc=v.shpilevoy@tarantool.org \
    --subject='Re: [Tarantool-patches] [PATCH v4 0/7] Initial datetime support' \


* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox