1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-message-internal.h DBusMessage object internal interfaces
3  *
4  * Copyright (C) 2002  Red Hat Inc.
5  *
6  * Licensed under the Academic Free License version 2.1
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21  *
22  */
23 #ifndef DBUS_MESSAGE_INTERNAL_H
24 #define DBUS_MESSAGE_INTERNAL_H
25 
26 #include <dbus/dbus-marshal-validate.h>
27 #include <dbus/dbus-message.h>
28 #include <dbus/dbus-resources.h>
29 #include <dbus/dbus-list.h>
30 
31 DBUS_BEGIN_DECLS
32 
33 #ifdef DBUS_ENABLE_VERBOSE_MODE
34 void _dbus_message_trace_ref (DBusMessage *message,
35                               int          old_refcount,
36                               int          new_refcount,
37                               const char  *why);
38 #else
39 /* this bypasses any "unused" warnings for the old and new refcount */
40 #define _dbus_message_trace_ref(m, o, n, w) \
41   do \
42   {\
43     (void) (o); \
44     (void) (n); \
45   } while (0)
46 #endif
47 
48 typedef struct DBusMessageLoader DBusMessageLoader;
49 
50 void _dbus_message_get_network_data  (DBusMessage       *message,
51 				      const DBusString **header,
52 				      const DBusString **body);
53 DBUS_PRIVATE_EXPORT
54 void _dbus_message_get_unix_fds      (DBusMessage *message,
55                                       const int **fds,
56                                       unsigned *n_fds);
57 
58 unsigned int _dbus_message_get_n_unix_fds       (DBusMessage  *message);
59 void        _dbus_message_lock                  (DBusMessage  *message);
60 void        _dbus_message_unlock                (DBusMessage  *message);
61 dbus_bool_t _dbus_message_add_counter           (DBusMessage  *message,
62                                                  DBusCounter  *counter);
63 void        _dbus_message_add_counter_link      (DBusMessage  *message,
64                                                  DBusList     *link);
65 void        _dbus_message_remove_counter        (DBusMessage  *message,
66                                                  DBusCounter  *counter);
67 
68 DBUS_PRIVATE_EXPORT
69 DBusMessageLoader* _dbus_message_loader_new                   (void);
70 DBUS_PRIVATE_EXPORT
71 DBusMessageLoader* _dbus_message_loader_ref                   (DBusMessageLoader  *loader);
72 DBUS_PRIVATE_EXPORT
73 void               _dbus_message_loader_unref                 (DBusMessageLoader  *loader);
74 
75 DBUS_PRIVATE_EXPORT
76 void               _dbus_message_loader_get_buffer            (DBusMessageLoader  *loader,
77                                                                DBusString        **buffer,
78                                                                int                *max_to_read,
79                                                                dbus_bool_t        *may_read_unix_fds);
80 DBUS_PRIVATE_EXPORT
81 void               _dbus_message_loader_return_buffer         (DBusMessageLoader  *loader,
82                                                                DBusString         *buffer);
83 
84 
85 #ifdef HAVE_UNIX_FD_PASSING
86 DBUS_PRIVATE_EXPORT
87 dbus_bool_t        _dbus_message_loader_get_unix_fds          (DBusMessageLoader  *loader,
88                                                                int               **fds,
89                                                                unsigned           *max_n_fds);
90 
91 DBUS_PRIVATE_EXPORT
92 void               _dbus_message_loader_return_unix_fds       (DBusMessageLoader  *loader,
93                                                                int                *fds,
94                                                                unsigned            n_fds);
95 #endif
96 
97 DBUS_PRIVATE_EXPORT
98 dbus_bool_t        _dbus_message_loader_queue_messages        (DBusMessageLoader  *loader);
99 DBusMessage*       _dbus_message_loader_peek_message          (DBusMessageLoader  *loader);
100 DBUS_PRIVATE_EXPORT
101 DBusMessage*       _dbus_message_loader_pop_message           (DBusMessageLoader  *loader);
102 DBusList*          _dbus_message_loader_pop_message_link      (DBusMessageLoader  *loader);
103 void               _dbus_message_loader_putback_message_link  (DBusMessageLoader  *loader,
104                                                                DBusList           *link);
105 
106 DBUS_PRIVATE_EXPORT
107 dbus_bool_t        _dbus_message_loader_get_is_corrupted      (DBusMessageLoader  *loader);
108 DBusValidity       _dbus_message_loader_get_corruption_reason (DBusMessageLoader  *loader);
109 
110 void               _dbus_message_loader_set_max_message_size  (DBusMessageLoader  *loader,
111                                                                long                size);
112 DBUS_PRIVATE_EXPORT
113 long               _dbus_message_loader_get_max_message_size  (DBusMessageLoader  *loader);
114 
115 void               _dbus_message_loader_set_max_message_unix_fds(DBusMessageLoader  *loader,
116                                                                  long                n);
117 long               _dbus_message_loader_get_max_message_unix_fds(DBusMessageLoader  *loader);
118 int                _dbus_message_loader_get_pending_fds_count (DBusMessageLoader  *loader);
119 void               _dbus_message_loader_set_pending_fds_function (DBusMessageLoader *loader,
120                                                                   void (* callback) (void *),
121                                                                   void *data);
122 
123 typedef struct DBusVariant DBusVariant;
124 DBUS_PRIVATE_EXPORT
125 DBusVariant       *_dbus_variant_read                            (DBusMessageIter *reader);
126 DBUS_PRIVATE_EXPORT
127 dbus_bool_t        _dbus_variant_write                           (DBusVariant *self,
128                                                                   DBusMessageIter *writer);
129 DBUS_PRIVATE_EXPORT
130 void               _dbus_variant_free                            (DBusVariant *self);
131 DBUS_PRIVATE_EXPORT
132 int                _dbus_variant_get_length                      (DBusVariant *self);
133 DBUS_PRIVATE_EXPORT
134 const DBusString  *_dbus_variant_peek                            (DBusVariant *self);
135 DBUS_PRIVATE_EXPORT
136 const char        *_dbus_variant_get_signature                   (DBusVariant *self);
137 
138 static inline void
_dbus_clear_variant(DBusVariant ** variant_p)139 _dbus_clear_variant (DBusVariant **variant_p)
140 {
141   _dbus_clear_pointer_impl (DBusVariant, variant_p, _dbus_variant_free);
142 }
143 
144 typedef struct DBusInitialFDs DBusInitialFDs;
145 DBusInitialFDs *_dbus_check_fdleaks_enter (void);
146 void            _dbus_check_fdleaks_leave (DBusInitialFDs *fds);
147 
148 DBUS_END_DECLS
149 
150 #endif /* DBUS_MESSAGE_INTERNAL_H */
151