Утечка памяти из расширения, созданного SWIG - PullRequest
Новая
       31

Утечка памяти из расширения, созданного SWIG

2 голосов
/ 03 августа 2010

У меня проблема с утечкой памяти, оборачивая библиотеку C ++ в PHP с помощью SWIG.Похоже, это происходит, когда обратные вызовы из C ++, содержащие сложные типы, отправляются в PHP, когда включены директоры.Вот отдельный пример для воспроизведения утечки:

Client.hpp: 

#ifndef CLIENT_HPP_
#define CLIENT_HPP_

#include <vector>
#include "ProcedureCallback.hpp"

class Client {
public:
    void invoke(ProcedureCallback *callback) {
        callback->callback(std::vector<int>(0));
    }
};

#endif /* CLIENT_HPP_ */

PracticeCallback.hpp: 

#ifndef PROCEDURECALLBACK_HPP_
#define PROCEDURECALLBACK_HPP_

#include <vector>

class ProcedureCallback {
public:
    virtual void callback(std::vector<int>) = 0;
};

#endif /* PROCEDURECALLBACK_HPP_ */

Поэтому, чтобы использовать это, вы создаетеClient, передайте подкласс ProcedureCallback методу Клиента invoke, и затем Клиент отправляется и вызывает метод callback того, что вы ему дали, и передает пустой вектор int.

ЭтоФайл интерфейса SWIG: 

%module(directors="1") debugasync
%feature("director");

%{
#include "Client.hpp"
#include "ProcedureCallback.hpp"
%}

%include "Client.hpp"
%include "ProcedureCallback.hpp"

Его вывод очень велик, поэтому вместо него я поставил его на pastebin: debugasync_wrap.cpp .Интерес к этому файлу, вероятно, представляет SwigDirector_ProcedureCallback :: callback (строка 1319): 

void SwigDirector_ProcedureCallback::callback(std::vector< int > arg0) {
  zval *args[1];
  zval *result, funcname;
  MAKE_STD_ZVAL(result);
  ZVAL_STRING(&funcname, (char *)"callback", 0);
  if (!swig_self) {
    SWIG_PHP_Error(E_ERROR, "this pointer is NULL");
  }

  zval obj0;
  args[0] = &obj0;
  {
    SWIG_SetPointerZval(&obj0, SWIG_as_voidptr(&arg0), SWIGTYPE_p_std__vectorT_int_t, 2);
  }
  call_user_function(EG(function_table), (zval**)&swig_self, &funcname,
    result, 1, args TSRMLS_CC);
  FREE_ZVAL(result);
  return;
fail:
  zend_error(SWIG_ErrorCode(),"%s",SWIG_ErrorMsg());
}

Это также может представлять интерес (строка 827): 

static void
SWIG_ZTS_SetPointerZval(zval *z, void *ptr, swig_type_info *type, int newobject TSRMLS_DC) {
  swig_object_wrapper *value=NULL;
  /*
   * First test for Null pointers.  Return those as PHP native NULL
   */
  if (!ptr ) {
    ZVAL_NULL(z);
    return;
  }
  if (type->clientdata) {
    if (! (*(int *)(type->clientdata)))
      zend_error(E_ERROR, "Type: %s failed to register with zend",type->name);
    value=(swig_object_wrapper *)emalloc(sizeof(swig_object_wrapper));
    value->ptr=ptr;
    value->newobject=newobject;
    if (newobject <= 1) {
      /* Just register the pointer as a resource. */
      ZEND_REGISTER_RESOURCE(z, value, *(int *)(type->clientdata));
    } else {
      /*
       * Wrap the resource in an object, the resource will be accessible
       * via the "_cPtr" member. This is currently only used by
       * directorin typemaps.
       */
      value->newobject = 0;
      zval *resource;
      MAKE_STD_ZVAL(resource);
      ZEND_REGISTER_RESOURCE(resource, value, *(int *)(type->clientdata));
      zend_class_entry **ce = NULL;
      zval *classname;
      MAKE_STD_ZVAL(classname);
      /* _p_Foo -> Foo */
      ZVAL_STRING(classname, (char*)type->name+3, 1);
      /* class names are stored in lowercase */
      php_strtolower(Z_STRVAL_PP(&classname), Z_STRLEN_PP(&classname));
      if (zend_lookup_class(Z_STRVAL_P(classname), Z_STRLEN_P(classname), &ce TSRMLS_CC) != SUCCESS) {
        /* class does not exist */
        object_init(z);
      } else {
        object_init_ex(z, *ce);
      }
      Z_SET_REFCOUNT_P(z, 1);
      Z_SET_ISREF_P(z);
      zend_hash_update(HASH_OF(z), (char*)"_cPtr", sizeof("_cPtr"), (void*)&resource, sizeof(zval), NULL);
      FREE_ZVAL(classname);
    }
    return;
  }
  zend_error(E_ERROR, "Type: %s not registered with zend",type->name);
}

И для демонстрации памятиутечка в PHP ( debugasync.php - это набор прокси-классов, сгенерированных SWIG, которые я также загрузил в pastebin): 

<?php

require('debugasync.php');

class MyCallback extends ProcedureCallback {
    public function callback($intVector) {}
}

$client = new Client();
$callback = new MyCallback();

while (true) {
    print(number_format(memory_get_usage()) . "\n");
    for ($j = 0; $j < 1000; $j++) {
        $client->invoke($callback);
    }
}

Это печатает использование памяти, выполняет вызовы 1k иповторяется.Его запуск показывает быстро растущее пространство памяти: 

$ php test.php 
692,664
1,605,488
2,583,232
3,634,776
4,538,784
5,737,760
6,641,768
7,545,816
^C

Также следует отметить, что если обратный вызов C ++ передает примитив (например, int) вместо сложного типа (например, std::vector<int>),нет утечки памяти.

В чем причина этой утечки памяти?

И вообще, какие инструменты я могу использовать, чтобы решить эту проблему?Массив Valgrind не смог сузить происходящее даже после сборки PHP с отладочными символами.

1 Ответ

2 голосов
/ 03 августа 2010

Я ничего не знаю конкретно о SWIG, но если об использовании памяти сообщается memory_get_usage, то занятая память выделяется диспетчером памяти Zend Engine.

Когда скрипт завершит clean (без CTRL + C или die), менеджер памяти сообщит вам об обнаруженных утечках памяти, если:

  • PHP скомпилирован в режиме отладки (--enable-debug)
  • В вашем файле php.ini есть report_memleaks = true

Это скажет вам, где была выделена память, которая не была освобождена.

Тем не менее, в вашем фрагменте нет ничего особенно смешного; единственная переменная, не относящаяся к стеку, корректно утилизируется.

...