Документация

Обзор

Когда MEX-функция возвращает управление в MATLAB^®, это возвращает результаты своих вычислений в выходных аргументах — mxArray s содержавшийся в аргументах plhs[] левой стороны. Эти массивы должны иметь временный осциллограф, не передавайте массивы, созданные с функцией mexMakeArrayPersistent в plhs. MATLAB уничтожает любой mxArray, созданный MEX-функцией, которая не находится в plhs. MATLAB также освобождает любую память, которая была выделена в MEX-функции с помощью mxCalloc, mxMalloc или функций mxRealloc.

В целом MathWorks^® рекомендует, чтобы MEX-функции уничтожили свои собственные временные массивы и освободили их собственную динамически выделенную память. Более эффективно выполнить эту очистку в исходном файле MEX, чем полагаться на автоматический механизм. Этот подход сопоставим с другими приложениями MATLAB API (Приложения MAT-файла, приложения механизма, и MATLAB Compiler™ сгенерировал приложения, которые не имеют никакого автоматического механизма очистки.)

Однако не уничтожайте mxArray в исходном файле MEX, когда это будет:

В этом разделе описываются ситуации, характерные для управления памятью. Мы рекомендуем, чтобы вы рассмотрели код в своих исходных файлах MEX, чтобы избегать использования этих функций в следующих ситуациях. Для получения дополнительной информации смотрите Автоматическую Очистку Временных массивов и Персистентного mxArrays. Для руководства на проблемах памяти см. Стратегии Эффективного использования Памяти.

Потенциальные проблемы управления памятью включают:

Неправильное уничтожение mxArray

Не используйте mxFree, чтобы уничтожить mxArray.

mxArray *temp = mxCreateDoubleMatrix(1,1,mxREAL);
      ...
mxFree(temp);  /* INCORRECT */

mxDestroyArray(temp);  /* CORRECT */

Неправильно Создавая Ячейку или Структуру mxArray

Не вызывайте mxSetCell или варианты mxSetField с prhs[] как членский массив.

myfunction('hello')
/* myfunction is the name of your MEX file and your code
/* contains the following:    */

    mxArray *temp = mxCreateCellMatrix(1,1);
      ...
    mxSetCell(temp, 0, prhs[0]);  /* INCORRECT */

mxSetCell(temp, 0, mxDuplicateArray(prhs[0]));  /* CORRECT */

Создание Временного mxArray с Неподходящими Данными

Не вызывайте mxDestroyArray на mxArray, данные которого не были выделены стандартной программой API.

mxArray *temp = mxCreateDoubleMatrix(0,0,mxREAL);
double data[5] = {1,2,3,4,5};
      ...
mxSetM(temp,1); mxSetN(temp,5); mxSetDoubles(temp, data); 
/* INCORRECT */

mxArray *temp = mxCreateDoubleMatrix(1,5,mxREAL);
double data[5] = {1,2,3,4,5};
      ...
memcpy(mxGetDoubles(temp), data, 5*sizeof(double)); /* CORRECT */

Создание потенциальных утечек памяти

Перед Версией 5.2, если вы создали mxArray с помощью одной из стандартных программ создания API и затем вы перезаписали указатель на данные с помощью mxSetDoubles, MATLAB все еще освободил исходную память. MATLAB больше не освобождает память.

Например:

pr = mxCalloc(5*5, sizeof(double));
... <load data into pr>
plhs[0] = mxCreateDoubleMatrix(5,5,mxREAL);
mxSetDoubles(plhs[0], pr);  /* INCORRECT */

теперь 5*5*8 байтов утечек памяти, где 8 байтов размер double.

Можно избежать что утечка памяти путем изменения кода на:

plhs[0] = mxCreateDoubleMatrix(5,5,mxREAL);
pr = mxGetDoubles(plhs[0]);
... <load data into pr> 

или альтернативно:

pr = mxCalloc(5*5, sizeof(double));
... <load data into pr>
plhs[0] = mxCreateDoubleMatrix(5,5,mxREAL);
mxFree(mxGetDoubles(plhs[0]));
mxSetDoubles(plhs[0], pr);

Первое решение более эффективно.

Подобные утечки памяти могут также произойти при использовании mxSetDoubles, mxSetComplexDoubles, mxSetIr, mxSetJc или любой из числовых введенных функций доступа к данным. Можно избежать утечек памяти путем изменения кода, как описано в этом разделе.

Неправильное уничтожение структуры

Для структуры необходимо вызвать mxDestroyArray только на структуре, не на полевых массивах данных. Поле в структуре указывает на данные в массиве, используемом mxSetField или mxSetFieldByNumber. Когда mxDestroyArray уничтожает структуру, он пытается пересечь вниз через себя и свободный все другие данные, включая память в массивах данных. Если вы вызываете mxDestroyArray на каждом массиве данных, та же память освобождена дважды, который может повредить память.

mxArray *myDataOne; 
mxArray *myDataTwo; 
mxArray *aStruct; 
const char *fields[] = { "one", "two" }; 
 
myDataOne = mxCreateDoubleScalar(1.0); 
myDataTwo = mxCreateDoubleScalar(2.0); 
 
aStruct = mxCreateStructMatrix(1,1,2,fields); 
mxSetField( aStruct, 0, "one", myDataOne ); 
mxSetField( aStruct, 1, "two", myDataTwo ); 
mxDestroyArray(myDataOne); 
mxDestroyArray(myDataTwo);
mxDestroyArray(aStruct); /* tries to free myDataOne and myDataTwo */

      ...
aStruct = mxCreateStructMatrix(1,1,2,fields); 
mxSetField( aStruct, 0, "one", myDataOne ); 
mxSetField( aStruct, 1, "two", myDataTwo ); 
mxDestroyArray(aStruct); 

Уничтожение памяти в деструкторе класса C++

Не используйте mxFree или функции mxDestroyArray в деструкторе C++ класса, используемого в MEX-функции. Если MEX-функция выдает ошибку, MATLAB очищает переменные файла MEX, как описано в Автоматической Очистке Временных массивов.

Если ошибка происходит, который вызывает объект выйти из осциллографа, MATLAB вызывает деструктор C++. Освобождение памяти непосредственно в деструкторе означает, что и MATLAB и деструктор освобождают ту же память, которая может повредить память.