lib/param: Rename "socket address" to "nbt client socket address" to clarify role
[kai/samba.git] / source3 / include / messages.h
index e3f29832add459e39d60d99c28e15cd799922c12..4b45901afda2fe6718fce6af9895d3efde1dac1e 100644 (file)
    messages.c header
    Copyright (C) Andrew Tridgell 2000
    Copyright (C) 2001, 2002 by Martin Pool
-   
+
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
-   
+
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
-   
+
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #ifndef _MESSAGES_H_
 #define _MESSAGES_H_
 
-/* general messages */
-#define MSG_DEBUG              1
-#define MSG_PING               2
-#define MSG_PONG               3
-#define MSG_PROFILE            4
-#define MSG_REQ_DEBUGLEVEL     5
-#define MSG_DEBUGLEVEL         6
-#define MSG_REQ_PROFILELEVEL   7
-#define MSG_PROFILELEVEL       8
-#define MSG_REQ_POOL_USAGE     9
-#define MSG_POOL_USAGE         10
-
-/* If dmalloc is included, set a steady-state mark */
-#define MSG_REQ_DMALLOC_MARK   11
-
-/* If dmalloc is included, dump to the dmalloc log a description of
- * what has changed since the last MARK */
-#define MSG_REQ_DMALLOC_LOG_CHANGED    12
-
-#define MSG_SHUTDOWN           13
-
-/* nmbd messages */
-#define MSG_FORCE_ELECTION 1001
-#define MSG_WINS_NEW_ENTRY 1002
-#define MSG_SEND_PACKET    1003
-
-/* printing messages */
-/* #define MSG_PRINTER_NOTIFY  2001*/ /* Obsolete */
-#define MSG_PRINTER_NOTIFY2            2002
-
-#define MSG_PRINTER_DRVUPGRADE         2101
-#define MSG_PRINTERDATA_INIT_RESET     2102
-#define MSG_PRINTER_UPDATE             2103
-#define MSG_PRINTER_MOD                        2104
-
-/* smbd messages */
-#define MSG_SMB_CONF_UPDATED 3001
-#define MSG_SMB_FORCE_TDIS   3002
-#define MSG_SMB_SAM_SYNC     3003
-#define MSG_SMB_SAM_REPL     3004
-#define MSG_SMB_UNLOCK       3005
-#define MSG_SMB_BREAK_REQUEST 3006
-#define MSG_SMB_BREAK_RESPONSE 3007
-#define MSG_SMB_ASYNC_LEVEL2_BREAK 3008
-#define MSG_SMB_OPEN_RETRY   3009
-#define MSG_SMB_KERNEL_BREAK 3010
-#define MSG_SMB_FILE_RENAME  3011
-#define MSG_SMB_INJECT_FAULT 3012
-#define MSG_SMB_BLOCKING_LOCK_CANCEL 3013
-#define MSG_SMB_NOTIFY       3014
-#define MSG_SMB_STAT_CACHE_DELETE 3015
+/* change the message version with any incompatible changes in the protocol */
+#define MESSAGE_VERSION 2
+
 /*
- * Samba4 compatibility
+ * Special flags passed to message_send. Allocated from the top, lets see when
+ * it collides with the message types in the lower 16 bits :-)
  */
-#define MSG_PVFS_NOTIFY       3016
 
-/* winbind messages */
-#define MSG_WINBIND_FINISHED     4001
-#define MSG_WINBIND_FORGET_STATE 4002
-#define MSG_WINBIND_ONLINE       4003
-#define MSG_WINBIND_OFFLINE      4004
-#define MSG_WINBIND_ONLINESTATUS 4005
-#define MSG_WINBIND_TRY_TO_GO_ONLINE 4006
-#define MSG_WINBIND_FAILED_TO_GO_ONLINE 4007
+/*
+ * Under high load, this message can be dropped. Use for notify-style
+ * messages that are not critical for correct operation.
+ */
+#define MSG_FLAG_LOWPRIORITY           0x80000000
+
 
 /* Flags to classify messages - used in message_send_all() */
 /* Sender will filter by flag. */
 
