Hello Henning,

Thank you for your quick response !

I do not have any error messages.

Shared memory allocation and freeing is done exclusively by the RPC process. The workers only read that memory (and only the memory that is *not* being allocated or freed by the RPC process).

I've looked at the different shared memory managers as you suggested. First, « tlsf » does not work : Kamailio crashes on startup with « -x tlsf ».

A comparison of « qm » (default) and « fm » :

With « fm », the loading time is reduced by 25%. The freeing is also much faster (maybe 4 times faster). And I do not notice the performances issues (that I can reproduce when using « qm »). But maybe this is because I do not have enough data on my test environment. I'll have to test this with the real data.

But these first results with « fm » look promising ! :)

Could you maybe explain to me the main differences between the 3 shared memory managers ? and why is « qm » the default ? Also, do you have an idea why « tlsf » makes Kamailio crash ? (does anyone use « tlsf » ?)

Thanks again.

Regards, Nicolas.

De : Henning Westerholt hw@gilawa.com Envoyé : jeudi 19 janvier 2023 08:28 À : Kamailio (SER) - Users Mailing List Cc : Chaigneau, Nicolas; sr-dev@lists.kamailio.org Objet : RE: Performances issue when freeing shared memory in custom module (Kamailio 5.5.2)

This mail has been sent from an external source Hello,

(Adding sr-dev to CC)

This looks indeed a bit strange. Do you get any error messages in the log? In which process you are freeing the memory, one of the worker processes or the RPC process?

You could also try to use another memory manager to see if you get better performance. There is a command line parameter to choose one during startup.

Cheers,

Henning

-- Henning Westerholt - https://skalatan.de/blog/ Kamailio services - https://gilawa.comhttps://gilawa.com/

From: Chaigneau, Nicolas <nicolas.chaigneau@capgemini.commailto:nicolas.chaigneau@capgemini.com> Sent: Wednesday, January 18, 2023 6:49 PM To: Kamailio (SER) - Users Mailing List <sr-users@lists.kamailio.orgmailto:sr-users@lists.kamailio.org> Subject: [SR-Users] Performances issue when freeing shared memory in custom module (Kamailio 5.5.2)

Hello,

I'm encountering performance issues with Kamailio (5.5.2).

I'm using a custom Kamailio module that loads routing data in memory, using Kamailio shared memory. This routing data is very large. It can be fully reloaded through a Kamailio RPC command (which is done once each day).

When reloading, two sets of data are maintained, one "loading" and another "current" (the latter being used to handle SIP requests). When loading of the new data is finished, it is swapped to "current". Then, memory of the old (now unused) data is freed.

I've noticed that when Kamailio is freeing the old data, there is a very significant performance impact on SIP requests. This is surprising to me, because the SIP requests do not use this old data. This is not a CPU issue, idle CPU% is at about 99% at that moment.

I'm using the following functions : - shm_mallocxz - shm_free

From what I understand, shm_free is actually "qm_shm_free" defined in "src\core\mem\q_malloc.c" (the default shared memory manager being "qm"). I've noticed that there is also a variant shm_free_unsafe ("qm_free"), which does not perform locking.

I'm wondering if the lock could be the cause of my performances issues ? (But I'm not sure how this could be possible, because although the SIP requests need to access the shared memory allocated, they do not use directly the functions from the share memory manager.)

If the performances issues are causes by the lock, could I use the unsafe version "safely" ? (considering that it is guaranteed that the old data cannot be used by anyone else)

Thanks for your help.

Regards, Nicolas. This message contains information that may be privileged or confidential and is the property of the Capgemini Group. It is intended only for the person to whom it is addressed. If you are not the intended recipient, you are not authorized to read, print, retain, copy, disseminate, distribute, or use this message or any part thereof. If you receive this message in error, please notify the sender immediately and delete all copies of this message.

Hello Nicolas,

some people are using the TLSF memory manager, so it should certainly not crash. Maybe you could create an issue about it if you got a backtrace and its not related to your (custom) module.

The QM memory manager is providing more debugging information and can be also used to find memory leaks and such. Therefore, its enabled by default, as most people are not using huge data sets internally.

The FM memory manager is more lightweight, and in your scenario apparently significant faster. Let us know if it's also working fine in the production setup.

Cheers,

Henning

-- Henning Westerholt - https://skalatan.de/blog/ Kamailio services - https://gilawa.comhttps://gilawa.com/

