+// SPDX-License-Identifier: ISC OR GPL-2.0-or-later
/*
* Public definitions pertaining to the Forwarding Plane Manager component.
*
/*
* License Option 1: GPL
- *
- * 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 (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.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- */
-
-/*
* License Option 2: ISC License
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose with or without fee is hereby granted, provided
- * that the above copyright notice and this permission notice appear
- * in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
- * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
- * OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
- * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
- * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#ifndef _FPM_H
*/
/*
- * Local host as a default server for fpm connection
+ * Local host as a default server for fpm connection
*/
#define FPM_DEFAULT_IP (htonl (INADDR_LOOPBACK))
/*
* Header that precedes each fpm message to/from the FPM.
*/
-typedef struct fpm_msg_hdr_t_
-{
- /*
- * Protocol version.
- */
- uint8_t version;
-
- /*
- * Type of message, see below.
- */
- uint8_t msg_type;
-
- /*
- * Length of entire message, including the header, in network byte
- * order.
- */
- uint16_t msg_len;
-} __attribute__ ((packed)) fpm_msg_hdr_t;
+typedef struct fpm_msg_hdr_t_ {
+ /*
+ * Protocol version.
+ */
+ uint8_t version;
+
+ /*
+ * Type of message, see below.
+ */
+ uint8_t msg_type;
+
+ /*
+ * Length of entire message, including the header, in network byte
+ * order.
+ */
+ uint16_t msg_len;
+} __attribute__((packed)) fpm_msg_hdr_t;
#ifdef __SUNPRO_C
#pragma pack()
#define FPM_PROTO_VERSION 1
typedef enum fpm_msg_type_e_ {
- FPM_MSG_TYPE_NONE = 0,
-
- /*
- * Indicates that the payload is a completely formed netlink
- * message.
- *
- * XXX Netlink cares about the alignment of messages. When any
- * FPM_MSG_TYPE_NETLINK messages are sent over a channel, then all
- * messages should be sized such that netlink alignment is
- * maintained.
- */
- FPM_MSG_TYPE_NETLINK = 1,
- FPM_MSG_TYPE_PROTOBUF = 2,
+ FPM_MSG_TYPE_NONE = 0,
+
+ /*
+ * Indicates that the payload is a completely formed netlink
+ * message.
+ *
+ * XXX Netlink cares about the alignment of messages. When any
+ * FPM_MSG_TYPE_NETLINK messages are sent over a channel, then all
+ * messages should be sized such that netlink alignment is
+ * maintained.
+ */
+ FPM_MSG_TYPE_NETLINK = 1,
+ FPM_MSG_TYPE_PROTOBUF = 2,
} fpm_msg_type_e;
/*
*
* **NB**: Alignment is required only when netlink messages are used.
*/
-static inline size_t
-fpm_msg_align (size_t len)
+static inline size_t fpm_msg_align(size_t len)
{
- return (len + FPM_MSG_ALIGNTO - 1) & ~(FPM_MSG_ALIGNTO - 1);
+ return (len + FPM_MSG_ALIGNTO - 1) & ~(FPM_MSG_ALIGNTO - 1);
}
/*
* The (rounded up) size of the FPM message header. This ensures that
* the message payload always starts at an aligned address.
*/
-#define FPM_MSG_HDR_LEN (sizeof (fpm_msg_hdr_t))
+#define FPM_MSG_HDR_LEN (sizeof(fpm_msg_hdr_t))
#ifndef COMPILE_ASSERT
#define COMPILE_ASSERT(x) extern int __dummy[2 * !!(x) - 1]
* The length value that should be placed in the msg_len field of the
* header for a *payload* of size 'data_len'.
*/
-static inline size_t
-fpm_data_len_to_msg_len (size_t data_len)
+static inline size_t fpm_data_len_to_msg_len(size_t data_len)
{
- return data_len + FPM_MSG_HDR_LEN;
+ return data_len + FPM_MSG_HDR_LEN;
}
/*
*
* Pointer to the payload of the given fpm header.
*/
-static inline void *
-fpm_msg_data (fpm_msg_hdr_t *hdr)
+static inline void *fpm_msg_data(fpm_msg_hdr_t *hdr)
{
- return ((char*) hdr) + FPM_MSG_HDR_LEN;
+ return ((char *)hdr) + FPM_MSG_HDR_LEN;
}
/*
* fpm_msg_len
*/
-static inline size_t
-fpm_msg_len (const fpm_msg_hdr_t *hdr)
+static inline size_t fpm_msg_len(const fpm_msg_hdr_t *hdr)
{
- return ntohs (hdr->msg_len);
+ return ntohs(hdr->msg_len);
}
/*
* fpm_msg_data_len
*/
-static inline size_t
-fpm_msg_data_len (const fpm_msg_hdr_t *hdr)
+static inline size_t fpm_msg_data_len(const fpm_msg_hdr_t *hdr)
{
- return (fpm_msg_len (hdr) - FPM_MSG_HDR_LEN);
+ return (fpm_msg_len(hdr) - FPM_MSG_HDR_LEN);
}
/*
*
* Move to the next message in a buffer.
*/
-static inline fpm_msg_hdr_t *
-fpm_msg_next (fpm_msg_hdr_t *hdr, size_t *len)
+static inline fpm_msg_hdr_t *fpm_msg_next(fpm_msg_hdr_t *hdr, size_t *len)
{
- size_t msg_len;
+ size_t msg_len;
- msg_len = fpm_msg_len (hdr);
+ msg_len = fpm_msg_len(hdr);
- if (len) {
- if (*len < msg_len)
- {
- assert(0);
- return NULL;
- }
- *len -= msg_len;
- }
+ if (len) {
+ if (*len < msg_len) {
+ assert(0);
+ return NULL;
+ }
+ *len -= msg_len;
+ }
- return (fpm_msg_hdr_t *) (((char*) hdr) + msg_len);
+ return (fpm_msg_hdr_t *)(((char *)hdr) + msg_len);
}
/*
* fpm_msg_hdr_ok
*
- * Returns TRUE if a message header looks well-formed.
+ * Returns true if a message header looks well-formed.
*/
-static inline int
-fpm_msg_hdr_ok (const fpm_msg_hdr_t *hdr)
+static inline int fpm_msg_hdr_ok(const fpm_msg_hdr_t *hdr)
{
- size_t msg_len;
+ size_t msg_len;
- if (hdr->msg_type == FPM_MSG_TYPE_NONE)
- return 0;
+ if (hdr->msg_type == FPM_MSG_TYPE_NONE)
+ return 0;
- msg_len = fpm_msg_len (hdr);
+ msg_len = fpm_msg_len(hdr);
- if (msg_len < FPM_MSG_HDR_LEN || msg_len > FPM_MAX_MSG_LEN)
- return 0;
+ if (msg_len < FPM_MSG_HDR_LEN || msg_len > FPM_MAX_MSG_LEN)
+ return 0;
- /*
- * Netlink messages must be aligned properly.
- */
- if (hdr->msg_type == FPM_MSG_TYPE_NETLINK &&
- fpm_msg_align (msg_len) != msg_len)
- return 0;
+ /*
+ * Netlink messages must be aligned properly.
+ */
+ if (hdr->msg_type == FPM_MSG_TYPE_NETLINK
+ && fpm_msg_align(msg_len) != msg_len)
+ return 0;
- return 1;
+ return 1;
}
/*
* fpm_msg_ok
*
- * Returns TRUE if a message looks well-formed.
+ * Returns true if a message looks well-formed.
*
* @param len The length in bytes from 'hdr' to the end of the buffer.
*/
-static inline int
-fpm_msg_ok (const fpm_msg_hdr_t *hdr, size_t len)
+static inline int fpm_msg_ok(const fpm_msg_hdr_t *hdr, size_t len)
{
- if (len < FPM_MSG_HDR_LEN)
- return 0;
+ if (len < FPM_MSG_HDR_LEN)
+ return 0;
- if (!fpm_msg_hdr_ok (hdr))
- return 0;
+ if (!fpm_msg_hdr_ok(hdr))
+ return 0;
- if (fpm_msg_len (hdr) > len)
- return 0;
+ if (fpm_msg_len(hdr) > len)
+ return 0;
- return 1;
+ return 1;
}
// tcp maximum range
#define TCP_MAX_PORT 65535
-// tcp minimum range
+// tcp minimum range
#define TCP_MIN_PORT 1
#endif /* _FPM_H */
projects / mirror_frr.git / blobdiff