memory footprint for ftpClient

[erwinschrodinger1]

hey @nopnop2002. while tracking the memory for ftpclient it should tentatively take 4096 (for crtl buf) + 1024 (for response buffer) + 4096 (if ascii - but what is the requirement for this in case of ASCII?

esp-idf-ftpClient/components/ftpClient/FtpClient.c

Lines 501 to 508 in 1ca7034

	if ((mode == 'A') && ((ctrl->buf = malloc(FTP_CLIENT_BUFFER_SIZE)) == NULL)) {
	#if FTP_CLIENT_DEBUG
	perror("FTP Client openPort: malloc ctrl->buf");
	#endif
	closesocket(sData);
	free(ctrl);
	return -1;
	}

I am happy to contribute on creating a memory footprint docs. Can you please help me figure it out?

[nopnop2002]

what is the requirement for this in case of ASCII?

I can't understand your question.
ASCII is ftp ASCII mode.

4096 (for crtl buf) + 1024 (for response buffer) + 4096 (if ascii - but what is the requirement for this in case of ASCII?

This is Not current.
4096 (for crtl buf) + 1024 (for response buffer)

[erwinschrodinger1]

Why should we malloc 4096 bytes for crt->buf in ascii mode and not in binary mode?

[nopnop2002]

crt->buf is reserved in BINARY mode too.

$ grep -rn "ctrl->buf" *
FtpClient.c:505:        if ((mode == 'A') && ((ctrl->buf = malloc(FTP_CLIENT_BUFFER_SIZE)) == NULL)) {
FtpClient.c:507:                perror("FTP Client openPort: malloc ctrl->buf");
FtpClient.c:846:        ctrl->buf = malloc(FTP_CLIENT_BUFFER_SIZE);
FtpClient.c:847:        if (ctrl->buf == NULL) {
FtpClient.c:849:                perror("FTP Client Error: Connect, malloc ctrl->buf");
FtpClient.c:868:                free(ctrl->buf);

[erwinschrodinger1]

got it. But why is there a if condition for only ASCII mode in static int openPort(NetBuf_t* nControl, NetBuf_t** nData, int mode, int dir)
FtpClient.c:505?

Also currenly my system is taking around >11kb of heap and >4k words of stack. How should I track the memory in detail?

[nopnop2002]

We may not need this code.

#if 0
    if ((mode == 'A') && ((ctrl->buf = malloc(FTP_CLIENT_BUFFER_SIZE)) == NULL)) {
        #if FTP_CLIENT_DEBUG
        perror("FTP Client openPort: malloc ctrl->buf");
        #endif
        closesocket(sData);
        free(ctrl);
        return -1;
    }
#endif

ctrl->buf is the area for sending commands, BUT is allocated here as static.

https://github.com/nopnop2002/esp-idf-ftpClient/blob/master/components/ftpClient/FtpClient.c#L288

[erwinschrodinger1]

So this results in memory leak right of BUFF_SIZE?
Cause we are malloc ing the value again in connect too resulting in unused memory?

[nopnop2002]

No, the memory is freed here.

https://github.com/nopnop2002/esp-idf-ftpClient/blob/master/components/ftpClient/FtpClient.c#L1329-L1334

[erwinschrodinger1]

ctrl->buf is the area for sending commands, and is allocated here.

esp-idf-ftpClient/components/ftpClient/FtpClient.c

Line 288 in 1ca7034

char buf[FTP_CLIENT_TEMP_BUFFER_SIZE];

If ctrl->buf is only required for sending commands. Why are we are malloc ing it in here too?

esp-idf-ftpClient/components/ftpClient/FtpClient.c

Line 842 in 1ca7034

ctrl->buf = malloc(FTP_CLIENT_BUFFER_SIZE);

[nopnop2002]

ctrl->buf is used by readLine() and writeLine() when in ASCII mode.

readLine() is called from readFtpClient().
writeLine() is called from writeFtpClient().

These functions perform operations specific to ASCII mode.

[nopnop2002]

I checked for memory leaks using 1000 Put/Gets.
No memory leaks.

    uint32_t startHeap = esp_get_free_heap_size();
    for (int i=0;i<1000;i++) {
    // Put file to FTP server
    ftpClient->ftpClientPut(srcFileName, dstFileName, FTP_CLIENT_TEXT, ftpClientNetBuf);
    ESP_LOGI(TAG, "ftpClientPut %s ---> %s", srcFileName, dstFileName);

    // Delete file
    unlink(srcFileName);
    ESP_LOGI(TAG, "Deleted %s", srcFileName);

    // Get file from FTP server
    ftpClient->ftpClientGet(srcFileName, dstFileName, FTP_CLIENT_TEXT, ftpClientNetBuf);
    ESP_LOGI(TAG, "ftpClientGet %s <--- %s", srcFileName, dstFileName);

    // Open file for reading
    ESP_LOGI(TAG, "Open %s", srcFileName);
    f = fopen(srcFileName, "r");
    if (f == NULL) {
        ESP_LOGE(TAG, "Failed to open file for reading");
        return;
    }
    fgets(line, sizeof(line), f);
    fclose(f);
    // strip newline
    char* pos = strchr(line, '\n');
    if (pos) {
        *pos = '\0';
    }
    ESP_LOGI(TAG, "Read from %s: '%s'", srcFileName, line);

    uint32_t nowHeap = esp_get_free_heap_size();
    ESP_LOGI(TAG, "i=%d startHeap=%"PRIu32" nowHeap=%"PRIu32, i, startHeap, nowHeap);
    vTaskDelay(50);
    }
    uint32_t endHeap = esp_get_free_heap_size();
    ESP_LOGI(TAG, "startHeap=%"PRIu32" endHeap=%"PRIi32, startHeap, endHeap);