organize files in directories

Summary: organize files in directories

Switched to <wdt/X.h> <wdt/util/Y.h> scheme from "X.h" "Y.h"

Improved some include readability (adding empty line, added (c))

Shared the compiler flags : fixed unused variables and signed comparison mismatch warnings uncovered as a result

Reduced some includes (still more to do)

Reviewed By: nikunjy

Differential Revision: D2569429

fb-gh-sync-id: 9cddc2072fc94fb11de34126089f2ba445ec0fb1

Author: ldemailly

AbortChecker.h

@@ -1,7 +1,17 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
 #pragma once
 #include <atomic>
+
 namespace facebook {
 namespace wdt {
+
 /// Interface for external abort checks (pull mode)
 class IAbortChecker {
  public:
@@ -23,5 +33,6 @@ class WdtAbortChecker : public IAbortChecker {
  private:
   std::atomic<bool> const *abortTriggerPtr_;
 };
-}
+
+}  // end namespaces
 }

ByteSource.h

@@ -8,8 +8,8 @@
  */
 #pragma once
 
-#include "Reporting.h"
-#include "Protocol.h"
+#include <wdt/Reporting.h>
+#include <wdt/Protocol.h>
 
 #include <string>
 
@@ -114,5 +114,6 @@ class ByteSource {
   /// @param stats    Stats to be added
   virtual void addTransferStats(const TransferStats &stats) = 0;
 };
-}
+
+}  // end namespaces
 }

CMakeLists.txt

@@ -22,7 +22,7 @@ cmake_minimum_required(VERSION 3.2)
 # There is no C per se in WDT but if you use CXX only here many checks fail
 # Version is Major.Minor.YYMMDDX for up to 10 releases per day
 # Minor currently is also the protocol version - has to match with Protocol.cpp
-project("WDT" LANGUAGES C CXX VERSION 1.22.1510210)
+project("WDT" LANGUAGES C CXX VERSION 1.22.1510220)
 
 # On MacOS this requires the latest (master) CMake (and/or CMake 3.1.1/3.2)
 set(CMAKE_CXX_STANDARD 11)
@@ -73,32 +73,32 @@ set (FOLLY_CPP_SRC
 
 # WDT's library proper - comes from: ls -1 *.cpp | grep -iv test
 add_library(wdtlib_min
-ClientSocket.cpp
-DirectorySourceQueue.cpp
+util/ClientSocket.cpp
+util/DirectorySourceQueue.cpp
 ErrorCodes.cpp
-FileByteSource.cpp
-FileCreator.cpp
+util/FileByteSource.cpp
+util/FileCreator.cpp
 Protocol.cpp
 WdtThread.cpp
-ThreadsController.cpp
+util/ThreadsController.cpp
 ReceiverThread.cpp
 Receiver.cpp
 Reporting.cpp
-ThreadTransferHistory.cpp
+util/ThreadTransferHistory.cpp
 SenderThread.cpp
 Sender.cpp
-ServerSocket.cpp
-SocketUtils.cpp
+util/ServerSocket.cpp
+util/SocketUtils.cpp
 Throttler.cpp
 WdtOptions.cpp
-FileWriter.cpp
-TransferLogManager.cpp
-SerializationUtil.cpp
+util/FileWriter.cpp
+util/TransferLogManager.cpp
+util/SerializationUtil.cpp
 WdtBase.cpp
 WdtResourceController.cpp
 )
 add_library(wdtlib
-WdtFlags.cpp
+util/WdtFlags.cpp
 )
 target_link_libraries(wdtlib wdtlib_min)
 
@@ -166,7 +166,7 @@ int main(int argc, char** argv) {
 }" FOLLY_HAVE_WEAK_SYMBOLS)
 # Now record all this :
 # Folly's:
-configure_file(folly-config.h.in folly/folly-config.h)
+configure_file(build/folly-config.h.in folly/folly-config.h)
 # Wdt's config/version
 configure_file(WdtConfig.h.in wdt/WdtConfig.h)
 
@@ -189,8 +189,9 @@ include_directories(${CMAKE_CURRENT_BINARY_DIR})
 include_directories(${FOLLY_SOURCE_DIR})
 include_directories(${GLOG_INCLUDE_DIR})
 include_directories(${GFLAGS_INCLUDE_DIR})
+include_directories(${CMAKE_CURRENT_SOURCE_DIR})
 
-add_executable(wdt wdtCmdLine.cpp WdtFlags.cpp)
+add_executable(wdt wdtCmdLine.cpp util/WdtFlags.cpp)
 set_target_properties(wdt PROPERTIES COMPILE_DEFINITIONS "STANDALONE_APP")
 
 target_link_libraries(wdt wdtlib_min)
@@ -203,7 +204,7 @@ install(TARGETS wdt wdtlib wdtlib_min folly4wdt
   ARCHIVE DESTINATION lib
   )
 # wcp script
-install(PROGRAMS wcp.sh DESTINATION bin RENAME wcp)
+install(PROGRAMS test/wcp.sh DESTINATION bin RENAME wcp)
 
 
 ### Everything below is about testing (and not required to create wdt/wdtlib)
@@ -255,59 +256,60 @@ if (BUILD_TESTING)
   )
 
   add_library(wdt4tests
-    WdtFlags.cpp
+    util/WdtFlags.cpp
   )
   target_link_libraries(wdt4tests wdt4tests_min)
 
 
