Do not execute two or more setxkbmap commands in parallel.

chrome/browser/chromeos/input_method/xkeyboard.cc

 // Copyright (c) 2011 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.
 
 #include "chrome/browser/chromeos/input_method/xkeyboard.h"
 
+#include <queue>
 #include <utility>
 
 #include <X11/XKBlib.h>
 #include <X11/Xlib.h>
 #include <glib.h>
 #include <stdlib.h>
 #include <string.h>
 
 #include "base/memory/singleton.h"
 #include "base/logging.h"
 #include "base/string_util.h"
 #include "base/process_util.h"
 #include "chrome/browser/chromeos/cros/cros_library.h"
 #include "chrome/browser/chromeos/input_method/input_method_util.h"
+#include "content/browser/browser_thread.h"
 
 namespace chromeos {
 namespace input_method {
 namespace {
 
 // The default keyboard layout name in the xorg config file.
 const char kDefaultLayoutName[] = "us";
 // The command we use to set the current XKB layout and modifier key mapping.
 // TODO(yusukes): Use libxkbfile.so instead of the command (crosbug.com/13105)
 const char kSetxkbmapCommand[] = "/usr/bin/setxkbmap";
@@ skipping 190 matching lines @@
   // This function is used by SetLayout() and RemapModifierKeys(). Calls
   // setxkbmap command if needed, and updates the last_full_layout_name_ cache.
   bool SetLayoutInternal(const std::string& layout_name,
                          const ModifierMap& modifier_map,
                          bool force) {
     if (!CrosLibrary::Get()->EnsureLoaded()) {
       // We should not try to change a layout inside ui_tests.
       return false;
     }
 
-    const std::string layouts_to_set = CreateFullXkbLayoutName(
+    const std::string layout_to_set = CreateFullXkbLayoutName(
         layout_name, modifier_map);
-    if (layouts_to_set.empty()) {
+    if (layout_to_set.empty()) {
       return false;
     }
 
     if (!current_layout_name_.empty()) {
       const std::string current_layout = CreateFullXkbLayoutName(
           current_layout_name_, current_modifier_map_);
-      if (!force && (current_layout == layouts_to_set)) {
-        DLOG(INFO) << "The requested layout is already set: " << layouts_to_set;
+      if (!force && (current_layout == layout_to_set)) {
+        DLOG(INFO) << "The requested layout is already set: " << layout_to_set;
         return true;
       }
     }
 
     // Turn off caps lock if there is no kCapsLockKey in the remapped keys.
     if (!ContainsModifierKeyAsReplacement(
             modifier_map, kCapsLockKey)) {
       SetCapsLockEnabled(false);
     }
 
     // TODO(yusukes): Revert to VLOG(1) when crosbug.com/15851 is resolved.
     LOG(WARNING) << (force ? "Reapply" : "Set")
-                 << " layout: " << layouts_to_set;
+                 << " layout: " << layout_to_set;
 
-    ExecuteSetLayoutCommand(layouts_to_set);
+    const bool start_execution = execute_queue_.empty();
+    execute_queue_.push(layout_to_set);
+    if (start_execution) {

[satorux1, 2011/06/07 05:41:29]

I thought we could move the queue management logic to
MaybeExecuteSetLayoutCommand();

Something like below may be a bit cleaner.

  execute_queue_.push(layout_to_set);
  MaybeExecuteSetLayoutCommand();


void MaybeExecuteSetLayoutCommand() {
  // We execute the setxkbmap command one at a time.
  // OnSetLayoutFinish() dequeues and retries as needed.
  if (execute_queue_.size() != 1)
    return;

[Yusuke Sato, 2011/06/07 05:51:43]

I think it will not work if SetLayout() is rapidly called more than 3 times.

SetLayout(A);  // queue.size() == 1, call setxkbmap
SetLayout(B);  // queue.size() == 2, do not call setxkbmap since the size != 1
SetLayout(C);  // queue.size() == 3, do not call setxkbmap since the size != 1
OnSetLayoutFinish() for A; // queue.pop() is called first and queue.size()
becomes 2, the next setxkbmap will NOT be called since the size != 1

On 2011/06/07 05:41:29, satorux1 wrote:

[satorux1, 2011/06/07 05:59:13]

Thank you for the explanation. The code wasn't obvious to me. Would be nice to
add a comment why you are doing this here.


On 2011/06/07 05:51:43, Yusuke Sato wrote:

[Yusuke Sato, 2011/06/07 06:53:28]

Done.

+      // No setxkbmap command is in flight. Start the first one.
+      MaybeExecuteSetLayoutCommand();
+    }
     return true;
   }
 
-  // Executes 'setxkbmap -layout ...' command asynchronously.
+  // Executes 'setxkbmap -layout ...' command asynchronously using a layout name
+  // in the |execute_queue_|. Do nothing if the queue is empty.
   // TODO(yusukes): Use libxkbfile.so instead of the command (crosbug.com/13105)
-  void ExecuteSetLayoutCommand(const std::string& layouts_to_set) {
+  void MaybeExecuteSetLayoutCommand() {
+    if (execute_queue_.empty()) {
+      return;
+    }
+    const std::string layout_to_set = execute_queue_.front();
+
     std::vector<std::string> argv;
     base::file_handle_mapping_vector fds_to_remap;
     base::ProcessHandle handle = base::kNullProcessHandle;
 
     argv.push_back(kSetxkbmapCommand);
     argv.push_back("-layout");
-    argv.push_back(layouts_to_set);
+    argv.push_back(layout_to_set);
+    argv.push_back("-synch");
     const bool result = base::LaunchApp(argv,
                                         fds_to_remap,  // No remapping.
                                         false,  // Don't wait.
                                         &handle);
     if (!result) {
-      LOG(ERROR) << "Failed to execute setxkbmap: " << layouts_to_set;
+      LOG(ERROR) << "Failed to execute setxkbmap: " << layout_to_set;
+      execute_queue_ = std::queue<std::string>();  // clear the queue.
       return;
     }
 
     // g_child_watch_add is necessary to prevent the process from becoming a
     // zombie.
     const base::ProcessId pid = base::GetProcId(handle);
     g_child_watch_add(pid,
                       reinterpret_cast<GChildWatchFunc>(OnSetLayoutFinish),
                       this);
+    VLOG(1) << "ExecuteSetLayoutCommand: " << layout_to_set << ": pid=" << pid;
   }
 
   static void OnSetLayoutFinish(GPid pid, gint status, XKeyboard* self) {
-    DLOG(INFO) << "OnSetLayoutFinish: pid=" << pid;
+    CHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+    VLOG(1) << "OnSetLayoutFinish: pid=" << pid;
+    if (self->execute_queue_.empty()) {
+      LOG(ERROR) << "OnSetLayoutFinish: execute_queue_ is empty. "
+                 << "base::LaunchApp failed? pid=" << pid;
+      return;
+    }
+    self->execute_queue_.pop();
+    self->MaybeExecuteSetLayoutCommand();
   }
 
   // The XKB layout name which we set last time like "us" and "us(dvorak)".
   std::string current_layout_name_;
   // The mapping of modifier keys we set last time.
   ModifierMap current_modifier_map_;
+  // A queue for executing setxkbmap one by one.
+  std::queue<std::string> execute_queue_;
 
   DISALLOW_COPY_AND_ASSIGN(XKeyboard);
 };
 
 }  // namespace
 
 std::string CreateFullXkbLayoutName(const std::string& layout_name,
                                     const ModifierMap& modifier_map) {
   static const char kValidLayoutNameCharacters[] =
       "abcdefghijklmnopqrstuvwxyz0123456789()-_";
@@ skipping 113 matching lines @@
 bool SetAutoRepeatEnabled(bool enabled) {
   return XKeyboard::GetInstance()->SetAutoRepeatEnabled(enabled);
 }
 
 bool SetAutoRepeatRate(const AutoRepeatRate& rate) {
   return XKeyboard::GetInstance()->SetAutoRepeatRate(rate);
 }
 
 }  // namespace input_method
 }  // namespace chromeos