[k2] implement zip functions in light runtime #1486

Shamzik · 2025-12-16T10:29:39Z

The goal is to implement functions:

deflate_init;
deflate_add.

DeflateContext was implemented too as it is used in deflate functions.

runtime-light/stdlib/zlib/deflatecontext.h

runtime-light/stdlib/zlib/zlib-functions.cpp

astrophysik

Generally, maybe remove prefixes `deflate_add()/deflate_init'? The location of the error should be clear from the trace

builtin-functions/kphp-light/stdlib/zlib-functions.txt

runtime-light/stdlib/zlib/zlib-functions.cpp

runtime-light/stdlib/zlib/deflate-context.h

apolyakov · 2025-12-19T11:47:39Z

runtime-light/stdlib/zlib/zlib-functions.cpp

 void zlib_static_free([[maybe_unused]] voidpf opaque, [[maybe_unused]] voidpf address) noexcept {}

+voidpf zlib_dynamic_alloc([[maybe_unused]] voidpf opaque, uInt items, uInt size) noexcept {
+  auto* mem{kphp::memory::script::calloc(items, size)};


Could you please explain the reason you chose calloc instead of alloc?

Because old KPHP runtime does

You're right. Let's then rename it to zlib_dynamic_calloc

runtime-light/stdlib/zlib/zlib-functions.cpp

apolyakov · 2025-12-19T11:56:19Z

runtime-light/stdlib/zlib/zlib-functions.cpp

+  }
+
+  z_stream* stream{std::addressof(context.get()->stream)};
+  auto out_size{deflateBound(stream, data.size()) + 30};


What does this magic constant mean?

I don't know. =)

I got it from old KPHP runtime

I think we need to figure this out

apolyakov · 2025-12-19T11:56:28Z

runtime-light/stdlib/zlib/zlib-functions.cpp

+
+  z_stream* stream{std::addressof(context.get()->stream)};
+  auto out_size{deflateBound(stream, data.size()) + 30};
+  out_size = out_size < 64 ? 64 : out_size;


And this one

I gave them names. What do you think?

It's not a solution we want tbh

apolyakov · 2025-12-19T15:33:27Z

runtime-light/stdlib/zlib/zlib-functions.cpp

+  int32_t window{15};
+  auto strategy{Z_DEFAULT_STRATEGY};
+  constexpr auto extract_int_option{[](int32_t lbound, int32_t ubound, const array_iterator<const mixed>& option, int32_t& dst) noexcept {
+    if (const mixed & value{option.get_value()}; value.is_int() && value.as_int() >= lbound && value.as_int() <= ubound) {


nit: something is wrong with your formatter as it should be const mixed&

apolyakov · 2025-12-19T15:33:56Z

runtime-light/stdlib/zlib/zlib-functions.cpp

+      dst = value.as_int();
+      return true;
+    } else {
+      kphp::log::warning("option {} should be number between {}..{}", option.get_string_key().c_str(), lbound, ubound);


nit: a number

apolyakov · 2025-12-19T15:48:04Z

runtime-light/stdlib/zlib/zlib-functions.cpp

+class_instance<C$DeflateContext> f$deflate_init(int64_t encoding, const array<mixed>& options) noexcept {
+  int32_t level{-1};
+  int32_t memory{8};
+  int32_t window{15};


Can we not have such magic constants?

apolyakov · 2025-12-22T13:27:49Z

runtime-light/stdlib/zlib/zlib-functions.h

+
+class_instance<C$DeflateContext> f$deflate_init(int64_t encoding, const array<mixed>& options = {}) noexcept;
+
+Optional<string> f$deflate_add(const class_instance<C$DeflateContext>& context, const string& data, int64_t flush_type = Z_SYNC_FLUSH) noexcept;


Missing include for zlib here

apolyakov · 2025-12-22T13:38:52Z

runtime-light/stdlib/zlib/deflate-context.h

+
+struct C$DeflateContext : public refcountable_php_classes<C$DeflateContext>, private DummyVisitorMethods {
+  C$DeflateContext() noexcept = default;
+  using DummyVisitorMethods::accept;


nit: I'd swap these two lines

apolyakov · 2025-12-22T13:40:09Z

runtime-light/stdlib/zlib/zlib-functions.cpp

+  int32_t memory{8};
+  int32_t window{15};
+  auto strategy{Z_DEFAULT_STRATEGY};
+  constexpr auto extract_int_option{[](int32_t lbound, int32_t ubound, const array_iterator<const mixed>& option, int32_t& dst) noexcept {


I'd like to see this refactored as now it's hard to undersand

apolyakov · 2025-12-22T13:40:46Z

runtime-light/stdlib/zlib/zlib-functions.cpp

+    }
+
+    const auto& key{option.get_string_key()};
+    if (std::string_view{key.c_str(), key.size()} == "level") {


I think we can have const std::string_view key_view{...} defined once

apolyakov · 2025-12-22T13:41:29Z

runtime-light/stdlib/zlib/zlib-functions.cpp

+    }
+  }
+
+  class_instance<C$DeflateContext> context;


nit: there is a nice make_instance function that also allocates a class instance

apolyakov · 2025-12-22T13:44:23Z

runtime-light/stdlib/zlib/zlib-functions.cpp

+  stream->zfree = zlib_dynamic_free;
+  stream->opaque = nullptr;
+
+  if (encoding < 0) {


Let's get rid of all the magic constants

apolyakov · 2025-12-22T13:45:02Z

runtime-light/stdlib/zlib/zlib-functions.cpp

+  }
+
+  if (auto err{deflateInit2(stream, level, Z_DEFLATED, encoding, memory, strategy)}; err != Z_OK) {
+    kphp::log::warning("zlib error {}", zError(err));


It's a common pattern here to just print the error number

apolyakov · 2025-12-22T13:45:37Z

runtime-light/stdlib/zlib/zlib-functions.cpp

+
+  if (auto err{deflateInit2(stream, level, Z_DEFLATED, encoding, memory, strategy)}; err != Z_OK) {
+    kphp::log::warning("zlib error {}", zError(err));
+    context.destroy();


Isn't it enough to just wait for C$DeflateContext's destructor to be invoked?

apolyakov · 2025-12-22T13:49:51Z

runtime-light/stdlib/zlib/zlib-functions.cpp

+    context.destroy();
+    return {};
+  }
+  return context;


I don't like that we allocate a class_instance<C$DeflateContext> even in the case of error. Can we create a zstream, try to make deflateInit2 on it, and then somehow move the stream?

Shamzik added 2 commits December 16, 2025 11:50

f$deflate_init

3cfcca5

f$deflate_add & tests

a276c47

Shamzik added this to the next milestone Dec 16, 2025

Shamzik self-assigned this Dec 16, 2025

Shamzik added the k2 k2 related label Dec 16, 2025

format

92ed7c4

Shamzik marked this pull request as ready for review December 16, 2025 11:07

Shamzik requested a review from apolyakov December 16, 2025 11:07

apolyakov requested changes Dec 17, 2025

View reviewed changes

Shamzik added 4 commits December 18, 2025 12:37

noexcept

0034e3b

std::addressof

9ec93d8

brace init

d94ed89

rewrite key comparing

53d5b08

Shamzik requested a review from apolyakov December 18, 2025 10:03

astrophysik reviewed Dec 18, 2025

View reviewed changes

builtin-functions/kphp-light/stdlib/zlib-functions.txt Outdated Show resolved Hide resolved

runtime-light/stdlib/zlib/zlib-functions.cpp Outdated Show resolved Hide resolved

runtime-light/stdlib/zlib/zlib-functions.cpp Outdated Show resolved Hide resolved

Shamzik added 3 commits December 18, 2025 19:17

small fixes

7452dd1

constexpr

9df0e83

move statement to if

a184c56

astrophysik reviewed Dec 19, 2025

View reviewed changes

runtime-light/stdlib/zlib/zlib-functions.cpp Outdated Show resolved Hide resolved

fix message

35588e6

Shamzik requested a review from astrophysik December 19, 2025 11:34

apolyakov requested changes Dec 19, 2025

View reviewed changes

Shamzik added 5 commits December 19, 2025 16:37

fixes

f9e1446

2025

493d261

do not check zlib_dynamic_free arg

252a1e8

move value declaration

c31bb20

constants

81c5ae7

Shamzik requested a review from apolyakov December 19, 2025 14:05

apolyakov reviewed Dec 19, 2025

View reviewed changes

apolyakov reviewed Dec 22, 2025

View reviewed changes


		class_instance<C$DeflateContext> f$deflate_init(int64_t encoding, const array<mixed>& options = {}) noexcept;

		Optional<string> f$deflate_add(const class_instance<C$DeflateContext>& context, const string& data, int64_t flush_type = Z_SYNC_FLUSH) noexcept;

[k2] implement zip functions in light runtime #1486

Are you sure you want to change the base?

[k2] implement zip functions in light runtime #1486

Uh oh!

Conversation

Shamzik commented Dec 16, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

astrophysik left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants