xref: /btstack/platform/posix/hci_dump_posix_fs.c (revision e51d966a3d8bac55200d7fab1fb10fd7c79e3a2a)
1 /*
2  * Copyright (C) 2014-2020 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
24  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 #define BTSTACK_FILE__ "hci_dump_posix_fs.c"
39 
40 /*
41  *  hci_dump_posix_fs.c
42  *
43  *  Dump HCI trace in various formats into a file:
44  *
45  *  - BlueZ's hcidump format
46  *  - Apple's PacketLogger
47  *  - stdout hexdump
48  *
49  */
50 
51 #include "btstack_config.h"
52 
53 // enable POSIX functions (needed for -std=c99)
54 #define _POSIX_C_SOURCE 200809
55 
56 #include "hci_dump_posix_fs.h"
57 
58 #include "btstack_debug.h"
59 #include "hci_cmd.h"
60 
61 #include <time.h>
62 #include <stdio.h>        // printf
63 #include <fcntl.h>        // open
64 #include <unistd.h>       // write
65 #include <errno.h>        // errno
66 #include <sys/time.h>     // for timestamps
67 #include <sys/stat.h>     // file modes
68 
69 static int  dump_file = -1;
70 static int  dump_format;
71 static char log_message_buffer[256];
72 
73 static void hci_dump_posix_fs_reset(void){
74     btstack_assert(dump_file >= 0);
75     (void) lseek(dump_file, 0, SEEK_SET);
76     (void) ftruncate(dump_file, 0);
77 }
78 
79 static void hci_dump_posix_fs_log_packet(uint8_t packet_type, uint8_t in, uint8_t *packet, uint16_t len) {
80     if (dump_file < 0) return;
81 
82     static union {
83         uint8_t header_bluez[HCI_DUMP_HEADER_SIZE_BLUEZ];
84         uint8_t header_packetlogger[HCI_DUMP_HEADER_SIZE_PACKETLOGGER];
85     } header;
86 
87     uint32_t tv_sec = 0;
88     uint32_t tv_us  = 0;
89 
90     // get time
91     struct timeval curr_time;
92     gettimeofday(&curr_time, NULL);
93     tv_sec = curr_time.tv_sec;
94     tv_us  = curr_time.tv_usec;
95 
96     uint16_t header_len = 0;
97     switch (dump_format){
98         case HCI_DUMP_BLUEZ:
99             hci_dump_setup_header_bluez(header.header_bluez, tv_sec, tv_us, packet_type, in, len);
100             header_len = HCI_DUMP_HEADER_SIZE_BLUEZ;
101             break;
102         case HCI_DUMP_PACKETLOGGER:
103             hci_dump_setup_header_packetlogger(header.header_packetlogger, tv_sec, tv_us, packet_type, in, len);
104             header_len = HCI_DUMP_HEADER_SIZE_PACKETLOGGER;
105             break;
106         default:
107             return;
108     }
109 
110     (void) write(dump_file, &header, header_len);
111     (void) write(dump_file, packet, len );
112 }
113 
114 static void hci_dump_posix_fs_log_message(const char * format, va_list argptr){
115     if (dump_file < 0) return;
116     int len = vsnprintf(log_message_buffer, sizeof(log_message_buffer), format, argptr);
117     hci_dump_posix_fs_log_packet(LOG_MESSAGE_PACKET, 0, (uint8_t*) log_message_buffer, len);
118 }
119 
120 // returns system errno
121 int hci_dump_posix_fs_open(const char *filename, hci_dump_format_t format){
122     btstack_assert(format == HCI_DUMP_BLUEZ || format == HCI_DUMP_PACKETLOGGER);
123 
124     dump_format = format;
125     int oflags = O_WRONLY | O_CREAT | O_TRUNC;
126 #ifdef _WIN32
127     oflags |= O_BINARY;
128 #endif
129     dump_file = open(filename, oflags, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH );
130     if (dump_file < 0){
131         printf("failed to open file %s, errno = %d\n", filename, errno);
132         return errno;
133     }
134     return 0;
135 }
136 
137 void hci_dump_posix_fs_close(void){
138     close(dump_file);
139     dump_file = -1;
140 }
141 
142 const hci_dump_t * hci_dump_posix_fs_get_instance(void){
143     static const hci_dump_t hci_dump_instance = {
144         // void (*reset)(void);
145         &hci_dump_posix_fs_reset,
146         // void (*log_packet)(uint8_t packet_type, uint8_t in, uint8_t *packet, uint16_t len);
147         &hci_dump_posix_fs_log_packet,
148         // void (*log_message)(int log_level, const char * format, va_list argptr);
149         &hci_dump_posix_fs_log_message,
150     };
151     return &hci_dump_instance;
152 }
153