2eaf146fbb2bd84a90a29ac4d066adce5dae0f08
[nivanova/samba-autobuild/.git] / source3 / include / messages.h
1 /* 
2    Unix SMB/CIFS implementation.
3    messages.c header
4    Copyright (C) Andrew Tridgell 2000
5    Copyright (C) 2001, 2002 by Martin Pool
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #ifndef _MESSAGES_H_
22 #define _MESSAGES_H_
23
24 /* change the message version with any incompatible changes in the protocol */
25 #define MESSAGE_VERSION 2
26
27 /*
28  * Special flags passed to message_send. Allocated from the top, lets see when
29  * it collides with the message types in the lower 16 bits :-)
30  */
31
32 /*
33  * Under high load, this message can be dropped. Use for notify-style
34  * messages that are not critical for correct operation.
35  */
36 #define MSG_FLAG_LOWPRIORITY            0x80000000
37
38
39 /* Flags to classify messages - used in message_send_all() */
40 /* Sender will filter by flag. */
41
42 #define FLAG_MSG_GENERAL                0x0001
43 #define FLAG_MSG_SMBD                   0x0002
44 #define FLAG_MSG_NMBD                   0x0004
45 #define FLAG_MSG_WINBIND                0x0008
46 #define FLAG_MSG_PRINT_GENERAL          0x0010
47 /* dbwrap messages 4001-4999 */
48 #define FLAG_MSG_DBWRAP                 0x0020
49
50 /*
51  * ctdb gives us 64-bit server ids for messaging_send. This is done to avoid
52  * pid clashes and to be able to register for special messages like "all
53  * smbds".
54  *
55  * Normal individual server id's have the upper 32 bits to 0, I picked "1" for
56  * Samba, other subsystems might use something else.
57  */
58
59 #define MSG_SRVID_SAMBA 0x0000000100000000LL
60
61 #include "librpc/gen_ndr/server_id.h"
62 #include "lib/util/data_blob.h"
63 #include "system/network.h"
64
65 #define MSG_BROADCAST_PID_STR   "0:0"
66
67 struct messaging_context;
68 struct messaging_rec;
69
70 struct messaging_backend {
71         int (*send_fn)(struct server_id src,
72                        struct server_id pid, int msg_type,
73                        const struct iovec *iov, int iovlen,
74                        const int *fds, size_t num_fds,
75                        struct messaging_backend *backend);
76         void *private_data;
77 };
78
79 int messaging_ctdbd_init(struct messaging_context *msg_ctx,
80                          TALLOC_CTX *mem_ctx,
81                          struct messaging_backend **presult);
82 int messaging_ctdbd_reinit(struct messaging_context *msg_ctx,
83                            TALLOC_CTX *mem_ctx,
84                            struct messaging_backend *backend);
85 struct ctdbd_connection *messaging_ctdbd_connection(void);
86
87 bool message_send_all(struct messaging_context *msg_ctx,
88                       int msg_type,
89                       const void *buf, size_t len,
90                       int *n_sent);
91 struct messaging_context *messaging_init(TALLOC_CTX *mem_ctx, 
92                                          struct tevent_context *ev);
93
94 struct server_id messaging_server_id(const struct messaging_context *msg_ctx);
95 struct tevent_context *messaging_tevent_context(
96         struct messaging_context *msg_ctx);
97 struct server_id_db *messaging_names_db(struct messaging_context *msg_ctx);
98
99 /*
100  * re-init after a fork
101  */
102 NTSTATUS messaging_reinit(struct messaging_context *msg_ctx);
103
104 NTSTATUS messaging_register(struct messaging_context *msg_ctx,
105                             void *private_data,
106                             uint32_t msg_type,
107                             void (*fn)(struct messaging_context *msg,
108                                        void *private_data, 
109                                        uint32_t msg_type, 
110                                        struct server_id server_id,
111                                        DATA_BLOB *data));
112 void messaging_deregister(struct messaging_context *ctx, uint32_t msg_type,
113                           void *private_data);
114
115 /**
116  * CAVEAT:
117  *
118  * While the messaging_send*() functions are synchronuous by API,
119  * they trigger a tevent-based loop upon sending bigger messages.
120  *
121  * Hence callers should not use these in purely synchonous code,
122  * but run a tevent_loop instead.
123  */
124 NTSTATUS messaging_send(struct messaging_context *msg_ctx,
125                         struct server_id server, 
126                         uint32_t msg_type, const DATA_BLOB *data);
127
128 NTSTATUS messaging_send_buf(struct messaging_context *msg_ctx,
129                             struct server_id server, uint32_t msg_type,
130                             const uint8_t *buf, size_t len);
131 int messaging_send_iov_from(struct messaging_context *msg_ctx,
132                             struct server_id src, struct server_id dst,
133                             uint32_t msg_type,
134                             const struct iovec *iov, int iovlen,
135                             const int *fds, size_t num_fds);
136 NTSTATUS messaging_send_iov(struct messaging_context *msg_ctx,
137                             struct server_id server, uint32_t msg_type,
138                             const struct iovec *iov, int iovlen,
139                             const int *fds, size_t num_fds);
140
141 struct tevent_req *messaging_filtered_read_send(
142         TALLOC_CTX *mem_ctx, struct tevent_context *ev,
143         struct messaging_context *msg_ctx,
144         bool (*filter)(struct messaging_rec *rec, void *private_data),
145         void *private_data);
146 int messaging_filtered_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
147                                  struct messaging_rec **presult);
148
149 struct tevent_req *messaging_read_send(TALLOC_CTX *mem_ctx,
150                                        struct tevent_context *ev,
151                                        struct messaging_context *msg,
152                                        uint32_t msg_type);
153 int messaging_read_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
154                         struct messaging_rec **presult);
155
156 struct tevent_req *messaging_handler_send(
157         TALLOC_CTX *mem_ctx, struct tevent_context *ev,
158         struct messaging_context *msg_ctx, uint32_t msg_type,
159         bool (*handler)(struct messaging_context *msg_ctx,
160                         struct messaging_rec **rec, void *private_data),
161         void *private_data);
162 int messaging_handler_recv(struct tevent_req *req);
163
164 int messaging_cleanup(struct messaging_context *msg_ctx, pid_t pid);
165
166 bool messaging_parent_dgm_cleanup_init(struct messaging_context *msg);
167
168 #include "librpc/gen_ndr/ndr_messaging.h"
169
170 #endif