Conflicts with php8.4-ds

[CharlemagneLasse]

I wanted to use scylladb-php-driver with PHP 8.4. But after installing the driver, suddenly other parts of my code broken. Here is a minimal reproducer:

<?php
$set = new \Ds\Set();

No output is expected. But with scylladb-php-driver installed, I get:

PHP Fatal error:  Uncaught ArgumentCountError: Ds\Set::__construct() expects exactly 1 argument, 0 given in Standard input code:2
Stack trace:
#0 Standard input code(2): Ds\Set->__construct()
#1 {main}
  thrown in Standard input code on line 2

I only found out that this is caused by scylladb-php-driver because with the modified code:

<?php
$set = new \Ds\Set([]);

I get:

PHP Warning:  Array to string conversion in Standard input code on line 2
PHP Fatal error:  Uncaught Cassandra\Exception\InvalidArgumentException: type must be a string or an instance of Cassandra\Type, Array given in Standard input code:2
Stack trace:
#0 Standard input code(2): Ds\Set->__construct()
#1 {main}
  thrown in Standard input code on line 2

This caused me to uninstall scylladb-php-driver. And as mentioned earlier, then I had no problems whatsoever with running these two reproducers.

[CharlemagneLasse]

Just removing following doesn't help:

--- a/src/php_driver.cpp
+++ b/src/php_driver.cpp
@@ -478,7 +478,7 @@ PHP_MINIT_FUNCTION(php_driver) {
   php_driver_define_Custom();
   php_driver_define_Duration();
 
-  php_driver_define_Set();
+  //php_driver_define_Set();
   php_driver_define_Map();
   php_driver_define_Collection();
   php_driver_define_Tuple();
@@ -525,7 +525,7 @@ PHP_MINIT_FUNCTION(php_driver) {
   php_driver_define_Type();
   php_driver_define_TypeScalar();
   php_driver_define_TypeCollection();
-  php_driver_define_TypeSet();
+  //php_driver_define_TypeSet();
   php_driver_define_TypeMap();
   php_driver_define_TypeTuple();
   php_driver_define_TypeUserType();

But removing:

/* {{{ Set::__construct(type) */
PHP_METHOD(Set, __construct)
{
  php_driver_set* self;
  zval* type;

  if (zend_parse_parameters(ZEND_NUM_ARGS() , "z", &type) == FAILURE)
    return;

  self = PHP_DRIVER_GET_SET(getThis());

  if (Z_TYPE_P(type) == IS_STRING) {
    CassValueType value_type;
    if (!php_driver_value_type(Z_STRVAL_P(type), &value_type ))
      return;
    self->type = php_driver_type_set_from_value_type(value_type );
  } else if (Z_TYPE_P(type) == IS_OBJECT && instanceof_function(Z_OBJCE_P(type), php_driver_type_ce )) {
    if (!php_driver_type_validate(type, "type" )) {
      return;
    }
    self->type = php_driver_type_set(type );
    Z_ADDREF_P(type);
  } else {
    INVALID_ARGUMENT(type, "a string or an instance of " PHP_DRIVER_NAMESPACE "\\Type");
  }
}
/* }}} */

Fixes this problem (but I must at the same time also remove basically everything below this block - but removing this is the first thing which makes everything work again. So, removing everything below this block will NOT fix it by itself)

[CharlemagneLasse]

The smallest change I could use to get it to work was:

--- a/src/Set.cpp
+++ b/src/Set.cpp
@@ -116,34 +116,6 @@ php_driver_set_populate(php_driver_set* set, zval* array )
   }
 }
 
-/* {{{ Set::__construct(type) */
-PHP_METHOD(Set, __construct)
-{
-  php_driver_set* self;
-  zval* type;
-
-  if (zend_parse_parameters(ZEND_NUM_ARGS() , "z", &type) == FAILURE)
-    return;
-
-  self = PHP_DRIVER_GET_SET(getThis());
-
-  if (Z_TYPE_P(type) == IS_STRING) {
-    CassValueType value_type;
-    if (!php_driver_value_type(Z_STRVAL_P(type), &value_type ))
-      return;
-    self->type = php_driver_type_set_from_value_type(value_type );
-  } else if (Z_TYPE_P(type) == IS_OBJECT && instanceof_function(Z_OBJCE_P(type), php_driver_type_ce )) {
-    if (!php_driver_type_validate(type, "type" )) {
-      return;
-    }
-    self->type = php_driver_type_set(type );
-    Z_ADDREF_P(type);
-  } else {
-    INVALID_ARGUMENT(type, "a string or an instance of " PHP_DRIVER_NAMESPACE "\\Type");
-  }
-}
-/* }}} */
-
 /* {{{ Set::type() */
 PHP_METHOD(Set, type)
 {
@@ -299,7 +271,6 @@ ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_INFO_EX(arginfo_count, 0, 0, IS_LONG,
 ZEND_END_ARG_INFO()
 
 static zend_function_entry php_driver_set_methods[] = {
-  PHP_ME(Set, __construct, arginfo__construct, ZEND_ACC_CTOR | ZEND_ACC_PUBLIC)
     PHP_ME(Set, type, arginfo_none, ZEND_ACC_PUBLIC)
       PHP_ME(Set, values, arginfo_none, ZEND_ACC_PUBLIC)
         PHP_ME(Set, add, arginfo_one, ZEND_ACC_PUBLIC)

But I would guess that there is a lot better way to get it to work.

One thing I've noticed was the conflicting symbols between ds and scylladb-driver:

$ objdump -T /usr/lib/php/20240924/ds.so|grep construct|grep -i Set
0000000000021c30 g    DF .text  0000000000000072  Base        zim_Set___construct


$ objdump -T /usr/lib/php/20240924/cassandra.so|grep construct|grep -i Set
0000000000033a40 g    DF .text  000000000000013a  Base        zim_Set___construct
0000000000026ecc g    DF .text  000000000000001a  Base        zim_TypeSet___construct

[CharlemagneLasse]

I could find following conflicting symbols:

zim_Map___construct
zim_Map_count
zim_Map_get
zim_Map_keys
zim_Map_offsetExists
zim_Map_offsetGet
zim_Map_offsetSet
zim_Map_offsetUnset
zim_Map_remove
zim_Map_values
zim_Set_add
zim_Set___construct
zim_Set_count
zim_Set_remove
```

[CharlemagneLasse]

The easiest way to fix it for me was to switch to hidden symbols and only export get_module (see #119 to understand why this is not 100% true):

diff --git i/cmake/TargetOptimizations.cmake w/cmake/TargetOptimizations.cmake
index 84144e92..b974b88e 100644
--- i/cmake/TargetOptimizations.cmake
+++ w/cmake/TargetOptimizations.cmake
@@ -29,6 +29,8 @@ function(scylladb_php_library target enable_sanitizers cpu_type lto)
     target_compile_options(
             ${target}
             PRIVATE
+            -fvisibility=hidden
+            -fvisibility-inlines-hidden
             -fPIC
             -Wall
             -Wextra