clang: Break after return type is always on

Signed-off-by: Adit Ranadive <[email protected]>

Author: aranadive

.clang-format

@@ -12,7 +12,7 @@ AllowShortCaseLabelsOnASingleLine: false
 AllowShortFunctionsOnASingleLine: Empty
 AllowShortIfStatementsOnASingleLine: false
 AllowShortLoopsOnASingleLine: false
-AlwaysBreakAfterReturnType: TopLevel
+AlwaysBreakAfterReturnType: All
 AlwaysBreakBeforeMultilineStrings: false
 AlwaysBreakTemplateDeclarations: false
 BinPackArguments: false
@@ -49,7 +49,7 @@ MaxEmptyLinesToKeep: 2
 NamespaceIndentation: Inner
 
 PackConstructorInitializers: CurrentLine
-PointerAlignment: Left
+PointerAlignment: Right
 ReferenceAlignment: Right
 ReflowComments: true
 SortIncludes: false

src/api/cpp/nixl.h

@@ -52,15 +52,17 @@ class nixlAgent {
 
     /* It is unsafe to move nixlAgent object */
     nixlAgent(nixlAgent &&) noexcept = delete;
-    nixlAgent &operator=(nixlAgent &&) noexcept = delete;
+    nixlAgent &
+    operator=(nixlAgent &&) noexcept = delete;
 
     /**
      * @brief  Discover the available supported plugins found in the plugin paths
      *
      * @param  plugins [out] Vector of available backend plugins
      * @return nixl_status_t Error code if call was not successful
      */
-    nixl_status_t getAvailPlugins(std::vector<nixl_backend_t> &plugins);
+    nixl_status_t
+    getAvailPlugins(std::vector<nixl_backend_t> &plugins);
 
     /**
      * @brief  Get the supported memory types, and init config parameters and their
@@ -71,9 +73,10 @@ class nixlAgent {
      * @param  params [out]  List of init parameters and their values for the plugin
      * @return nixl_status_t Error code if call was not successful
      */
-    nixl_status_t getPluginParams(const nixl_backend_t &type,
-                                  nixl_mem_list_t &mems,
-                                  nixl_b_params_t &params) const;
+    nixl_status_t
+    getPluginParams(const nixl_backend_t &type,
+                    nixl_mem_list_t &mems,
+                    nixl_b_params_t &params) const;
     /**
      * @brief  Get the backend parameters after instantiation. This will be a comprehensive
      *         list, for instance the default values used for parameters that were not
@@ -84,9 +87,10 @@ class nixlAgent {
      * @param  params [out]  List of init parameters and their values for the backend
      * @return nixl_status_t Error code if call was not successful
      */
-    nixl_status_t getBackendParams(const nixlBackendH* backend,
-                                   nixl_mem_list_t &mems,
-                                   nixl_b_params_t &params) const;
+    nixl_status_t
+    getBackendParams(const nixlBackendH *backend,
+                     nixl_mem_list_t &mems,
+                     nixl_b_params_t &params) const;
 
     /**
      * @brief  Instantiate a backend engine object based on the corresponding parameters
@@ -97,7 +101,9 @@ class nixlAgent {
      * @return nixl_status_t Error code if call was not successful
      */
     nixl_status_t
-    createBackend(const nixl_backend_t &type, const nixl_b_params_t &params, nixlBackendH*&backend);
+    createBackend(const nixl_backend_t &type,
+                  const nixl_b_params_t &params,
+                  nixlBackendH *&backend);
     /**
      * @brief  Register a memory/storage with NIXL. If a list of backends hints is provided
      *         (via extra_params), the registration is limited to the specified backends.
@@ -106,8 +112,8 @@ class nixlAgent {
      * @param  extra_params  Optional additional parameters used in registering memory
      * @return nixl_status_t Error code if call was not successful
      */
-    nixl_status_t registerMem(const nixl_reg_dlist_t &descs,
-                              const nixl_opt_args_t* extra_params = nullptr);
+    nixl_status_t
+    registerMem(const nixl_reg_dlist_t &descs, const nixl_opt_args_t *extra_params = nullptr);
 
     /**
      * @brief  Deregister a memory/storage from NIXL. If a list of backends hints is provided
@@ -118,8 +124,8 @@ class nixlAgent {
      * @param  extra_params  Optional additional parameters used in deregistering memory
      * @return nixl_status_t Error code if call was not successful
      */
-    nixl_status_t deregisterMem(const nixl_reg_dlist_t &descs,
-                                const nixl_opt_args_t* extra_params = nullptr);
+    nixl_status_t
+    deregisterMem(const nixl_reg_dlist_t &descs, const nixl_opt_args_t *extra_params = nullptr);
 
     /**
      * @brief  Make connection proactively, instead of at the time of the first transfer
@@ -129,8 +135,8 @@ class nixlAgent {
      * @param  remote_agent  Name of the remote agent
      * @return nixl_status_t Error code if call was not successful
      */
-    nixl_status_t makeConnection(const std::string &remote_agent,
-                                 const nixl_opt_args_t* extra_params = nullptr);
+    nixl_status_t
+    makeConnection(const std::string &remote_agent, const nixl_opt_args_t *extra_params = nullptr);
 
     /*** Transfer Request Preparation ***/
     /**
@@ -154,10 +160,11 @@ class nixlAgent {
      * @param  extra_params     Optional additional parameters used in preparing dlist handle
      * @return nixl_status_t    Error code if call was not successful
      */
-    nixl_status_t prepXferDlist(const std::string &agent_name,
-                                const nixl_xfer_dlist_t &descs,
-                                nixlDlistH*&dlist_hndl,
-                                const nixl_opt_args_t* extra_params = nullptr) const;
+    nixl_status_t
+    prepXferDlist(const std::string &agent_name,
+                  const nixl_xfer_dlist_t &descs,
+                  nixlDlistH *&dlist_hndl,
+                  const nixl_opt_args_t *extra_params = nullptr) const;
     /**
      * @brief  Make a transfer request `req_handl` by selecting indices from already
      *         prepared descriptor list handles. NIXL automatically determines the backend
@@ -174,13 +181,14 @@ class nixlAgent {
      * @param  extra_params     Optional additional parameters used in making a transfer request
      * @return nixl_status_t    Error code if call was not successful
      */
-    nixl_status_t makeXferReq(const nixl_xfer_op_t &operation,
-                              const nixlDlistH* local_side,
-                              const std::vector<int> &local_indices,
-                              const nixlDlistH* remote_side,
-                              const std::vector<int> &remote_indices,
-                              nixlXferReqH*&req_hndl,
-                              const nixl_opt_args_t* extra_params = nullptr) const;
+    nixl_status_t
+    makeXferReq(const nixl_xfer_op_t &operation,
+                const nixlDlistH *local_side,
+                const std::vector<int> &local_indices,
+                const nixlDlistH *remote_side,
+                const std::vector<int> &remote_indices,
+                nixlXferReqH *&req_hndl,
+                const nixl_opt_args_t *extra_params = nullptr) const;
     /**
      * @brief  A combined API, to create a transfer request from two descriptor lists.
      *         NIXL will prepare each side and create a transfer handle `req_hndl`.
@@ -210,12 +218,13 @@ class nixlAgent {
      * @param  extra_params   Optional extra parameters used in creating a transfer request
      * @return nixl_status_t  Error code if call was not successful
      */
-    nixl_status_t createXferReq(const nixl_xfer_op_t &operation,
-                                const nixl_xfer_dlist_t &local_descs,
-                                const nixl_xfer_dlist_t &remote_descs,
-                                const std::string &remote_agent,
-                                nixlXferReqH*&req_hndl,
-                                const nixl_opt_args_t* extra_params = nullptr) const;
+    nixl_status_t
+    createXferReq(const nixl_xfer_op_t &operation,
+                  const nixl_xfer_dlist_t &local_descs,
+                  const nixl_xfer_dlist_t &remote_descs,
+                  const std::string &remote_agent,
+                  nixlXferReqH *&req_hndl,
+                  const nixl_opt_args_t *extra_params = nullptr) const;
 
     /*** Operations on prepared Transfer Request ***/
 
@@ -231,16 +240,17 @@ class nixlAgent {
      * @param  extra_params  Optional extra parameters used in posting a transfer request
      * @return nixl_status_t NIXL_IN_PROG or error code if call was not successful
      */
-    nixl_status_t postXferReq(nixlXferReqH* req_hndl,
-                              const nixl_opt_args_t* extra_params = nullptr) const;
+    nixl_status_t
+    postXferReq(nixlXferReqH *req_hndl, const nixl_opt_args_t *extra_params = nullptr) const;
 
     /**
      * @brief  Check the status of transfer request `req_hndl`
      *
      * @param  req_hndl      Transfer request handle after postXferReq
      * @return nixl_status_t NIXL_IN_PROG or error code if call was not successful
      */
-    nixl_status_t getXferStatus(nixlXferReqH* req_hndl) const;
+    nixl_status_t
+    getXferStatus(nixlXferReqH *req_hndl) const;
 
     /**
      * @brief  Query the backend associated with `req_hndl`. E.g., if for genNotif
@@ -250,7 +260,8 @@ class nixlAgent {
      * @param  backend [out] Output backend handle chosen for the transfer request
      * @return nixl_status_t Error code if call was not successful
      */
-    nixl_status_t queryXferBackend(const nixlXferReqH* req_hndl, nixlBackendH*&backend) const;
+    nixl_status_t
+    queryXferBackend(const nixlXferReqH *req_hndl, nixlBackendH *&backend) const;
 
     /**
      * @brief  Release the transfer request `req_hndl`. If the transfer is active,
@@ -259,15 +270,17 @@ class nixlAgent {
      * @param  req_hndl      Transfer request handle to be released
      * @return nixl_status_t Error code if call was not successful
      */
-    nixl_status_t releaseXferReq(nixlXferReqH* req_hndl) const;
+    nixl_status_t
+    releaseXferReq(nixlXferReqH *req_hndl) const;
 
     /**
      * @brief  Release the prepared descriptor list handle `dlist_hndl`
      *
      * @param  dlist_hndl    Prepared descriptor list handle to be released
      * @return nixl_status_t Error code if call was not successful
      */
-    nixl_status_t releasedDlistH(nixlDlistH* dlist_hndl) const;
+    nixl_status_t
+    releasedDlistH(nixlDlistH *dlist_hndl) const;
 
 
     /*** Notification Handling ***/
@@ -282,8 +295,8 @@ class nixlAgent {
      * @param  extra_params  Optional extra parameters used in getting notifications
      * @return nixl_status_t Error code if call was not successful
      */
-    nixl_status_t getNotifs(nixl_notifs_t &notif_map,
-                            const nixl_opt_args_t* extra_params = nullptr);
+    nixl_status_t
+    getNotifs(nixl_notifs_t &notif_map, const nixl_opt_args_t *extra_params = nullptr);
 
     /**
      * @brief  Generate a notification, not bound to a transfer, e.g., for control.
@@ -297,9 +310,10 @@ class nixlAgent {
      * @param  extra_params  Optional extra parameters used in generating a standalone notif
      * @return nixl_status_t Error code if call was not successful
      */
-    nixl_status_t genNotif(const std::string &remote_agent,
-                           const nixl_blob_t &msg,
-                           const nixl_opt_args_t* extra_params = nullptr) const;
+    nixl_status_t
+    genNotif(const std::string &remote_agent,
+             const nixl_blob_t &msg,
+             const nixl_opt_args_t *extra_params = nullptr) const;
 
     /*** Metadata handling through side channel ***/
     /**
@@ -308,7 +322,8 @@ class nixlAgent {
      * @param  str [out]     The serialized metadata blob
      * @return nixl_status_t Error code if call was not successful
      */
-    nixl_status_t getLocalMD(nixl_blob_t &str) const;
+    nixl_status_t
+    getLocalMD(nixl_blob_t &str) const;
 
     /**
      * @brief  Get partial metadata blob for this agent, to be given to other agents.
@@ -325,9 +340,10 @@ class nixlAgent {
      * @param  extra_params  [in]  Optional extra parameters used in getting partial metadata
      * @return nixl_status_t       Error code if call was not successful
      */
-    nixl_status_t getLocalPartialMD(const nixl_reg_dlist_t &descs,
-                                    nixl_blob_t &str,
-                                    const nixl_opt_args_t* extra_params = nullptr) const;
+    nixl_status_t
+    getLocalPartialMD(const nixl_reg_dlist_t &descs,
+                      nixl_blob_t &str,
+                      const nixl_opt_args_t *extra_params = nullptr) const;
 
     /**
      * @brief  Load other agent's metadata and unpack it internally. Now the local
@@ -337,7 +353,8 @@ class nixlAgent {
      * @param  agent_name [out] Agent name extracted from the loaded metadata blob
      * @return nixl_status_t    Error code if call was not successful
      */
-    nixl_status_t loadRemoteMD(const nixl_blob_t &remote_metadata, std::string &agent_name);
+    nixl_status_t
+    loadRemoteMD(const nixl_blob_t &remote_metadata, std::string &agent_name);
 
     /**
      * @brief  Invalidate the remote agent metadata cached locally. This will
@@ -347,7 +364,8 @@ class nixlAgent {
      * @param  remote_agent  Remote agent name to invalidate its metadata blob
      * @return nixl_status_t Error code if call was not successful
      */
-    nixl_status_t invalidateRemoteMD(const std::string &remote_agent);
+    nixl_status_t
+    invalidateRemoteMD(const std::string &remote_agent);
 
     /*** Metadata handling through direct channels (p2p socket and ETCD) ***/
     /**
@@ -360,7 +378,8 @@ class nixlAgent {
      *
      * @return nixl_status_t Error code if call was not successful
      */
-    nixl_status_t sendLocalMD(const nixl_opt_args_t* extra_params = nullptr) const;
+    nixl_status_t
+    sendLocalMD(const nixl_opt_args_t *extra_params = nullptr) const;
 
     /**
      * @brief  Send partial metadata blob for this agent to peer or central metadata server
@@ -382,8 +401,9 @@ class nixlAgent {
      * @param  extra_params  [in]  Optional extra parameters used in getting partial metadata
      * @return nixl_status_t       Error code if call was not successful
      */
-    nixl_status_t sendLocalPartialMD(const nixl_reg_dlist_t &descs,
-                                     const nixl_opt_args_t* extra_params = nullptr) const;
+    nixl_status_t
+    sendLocalPartialMD(const nixl_reg_dlist_t &descs,
+                       const nixl_opt_args_t *extra_params = nullptr) const;
 
     /**
      * @brief  Fetch other agent's metadata and unpack it internally.
@@ -399,8 +419,8 @@ class nixlAgent {
      *
      * @return nixl_status_t    Error code if call was not successful
      */
-    nixl_status_t fetchRemoteMD(const std::string remote_name,
-                                const nixl_opt_args_t* extra_params = nullptr);
+    nixl_status_t
+    fetchRemoteMD(const std::string remote_name, const nixl_opt_args_t *extra_params = nullptr);
 
     /**
      * @brief  Invalidate your own memory in one/all remote agent(s).
@@ -412,7 +432,8 @@ class nixlAgent {
      *
      * @return nixl_status_t    Error code if call was not successful
      */
-    nixl_status_t invalidateLocalMD(const nixl_opt_args_t* extra_params = nullptr) const;
+    nixl_status_t
+    invalidateLocalMD(const nixl_opt_args_t *extra_params = nullptr) const;
 
     /**
      * @brief  Check if metadata is available for a remote agent.
@@ -422,8 +443,8 @@ class nixlAgent {
      * @param  str           Remote agent to check for
      * @return nixl_status_t Error code, NOT_FOUND if metadata not found
      */
-    nixl_status_t checkRemoteMD(const std::string remote_name,
-                                const nixl_xfer_dlist_t &descs) const;
+    nixl_status_t
+    checkRemoteMD(const std::string remote_name, const nixl_xfer_dlist_t &descs) const;
 };
 
 #endif