mash: Allow a subset of D-Bus clients to be created in DBusThreadManager

chromeos/dbus/dbus_client_bundle.h

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROMEOS_DBUS_DBUS_CLIENT_BUNDLE_H_
 #define CHROMEOS_DBUS_DBUS_CLIENT_BUNDLE_H_
 
 #include <memory>
 #include <string>
 
@@ skipping 18 matching lines @@
 class SessionManagerClient;
 class ShillDeviceClient;
 class ShillIPConfigClient;
 class ShillManagerClient;
 class ShillProfileClient;
 class ShillServiceClient;
 class ShillThirdPartyVpnDriverClient;
 class SystemClockClient;
 class UpdateEngineClient;
 
+// Declared outside of DBusClientBundle to make identifiers shorter in outside
+// classes.
+using DBusClientTypeMask = int;
+
 // The bundle of all D-Bus clients used in DBusThreadManager. The bundle
 // is used to delete them at once in the right order before shutting down the
 // system bus. See also the comment in the destructor of DBusThreadManager.
 class CHROMEOS_EXPORT DBusClientBundle {
  public:
-  typedef int DBusClientTypeMask;
-
-  // TODO(zelidrag): We might want to collapse few more of these subsystems if
-  // their dbus interfaced correspond to the same daemon.
   enum DBusClientType {
     NO_CLIENT = 0,
     BLUETOOTH = 1 << 0,
     CRAS = 1 << 1,
     CROS_DISKS = 1 << 2,
     CRYPTOHOME = 1 << 3,
     DEBUG_DAEMON = 1 << 4,
     EASY_UNLOCK = 1 << 5,
     LORGNETTE_MANAGER = 1 << 6,
     SHILL = 1 << 7,
     GSM_SMS = 1 << 8,
     IMAGE_BURNER = 1 << 9,
     MODEM_MESSAGING = 1 << 10,
     PERMISSION_BROKER = 1 << 11,
     POWER_MANAGER = 1 << 12,
     SESSION_MANAGER = 1 << 13,
     SMS = 1 << 14,
     SYSTEM_CLOCK = 1 << 15,
     UPDATE_ENGINE = 1 << 16,
     ARC_OBB_MOUNTER = 1 << 17,
+    ALL_CLIENTS = ~NO_CLIENT,
   };
 
-  explicit DBusClientBundle(DBusClientTypeMask unstub_client_mask);
+  // Creates real implementations for |real_client_mask| and fakes for
+  // |fake_client_mask|. The masks must be mutually exclusive. Fakes are used
+  // when running on Linux desktop and in tests. If a client does not appear in
+  // either mask then no implementation will be created and the getters below
+  // will return null.
+  DBusClientBundle(DBusClientTypeMask real_client_mask,
+                   DBusClientTypeMask fake_client_mask);
   ~DBusClientBundle();
 
-  // Returns true if |client| is stubbed.
-  bool IsUsingStub(DBusClientType client);
+  // Returns true if |client| is faked.
+  bool IsUsingFake(DBusClientType client) const;
+
+  // Returns true if |client| has the real client implementation.
+  bool IsUsingReal(DBusClientType client) const;
 
   // Returns true if any real DBusClient is used.
   bool IsUsingAnyRealClient();
 
   // Initialize proper runtime environment for its dbus clients.
   void SetupDefaultEnvironment();
 
-  // Parses command line param values for dbus subsystem that should be
-  // un-stubbed.
+  // Parses command line param values for dbus subsystems that should be forced
+  // to use real implementations.
   static DBusClientTypeMask ParseUnstubList(const std::string& unstub_list);

[James Cook, 2016/09/07 19:56:07]

I did not rename the --dbus-unstub-clients flag because I don't know who is
using it and I don't want to break their workflow. I also didn't rename any of
these functions, since I thought it would be useful to have it match the flag.

 
   ArcObbMounterClient* arc_obb_mounter_client() {
     return arc_obb_mounter_client_.get();
   }
 
   CrasAudioClient* cras_audio_client() {
     return cras_audio_client_.get();
   }
 
   CrosDisksClient* cros_disks_client() {
@@ skipping 72 matching lines @@
     return sms_client_.get();
   }
 
   UpdateEngineClient* update_engine_client() {
     return update_engine_client_.get();
   }
 
  private:
   friend class DBusThreadManagerSetter;
 
-  // Bitmask that defines which dbus clients are not stubbed out. Bitmap flags
-  // are defined within DBusClientType enum.
-  DBusClientTypeMask unstub_client_mask_;
+  // Bitmask for clients with real implementations. See DBusClientType.
+  const DBusClientTypeMask real_client_mask_;
 
+  // Bitmask for clients with fake implementations. See DBusClientType.
+  const DBusClientTypeMask fake_client_mask_;
+
+  // May be null if the current process does not use the client (e.g. in the
+  // ash process on mustash).
   std::unique_ptr<ArcObbMounterClient> arc_obb_mounter_client_;
   std::unique_ptr<CrasAudioClient> cras_audio_client_;
   std::unique_ptr<CrosDisksClient> cros_disks_client_;
   std::unique_ptr<CryptohomeClient> cryptohome_client_;
   std::unique_ptr<DebugDaemonClient> debug_daemon_client_;
   std::unique_ptr<EasyUnlockClient> easy_unlock_client_;
   std::unique_ptr<LorgnetteManagerClient> lorgnette_manager_client_;
   std::unique_ptr<ShillDeviceClient> shill_device_client_;
   std::unique_ptr<ShillIPConfigClient> shill_ipconfig_client_;
   std::unique_ptr<ShillManagerClient> shill_manager_client_;
@@ skipping 10 matching lines @@
   std::unique_ptr<SessionManagerClient> session_manager_client_;
   std::unique_ptr<SMSClient> sms_client_;
   std::unique_ptr<UpdateEngineClient> update_engine_client_;
 
   DISALLOW_COPY_AND_ASSIGN(DBusClientBundle);
 };
 
 }  // namespace chromeos
 
 #endif  // CHROMEOS_DBUS_DBUS_CLIENT_BUNDLE_H_