San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2007 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package com.android.server; |
| 18 | |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 19 | import android.net.LocalSocket; |
Jeff Sharkey | fa23c5a | 2011-08-09 21:44:24 -0700 | [diff] [blame] | 20 | import android.net.LocalSocketAddress; |
Chia-chi Yeh | e5750a3 | 2011-08-03 14:42:11 -0700 | [diff] [blame] | 21 | import android.os.Handler; |
| 22 | import android.os.HandlerThread; |
| 23 | import android.os.Message; |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 24 | import android.os.SystemClock; |
Robert Greenwalt | 470fd72 | 2012-01-18 12:51:15 -0800 | [diff] [blame] | 25 | import android.util.LocalLog; |
Joe Onorato | 8a9b220 | 2010-02-26 18:56:32 -0800 | [diff] [blame] | 26 | import android.util.Slog; |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 27 | |
Jeff Sharkey | 8b2c3a14 | 2012-11-12 11:45:05 -0800 | [diff] [blame] | 28 | import com.android.internal.annotations.VisibleForTesting; |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 29 | import com.google.android.collect.Lists; |
| 30 | |
Robert Greenwalt | 470fd72 | 2012-01-18 12:51:15 -0800 | [diff] [blame] | 31 | import java.nio.charset.Charsets; |
| 32 | import java.io.FileDescriptor; |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 33 | import java.io.IOException; |
| 34 | import java.io.InputStream; |
| 35 | import java.io.OutputStream; |
Robert Greenwalt | 470fd72 | 2012-01-18 12:51:15 -0800 | [diff] [blame] | 36 | import java.io.PrintWriter; |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 37 | import java.util.ArrayList; |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 38 | import java.util.concurrent.atomic.AtomicInteger; |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 39 | import java.util.concurrent.ArrayBlockingQueue; |
| 40 | import java.util.concurrent.BlockingQueue; |
| 41 | import java.util.concurrent.TimeUnit; |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 42 | import java.util.LinkedList; |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 43 | |
| 44 | /** |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 45 | * Generic connector class for interfacing with a native daemon which uses the |
| 46 | * {@code libsysutils} FrameworkListener protocol. |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 47 | */ |
Jeff Sharkey | fa23c5a | 2011-08-09 21:44:24 -0700 | [diff] [blame] | 48 | final class NativeDaemonConnector implements Runnable, Handler.Callback, Watchdog.Monitor { |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 49 | private static final boolean LOGD = false; |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 50 | |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 51 | private final String TAG; |
| 52 | |
| 53 | private String mSocket; |
| 54 | private OutputStream mOutputStream; |
Robert Greenwalt | 470fd72 | 2012-01-18 12:51:15 -0800 | [diff] [blame] | 55 | private LocalLog mLocalLog; |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 56 | |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 57 | private final ResponseQueue mResponseQueue; |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 58 | |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 59 | private INativeDaemonConnectorCallbacks mCallbacks; |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 60 | private Handler mCallbackHandler; |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 61 | |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 62 | private AtomicInteger mSequenceNumber; |
| 63 | |
| 64 | private static final int DEFAULT_TIMEOUT = 1 * 60 * 1000; /* 1 minute */ |
Robert Greenwalt | 5a0c320 | 2012-05-22 16:07:46 -0700 | [diff] [blame] | 65 | private static final long WARN_EXECUTE_DELAY_MS = 500; /* .5 sec */ |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 66 | |
Jeff Sharkey | fa23c5a | 2011-08-09 21:44:24 -0700 | [diff] [blame] | 67 | /** Lock held whenever communicating with native daemon. */ |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 68 | private final Object mDaemonLock = new Object(); |
Jeff Sharkey | fa23c5a | 2011-08-09 21:44:24 -0700 | [diff] [blame] | 69 | |
Kenny Root | 961aa8c | 2010-03-22 18:02:45 -0700 | [diff] [blame] | 70 | private final int BUFFER_SIZE = 4096; |
| 71 | |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 72 | NativeDaemonConnector(INativeDaemonConnectorCallbacks callbacks, String socket, |
Robert Greenwalt | 470fd72 | 2012-01-18 12:51:15 -0800 | [diff] [blame] | 73 | int responseQueueSize, String logTag, int maxLogSize) { |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 74 | mCallbacks = callbacks; |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 75 | mSocket = socket; |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 76 | mResponseQueue = new ResponseQueue(responseQueueSize); |
| 77 | mSequenceNumber = new AtomicInteger(0); |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 78 | TAG = logTag != null ? logTag : "NativeDaemonConnector"; |
Robert Greenwalt | 470fd72 | 2012-01-18 12:51:15 -0800 | [diff] [blame] | 79 | mLocalLog = new LocalLog(maxLogSize); |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 80 | } |
| 81 | |
Chia-chi Yeh | e5750a3 | 2011-08-03 14:42:11 -0700 | [diff] [blame] | 82 | @Override |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 83 | public void run() { |
Chia-chi Yeh | e5750a3 | 2011-08-03 14:42:11 -0700 | [diff] [blame] | 84 | HandlerThread thread = new HandlerThread(TAG + ".CallbackHandler"); |
| 85 | thread.start(); |
| 86 | mCallbackHandler = new Handler(thread.getLooper(), this); |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 87 | |
| 88 | while (true) { |
| 89 | try { |
| 90 | listenToSocket(); |
| 91 | } catch (Exception e) { |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 92 | loge("Error in NativeDaemonConnector: " + e); |
San Mehat | 4c27e0e | 2010-01-29 05:22:17 -0800 | [diff] [blame] | 93 | SystemClock.sleep(5000); |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 94 | } |
| 95 | } |
| 96 | } |
| 97 | |
Chia-chi Yeh | e5750a3 | 2011-08-03 14:42:11 -0700 | [diff] [blame] | 98 | @Override |
| 99 | public boolean handleMessage(Message msg) { |
| 100 | String event = (String) msg.obj; |
| 101 | try { |
Robert Greenwalt | 2d34b4a | 2012-04-20 13:08:02 -0700 | [diff] [blame] | 102 | if (!mCallbacks.onEvent(msg.what, event, NativeDaemonEvent.unescapeArgs(event))) { |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 103 | log(String.format("Unhandled event '%s'", event)); |
Chia-chi Yeh | e5750a3 | 2011-08-03 14:42:11 -0700 | [diff] [blame] | 104 | } |
| 105 | } catch (Exception e) { |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 106 | loge("Error handling '" + event + "': " + e); |
Chia-chi Yeh | e5750a3 | 2011-08-03 14:42:11 -0700 | [diff] [blame] | 107 | } |
| 108 | return true; |
| 109 | } |
| 110 | |
San Mehat | 4c27e0e | 2010-01-29 05:22:17 -0800 | [diff] [blame] | 111 | private void listenToSocket() throws IOException { |
Kenny Root | 961aa8c | 2010-03-22 18:02:45 -0700 | [diff] [blame] | 112 | LocalSocket socket = null; |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 113 | |
| 114 | try { |
| 115 | socket = new LocalSocket(); |
| 116 | LocalSocketAddress address = new LocalSocketAddress(mSocket, |
| 117 | LocalSocketAddress.Namespace.RESERVED); |
| 118 | |
| 119 | socket.connect(address); |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 120 | |
| 121 | InputStream inputStream = socket.getInputStream(); |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 122 | synchronized (mDaemonLock) { |
| 123 | mOutputStream = socket.getOutputStream(); |
| 124 | } |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 125 | |
anga | 030bc88 | 2011-02-01 14:10:25 +0100 | [diff] [blame] | 126 | mCallbacks.onDaemonConnected(); |
| 127 | |
Kenny Root | 961aa8c | 2010-03-22 18:02:45 -0700 | [diff] [blame] | 128 | byte[] buffer = new byte[BUFFER_SIZE]; |
| 129 | int start = 0; |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 130 | |
| 131 | while (true) { |
Kenny Root | 961aa8c | 2010-03-22 18:02:45 -0700 | [diff] [blame] | 132 | int count = inputStream.read(buffer, start, BUFFER_SIZE - start); |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 133 | if (count < 0) { |
| 134 | loge("got " + count + " reading with start = " + start); |
| 135 | break; |
| 136 | } |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 137 | |
Kenny Root | 12da9d7 | 2010-09-02 22:18:14 -0700 | [diff] [blame] | 138 | // Add our starting point to the count and reset the start. |
| 139 | count += start; |
| 140 | start = 0; |
| 141 | |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 142 | for (int i = 0; i < count; i++) { |
| 143 | if (buffer[i] == 0) { |
Jeff Sharkey | ba2896e | 2011-11-30 18:13:54 -0800 | [diff] [blame] | 144 | final String rawEvent = new String( |
| 145 | buffer, start, i - start, Charsets.UTF_8); |
Robert Greenwalt | 470fd72 | 2012-01-18 12:51:15 -0800 | [diff] [blame] | 146 | log("RCV <- {" + rawEvent + "}"); |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 147 | |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 148 | try { |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 149 | final NativeDaemonEvent event = NativeDaemonEvent.parseRawEvent( |
| 150 | rawEvent); |
| 151 | if (event.isClassUnsolicited()) { |
Jeff Sharkey | ba2896e | 2011-11-30 18:13:54 -0800 | [diff] [blame] | 152 | // TODO: migrate to sending NativeDaemonEvent instances |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 153 | mCallbackHandler.sendMessage(mCallbackHandler.obtainMessage( |
| 154 | event.getCode(), event.getRawEvent())); |
Irfan Sheriff | 1cd94ef | 2011-01-16 14:31:55 -0800 | [diff] [blame] | 155 | } else { |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 156 | mResponseQueue.add(event.getCmdNumber(), event); |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 157 | } |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 158 | } catch (IllegalArgumentException e) { |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 159 | log("Problem parsing message: " + rawEvent + " - " + e); |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 160 | } |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 161 | |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 162 | start = i + 1; |
| 163 | } |
| 164 | } |
Robert Greenwalt | f0be1d89 | 2012-01-20 16:33:15 -0800 | [diff] [blame] | 165 | if (start == 0) { |
| 166 | final String rawEvent = new String(buffer, start, count, Charsets.UTF_8); |
| 167 | log("RCV incomplete <- {" + rawEvent + "}"); |
| 168 | } |
Kenny Root | 12da9d7 | 2010-09-02 22:18:14 -0700 | [diff] [blame] | 169 | |
| 170 | // We should end at the amount we read. If not, compact then |
| 171 | // buffer and read again. |
Kenny Root | 961aa8c | 2010-03-22 18:02:45 -0700 | [diff] [blame] | 172 | if (start != count) { |
| 173 | final int remaining = BUFFER_SIZE - start; |
| 174 | System.arraycopy(buffer, start, buffer, 0, remaining); |
| 175 | start = remaining; |
| 176 | } else { |
| 177 | start = 0; |
| 178 | } |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 179 | } |
| 180 | } catch (IOException ex) { |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 181 | loge("Communications error: " + ex); |
San Mehat | 4c27e0e | 2010-01-29 05:22:17 -0800 | [diff] [blame] | 182 | throw ex; |
| 183 | } finally { |
Jeff Sharkey | fa23c5a | 2011-08-09 21:44:24 -0700 | [diff] [blame] | 184 | synchronized (mDaemonLock) { |
San Mehat | 4c27e0e | 2010-01-29 05:22:17 -0800 | [diff] [blame] | 185 | if (mOutputStream != null) { |
| 186 | try { |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 187 | loge("closing stream for " + mSocket); |
San Mehat | 4c27e0e | 2010-01-29 05:22:17 -0800 | [diff] [blame] | 188 | mOutputStream.close(); |
| 189 | } catch (IOException e) { |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 190 | loge("Failed closing output stream: " + e); |
San Mehat | 4c27e0e | 2010-01-29 05:22:17 -0800 | [diff] [blame] | 191 | } |
| 192 | mOutputStream = null; |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 193 | } |
San Mehat | 4c27e0e | 2010-01-29 05:22:17 -0800 | [diff] [blame] | 194 | } |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 195 | |
San Mehat | 4c27e0e | 2010-01-29 05:22:17 -0800 | [diff] [blame] | 196 | try { |
| 197 | if (socket != null) { |
| 198 | socket.close(); |
| 199 | } |
| 200 | } catch (IOException ex) { |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 201 | loge("Failed closing socket: " + ex); |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 202 | } |
| 203 | } |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 204 | } |
| 205 | |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 206 | /** |
Jeff Sharkey | 56cd646 | 2013-06-07 15:09:15 -0700 | [diff] [blame] | 207 | * Wrapper around argument that indicates it's sensitive and shouldn't be |
| 208 | * logged. |
| 209 | */ |
| 210 | public static class SensitiveArg { |
| 211 | private final Object mArg; |
| 212 | |
| 213 | public SensitiveArg(Object arg) { |
| 214 | mArg = arg; |
| 215 | } |
| 216 | |
| 217 | @Override |
| 218 | public String toString() { |
| 219 | return String.valueOf(mArg); |
| 220 | } |
| 221 | } |
| 222 | |
| 223 | /** |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 224 | * Make command for daemon, escaping arguments as needed. |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 225 | */ |
Jeff Sharkey | 56cd646 | 2013-06-07 15:09:15 -0700 | [diff] [blame] | 226 | @VisibleForTesting |
| 227 | static void makeCommand(StringBuilder rawBuilder, StringBuilder logBuilder, int sequenceNumber, |
| 228 | String cmd, Object... args) { |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 229 | if (cmd.indexOf('\0') >= 0) { |
Jeff Sharkey | 7b4596f | 2013-02-25 10:55:29 -0800 | [diff] [blame] | 230 | throw new IllegalArgumentException("Unexpected command: " + cmd); |
| 231 | } |
| 232 | if (cmd.indexOf(' ') >= 0) { |
| 233 | throw new IllegalArgumentException("Arguments must be separate from command"); |
Jeff Sharkey | b0aec07 | 2011-10-14 18:32:24 -0700 | [diff] [blame] | 234 | } |
| 235 | |
Jeff Sharkey | 56cd646 | 2013-06-07 15:09:15 -0700 | [diff] [blame] | 236 | rawBuilder.append(sequenceNumber).append(' ').append(cmd); |
| 237 | logBuilder.append(sequenceNumber).append(' ').append(cmd); |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 238 | for (Object arg : args) { |
| 239 | final String argString = String.valueOf(arg); |
| 240 | if (argString.indexOf('\0') >= 0) { |
Jeff Sharkey | 7b4596f | 2013-02-25 10:55:29 -0800 | [diff] [blame] | 241 | throw new IllegalArgumentException("Unexpected argument: " + arg); |
Jeff Sharkey | fa23c5a | 2011-08-09 21:44:24 -0700 | [diff] [blame] | 242 | } |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 243 | |
Jeff Sharkey | 56cd646 | 2013-06-07 15:09:15 -0700 | [diff] [blame] | 244 | rawBuilder.append(' '); |
| 245 | logBuilder.append(' '); |
| 246 | |
| 247 | appendEscaped(rawBuilder, argString); |
| 248 | if (arg instanceof SensitiveArg) { |
| 249 | logBuilder.append("[scrubbed]"); |
| 250 | } else { |
| 251 | appendEscaped(logBuilder, argString); |
| 252 | } |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 253 | } |
Jeff Sharkey | 56cd646 | 2013-06-07 15:09:15 -0700 | [diff] [blame] | 254 | |
| 255 | rawBuilder.append('\0'); |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 256 | } |
San Mehat | deba693 | 2010-01-20 15:14:31 -0800 | [diff] [blame] | 257 | |
Jeff Sharkey | fa23c5a | 2011-08-09 21:44:24 -0700 | [diff] [blame] | 258 | /** |
Jeff Sharkey | ba2896e | 2011-11-30 18:13:54 -0800 | [diff] [blame] | 259 | * Issue the given command to the native daemon and return a single expected |
| 260 | * response. |
| 261 | * |
| 262 | * @throws NativeDaemonConnectorException when problem communicating with |
| 263 | * native daemon, or if the response matches |
| 264 | * {@link NativeDaemonEvent#isClassClientError()} or |
| 265 | * {@link NativeDaemonEvent#isClassServerError()}. |
San Mehat | deba693 | 2010-01-20 15:14:31 -0800 | [diff] [blame] | 266 | */ |
Jeff Sharkey | ba2896e | 2011-11-30 18:13:54 -0800 | [diff] [blame] | 267 | public NativeDaemonEvent execute(Command cmd) throws NativeDaemonConnectorException { |
| 268 | return execute(cmd.mCmd, cmd.mArguments.toArray()); |
| 269 | } |
| 270 | |
| 271 | /** |
| 272 | * Issue the given command to the native daemon and return a single expected |
Jeff Sharkey | 7b4596f | 2013-02-25 10:55:29 -0800 | [diff] [blame] | 273 | * response. Any arguments must be separated from base command so they can |
| 274 | * be properly escaped. |
Jeff Sharkey | ba2896e | 2011-11-30 18:13:54 -0800 | [diff] [blame] | 275 | * |
| 276 | * @throws NativeDaemonConnectorException when problem communicating with |
| 277 | * native daemon, or if the response matches |
| 278 | * {@link NativeDaemonEvent#isClassClientError()} or |
| 279 | * {@link NativeDaemonEvent#isClassServerError()}. |
| 280 | */ |
| 281 | public NativeDaemonEvent execute(String cmd, Object... args) |
| 282 | throws NativeDaemonConnectorException { |
| 283 | final NativeDaemonEvent[] events = executeForList(cmd, args); |
| 284 | if (events.length != 1) { |
| 285 | throw new NativeDaemonConnectorException( |
| 286 | "Expected exactly one response, but received " + events.length); |
| 287 | } |
| 288 | return events[0]; |
| 289 | } |
| 290 | |
| 291 | /** |
| 292 | * Issue the given command to the native daemon and return any |
| 293 | * {@link NativeDaemonEvent#isClassContinue()} responses, including the |
| 294 | * final terminal response. |
| 295 | * |
| 296 | * @throws NativeDaemonConnectorException when problem communicating with |
| 297 | * native daemon, or if the response matches |
| 298 | * {@link NativeDaemonEvent#isClassClientError()} or |
| 299 | * {@link NativeDaemonEvent#isClassServerError()}. |
| 300 | */ |
| 301 | public NativeDaemonEvent[] executeForList(Command cmd) throws NativeDaemonConnectorException { |
| 302 | return executeForList(cmd.mCmd, cmd.mArguments.toArray()); |
| 303 | } |
| 304 | |
| 305 | /** |
| 306 | * Issue the given command to the native daemon and return any |
| 307 | * {@link NativeDaemonEvent#isClassContinue()} responses, including the |
Jeff Sharkey | 7b4596f | 2013-02-25 10:55:29 -0800 | [diff] [blame] | 308 | * final terminal response. Any arguments must be separated from base |
| 309 | * command so they can be properly escaped. |
Jeff Sharkey | ba2896e | 2011-11-30 18:13:54 -0800 | [diff] [blame] | 310 | * |
| 311 | * @throws NativeDaemonConnectorException when problem communicating with |
| 312 | * native daemon, or if the response matches |
| 313 | * {@link NativeDaemonEvent#isClassClientError()} or |
| 314 | * {@link NativeDaemonEvent#isClassServerError()}. |
| 315 | */ |
| 316 | public NativeDaemonEvent[] executeForList(String cmd, Object... args) |
San Mehat | 4c27e0e | 2010-01-29 05:22:17 -0800 | [diff] [blame] | 317 | throws NativeDaemonConnectorException { |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 318 | return execute(DEFAULT_TIMEOUT, cmd, args); |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 319 | } |
San Mehat | deba693 | 2010-01-20 15:14:31 -0800 | [diff] [blame] | 320 | |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 321 | /** |
Jeff Sharkey | 7b4596f | 2013-02-25 10:55:29 -0800 | [diff] [blame] | 322 | * Issue the given command to the native daemon and return any {@linke |
| 323 | * NativeDaemonEvent@isClassContinue()} responses, including the final |
| 324 | * terminal response. Note that the timeout does not count time in deep |
| 325 | * sleep. Any arguments must be separated from base command so they can be |
| 326 | * properly escaped. |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 327 | * |
| 328 | * @throws NativeDaemonConnectorException when problem communicating with |
| 329 | * native daemon, or if the response matches |
| 330 | * {@link NativeDaemonEvent#isClassClientError()} or |
| 331 | * {@link NativeDaemonEvent#isClassServerError()}. |
| 332 | */ |
| 333 | public NativeDaemonEvent[] execute(int timeout, String cmd, Object... args) |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 334 | throws NativeDaemonConnectorException { |
Robert Greenwalt | 5a0c320 | 2012-05-22 16:07:46 -0700 | [diff] [blame] | 335 | final long startTime = SystemClock.elapsedRealtime(); |
Robert Greenwalt | d192598 | 2012-03-12 15:37:40 -0700 | [diff] [blame] | 336 | |
Jeff Sharkey | 56cd646 | 2013-06-07 15:09:15 -0700 | [diff] [blame] | 337 | final ArrayList<NativeDaemonEvent> events = Lists.newArrayList(); |
Robert Greenwalt | d192598 | 2012-03-12 15:37:40 -0700 | [diff] [blame] | 338 | |
Jeff Sharkey | 56cd646 | 2013-06-07 15:09:15 -0700 | [diff] [blame] | 339 | final StringBuilder rawBuilder = new StringBuilder(); |
| 340 | final StringBuilder logBuilder = new StringBuilder(); |
| 341 | final int sequenceNumber = mSequenceNumber.incrementAndGet(); |
| 342 | |
| 343 | makeCommand(rawBuilder, logBuilder, sequenceNumber, cmd, args); |
| 344 | |
| 345 | final String rawCmd = rawBuilder.toString(); |
| 346 | final String logCmd = logBuilder.toString(); |
| 347 | |
Robert Greenwalt | d192598 | 2012-03-12 15:37:40 -0700 | [diff] [blame] | 348 | log("SND -> {" + logCmd + "}"); |
| 349 | |
Robert Greenwalt | d192598 | 2012-03-12 15:37:40 -0700 | [diff] [blame] | 350 | synchronized (mDaemonLock) { |
| 351 | if (mOutputStream == null) { |
| 352 | throw new NativeDaemonConnectorException("missing output stream"); |
| 353 | } else { |
| 354 | try { |
Jeff Sharkey | 56cd646 | 2013-06-07 15:09:15 -0700 | [diff] [blame] | 355 | mOutputStream.write(rawCmd.getBytes(Charsets.UTF_8)); |
Robert Greenwalt | d192598 | 2012-03-12 15:37:40 -0700 | [diff] [blame] | 356 | } catch (IOException e) { |
| 357 | throw new NativeDaemonConnectorException("problem sending command", e); |
| 358 | } |
| 359 | } |
| 360 | } |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 361 | |
| 362 | NativeDaemonEvent event = null; |
| 363 | do { |
Jeff Sharkey | 56cd646 | 2013-06-07 15:09:15 -0700 | [diff] [blame] | 364 | event = mResponseQueue.remove(sequenceNumber, timeout, logCmd); |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 365 | if (event == null) { |
Robert Greenwalt | d192598 | 2012-03-12 15:37:40 -0700 | [diff] [blame] | 366 | loge("timed-out waiting for response to " + logCmd); |
| 367 | throw new NativeDaemonFailureException(logCmd, event); |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 368 | } |
Robert Greenwalt | b5aff3f | 2012-05-15 17:26:57 -0700 | [diff] [blame] | 369 | log("RMV <- {" + event + "}"); |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 370 | events.add(event); |
| 371 | } while (event.isClassContinue()); |
| 372 | |
Robert Greenwalt | 5a0c320 | 2012-05-22 16:07:46 -0700 | [diff] [blame] | 373 | final long endTime = SystemClock.elapsedRealtime(); |
| 374 | if (endTime - startTime > WARN_EXECUTE_DELAY_MS) { |
| 375 | loge("NDC Command {" + logCmd + "} took too long (" + (endTime - startTime) + "ms)"); |
| 376 | } |
| 377 | |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 378 | if (event.isClassClientError()) { |
Robert Greenwalt | d192598 | 2012-03-12 15:37:40 -0700 | [diff] [blame] | 379 | throw new NativeDaemonArgumentException(logCmd, event); |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 380 | } |
| 381 | if (event.isClassServerError()) { |
Robert Greenwalt | d192598 | 2012-03-12 15:37:40 -0700 | [diff] [blame] | 382 | throw new NativeDaemonFailureException(logCmd, event); |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 383 | } |
| 384 | |
| 385 | return events.toArray(new NativeDaemonEvent[events.size()]); |
| 386 | } |
| 387 | |
| 388 | /** |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 389 | * Append the given argument to {@link StringBuilder}, escaping as needed, |
| 390 | * and surrounding with quotes when it contains spaces. |
| 391 | */ |
Jeff Sharkey | 8b2c3a14 | 2012-11-12 11:45:05 -0800 | [diff] [blame] | 392 | @VisibleForTesting |
Jeff Sharkey | 31c6e48 | 2011-11-18 17:09:01 -0800 | [diff] [blame] | 393 | static void appendEscaped(StringBuilder builder, String arg) { |
| 394 | final boolean hasSpaces = arg.indexOf(' ') >= 0; |
| 395 | if (hasSpaces) { |
| 396 | builder.append('"'); |
| 397 | } |
| 398 | |
| 399 | final int length = arg.length(); |
| 400 | for (int i = 0; i < length; i++) { |
| 401 | final char c = arg.charAt(i); |
| 402 | |
| 403 | if (c == '"') { |
| 404 | builder.append("\\\""); |
| 405 | } else if (c == '\\') { |
| 406 | builder.append("\\\\"); |
| 407 | } else { |
| 408 | builder.append(c); |
| 409 | } |
| 410 | } |
| 411 | |
| 412 | if (hasSpaces) { |
| 413 | builder.append('"'); |
| 414 | } |
| 415 | } |
| 416 | |
| 417 | private static class NativeDaemonArgumentException extends NativeDaemonConnectorException { |
| 418 | public NativeDaemonArgumentException(String command, NativeDaemonEvent event) { |
| 419 | super(command, event); |
| 420 | } |
| 421 | |
| 422 | @Override |
| 423 | public IllegalArgumentException rethrowAsParcelableException() { |
| 424 | throw new IllegalArgumentException(getMessage(), this); |
| 425 | } |
| 426 | } |
| 427 | |
| 428 | private static class NativeDaemonFailureException extends NativeDaemonConnectorException { |
| 429 | public NativeDaemonFailureException(String command, NativeDaemonEvent event) { |
| 430 | super(command, event); |
| 431 | } |
San Mehat | deba693 | 2010-01-20 15:14:31 -0800 | [diff] [blame] | 432 | } |
Jeff Sharkey | fa23c5a | 2011-08-09 21:44:24 -0700 | [diff] [blame] | 433 | |
Jeff Sharkey | ba2896e | 2011-11-30 18:13:54 -0800 | [diff] [blame] | 434 | /** |
Jeff Sharkey | 7b4596f | 2013-02-25 10:55:29 -0800 | [diff] [blame] | 435 | * Command builder that handles argument list building. Any arguments must |
| 436 | * be separated from base command so they can be properly escaped. |
Jeff Sharkey | ba2896e | 2011-11-30 18:13:54 -0800 | [diff] [blame] | 437 | */ |
| 438 | public static class Command { |
| 439 | private String mCmd; |
| 440 | private ArrayList<Object> mArguments = Lists.newArrayList(); |
| 441 | |
| 442 | public Command(String cmd, Object... args) { |
| 443 | mCmd = cmd; |
| 444 | for (Object arg : args) { |
| 445 | appendArg(arg); |
| 446 | } |
| 447 | } |
| 448 | |
| 449 | public Command appendArg(Object arg) { |
| 450 | mArguments.add(arg); |
| 451 | return this; |
| 452 | } |
| 453 | } |
| 454 | |
Jeff Sharkey | fa23c5a | 2011-08-09 21:44:24 -0700 | [diff] [blame] | 455 | /** {@inheritDoc} */ |
| 456 | public void monitor() { |
| 457 | synchronized (mDaemonLock) { } |
| 458 | } |
Robert Greenwalt | 470fd72 | 2012-01-18 12:51:15 -0800 | [diff] [blame] | 459 | |
| 460 | public void dump(FileDescriptor fd, PrintWriter pw, String[] args) { |
| 461 | mLocalLog.dump(fd, pw, args); |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 462 | pw.println(); |
| 463 | mResponseQueue.dump(fd, pw, args); |
Robert Greenwalt | 470fd72 | 2012-01-18 12:51:15 -0800 | [diff] [blame] | 464 | } |
| 465 | |
| 466 | private void log(String logstring) { |
| 467 | if (LOGD) Slog.d(TAG, logstring); |
| 468 | mLocalLog.log(logstring); |
| 469 | } |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 470 | |
| 471 | private void loge(String logstring) { |
| 472 | Slog.e(TAG, logstring); |
| 473 | mLocalLog.log(logstring); |
| 474 | } |
| 475 | |
| 476 | private static class ResponseQueue { |
| 477 | |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 478 | private static class PendingCmd { |
Jeff Sharkey | 56cd646 | 2013-06-07 15:09:15 -0700 | [diff] [blame] | 479 | public final int cmdNum; |
| 480 | public final String logCmd; |
| 481 | |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 482 | public BlockingQueue<NativeDaemonEvent> responses = |
| 483 | new ArrayBlockingQueue<NativeDaemonEvent>(10); |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 484 | |
| 485 | // The availableResponseCount member is used to track when we can remove this |
| 486 | // instance from the ResponseQueue. |
| 487 | // This is used under the protection of a sync of the mPendingCmds object. |
| 488 | // A positive value means we've had more writers retreive this object while |
| 489 | // a negative value means we've had more readers. When we've had an equal number |
| 490 | // (it goes to zero) we can remove this object from the mPendingCmds list. |
| 491 | // Note that we may have more responses for this command (and more readers |
| 492 | // coming), but that would result in a new PendingCmd instance being created |
| 493 | // and added with the same cmdNum. |
| 494 | // Also note that when this goes to zero it just means a parity of readers and |
| 495 | // writers have retrieved this object - not that they are done using it. The |
| 496 | // responses queue may well have more responses yet to be read or may get more |
| 497 | // responses added to it. But all those readers/writers have retreived and |
| 498 | // hold references to this instance already so it can be removed from |
| 499 | // mPendingCmds queue. |
| 500 | public int availableResponseCount; |
Jeff Sharkey | 56cd646 | 2013-06-07 15:09:15 -0700 | [diff] [blame] | 501 | |
| 502 | public PendingCmd(int cmdNum, String logCmd) { |
| 503 | this.cmdNum = cmdNum; |
| 504 | this.logCmd = logCmd; |
| 505 | } |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 506 | } |
| 507 | |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 508 | private final LinkedList<PendingCmd> mPendingCmds; |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 509 | private int mMaxCount; |
| 510 | |
| 511 | ResponseQueue(int maxCount) { |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 512 | mPendingCmds = new LinkedList<PendingCmd>(); |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 513 | mMaxCount = maxCount; |
| 514 | } |
| 515 | |
| 516 | public void add(int cmdNum, NativeDaemonEvent response) { |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 517 | PendingCmd found = null; |
| 518 | synchronized (mPendingCmds) { |
| 519 | for (PendingCmd pendingCmd : mPendingCmds) { |
| 520 | if (pendingCmd.cmdNum == cmdNum) { |
| 521 | found = pendingCmd; |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 522 | break; |
| 523 | } |
| 524 | } |
| 525 | if (found == null) { |
| 526 | // didn't find it - make sure our queue isn't too big before adding |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 527 | while (mPendingCmds.size() >= mMaxCount) { |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 528 | Slog.e("NativeDaemonConnector.ResponseQueue", |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 529 | "more buffered than allowed: " + mPendingCmds.size() + |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 530 | " >= " + mMaxCount); |
| 531 | // let any waiter timeout waiting for this |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 532 | PendingCmd pendingCmd = mPendingCmds.remove(); |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 533 | Slog.e("NativeDaemonConnector.ResponseQueue", |
Jeff Sharkey | 56cd646 | 2013-06-07 15:09:15 -0700 | [diff] [blame] | 534 | "Removing request: " + pendingCmd.logCmd + " (" + |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 535 | pendingCmd.cmdNum + ")"); |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 536 | } |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 537 | found = new PendingCmd(cmdNum, null); |
| 538 | mPendingCmds.add(found); |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 539 | } |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 540 | found.availableResponseCount++; |
| 541 | // if a matching remove call has already retrieved this we can remove this |
| 542 | // instance from our list |
| 543 | if (found.availableResponseCount == 0) mPendingCmds.remove(found); |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 544 | } |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 545 | try { |
| 546 | found.responses.put(response); |
| 547 | } catch (InterruptedException e) { } |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 548 | } |
| 549 | |
| 550 | // note that the timeout does not count time in deep sleep. If you don't want |
| 551 | // the device to sleep, hold a wakelock |
Jeff Sharkey | 56cd646 | 2013-06-07 15:09:15 -0700 | [diff] [blame] | 552 | public NativeDaemonEvent remove(int cmdNum, int timeoutMs, String logCmd) { |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 553 | PendingCmd found = null; |
| 554 | synchronized (mPendingCmds) { |
| 555 | for (PendingCmd pendingCmd : mPendingCmds) { |
| 556 | if (pendingCmd.cmdNum == cmdNum) { |
| 557 | found = pendingCmd; |
| 558 | break; |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 559 | } |
| 560 | } |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 561 | if (found == null) { |
Jeff Sharkey | 56cd646 | 2013-06-07 15:09:15 -0700 | [diff] [blame] | 562 | found = new PendingCmd(cmdNum, logCmd); |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 563 | mPendingCmds.add(found); |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 564 | } |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 565 | found.availableResponseCount--; |
| 566 | // if a matching add call has already retrieved this we can remove this |
| 567 | // instance from our list |
| 568 | if (found.availableResponseCount == 0) mPendingCmds.remove(found); |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 569 | } |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 570 | NativeDaemonEvent result = null; |
| 571 | try { |
| 572 | result = found.responses.poll(timeoutMs, TimeUnit.MILLISECONDS); |
| 573 | } catch (InterruptedException e) {} |
| 574 | if (result == null) { |
| 575 | Slog.e("NativeDaemonConnector.ResponseQueue", "Timeout waiting for response"); |
| 576 | } |
| 577 | return result; |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 578 | } |
| 579 | |
| 580 | public void dump(FileDescriptor fd, PrintWriter pw, String[] args) { |
| 581 | pw.println("Pending requests:"); |
Robert Greenwalt | ef21599 | 2012-06-05 11:48:40 -0700 | [diff] [blame] | 582 | synchronized (mPendingCmds) { |
| 583 | for (PendingCmd pendingCmd : mPendingCmds) { |
Jeff Sharkey | 56cd646 | 2013-06-07 15:09:15 -0700 | [diff] [blame] | 584 | pw.println(" Cmd " + pendingCmd.cmdNum + " - " + pendingCmd.logCmd); |
Robert Greenwalt | 470007f | 2012-02-07 11:36:55 -0800 | [diff] [blame] | 585 | } |
| 586 | } |
| 587 | } |
| 588 | } |
San Mehat | 67bd2cd | 2010-01-12 12:18:49 -0800 | [diff] [blame] | 589 | } |