From: Chaigneau, Nicolas nicolas.chaigneau@capgemini.com Sent: Thursday, January 19, 2023 12:47 PM To: Henning Westerholt hw@gilawa.com; Kamailio (SER) - Users Mailing List sr-users@lists.kamailio.org Cc: sr-dev@lists.kamailio.org Subject: RE: Performances issue when freeing shared memory in custom module (Kamailio 5.5.2)

[mail resent because I was not subscribed to sr-dev - sorry for the duplicate]

Hello Henning,

Thank you for your quick response !

I do not have any error messages.

Shared memory allocation and freeing is done exclusively by the RPC process. The workers only read that memory (and only the memory that is *not* being allocated or freed by the RPC process).

I've looked at the different shared memory managers as you suggested. First, « tlsf » does not work : Kamailio crashes on startup with « -x tlsf ».

A comparison of « qm » (default) and « fm » :

With « fm », the loading time is reduced by 25%. The freeing is also much faster (maybe 4 times faster). And I do not notice the performances issues (that I can reproduce when using « qm »). But maybe this is because I do not have enough data on my test environment. I'll have to test this with the real data.

But these first results with « fm » look promising ! :)

Could you maybe explain to me the main differences between the 3 shared memory managers ? and why is « qm » the default ? Also, do you have an idea why « tlsf » makes Kamailio crash ? (does anyone use « tlsf » ?)

Thanks again.

Regards, Nicolas.

De : Henning Westerholt <hw@gilawa.commailto:hw@gilawa.com> Envoyé : jeudi 19 janvier 2023 08:28 À : Kamailio (SER) - Users Mailing List Cc : Chaigneau, Nicolas; sr-dev@lists.kamailio.orgmailto:sr-dev@lists.kamailio.org Objet : RE: Performances issue when freeing shared memory in custom module (Kamailio 5.5.2)

This mail has been sent from an external source Hello,

(Adding sr-dev to CC)

This looks indeed a bit strange. Do you get any error messages in the log? In which process you are freeing the memory, one of the worker processes or the RPC process?

You could also try to use another memory manager to see if you get better performance. There is a command line parameter to choose one during startup.

Cheers,

Henning

-- Henning Westerholt - https://skalatan.de/blog/ Kamailio services - https://gilawa.comhttps://gilawa.com/

From: Chaigneau, Nicolas <nicolas.chaigneau@capgemini.commailto:nicolas.chaigneau@capgemini.com> Sent: Wednesday, January 18, 2023 6:49 PM To: Kamailio (SER) - Users Mailing List <sr-users@lists.kamailio.orgmailto:sr-users@lists.kamailio.org> Subject: [SR-Users] Performances issue when freeing shared memory in custom module (Kamailio 5.5.2)

Hello,

I'm encountering performance issues with Kamailio (5.5.2).

I'm using a custom Kamailio module that loads routing data in memory, using Kamailio shared memory. This routing data is very large. It can be fully reloaded through a Kamailio RPC command (which is done once each day).

When reloading, two sets of data are maintained, one "loading" and another "current" (the latter being used to handle SIP requests). When loading of the new data is finished, it is swapped to "current". Then, memory of the old (now unused) data is freed.

I've noticed that when Kamailio is freeing the old data, there is a very significant performance impact on SIP requests. This is surprising to me, because the SIP requests do not use this old data. This is not a CPU issue, idle CPU% is at about 99% at that moment.

I'm using the following functions : - shm_mallocxz - shm_free

From what I understand, shm_free is actually "qm_shm_free" defined in "src\core\mem\q_malloc.c" (the default shared memory manager being "qm"). I've noticed that there is also a variant shm_free_unsafe ("qm_free"), which does not perform locking.

I'm wondering if the lock could be the cause of my performances issues ? (But I'm not sure how this could be possible, because although the SIP requests need to access the shared memory allocated, they do not use directly the functions from the share memory manager.)

If the performances issues are causes by the lock, could I use the unsafe version "safely" ? (considering that it is guaranteed that the old data cannot be used by anyone else)

Thanks for your help.

Regards, Nicolas. This message contains information that may be privileged or confidential and is the property of the Capgemini Group. It is intended only for the person to whom it is addressed. If you are not the intended recipient, you are not authorized to read, print, retain, copy, disseminate, distribute, or use this message or any part thereof. If you receive this message in error, please notify the sender immediately and delete all copies of this message.

Hello,

I've pushed my investigations further, and now I understand a bit better what's going on. The following applies to the two memory managers « qm » and « fm ».

In its simplest form, what I'm doing is the following :

alloc_new_data(); free_old_data();

