.TH global 3 "kernel  2.12.3" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
global \- A Global Name Registration Facility
.SH DESCRIPTION
.LP
This documentation describes the Global module which consists of the following functionalities: 
.RS 2
.TP 2
*
registration of global names;
.TP 2
*
global locks;
.TP 2
*
maintenance of the fully connected network\&.
.RE
.LP
These services are controlled via the process \fIglobal_name_server\fR which exists on every node\&. The global name server is started automatically when a node is started\&. With the term \fIglobal\fR is meant over a system consisting of several Erlang nodes\&.
.LP
The ability to globally register names is a central concept in the programming of distributed Erlang systems\&. In this module, the equivalent of the \fIregister/2\fR and \fIwhereis/1\fR BIFs (for local name registration) are implemented, but for a network of Erlang nodes\&. A registered name is an alias for a process identifier (pid)\&. The global name server monitors globally registered pids\&. If a process terminates, the name will also be globally unregistered\&.
.LP
The registered names are stored in replica global name tables on every node\&. There is no central storage point\&. Thus, the translation of a name to a pid is fast, as it is always done locally\&. When any action in taken which results in a change to the global name table, all tables on other nodes are automatically updated\&.
.LP
Global locks have lock identities and are set on a specific resource\&. For instance, the specified resource could be a pid\&. When a global lock is set, access to the locked resource is denied for all other resources other than the lock requester\&.
.LP
Both the registration and lock functionalities are atomic\&. All nodes involved in these actions will have the same view of the information\&.
.LP
The global name server also performs the critical task of continuously monitoring changes in node configuration: if a node which runs a globally registered process goes down, the name will be globally unregistered\&. To this end the global name server subscribes to \fInodeup\fR and \fInodedown\fR messages sent from the \fInet_kernel\fR module\&. Relevant Kernel application variables in this context are \fInet_setuptime\fR, \fInet_ticktime\fR, and \fIdist_auto_connect\fR\&. See also kernel(6)\&. 
.LP
The server will also maintain a fully connected network\&. For example, if node \fIN1\fR connects to node \fIN2\fR (which is already connected to \fIN3\fR), the global name servers on the nodes \fIN1\fR and \fIN3\fR will make sure that also \fIN1\fR and \fIN3\fR are connected\&. If this is not desired, the command line flag \fI-connect_all false\fR can be used (see also erl(1))\&. In this case the name registration facility cannot be used, but the lock mechanism will still work\&. 
.LP
If the global name server fails to connect nodes (\fIN1\fR and \fIN3\fR in the example above) a warning event is sent to the error logger\&. The presence of such an event does not exclude the possibility that the nodes will later connect--one can for example try the command \fIrpc:call(N1, net_adm, ping, [N2]) in the Erlang shell\fR--but it indicates some kind of problem with the network\&. 
.SS Note:
.LP
If the fully connected network is not set up properly, the first thing to try is to increase the value of \fInet_setuptime\fR\&.


.SH EXPORTS
.LP
.B
del_lock(Id)
.br
.B
del_lock(Id, Nodes) -> void()
.br
.RS
.TP
Types
Id = {ResourceId, LockRequesterId}
.br
ResourceId = term()
.br
LockRequesterId = term()
.br
Nodes = [node()]
.br
.RE
.RS
.LP
Deletes the lock \fIId\fR synchronously\&.
.RE
.LP
.B
notify_all_name(Name, Pid1, Pid2) -> none
.br
.RS
.TP
Types
Name = term()
.br
Pid1 = Pid2 = pid()
.br
.RE
.RS
.LP
This function can be used as a name resolving function for \fIregister_name/3\fR and \fIre_register_name/3\fR\&. It unregisters both pids, and sends the message \fI{global_name_conflict, Name, OtherPid}\fR to both processes\&.
.RE
.LP
.B
random_exit_name(Name, Pid1, Pid2) -> Pid1 | Pid2
.br
.RS
.TP
Types
Name = term()
.br
Pid1 = Pid2 = pid()
.br
.RE
.RS
.LP
This function can be used as a name resolving function for \fIregister_name/3\fR and \fIre_register_name/3\fR\&. It randomly chooses one of the pids for registration and kills the other one\&.
.RE
.LP
.B
random_notify_name(Name, Pid1, Pid2) -> Pid1 | Pid2
.br
.RS
.TP
Types
Name = term()
.br
Pid1 = Pid2 = pid()
.br
.RE
.RS
.LP
This function can be used as a name resolving function for \fIregister_name/3\fR and \fIre_register_name/3\fR\&. It randomly chooses one of the pids for registration, and sends the message \fI{global_name_conflict, Name}\fR to the other pid\&.
.RE
.LP
.B
register_name(Name, Pid)
.br
.B
register_name(Name, Pid, Resolve) -> yes | no
.br
.RS
.TP
Types
Name = term()
.br
Pid = pid()
.br
Resolve = fun() or {Module, Function} where
.br
Resolve(Name, Pid, Pid2) -> Pid | Pid2 | none
.br
.RE
.RS
.LP
Globally associates the name \fIName\fR with a pid, that is, Globally notifies all nodes of a new global name in a network of Erlang nodes\&.
.LP
When new nodes are added to the network, they are informed of the globally registered names that already exist\&. The network is also informed of any global names in newly connected nodes\&. If any name clashes are discovered, the \fIResolve\fR function is called\&. Its purpose is to decide which pid is correct\&. If the function crashes, or returns anything other than one of the pids, the name is unregistered\&. This function is called once for each name clash\&.
.LP
There are three pre-defined resolve functions: \fIrandom_exit_name/3\fR, \fIrandom_notify_name/3\fR, and \fInotify_all_name/3\fR\&. If no \fIResolve\fR function is defined, \fIrandom_exit_name\fR is used\&. This means that one of the two registered processes will be selected as correct while the other is killed\&.
.LP
This function is completely synchronous\&. This means that when this function returns, the name is either registered on all nodes or none\&.
.LP
The function returns \fIyes\fR if successful, \fIno\fR if it fails\&. For example, \fIno\fR is returned if an attempt is made to register an already registered process or to register a process with a name that is already in use\&.
.SS Note:
.LP
Releases up to and including OTP R10 did not check if the process was already registered\&. As a consequence the global name table could become inconsistent\&. The old (buggy) behavior can be chosen by giving the Kernel application variable \fIglobal_multi_name_action\fR the value \fIallow\fR\&.