-  add_executable(protocol_test ProtocolTest.cpp)
+  add_executable(protocol_test test/ProtocolTest.cpp)
   target_link_libraries(protocol_test wdt4tests)
   add_test(NAME AllTestsInProtocolTest COMMAND protocol_test)
 
-  add_executable(resource_controller_test  WdtResourceControllerTest.cpp)
+  add_executable(resource_controller_test  test/WdtResourceControllerTest.cpp)
   target_link_libraries(resource_controller_test wdt4tests)
   add_test(NAME ResourceControllerTests COMMAND resource_controller_test)
 
-  add_executable(file_reader_test  FileReaderTest.cpp)
+  add_executable(file_reader_test  test/FileReaderTest.cpp)
   target_link_libraries(file_reader_test wdt4tests)
   add_test(NAME FileReaderTests COMMAND file_reader_test)
 
-  add_executable(option_type_test_long_flags OptionTypeTest.cpp)
+  add_executable(option_type_test_long_flags test/OptionTypeTest.cpp)
   target_link_libraries(option_type_test_long_flags wdt4tests)
 
-  add_executable(option_type_test_short_flags OptionTypeTest.cpp WdtFlags.cpp)
+  add_executable(option_type_test_short_flags test/OptionTypeTest.cpp
+                                              util/WdtFlags.cpp)
   set_target_properties(option_type_test_short_flags PROPERTIES
     COMPILE_DEFINITIONS "STANDALONE_APP")
   target_link_libraries(option_type_test_short_flags wdt4tests_min)
 
   add_test(NAME WdtRandGenTest COMMAND
-    "${CMAKE_CURRENT_SOURCE_DIR}/wdt_rand_gen_test.sh")
+    "${CMAKE_CURRENT_SOURCE_DIR}/test/wdt_rand_gen_test.sh")
 
   add_test(NAME WdtBasicE2E COMMAND
-    "${CMAKE_CURRENT_SOURCE_DIR}/wdt_e2e_simple_test.sh")
+    "${CMAKE_CURRENT_SOURCE_DIR}/test/wdt_e2e_simple_test.sh")
 
   add_test(NAME WdtBasicE2Exfs COMMAND
-    "${CMAKE_CURRENT_SOURCE_DIR}/wdt_e2e_xfs_test.sh")
+    "${CMAKE_CURRENT_SOURCE_DIR}/test/wdt_e2e_xfs_test.sh")
 
   add_test(NAME WdtOptionsTypeTests COMMAND
-    "${CMAKE_CURRENT_SOURCE_DIR}/wdt_option_type_test.sh")
+    "${CMAKE_CURRENT_SOURCE_DIR}/test/wdt_option_type_test.sh")
 
   add_test(NAME WdtPortBlockTest COMMAND
-    "${CMAKE_CURRENT_SOURCE_DIR}/wdt_port_block_test.py")
+    "${CMAKE_CURRENT_SOURCE_DIR}/test/wdt_port_block_test.py")
 
   add_test(NAME WdtProtocolNegotiationTest COMMAND
-    "${CMAKE_CURRENT_SOURCE_DIR}/wdt_protocol_negotiation_test.py")
+    "${CMAKE_CURRENT_SOURCE_DIR}/test/wdt_protocol_negotiation_test.py")
 
   add_test(NAME WdtSimpleOdirectTest COMMAND
-    "${CMAKE_CURRENT_SOURCE_DIR}/wdt_e2e_simple_test.sh" -o true)
+    "${CMAKE_CURRENT_SOURCE_DIR}/test/wdt_e2e_simple_test.sh" -o true)
 
   add_test(NAME WdtFileListTest COMMAND
-    "${CMAKE_CURRENT_SOURCE_DIR}/wdt_file_list_test.py")
+    "${CMAKE_CURRENT_SOURCE_DIR}/test/wdt_file_list_test.py")
 
   add_test(NAME WdtOverwriteTest COMMAND
-    "${CMAKE_CURRENT_SOURCE_DIR}/wdt_overwrite_test.py")
+    "${CMAKE_CURRENT_SOURCE_DIR}/test/wdt_overwrite_test.py")
 
   add_test(NAME WdtBadServerTest COMMAND
-    "${CMAKE_CURRENT_SOURCE_DIR}/wdt_bad_server_test.py")
+    "${CMAKE_CURRENT_SOURCE_DIR}/test/wdt_bad_server_test.py")
 
 endif(BUILD_TESTING)