After this, I'm looking at :

1. Kamailio available shared memory (as returned by function « shm_available »). 2. My module shared memory usage (as shown by command « kamcmd mod.stats my_module shm »).

What I'm observing is that Kamailio available shared memory is steadily decreasing (but not systematically after each execution), and that my module shared memory usage is, conversely, steadily increasing. (My fear is, of course, that at some point the allocation will fail because the available shared memory would be exhausted.)

I notice from the reports of « mod.stats » that Kamailio seems to keep track of the exact function and line number where an allocation occured. Maybe, as long as such a reference exists, the shared memory is not properly recovered ? (even though it is properly freed using shm_free).

To test this theory, I temporarily changed the code to :

free_old_data(); alloc_new_data();

With this all my issues disappear. The available shared memory is stable, as well as the module shared memory usage reported.

This is really weird. Is it how Kamailio shared memory is supposed to work ? How could I solve this issue ?

Regards, Nicolas.

De : Chaigneau, Nicolas Envoyé : vendredi 20 janvier 2023 15:28 À : Henning Westerholt; sr-dev@lists.kamailio.org Cc : Kamailio (SER) - Users Mailing List Objet : RE: issues when freeing shared memory in custom module (Kamailio 5.5.2) - available shared memory

Hello Henning,

Thanks for your help. :) I'm coming with an update, and yet more questions.

First, I tried using « fm » instead of « qm » on real data. The results are impressive :

* Allocation time is reduced from 85 s to 49 s * Free time is reduced from 77 s to about 2 s * And I do not notice SIP high response times when freeing

The time difference when freeing is huge. I'm surprised that this is so much faster than « qm », this is just because we don't have the same debugging information ?

Now, another issue I'm looking into (possible memory leak ?). This happens with both memory managers, « qm » and « fm ».

I'm using « shm_available » function from Kamailio to keep track of the remaining available memory in the shared memory pool. I've noticed something weird. At first I thought that I had a memory leak in my code, but I'm not so sure anymore...

Each time I reload the (same) data (through a RPC command), the value of shm_available is decreasing. This happens if I load new data before freeing the old data. However, if I first free the existing data, then load the new data, the memory available shown by shm_available seems to be properly « reset ».

For example :

Remaining memory available: 758960224 # <- allocate new Remaining memory available: 756141328 # <- allocate new, then free old Remaining memory available: 752037032 # <- allocate new, then free old Remaining memory available: 749523176 # <- allocate new, then free old

Remaining memory available: 1073094936 # <- free Remaining memory available: 758958544 # <- allocate new Remaining memory available: 756143304 # <- allocate new, then free old Remaining memory available: 752067480 # <- allocate new, then free old Remaining memory available: 749532680 # <- allocate new, then free old

And so on... This is for the same exact data used each time.

I've also tried to use the following command to track memory :

kamcmd mod.stats my_module shm

The results seem consistent with what shm_available reports : the memory used seem to increase for each allocation being tracked, even though the memory is properly freed (or should be : shm_free is called as needed). Apparently the values are only reset when the free is performed before the new allocation.

It is as if the memory being tracked is not properly « cleaned up » until everything has been freed...

I'm not sure what this entails : is the memory really not properly released ? or is it just a reporting issue ?

One more thing, I think there might be a bug with the command « kamcmd mod.stats my_module shm » : it can display negative values. Maybe there's an integer overflow ?

Regards, Nicolas.

De : Henning Westerholt <hw@gilawa.commailto:hw@gilawa.com> Envoyé : jeudi 19 janvier 2023 15:43 À : Chaigneau, Nicolas; sr-dev@lists.kamailio.orgmailto:sr-dev@lists.kamailio.org Cc : Kamailio (SER) - Users Mailing List Objet : RE: Performances issue when freeing shared memory in custom module (Kamailio 5.5.2)

This mail has been sent from an external source Hello Nicolas,

some people are using the TLSF memory manager, so it should certainly not crash. Maybe you could create an issue about it if you got a backtrace and its not related to your (custom) module.

The QM memory manager is providing more debugging information and can be also used to find memory leaks and such. Therefore, its enabled by default, as most people are not using huge data sets internally.

The FM memory manager is more lightweight, and in your scenario apparently significant faster. Let us know if it's also working fine in the production setup.

Cheers,

Henning

-- Henning Westerholt - https://skalatan.de/blog/ Kamailio services - https://gilawa.comhttps://gilawa.com/

