Memory Leak

[dfmarulanda]

I'm getting around 500MB of memory leak with this lib.

[yeatse]

Hello @dfmarulanda , I'm sorry to hear this. But I can't reproduce it in my own project (using KingfisherWebP 0.5.0, Kingfisher 5.5.0, libwebp 1.0.2 & Xcode 10.2). After double checking the implementation of WebPImageCreateWithData I also can't find the line which may cause this memory leak.
Would you mind sharing your code or a demo project to reproduce it? 😅

[dfmarulanda]

This is my code.
KingFisherSource is an array of Kingfisher Images. Every CELL have a ImageSlideShow with more than 1 picture.

  viewModel.imageURL.map { itemImages in
      let processor = WebPProcessor.default
      let inputs: [KingfisherSource] = itemImages.compactMap({ return KingfisherSource(url: URL(string:$0!)!, options: [.transition(.fade(0.33)), .processor(processor), .cacheSerializer(WebPSerializer.default), .scaleFactor(UIScreen.main.scale)]) })
      return inputs }
      .observeOn(MainScheduler.instance)
      .subscribe(onNext: { [unowned self] inputs in
        self.itemSlideShow.setImageInputs(inputs)
      }).disposed(by: disposeBag)

[yeatse]

I'm guessing you are using ImageSlideshow, right? I set up a demo project with ImageSlideshow, but still couldn't reproduce this issue.
Your screenshot just shows that KingfisherWebP allocates memory, but not leaks memory, so I assume it should not be a KingfisherWebP issue. Maybe it's designed feature relating to memory cache in Kingfisher itself.
You can add this line in your ImageSlideshow view controller to see whether the "memory leak" still happen:

override func viewDidDisappear(_ animated: Bool) {
    KingfisherManager.shared.cache.clearMemoryCache()
}

[dfmarulanda]

I changed everything from WebP to JPG and remove the library, and i have no leaks right now.
I'll try to cleanMemoryCache.

[yeatse]

Hello, have you tried the clearMemoryCache method? Did it fix this memory problem?

[Out1and3r]

I experience exactly same issue. Massive memory leaks but no issues with JPG and default Kingfisher processors.

[duyhungtnn]

Hello, have you tried the clearMemoryCache method? Did it fix this memory problem?

I experience exactly same issue , try clearMemoryCache but no hope :( , app quickly crash by the system because use too much memory.

[WangKunKun]

我也遇到了 内存暴涨的问题··· 请问你是怎么解决的?

Hello, have you tried the clearMemoryCache method? Did it fix this memory problem?

I experience exactly same issue , try clearMemoryCache but no hope :( , app quickly crash by the system because use too much memory.

[yeatse]

Hi @duyhungtnn @WangKunKun @Out1and3r , I'm investigating this problem now, but cannot reproduce it myself currently. In order to make sure it's not the cache feature in Kingfisher itself, would you mind trying these methods in your projects?

// Limit memory cache size to 20 MB.
cache.memoryStorage.config.totalCostLimit = 20 * 1024 * 1024

// Limit memory cache to hold 50 images at most. 
cache.memoryStorage.config.countLimit = 50

The code above is taken from Kingfisher Cheat-Sheet, please let me know whether it works or not. Thank you all 🥺

[ZackZheng2014]

It happened to me at Animated WebP list when I load more items .

[ZackZheng2014]

It happened to me at Animated WebP list when I load more items .

it's fine now and memory used return to normal since I changed all webp url to gif.

[duyhungtnn]

@zhangzhifangi no , after many hour to try :(

…

On Wed, Jul 8, 2020 at 3:42 PM zhangzhifangi ***@***.***> wrote: Hello, did the latest version solve this problem of memory explosion — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#25 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAT2GTSVZFS3A7W4OQ5WSPTR2QWNNANCNFSM4HOF7Q5A> .

-- *Phạm Duy Hưng* iOS Lead Engineer +84 9 7467-5965 | https://umbala.tv/ | [email protected] | North Sunrise City, 27 Nguyen Huu Tho <https://maps.google.com/?q=27+Nguyen+Huu+Tho&entry=gmail&source=g>, D7, HCM City

[tanis2000]

I'm experiencing the same issue where memory is being allocated and then it's never freed.

I'm attaching a screenshot of instruments for you to have a look at... the version of the library is 1.1.0 (the latest at the time I'm writing this)

[tanis2000]

I believe the leak is mostly caused by the following allocation:

void *bufCopy = malloc(bufSize);

It is this line: https://github.com/Yeatse/KingfisherWebP/blob/7f5e0f5eb0e799e09d6850a0da85ace97f8d9a74/KingfisherWebP/Classes/CGImage%2BWebP.m#L260

I can't see this memory being deallocated anywhere. @yeatse when can we free this buffer?

[yeatse]

I believe the leak is mostly caused by the following allocation:

void *bufCopy = malloc(bufSize);

It is this line:

https://github.com/Yeatse/KingfisherWebP/blob/7f5e0f5eb0e799e09d6850a0da85ace97f8d9a74/KingfisherWebP/Classes/CGImage%2BWebP.m#L260

I can't see this memory being deallocated anywhere. @yeatse when can we free this buffer?

Thanks for pointing it out. The memory pointed by bufCopy is transferred to CGDataProvider by CGDataProviderCreateWithData, and will be freed in WebPFreeInfoReleaseDataCallback when the CGDataProvider deallocates. CGDataProvider's lifecycle is bounded to the result image, so when the image releases, everything is freed.

You can test it yourself by forcing Kingfisher not to cache any image using .forceRefresh option:

KingfisherManager.shared.defaultOptions += [.forceRefresh]

[tanis2000]

Thanks for the explanation. I didn’t see that callback.
in my case it looks like the real issue is with the cache storing huge images. I don’t know where they came from but I disabled storing the original and I’m only saving the webp images which are all well under 500kb. But the other images were allocating about 200-300Mb each. Put them in a collection view and everything is going to crash and burn

[LOVEY9527]

内存暴增是由于缓存了解析的每一帧图，目的是降低CPU的消耗

所以即使设置KingfisherManager缓存上限也是没用的
#25 (comment)

简单的做法就是设置frameCache缓存上限，并且缓存处理过的每一帧图

[yeatse]

内存暴增是由于缓存了解析的每一帧图，目的是降低CPU的消耗 所以即使设置KingfisherManager缓存上限也是没用的 #25 (comment) 简单的做法就是设置frameCache缓存上限，并且缓存处理过的每一帧图

NSCache 本身会在收到 memory warning 的时候清理资源所以感觉还好，不加的话在某些场景会非常卡。后面我可以提供个开关配置下。