You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by GitBox <gi...@apache.org> on 2022/08/23 11:25:05 UTC
[GitHub] [incubator-nuttx] xiaoxiang781216 commented on a diff in pull request #6899: net:add btsnoop and snoop
xiaoxiang781216 commented on code in PR #6899:
URL: https://github.com/apache/incubator-nuttx/pull/6899#discussion_r952486401
##########
net/utils/net_snoop.c:
##########
@@ -0,0 +1,393 @@
+/****************************************************************************
+ * net/utils/net_snoop.c
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership. The
+ * ASF licenses this file to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the
+ * License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ ****************************************************************************/
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <endian.h>
+#include <fcntl.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <sys/time.h>
+#include <string.h>
+
+#include <nuttx/net/snoop.h>
+
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+
+#ifndef ARRAY_SIZE
+# define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
+#endif
+
+#define SNOOP_VERSION_1 1
+#define SNOOP_VERSION_2 2
+
+/* microseconds since midnight, January 1st, 0 AD nominal Gregorian. */
+
+#define SNOOP_EPOCH_USEC(tv) (((tv).tv_sec - 0x386d4380ll) * 1000000ll \
+ + (tv).tv_usec + 0x00e03ab44a676000ll)
+
+/****************************************************************************
+ * Private Type Definitions
+ ****************************************************************************/
+
+/* The availability of tools to capture, display and interpret packets
+ * traversing a network has proven extremely useful in debugging
+ * networking problems. The ability to capture packets and store them
+ * for later analysis allows one to de-couple the tasks of collecting
+ * information about a network problem and analysing that information.
+ *
+ * More info about snoop datalink type, please refer to
+ * https://www.rfc-editor.org/rfc/rfc1761.txt and
+ * https://fte.com/webhelpii/hsu/Content/Technical_Information/
+ * BT_Snoop_File_Format.htm
+ */
+
+/* The snoop packet capture file is an array of octets structured as
+ * follows:
+ *
+ * +------------------------+
+ * | |
+ * | File Header |
+ * | |
+ * +------------------------+
+ * | |
+ * | Packet Record |
+ * ~ Number 1 ~
+ * | |
+ * +------------------------+
+ * . .
+ * . .
+ * . .
+ * +------------------------+
+ * | |
+ * | Packet Record |
+ * ~ Number N ~
+ * | |
+ * +------------------------+
+ */
+
+/* snoop_file_header_s
+ *
+ * The structure of the File Header is as follows:
+ *
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ * | |
+ * + Identification Pattern +
+ * | |
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ * | Version Number |
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ * | Datalink Type |
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ */
+
+begin_packed_struct struct snoop_file_header_s
+{
+ uint8_t magic[8]; /* Identification Pattern */
+ uint32_t version; /* Version Number */
+ uint32_t datalink; /* Datalink Type */
+} end_packed_struct;
+
+/* snoop_packet_header_s
+ *
+ * The structure of the packet record is as follows:
+ *
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ * | Original Length |
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ * | Included Length |
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ * | Packet Record Length |
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ * | Cumulative Drops |
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ * | Timestamp Seconds |
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ * | Timestamp Microseconds |
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ * | |
+ * . .
+ * . Packet Data .
+ * . .
+ * + +- - - - - - - -+
+ * | | Pad |
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ */
+
+begin_packed_struct struct snoop_packet_header_s
+{
+ uint32_t orig_len; /* actual length of packet */
+ uint32_t incl_len; /* number of octets captured in file */
+ union
+ {
+ uint32_t flags; /* Packet Flags: 1 hci cmd , eg: btsnoop */
+ uint32_t rec_len; /* length of record */
+ };
+ uint32_t cum_drops; /* cumulative number of dropped packets */
+ union
+ {
+ uint64_t ts_usec; /* timestamp microseconds, eg: btsnoop */
+ struct
+ {
+ uint32_t ts_sec; /* timestamp seconds */
+ uint32_t ts_usec; /* timestamp microseconds */
+ } ts;
+ };
+} end_packed_struct;
+
+/****************************************************************************
+ * Private Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: snoop_dump_packet_header
+ *
+ * Description:
+ * This function fill snoop headr info.
+ *
+ ****************************************************************************/
+
+static int snoop_dump_packet_header(FAR struct snoop_s *snoop,
+ uint32_t bytes, uint32_t drops,
+ uint32_t flags)
+{
+ struct snoop_packet_header_s header;
+ int ret;
+
+ if (!snoop)
+ {
+ return -EINVAL;
+ }
+
+ switch (snoop->datalink)
+ {
+ case SNOOP_DATALINK_HCI_UNENCAP:
+ case SNOOP_DATALINK_HCI_UART:
+ case SNOOP_DATALINK_HCI_BSCP:
+ case SNOOP_DATALINK_HCI_SERIAL:
+ {
+ struct timeval tv;
+
+ gettimeofday(&tv, NULL);
+ header.ts_usec = htobe64(SNOOP_EPOCH_USEC(tv));
+ header.flags = htobe32(flags);
+ break;
+ }
+
+ case SNOOP_DATALINK_TYPE_TOKENBUS:
+ case SNOOP_DATALINK_TYPE_TOKERING:
+ case SNOOP_DATALINK_TYPE_METRONET:
+ case SNOOP_DATALINK_TYPE_ETHERNET:
+ case SNOOP_DATALINK_TYPE_HDLC:
+ case SNOOP_DATALINK_TYPE_CHARSYNC:
+ case SNOOP_DATALINK_TYPE_IBMC2C:
+ case SNOOP_DATALINK_TYPE_FDDI:
+ case SNOOP_DATALINK_TYPE_OTHER:
+ {
+ struct timeval tv;
+
+ gettimeofday(&tv, NULL);
+ header.ts.ts_sec = htobe32(tv.tv_sec);
+ header.ts.ts_usec = htobe32(tv.tv_usec);
+ header.rec_len = htobe32(flags);
+ break;
+ }
+
+ default:
+ {
+ return -EINVAL;
+ }
+ }
+
+ header.orig_len = htobe32(bytes);
+ header.incl_len = htobe32(bytes);
+ header.cum_drops = htobe32(drops);
+
+ ret = file_write(&snoop->filep, &header, sizeof(header));
+ if (ret != sizeof(header))
+ {
+ return ret < 0 ? ret : -EINVAL;
+ }
+
+ return OK;
+}
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: snoop_open
+ *
+ * Description:
+ * This function open snoop file by datalink.
+ *
+ ****************************************************************************/
+
+int snoop_open(FAR struct snoop_s *snoop, FAR const char *filename,
+ uint32_t datalink, bool autosync)
+{
+ struct snoop_file_header_s header;
+ int ret;
+
+ if (!snoop)
+ {
+ return -EINVAL;
+ }
+
+ switch (datalink)
+ {
+ case SNOOP_DATALINK_TYPE_TOKENBUS:
+ case SNOOP_DATALINK_TYPE_TOKERING:
+ case SNOOP_DATALINK_TYPE_METRONET:
+ case SNOOP_DATALINK_TYPE_ETHERNET:
+ case SNOOP_DATALINK_TYPE_HDLC:
+ case SNOOP_DATALINK_TYPE_CHARSYNC:
+ case SNOOP_DATALINK_TYPE_IBMC2C:
+ case SNOOP_DATALINK_TYPE_FDDI:
+ case SNOOP_DATALINK_TYPE_OTHER:
+ {
+ uint8_t snoop_magic[] =
+ {
+ 's', 'n', 'o', 'o', 'p', '\0', '\0', '\0'
+ };
+
+ memcpy(header.magic, snoop_magic, ARRAY_SIZE(snoop_magic));
+ header.version = htobe32(SNOOP_VERSION_2);
+ break;
+ };
+
+ case SNOOP_DATALINK_HCI_UNENCAP:
+ case SNOOP_DATALINK_HCI_UART:
+ case SNOOP_DATALINK_HCI_BSCP:
+ case SNOOP_DATALINK_HCI_SERIAL:
+ {
+ uint8_t btsnoop_magic[] =
+ {
+ 'b', 't', 's', 'n', 'o', 'o', 'p', '\0'
+ };
+
+ memcpy(header.magic, btsnoop_magic, ARRAY_SIZE(btsnoop_magic));
+ header.version = htobe32(SNOOP_VERSION_1);
+ break;
+ }
+
+ default:
+ {
+ return -EINVAL;
+ }
+ }
+
+ ret = file_open(&snoop->filep, filename, O_RDWR | O_CREAT);
+ if (ret < 0)
+ {
+ return ret;
+ }
+
+ snoop->datalink = datalink;
+ snoop->autosync = autosync;
+ header.datalink = htobe32(datalink);
+
+ ret = file_write(&snoop->filep, &header, sizeof(header));
+ if (ret != sizeof(header))
+ {
+ ret = ret < 0 ? ret : -EINVAL;
+ goto error;
+ }
+
+ return OK;
+
+error:
+ file_close(&snoop->filep);
+ return ret;
+}
+
+/****************************************************************************
+ * Name: snoop_dump
+ *
+ * Description:
+ * This function dump nbytes buf data into snoop file.
+ *
+ ****************************************************************************/
+
+int snoop_dump(FAR struct snoop_s *snoop, FAR const void *buf,
+ uint32_t nbytes, uint32_t drops, uint32_t flags)
+{
+ int ret;
+
+ if (!snoop)
+ {
+ return -EINVAL;
+ }
+
+ ret = snoop_dump_packet_header(snoop, nbytes, drops, flags);
+ if (ret != OK)
+ {
+ return ret;
+ }
+
+ ret = file_write(&snoop->filep, buf, nbytes);
+ if (ret != nbytes)
+ {
+ return ret < 0 ? ret : -EINVAL;
+ }
+
+ return snoop->autosync ? snoop_sync(snoop) : OK;
+}
+
+/****************************************************************************
+ * Name: snoop_sync
+ *
+ * Description:
+ * This function sync snoop buffer.
+ *
+ ****************************************************************************/
+
+int snoop_sync(FAR struct snoop_s *snoop)
+{
+ if (!snoop)
+ {
+ return -EINVAL;
+ }
+
+ return file_fsync(&snoop->filep);
Review Comment:
add CONFIG_DISABLE_MOUNTPOINT check
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org