From: Chaigneau, Nicolas <nicolas.chaigneau@capgemini.commailto:nicolas.chaigneau@capgemini.com> Sent: Thursday, January 19, 2023 12:47 PM To: Henning Westerholt <hw@gilawa.commailto:hw@gilawa.com>; Kamailio (SER) - Users Mailing List <sr-users@lists.kamailio.orgmailto:sr-users@lists.kamailio.org> Cc: sr-dev@lists.kamailio.orgmailto:sr-dev@lists.kamailio.org Subject: RE: Performances issue when freeing shared memory in custom module (Kamailio 5.5.2)

[mail resent because I was not subscribed to sr-dev - sorry for the duplicate]

Hello Henning,

Thank you for your quick response !

I do not have any error messages.

Shared memory allocation and freeing is done exclusively by the RPC process. The workers only read that memory (and only the memory that is *not* being allocated or freed by the RPC process).

I've looked at the different shared memory managers as you suggested. First, « tlsf » does not work : Kamailio crashes on startup with « -x tlsf ».

A comparison of « qm » (default) and « fm » :

With « fm », the loading time is reduced by 25%. The freeing is also much faster (maybe 4 times faster). And I do not notice the performances issues (that I can reproduce when using « qm »). But maybe this is because I do not have enough data on my test environment. I'll have to test this with the real data.

But these first results with « fm » look promising ! :)

Could you maybe explain to me the main differences between the 3 shared memory managers ? and why is « qm » the default ? Also, do you have an idea why « tlsf » makes Kamailio crash ? (does anyone use « tlsf » ?)

Thanks again.

Regards, Nicolas.

De : Henning Westerholt <hw@gilawa.commailto:hw@gilawa.com> Envoyé : jeudi 19 janvier 2023 08:28 À : Kamailio (SER) - Users Mailing List Cc : Chaigneau, Nicolas; sr-dev@lists.kamailio.orgmailto:sr-dev@lists.kamailio.org Objet : RE: Performances issue when freeing shared memory in custom module (Kamailio 5.5.2)

This mail has been sent from an external source Hello,

(Adding sr-dev to CC)

This looks indeed a bit strange. Do you get any error messages in the log? In which process you are freeing the memory, one of the worker processes or the RPC process?

You could also try to use another memory manager to see if you get better performance. There is a command line parameter to choose one during startup.

Cheers,

Henning

-- Henning Westerholt - https://skalatan.de/blog/ Kamailio services - https://gilawa.comhttps://gilawa.com/

From: Chaigneau, Nicolas <nicolas.chaigneau@capgemini.commailto:nicolas.chaigneau@capgemini.com> Sent: Wednesday, January 18, 2023 6:49 PM To: Kamailio (SER) - Users Mailing List <sr-users@lists.kamailio.orgmailto:sr-users@lists.kamailio.org> Subject: [SR-Users] Performances issue when freeing shared memory in custom module (Kamailio 5.5.2)

Hello,

I'm encountering performance issues with Kamailio (5.5.2).

I'm using a custom Kamailio module that loads routing data in memory, using Kamailio shared memory. This routing data is very large. It can be fully reloaded through a Kamailio RPC command (which is done once each day).

When reloading, two sets of data are maintained, one "loading" and another "current" (the latter being used to handle SIP requests). When loading of the new data is finished, it is swapped to "current". Then, memory of the old (now unused) data is freed.

I've noticed that when Kamailio is freeing the old data, there is a very significant performance impact on SIP requests. This is surprising to me, because the SIP requests do not use this old data. This is not a CPU issue, idle CPU% is at about 99% at that moment.

I'm using the following functions : - shm_mallocxz - shm_free

From what I understand, shm_free is actually "qm_shm_free" defined in "src\core\mem\q_malloc.c" (the default shared memory manager being "qm"). I've noticed that there is also a variant shm_free_unsafe ("qm_free"), which does not perform locking.

I'm wondering if the lock could be the cause of my performances issues ? (But I'm not sure how this could be possible, because although the SIP requests need to access the shared memory allocated, they do not use directly the functions from the share memory manager.)

If the performances issues are causes by the lock, could I use the unsafe version "safely" ? (considering that it is guaranteed that the old data cannot be used by anyone else)

Thanks for your help.

Regards, Nicolas. This message contains information that may be privileged or confidential and is the property of the Capgemini Group. It is intended only for the person to whom it is addressed. If you are not the intended recipient, you are not authorized to read, print, retain, copy, disseminate, distribute, or use this message or any part thereof. If you receive this message in error, please notify the sender immediately and delete all copies of this message.