.LP
If a process with a registered name dies, or the node goes down, the name is unregistered on all nodes\&.
.RE
.LP
.B
registered_names() -> [Name]
.br
.RS
.TP
Types
Name = term()
.br
.RE
.RS
.LP
Returns a lists of all globally registered names\&.
.RE
.LP
.B
re_register_name(Name, Pid)
.br
.B
re_register_name(Name, Pid, Resolve) -> void()
.br
.RS
.TP
Types
Name = term()
.br
Pid = pid()
.br
Resolve = fun() or {Module, Function} where
.br
Resolve(Name, Pid, Pid2) -> Pid | Pid2 | none
.br
.RE
.RS
.LP
Atomically changes the registered name \fIName\fR on all nodes to refer to \fIPid\fR\&.
.LP
The \fIResolve\fR function has the same behavior as in \fIregister_name/2, 3\fR\&.
.RE
.LP
.B
send(Name, Msg) -> Pid
.br
.RS
.TP
Types
Name = term()
.br
Msg = term()
.br
Pid = pid()
.br
.RE
.RS
.LP
Sends the message \fIMsg\fR to the pid globally registered as \fIName\fR\&.
.LP
Failure: If \fIName\fR is not a globally registered name, the calling function will exit with reason \fI{badarg, {Name, Msg}}\fR\&.
.RE
.LP
.B
set_lock(Id)
.br
.B
set_lock(Id, Nodes)
.br
.B
set_lock(Id, Nodes, Retries) -> boolean()
.br
.RS
.TP
Types
Id = {ResourceId, LockRequesterId}
.br
ResourceId = term()
.br
LockRequesterId = term()
.br
Nodes = [node()]
.br
Retries = int() >= 0 | infinity
.br
.RE
.RS
.LP
Sets a lock on the specified nodes (or on all nodes if none are specified) on \fIResourceId\fR for \fILockRequesterId\fR\&. If a lock already exists on \fIResourceId\fR for another requester than \fILockRequesterId\fR, and \fIRetries\fR is not equal to 0, the process sleeps for a while and will try to execute the action later\&. When \fIRetries\fR attempts have been made, \fIfalse\fR is returned, otherwise \fItrue\fR\&. If \fIRetries\fR is \fIinfinity\fR, \fItrue\fR is eventually returned (unless the lock is never released)\&.
.LP
If no value for \fIRetries\fR is given, \fIinfinity\fR is used\&.
.LP
This function is completely synchronous\&.
.LP
If a process which holds a lock dies, or the node goes down, the locks held by the process are deleted\&.
.LP
The global name server keeps track of all processes sharing the same lock, that is, if two processes set the same lock, both processes must delete the lock\&.
.LP
This function does not address the problem of a deadlock\&. A deadlock can never occur as long as processes only lock one resource at a time\&. But if some processes try to lock two or more resources, a deadlock may occur\&. It is up to the application to detect and rectify a deadlock\&.
.SS Note:
.LP
Some values of \fIResourceId\fR should be avoided or Erlang/OTP will not work properly\&. A list of resources to avoid: \fIglobal\fR, \fIdist_ac\fR, \fImnesia_table_lock\fR, \fImnesia_adjust_log_writes\fR, \fIpg2\fR\&.

.RE
.LP
.B
sync() -> void()
.br
.RS
.LP
Synchronizes the global name server with all nodes known to this node\&. These are the nodes which are returned from \fIerlang:nodes()\fR\&. When this function returns, the global name server will receive global information from all nodes\&. This function can be called when new nodes are added to the network\&.
.RE
.LP
.B
trans(Id, Fun)
.br
.B
trans(Id, Fun, Nodes)
.br
.B
trans(Id, Fun, Nodes, Retries) -> Res | aborted
.br
.RS
.TP
Types
Id = {ResourceId, LockRequesterId}
.br
ResourceId = term()
.br
LockRequesterId = term()
.br
Fun = fun() | {M, F}
.br
Nodes = [node()]
.br
Retries = int() >= 0 | infinity
.br
Res = term()
.br
.RE
.RS
.LP
Sets a lock on \fIId\fR (using \fIset_lock/3\fR)\&. If this succeeds, \fIFun()\fR is evaluated and the result \fIRes\fR is returned\&. Returns \fIaborted\fR if the lock attempt failed\&. If \fIRetries\fR is set to \fIinfinity\fR, the transaction will not abort\&.
.LP
\fIinfinity\fR is the default setting and will be used if no value is given for \fIRetries\fR\&.
.RE
.LP
.B
unregister_name(Name) -> void()
.br
.RS
.TP
Types
Name = term()
.br
.RE
.RS
.LP
Removes the globally registered name \fIName\fR from the network of Erlang nodes\&.
.RE
.LP
.B
whereis_name(Name) -> pid() | undefined
.br
.RS
.TP
Types
Name = term()
.br
.RE
.RS
.LP
Returns the pid with the globally registered name \fIName\fR\&. Returns \fIundefined\fR if the name is not globally registered\&.
.RE
.SH SEE ALSO
.LP
global_group(3), net_kernel(3),