-#define FLAG_MSG_GENERAL       0x0001
-#define FLAG_MSG_SMBD          0x0002
-#define FLAG_MSG_NMBD          0x0004
-#define FLAG_MSG_PRINT_NOTIFY  0x0008
-#define FLAG_MSG_PRINT_GENERAL 0x0010
+#define FLAG_MSG_GENERAL               0x0001
+#define FLAG_MSG_SMBD                  0x0002
+#define FLAG_MSG_NMBD                  0x0004
+#define FLAG_MSG_WINBIND               0x0008
+#define FLAG_MSG_PRINT_GENERAL         0x0010
+/* dbwrap messages 4001-4999 */
+#define FLAG_MSG_DBWRAP                        0x0020
 
-struct server_id {
-       pid_t pid;
+/*
+ * ctdb gives us 64-bit server ids for messaging_send. This is done to avoid
+ * pid clashes and to be able to register for special messages like "all
+ * smbds".
+ *
+ * Normal individual server id's have the upper 32 bits to 0, I picked "1" for
+ * Samba, other subsystems might use something else.
+ */
+
+#define MSG_SRVID_SAMBA 0x0000000100000000LL
+
+#include "librpc/gen_ndr/server_id.h"
+
+#ifdef CLUSTER_SUPPORT
+#define MSG_BROADCAST_PID_STR  "0:0"
+#else
+#define MSG_BROADCAST_PID_STR  "0"
+#endif
+
+struct messaging_context;
+struct messaging_rec;
+
+/*
+ * struct messaging_context belongs to messages.c, but because we still have
+ * messaging_dispatch, we need it here. Once we get rid of signals for
+ * notifying processes, this will go.
+ */
+
+struct messaging_context {
+       struct server_id id;
+       struct event_context *event_ctx;
+       struct messaging_callback *callbacks;
+
+       struct messaging_backend *local;
+       struct messaging_backend *remote;
+};
+
+struct messaging_backend {
+       NTSTATUS (*send_fn)(struct messaging_context *msg_ctx,
+                           struct server_id pid, int msg_type,
+                           const DATA_BLOB *data,
+                           struct messaging_backend *backend);
+       void *private_data;
 };
 
+NTSTATUS messaging_tdb_init(struct messaging_context *msg_ctx,
+                           TALLOC_CTX *mem_ctx,
+                           struct messaging_backend **presult);
+
+bool messaging_tdb_parent_init(TALLOC_CTX *mem_ctx);
+
+void *messaging_tdb_event(TALLOC_CTX *mem_ctx, struct messaging_context *msg,
+                         struct tevent_context *ev);
+
+NTSTATUS messaging_ctdbd_init(struct messaging_context *msg_ctx,
+                             TALLOC_CTX *mem_ctx,
+                             struct messaging_backend **presult);
+struct ctdbd_connection *messaging_ctdbd_connection(void);
+
+bool message_send_all(struct messaging_context *msg_ctx,
+                     int msg_type,
+                     const void *buf, size_t len,
+                     int *n_sent);
+struct messaging_context *messaging_init(TALLOC_CTX *mem_ctx, 
+                                        struct event_context *ev);
+
+struct server_id messaging_server_id(const struct messaging_context *msg_ctx);
+
+/*
+ * re-init after a fork
+ */
+NTSTATUS messaging_reinit(struct messaging_context *msg_ctx);
+
+NTSTATUS messaging_register(struct messaging_context *msg_ctx,
+                           void *private_data,
+                           uint32_t msg_type,
+                           void (*fn)(struct messaging_context *msg,
+                                      void *private_data, 
+                                      uint32_t msg_type, 
+                                      struct server_id server_id,
+                                      DATA_BLOB *data));
+void messaging_deregister(struct messaging_context *ctx, uint32_t msg_type,
+                         void *private_data);
+NTSTATUS messaging_send(struct messaging_context *msg_ctx,
+                       struct server_id server, 
+                       uint32_t msg_type, const DATA_BLOB *data);
+
+NTSTATUS messaging_send_buf(struct messaging_context *msg_ctx,
+                           struct server_id server, uint32_t msg_type,
+                           const uint8 *buf, size_t len);
+void messaging_dispatch_rec(struct messaging_context *msg_ctx,
+                           struct messaging_rec *rec);
+
+#include "librpc/gen_ndr/ndr_messaging.h"
+
 #endif