gd/hal/snoop_logger.h

/*
 * Copyright 2019 The Android Open Source Project
 *
 * Licensed 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.
 */

#pragma once

#include <fstream>
#include <iostream>
#include <mutex>
#include <string>

#include "hal/hci_hal.h"
#include "module.h"

namespace bluetooth {
namespace hal {

class SnoopLogger : public ::bluetooth::Module {
 public:
  static const ModuleFactory Factory;

  // Each transport using SnoopLogger should define its own DefaultFilepath
  static const std::string DefaultFilePath;
  // Set File Path before module is started to ensure all packets are written to the right file
  static void SetFilePath(const std::string& filename);
  // Flag to allow flush into persistent memory on every packet captured. This is enabled on host for debugging.
  static const bool AlwaysFlush;

  enum class PacketType {
    CMD = 1,
    ACL = 2,
    SCO = 3,
    EVT = 4,
  };

  enum class Direction {
    INCOMING,
    OUTGOING,
  };

  void capture(const HciPacket& packet, Direction direction, PacketType type);

 protected:
  void ListDependencies(ModuleList* list) override;
  void Start() override;
  void Stop() override;

 private:
  SnoopLogger();
  static std::string file_path;
  std::ofstream btsnoop_ostream_;
  std::mutex file_mutex_;
};

}  // namespace hal
}  // namespace bluetooth