Protocol.cpp

@@ -6,11 +6,11 @@
  * LICENSE file in the root directory of this source tree. An additional grant
  * of patent rights can be found in the PATENTS file in the same directory.
  */
-#include "Protocol.h"
+#include <wdt/Protocol.h>
 
-#include "ErrorCodes.h"
-#include "WdtOptions.h"
-#include "SerializationUtil.h"
+#include <wdt/ErrorCodes.h>
+#include <wdt/WdtOptions.h>
+#include <wdt/util/SerializationUtil.h>
 
 #include <folly/String.h>  // exceptionStr
 #include <algorithm>

Protocol.h

@@ -8,7 +8,7 @@
  */
 #pragma once
 
-#include "ErrorCodes.h"
+#include <wdt/ErrorCodes.h>
 
 #include <folly/Range.h>
 #include <stddef.h>

README.md

@@ -92,8 +92,18 @@ needed.
 
 ### Directories
 
-* deps/
-Dependencies (open source version)
+* top level
+Main WDT classes and Wdt command line source, CMakeLists.txt
+
+* util/
+Utilities used for implementing the main objects
+
+* test/
+Tests files and scripts
+
+* build/
+Build related scripts and files and utils
+
 
 * fbonly/
 Stuff specific to facebook/ (not in open source version)
@@ -163,7 +173,7 @@ the current largest file)
 * ThreadTransferHistory.{h|cpp}
 
 Every thread maintains a transfer history so that when a connection breaks
-it can talk to the receiver to find out up to where in the history has been 
+it can talk to the receiver to find out up to where in the history has been
 sent. This class encapsulates all the logic for that bookkeeping
 
 * SenderThread.{h|cpp}
@@ -288,15 +298,15 @@ wdt_max_send_test.sh
 (facebook only:)
 Make sure to do the following, before "arc diff":
 ```
- (cd wdt ; ./clangformat.sh ; ./version_update.tcl )
+ (cd wdt ; ./build/clangformat.sh ; ./build/version_update.tcl )
 
  fbconfig  --clang --with-project-version clang:dev -r  wdt
 
  fbmake runtests --run-disabled --extended-tests
  fbmake runtests_opt
  fbmake opt
 
- wdt/wdt_max_send_test.sh
+ wdt/test/wdt_max_send_test.sh
 ```
 
 and check the output of the last step to make sure one of the 3 runs is

Receiver.cpp

@@ -6,10 +6,10 @@
  * LICENSE file in the root directory of this source tree. An additional grant
  * of patent rights can be found in the PATENTS file in the same directory.
  */
-#include "Receiver.h"
-#include "ServerSocket.h"
-#include "FileWriter.h"
-#include "SocketUtils.h"
+#include <wdt/Receiver.h>
+#include <wdt/util/FileWriter.h>
+#include <wdt/util/ServerSocket.h>
+#include <wdt/util/SocketUtils.h>
 
 #include <folly/Conv.h>
 #include <folly/Memory.h>

Receiver.h

@@ -8,18 +8,11 @@
  */
 #pragma once
 
-#include "WdtBase.h"
-#include "FileCreator.h"
-#include "ErrorCodes.h"
-#include "WdtOptions.h"
-#include "Reporting.h"
-#include "ServerSocket.h"
-#include "Protocol.h"
-#include "Writer.h"
-#include "Throttler.h"
-#include "ReceiverThread.h"
-#include "TransferLogManager.h"
-#include "ThreadsController.h"
+#include <wdt/WdtBase.h>
+#include <wdt/ReceiverThread.h>
+#include <wdt/util/FileCreator.h>
+#include <wdt/util/ServerSocket.h>
+#include <wdt/util/TransferLogManager.h>
 #include <memory>
 #include <string>
 #include <condition_variable>

ReceiverThread.cpp

@@ -6,8 +6,8 @@
  * LICENSE file in the root directory of this source tree. An additional grant
  * of patent rights can be found in the PATENTS file in the same directory.
  */
-#include "ReceiverThread.h"
-#include "FileWriter.h"
+#include <wdt/ReceiverThread.h>
+#include <wdt/util/FileWriter.h>
 #include <folly/Conv.h>
 #include <folly/Memory.h>
 #include <folly/String.h>

ReceiverThread.h

@@ -7,12 +7,14 @@
  * of patent rights can be found in the PATENTS file in the same directory.
  */
 #pragma once
-#include "WdtBase.h"
-#include "WdtThread.h"
-#include "Receiver.h"
-#include "ServerSocket.h"
+#include <wdt/WdtBase.h>
+#include <wdt/WdtThread.h>
+#include <wdt/Receiver.h>
+#include <wdt/util/ServerSocket.h>
+
 namespace facebook {
 namespace wdt {
+
 class Receiver;
 /**
  * Wdt receiver has logic to maintain the consistency of the