Memory notifier¶

There are six types of notification defined ininclude/linux/memory.h:

MEM_GOING_ONLINE

Generated before new memory becomes available in order to be able toprepare subsystems to handle memory. The page allocator is still unableto allocate from the new memory.

MEM_CANCEL_ONLINE

Generated if MEM_GOING_ONLINE fails.

MEM_ONLINE

Generated when memory has successfully brought online. The callback mayallocate pages from the new memory.

MEM_GOING_OFFLINE

Generated to begin the process of offlining memory. Allocations are nolonger possible from the memory but some of the memory to be offlinedis still in use. The callback can be used to free memory known to asubsystem from the indicated memory block.

MEM_CANCEL_OFFLINE

Generated if MEM_GOING_OFFLINE fails. Memory is available again fromthe memory block that we attempted to offline.

MEM_OFFLINE

Generated after offlining memory is complete.

A callback routine can be registered by calling:

hotplug_memory_notifier(callback_func, priority)

Callback functions with higher values of priority are called before callbackfunctions with lower values.

A callback function must have the following prototype:

int callback_func(  struct notifier_block *self, unsigned long action, void *arg);

The first argument of the callback function (self) is a pointer to the blockof the notifier chain that points to the callback function itself.The second argument (action) is one of the event types described above.The third argument (arg) passes a pointer ofstructmemory_notify:

struct memory_notify {        unsigned long start_pfn;        unsigned long nr_pages;}

• start_pfn is start_pfn of online/offline memory.

• nr_pages is # of pages of online/offline memory.

It is possible to get notified for MEM_CANCEL_ONLINE without having been notifiedfor MEM_GOING_ONLINE, and the same applies to MEM_CANCEL_OFFLINE andMEM_GOING_OFFLINE.This can happen when a consumer fails, meaning we break the callchain and westop calling the remaining consumers of the notifier.It is then important that users of memory_notify make no assumptions and getprepared to handle such cases.

The callback routine shall return one of the valuesNOTIFY_DONE, NOTIFY_OK, NOTIFY_BAD, NOTIFY_STOPdefined ininclude/linux/notifier.h

NOTIFY_DONE and NOTIFY_OK have no effect on the further processing.

NOTIFY_BAD is used as response to the MEM_GOING_ONLINE, MEM_GOING_OFFLINE,MEM_ONLINE, or MEM_OFFLINE action to cancel hotplugging. It stopsfurther processing of the notification queue.

NOTIFY_STOP stops further processing of the notification queue.

Numa node notifier¶

There are six types of notification defined ininclude/linux/node.h:

NODE_ADDING_FIRST_MEMORY

Generated before memory becomes available to this node for the first time.

NODE_CANCEL_ADDING_FIRST_MEMORY

Generated if NODE_ADDING_FIRST_MEMORY fails.

NODE_ADDED_FIRST_MEMORY

Generated when memory has become available fo this node for the first time.

NODE_REMOVING_LAST_MEMORY

Generated when the last memory available to this node is about to be offlined.

NODE_CANCEL_REMOVING_LAST_MEMORY

Generated when NODE_CANCEL_REMOVING_LAST_MEMORY fails.

NODE_REMOVED_LAST_MEMORY

Generated when the last memory available to this node has been offlined.

A callback routine can be registered by calling:

hotplug_node_notifier(callback_func, priority)

Callback functions with higher values of priority are called before callbackfunctions with lower values.

A callback function must have the following prototype:

int callback_func(  struct notifier_block *self, unsigned long action, void *arg);

The first argument of the callback function (self) is a pointer to the blockof the notifier chain that points to the callback function itself.The second argument (action) is one of the event types described above.The third argument (arg) passes a pointer ofstructnode_notify:

struct node_notify {        int nid;}

• nid is the node we are adding or removing memory to.

It is possible to get notified for NODE_CANCEL_ADDING_FIRST_MEMORY withouthaving been notified for NODE_ADDING_FIRST_MEMORY, and the same applies toNODE_CANCEL_REMOVING_LAST_MEMORY and NODE_REMOVING_LAST_MEMORY.This can happen when a consumer fails, meaning we break the callchain and westop calling the remaining consumers of the notifier.It is then important that users of node_notify make no assumptions and getprepared to handle such cases.

The callback routine shall return one of the valuesNOTIFY_DONE, NOTIFY_OK, NOTIFY_BAD, NOTIFY_STOPdefined ininclude/linux/notifier.h

NOTIFY_DONE and NOTIFY_OK have no effect on the further processing.

NOTIFY_BAD is used as response to the NODE_ADDING_FIRST_MEMORY,NODE_REMOVING_LAST_MEMORY, NODE_ADDED_FIRST_MEMORY orNODE_REMOVED_LAST_MEMORY action to cancel hotplugging.It stops further processing of the notification queue.

NOTIFY_STOP stops further processing of the notification queue.

Please note that we should not fail for NODE_ADDED_FIRST_MEMORY /NODE_REMOVED_FIRST_MEMORY, as memory_hotplug code cannot rollback at thatpoint anymore.