Process.java revision 6b0ed64fb868e64684031558cbdeedcd94d40713
1/*
2 * Copyright (C) 2006 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
17package android.os;
18
19import android.net.LocalSocket;
20import android.net.LocalSocketAddress;
21import android.system.Os;
22import android.util.Log;
23import com.android.internal.os.Zygote;
24import java.io.BufferedWriter;
25import java.io.DataInputStream;
26import java.io.IOException;
27import java.io.OutputStreamWriter;
28import java.nio.charset.StandardCharsets;
29import java.util.ArrayList;
30import java.util.Arrays;
31import java.util.List;
32
33/*package*/ class ZygoteStartFailedEx extends Exception {
34    ZygoteStartFailedEx(String s) {
35        super(s);
36    }
37
38    ZygoteStartFailedEx(Throwable cause) {
39        super(cause);
40    }
41
42    ZygoteStartFailedEx(String s, Throwable cause) {
43        super(s, cause);
44    }
45}
46
47/**
48 * Tools for managing OS processes.
49 */
50public class Process {
51    private static final String LOG_TAG = "Process";
52
53    /**
54     * @hide for internal use only.
55     */
56    public static final String ZYGOTE_SOCKET = "zygote";
57
58    /**
59     * @hide for internal use only.
60     */
61    public static final String SECONDARY_ZYGOTE_SOCKET = "zygote_secondary";
62
63    /**
64     * Defines the root UID.
65     * @hide
66     */
67    public static final int ROOT_UID = 0;
68
69    /**
70     * Defines the UID/GID under which system code runs.
71     */
72    public static final int SYSTEM_UID = 1000;
73
74    /**
75     * Defines the UID/GID under which the telephony code runs.
76     */
77    public static final int PHONE_UID = 1001;
78
79    /**
80     * Defines the UID/GID for the user shell.
81     * @hide
82     */
83    public static final int SHELL_UID = 2000;
84
85    /**
86     * Defines the UID/GID for the log group.
87     * @hide
88     */
89    public static final int LOG_UID = 1007;
90
91    /**
92     * Defines the UID/GID for the WIFI supplicant process.
93     * @hide
94     */
95    public static final int WIFI_UID = 1010;
96
97    /**
98     * Defines the UID/GID for the mediaserver process.
99     * @hide
100     */
101    public static final int MEDIA_UID = 1013;
102
103    /**
104     * Defines the UID/GID for the DRM process.
105     * @hide
106     */
107    public static final int DRM_UID = 1019;
108
109    /**
110     * Defines the UID/GID for the group that controls VPN services.
111     * @hide
112     */
113    public static final int VPN_UID = 1016;
114
115    /**
116     * Defines the UID/GID for the NFC service process.
117     * @hide
118     */
119    public static final int NFC_UID = 1027;
120
121    /**
122     * Defines the UID/GID for the Bluetooth service process.
123     * @hide
124     */
125    public static final int BLUETOOTH_UID = 1002;
126
127    /**
128     * Defines the GID for the group that allows write access to the internal media storage.
129     * @hide
130     */
131    public static final int MEDIA_RW_GID = 1023;
132
133    /**
134     * Access to installed package details
135     * @hide
136     */
137    public static final int PACKAGE_INFO_GID = 1032;
138
139    /**
140     * Defines the UID/GID for the shared RELRO file updater process.
141     * @hide
142     */
143    public static final int SHARED_RELRO_UID = 1037;
144
145    /**
146     * Defines the start of a range of UIDs (and GIDs), going from this
147     * number to {@link #LAST_APPLICATION_UID} that are reserved for assigning
148     * to applications.
149     */
150    public static final int FIRST_APPLICATION_UID = 10000;
151
152    /**
153     * Last of application-specific UIDs starting at
154     * {@link #FIRST_APPLICATION_UID}.
155     */
156    public static final int LAST_APPLICATION_UID = 19999;
157
158    /**
159     * First uid used for fully isolated sandboxed processes (with no permissions of their own)
160     * @hide
161     */
162    public static final int FIRST_ISOLATED_UID = 99000;
163
164    /**
165     * Last uid used for fully isolated sandboxed processes (with no permissions of their own)
166     * @hide
167     */
168    public static final int LAST_ISOLATED_UID = 99999;
169
170    /**
171     * Defines the gid shared by all applications running under the same profile.
172     * @hide
173     */
174    public static final int SHARED_USER_GID = 9997;
175
176    /**
177     * First gid for applications to share resources. Used when forward-locking
178     * is enabled but all UserHandles need to be able to read the resources.
179     * @hide
180     */
181    public static final int FIRST_SHARED_APPLICATION_GID = 50000;
182
183    /**
184     * Last gid for applications to share resources. Used when forward-locking
185     * is enabled but all UserHandles need to be able to read the resources.
186     * @hide
187     */
188    public static final int LAST_SHARED_APPLICATION_GID = 59999;
189
190    /**
191     * Standard priority of application threads.
192     * Use with {@link #setThreadPriority(int)} and
193     * {@link #setThreadPriority(int, int)}, <b>not</b> with the normal
194     * {@link java.lang.Thread} class.
195     */
196    public static final int THREAD_PRIORITY_DEFAULT = 0;
197
198    /*
199     * ***************************************
200     * ** Keep in sync with utils/threads.h **
201     * ***************************************
202     */
203
204    /**
205     * Lowest available thread priority.  Only for those who really, really
206     * don't want to run if anything else is happening.
207     * Use with {@link #setThreadPriority(int)} and
208     * {@link #setThreadPriority(int, int)}, <b>not</b> with the normal
209     * {@link java.lang.Thread} class.
210     */
211    public static final int THREAD_PRIORITY_LOWEST = 19;
212
213    /**
214     * Standard priority background threads.  This gives your thread a slightly
215     * lower than normal priority, so that it will have less chance of impacting
216     * the responsiveness of the user interface.
217     * Use with {@link #setThreadPriority(int)} and
218     * {@link #setThreadPriority(int, int)}, <b>not</b> with the normal
219     * {@link java.lang.Thread} class.
220     */
221    public static final int THREAD_PRIORITY_BACKGROUND = 10;
222
223    /**
224     * Standard priority of threads that are currently running a user interface
225     * that the user is interacting with.  Applications can not normally
226     * change to this priority; the system will automatically adjust your
227     * application threads as the user moves through the UI.
228     * Use with {@link #setThreadPriority(int)} and
229     * {@link #setThreadPriority(int, int)}, <b>not</b> with the normal
230     * {@link java.lang.Thread} class.
231     */
232    public static final int THREAD_PRIORITY_FOREGROUND = -2;
233
234    /**
235     * Standard priority of system display threads, involved in updating
236     * the user interface.  Applications can not
237     * normally change to this priority.
238     * Use with {@link #setThreadPriority(int)} and
239     * {@link #setThreadPriority(int, int)}, <b>not</b> with the normal
240     * {@link java.lang.Thread} class.
241     */
242    public static final int THREAD_PRIORITY_DISPLAY = -4;
243
244    /**
245     * Standard priority of the most important display threads, for compositing
246     * the screen and retrieving input events.  Applications can not normally
247     * change to this priority.
248     * Use with {@link #setThreadPriority(int)} and
249     * {@link #setThreadPriority(int, int)}, <b>not</b> with the normal
250     * {@link java.lang.Thread} class.
251     */
252    public static final int THREAD_PRIORITY_URGENT_DISPLAY = -8;
253
254    /**
255     * Standard priority of audio threads.  Applications can not normally
256     * change to this priority.
257     * Use with {@link #setThreadPriority(int)} and
258     * {@link #setThreadPriority(int, int)}, <b>not</b> with the normal
259     * {@link java.lang.Thread} class.
260     */
261    public static final int THREAD_PRIORITY_AUDIO = -16;
262
263    /**
264     * Standard priority of the most important audio threads.
265     * Applications can not normally change to this priority.
266     * Use with {@link #setThreadPriority(int)} and
267     * {@link #setThreadPriority(int, int)}, <b>not</b> with the normal
268     * {@link java.lang.Thread} class.
269     */
270    public static final int THREAD_PRIORITY_URGENT_AUDIO = -19;
271
272    /**
273     * Minimum increment to make a priority more favorable.
274     */
275    public static final int THREAD_PRIORITY_MORE_FAVORABLE = -1;
276
277    /**
278     * Minimum increment to make a priority less favorable.
279     */
280    public static final int THREAD_PRIORITY_LESS_FAVORABLE = +1;
281
282    /**
283     * Default scheduling policy
284     * @hide
285     */
286    public static final int SCHED_OTHER = 0;
287
288    /**
289     * First-In First-Out scheduling policy
290     * @hide
291     */
292    public static final int SCHED_FIFO = 1;
293
294    /**
295     * Round-Robin scheduling policy
296     * @hide
297     */
298    public static final int SCHED_RR = 2;
299
300    /**
301     * Batch scheduling policy
302     * @hide
303     */
304    public static final int SCHED_BATCH = 3;
305
306    /**
307     * Idle scheduling policy
308     * @hide
309     */
310    public static final int SCHED_IDLE = 5;
311
312    // Keep in sync with SP_* constants of enum type SchedPolicy
313    // declared in system/core/include/cutils/sched_policy.h,
314    // except THREAD_GROUP_DEFAULT does not correspond to any SP_* value.
315
316    /**
317     * Default thread group -
318     * has meaning with setProcessGroup() only, cannot be used with setThreadGroup().
319     * When used with setProcessGroup(), the group of each thread in the process
320     * is conditionally changed based on that thread's current priority, as follows:
321     * threads with priority numerically less than THREAD_PRIORITY_BACKGROUND
322     * are moved to foreground thread group.  All other threads are left unchanged.
323     * @hide
324     */
325    public static final int THREAD_GROUP_DEFAULT = -1;
326
327    /**
328     * Background thread group - All threads in
329     * this group are scheduled with a reduced share of the CPU.
330     * Value is same as constant SP_BACKGROUND of enum SchedPolicy.
331     * FIXME rename to THREAD_GROUP_BACKGROUND.
332     * @hide
333     */
334    public static final int THREAD_GROUP_BG_NONINTERACTIVE = 0;
335
336    /**
337     * Foreground thread group - All threads in
338     * this group are scheduled with a normal share of the CPU.
339     * Value is same as constant SP_FOREGROUND of enum SchedPolicy.
340     * Not used at this level.
341     * @hide
342     **/
343    private static final int THREAD_GROUP_FOREGROUND = 1;
344
345    /**
346     * System thread group.
347     * @hide
348     **/
349    public static final int THREAD_GROUP_SYSTEM = 2;
350
351    /**
352     * Application audio thread group.
353     * @hide
354     **/
355    public static final int THREAD_GROUP_AUDIO_APP = 3;
356
357    /**
358     * System audio thread group.
359     * @hide
360     **/
361    public static final int THREAD_GROUP_AUDIO_SYS = 4;
362
363    public static final int SIGNAL_QUIT = 3;
364    public static final int SIGNAL_KILL = 9;
365    public static final int SIGNAL_USR1 = 10;
366
367    /**
368     * State for communicating with the zygote process.
369     *
370     * @hide for internal use only.
371     */
372    public static class ZygoteState {
373        final LocalSocket socket;
374        final DataInputStream inputStream;
375        final BufferedWriter writer;
376        final List<String> abiList;
377
378        boolean mClosed;
379
380        private ZygoteState(LocalSocket socket, DataInputStream inputStream,
381                BufferedWriter writer, List<String> abiList) {
382            this.socket = socket;
383            this.inputStream = inputStream;
384            this.writer = writer;
385            this.abiList = abiList;
386        }
387
388        public static ZygoteState connect(String socketAddress) throws IOException {
389            DataInputStream zygoteInputStream = null;
390            BufferedWriter zygoteWriter = null;
391            final LocalSocket zygoteSocket = new LocalSocket();
392
393            try {
394                zygoteSocket.connect(new LocalSocketAddress(socketAddress,
395                        LocalSocketAddress.Namespace.RESERVED));
396
397                zygoteInputStream = new DataInputStream(zygoteSocket.getInputStream());
398
399                zygoteWriter = new BufferedWriter(new OutputStreamWriter(
400                        zygoteSocket.getOutputStream()), 256);
401            } catch (IOException ex) {
402                try {
403                    zygoteSocket.close();
404                } catch (IOException ignore) {
405                }
406
407                throw ex;
408            }
409
410            String abiListString = getAbiList(zygoteWriter, zygoteInputStream);
411            Log.i("Zygote", "Process: zygote socket opened, supported ABIS: " + abiListString);
412
413            return new ZygoteState(zygoteSocket, zygoteInputStream, zygoteWriter,
414                    Arrays.asList(abiListString.split(",")));
415        }
416
417        boolean matches(String abi) {
418            return abiList.contains(abi);
419        }
420
421        public void close() {
422            try {
423                socket.close();
424            } catch (IOException ex) {
425                Log.e(LOG_TAG,"I/O exception on routine close", ex);
426            }
427
428            mClosed = true;
429        }
430
431        boolean isClosed() {
432            return mClosed;
433        }
434    }
435
436    /**
437     * The state of the connection to the primary zygote.
438     */
439    static ZygoteState primaryZygoteState;
440
441    /**
442     * The state of the connection to the secondary zygote.
443     */
444    static ZygoteState secondaryZygoteState;
445
446    /**
447     * Start a new process.
448     *
449     * <p>If processes are enabled, a new process is created and the
450     * static main() function of a <var>processClass</var> is executed there.
451     * The process will continue running after this function returns.
452     *
453     * <p>If processes are not enabled, a new thread in the caller's
454     * process is created and main() of <var>processClass</var> called there.
455     *
456     * <p>The niceName parameter, if not an empty string, is a custom name to
457     * give to the process instead of using processClass.  This allows you to
458     * make easily identifyable processes even if you are using the same base
459     * <var>processClass</var> to start them.
460     *
461     * @param processClass The class to use as the process's main entry
462     *                     point.
463     * @param niceName A more readable name to use for the process.
464     * @param uid The user-id under which the process will run.
465     * @param gid The group-id under which the process will run.
466     * @param gids Additional group-ids associated with the process.
467     * @param debugFlags Additional flags.
468     * @param targetSdkVersion The target SDK version for the app.
469     * @param seInfo null-ok SELinux information for the new process.
470     * @param abi non-null the ABI this app should be started with.
471     * @param instructionSet null-ok the instruction set to use.
472     * @param zygoteArgs Additional arguments to supply to the zygote process.
473     *
474     * @return An object that describes the result of the attempt to start the process.
475     * @throws RuntimeException on fatal start failure
476     *
477     * {@hide}
478     */
479    public static final ProcessStartResult start(final String processClass,
480                                  final String niceName,
481                                  int uid, int gid, int[] gids,
482                                  int debugFlags, int mountExternal,
483                                  int targetSdkVersion,
484                                  String seInfo,
485                                  String abi,
486                                  String instructionSet,
487                                  String[] zygoteArgs) {
488        try {
489            return startViaZygote(processClass, niceName, uid, gid, gids,
490                    debugFlags, mountExternal, targetSdkVersion, seInfo,
491                    abi, instructionSet, zygoteArgs);
492        } catch (ZygoteStartFailedEx ex) {
493            Log.e(LOG_TAG,
494                    "Starting VM process through Zygote failed");
495            throw new RuntimeException(
496                    "Starting VM process through Zygote failed", ex);
497        }
498    }
499
500    /** retry interval for opening a zygote socket */
501    static final int ZYGOTE_RETRY_MILLIS = 500;
502
503    /**
504     * Queries the zygote for the list of ABIS it supports.
505     *
506     * @throws ZygoteStartFailedEx if the query failed.
507     */
508    private static String getAbiList(BufferedWriter writer, DataInputStream inputStream)
509            throws IOException {
510        // Each query starts with the argument count (1 in this case)
511        writer.write("1");
512        // ... followed by a new-line.
513        writer.newLine();
514        // ... followed by our only argument.
515        writer.write("--query-abi-list");
516        writer.newLine();
517        writer.flush();
518
519        // The response is a length prefixed stream of ASCII bytes.
520        int numBytes = inputStream.readInt();
521        byte[] bytes = new byte[numBytes];
522        inputStream.readFully(bytes);
523
524        return new String(bytes, StandardCharsets.US_ASCII);
525    }
526
527    /**
528     * Sends an argument list to the zygote process, which starts a new child
529     * and returns the child's pid. Please note: the present implementation
530     * replaces newlines in the argument list with spaces.
531     *
532     * @throws ZygoteStartFailedEx if process start failed for any reason
533     */
534    private static ProcessStartResult zygoteSendArgsAndGetResult(
535            ZygoteState zygoteState, ArrayList<String> args)
536            throws ZygoteStartFailedEx {
537        try {
538            /**
539             * See com.android.internal.os.ZygoteInit.readArgumentList()
540             * Presently the wire format to the zygote process is:
541             * a) a count of arguments (argc, in essence)
542             * b) a number of newline-separated argument strings equal to count
543             *
544             * After the zygote process reads these it will write the pid of
545             * the child or -1 on failure, followed by boolean to
546             * indicate whether a wrapper process was used.
547             */
548            final BufferedWriter writer = zygoteState.writer;
549            final DataInputStream inputStream = zygoteState.inputStream;
550
551            writer.write(Integer.toString(args.size()));
552            writer.newLine();
553
554            int sz = args.size();
555            for (int i = 0; i < sz; i++) {
556                String arg = args.get(i);
557                if (arg.indexOf('\n') >= 0) {
558                    throw new ZygoteStartFailedEx(
559                            "embedded newlines not allowed");
560                }
561                writer.write(arg);
562                writer.newLine();
563            }
564
565            writer.flush();
566
567            // Should there be a timeout on this?
568            ProcessStartResult result = new ProcessStartResult();
569            result.pid = inputStream.readInt();
570            if (result.pid < 0) {
571                throw new ZygoteStartFailedEx("fork() failed");
572            }
573            result.usingWrapper = inputStream.readBoolean();
574            return result;
575        } catch (IOException ex) {
576            zygoteState.close();
577            throw new ZygoteStartFailedEx(ex);
578        }
579    }
580
581    /**
582     * Starts a new process via the zygote mechanism.
583     *
584     * @param processClass Class name whose static main() to run
585     * @param niceName 'nice' process name to appear in ps
586     * @param uid a POSIX uid that the new process should setuid() to
587     * @param gid a POSIX gid that the new process shuold setgid() to
588     * @param gids null-ok; a list of supplementary group IDs that the
589     * new process should setgroup() to.
590     * @param debugFlags Additional flags.
591     * @param targetSdkVersion The target SDK version for the app.
592     * @param seInfo null-ok SELinux information for the new process.
593     * @param abi the ABI the process should use.
594     * @param instructionSet null-ok the instruction set to use.
595     * @param extraArgs Additional arguments to supply to the zygote process.
596     * @return An object that describes the result of the attempt to start the process.
597     * @throws ZygoteStartFailedEx if process start failed for any reason
598     */
599    private static ProcessStartResult startViaZygote(final String processClass,
600                                  final String niceName,
601                                  final int uid, final int gid,
602                                  final int[] gids,
603                                  int debugFlags, int mountExternal,
604                                  int targetSdkVersion,
605                                  String seInfo,
606                                  String abi,
607                                  String instructionSet,
608                                  String[] extraArgs)
609                                  throws ZygoteStartFailedEx {
610        synchronized(Process.class) {
611            ArrayList<String> argsForZygote = new ArrayList<String>();
612
613            // --runtime-init, --setuid=, --setgid=,
614            // and --setgroups= must go first
615            argsForZygote.add("--runtime-init");
616            argsForZygote.add("--setuid=" + uid);
617            argsForZygote.add("--setgid=" + gid);
618            if ((debugFlags & Zygote.DEBUG_ENABLE_JNI_LOGGING) != 0) {
619                argsForZygote.add("--enable-jni-logging");
620            }
621            if ((debugFlags & Zygote.DEBUG_ENABLE_SAFEMODE) != 0) {
622                argsForZygote.add("--enable-safemode");
623            }
624            if ((debugFlags & Zygote.DEBUG_ENABLE_DEBUGGER) != 0) {
625                argsForZygote.add("--enable-debugger");
626            }
627            if ((debugFlags & Zygote.DEBUG_ENABLE_CHECKJNI) != 0) {
628                argsForZygote.add("--enable-checkjni");
629            }
630            if ((debugFlags & Zygote.DEBUG_ENABLE_ASSERT) != 0) {
631                argsForZygote.add("--enable-assert");
632            }
633            if (mountExternal == Zygote.MOUNT_EXTERNAL_MULTIUSER) {
634                argsForZygote.add("--mount-external-multiuser");
635            } else if (mountExternal == Zygote.MOUNT_EXTERNAL_MULTIUSER_ALL) {
636                argsForZygote.add("--mount-external-multiuser-all");
637            }
638            argsForZygote.add("--target-sdk-version=" + targetSdkVersion);
639
640            //TODO optionally enable debuger
641            //argsForZygote.add("--enable-debugger");
642
643            // --setgroups is a comma-separated list
644            if (gids != null && gids.length > 0) {
645                StringBuilder sb = new StringBuilder();
646                sb.append("--setgroups=");
647
648                int sz = gids.length;
649                for (int i = 0; i < sz; i++) {
650                    if (i != 0) {
651                        sb.append(',');
652                    }
653                    sb.append(gids[i]);
654                }
655
656                argsForZygote.add(sb.toString());
657            }
658
659            if (niceName != null) {
660                argsForZygote.add("--nice-name=" + niceName);
661            }
662
663            if (seInfo != null) {
664                argsForZygote.add("--seinfo=" + seInfo);
665            }
666
667            if (instructionSet != null) {
668                argsForZygote.add("--instruction-set=" + instructionSet);
669            }
670
671            argsForZygote.add(processClass);
672
673            if (extraArgs != null) {
674                for (String arg : extraArgs) {
675                    argsForZygote.add(arg);
676                }
677            }
678
679            return zygoteSendArgsAndGetResult(openZygoteSocketIfNeeded(abi), argsForZygote);
680        }
681    }
682
683    /**
684     * Tries to open socket to Zygote process if not already open. If
685     * already open, does nothing.  May block and retry.
686     */
687    private static ZygoteState openZygoteSocketIfNeeded(String abi) throws ZygoteStartFailedEx {
688        if (primaryZygoteState == null || primaryZygoteState.isClosed()) {
689            try {
690                primaryZygoteState = ZygoteState.connect(ZYGOTE_SOCKET);
691            } catch (IOException ioe) {
692                throw new ZygoteStartFailedEx("Error connecting to primary zygote", ioe);
693            }
694        }
695
696        if (primaryZygoteState.matches(abi)) {
697            return primaryZygoteState;
698        }
699
700        // The primary zygote didn't match. Try the secondary.
701        if (secondaryZygoteState == null || secondaryZygoteState.isClosed()) {
702            try {
703            secondaryZygoteState = ZygoteState.connect(SECONDARY_ZYGOTE_SOCKET);
704            } catch (IOException ioe) {
705                throw new ZygoteStartFailedEx("Error connecting to secondary zygote", ioe);
706            }
707        }
708
709        if (secondaryZygoteState.matches(abi)) {
710            return secondaryZygoteState;
711        }
712
713        throw new ZygoteStartFailedEx("Unsupported zygote ABI: " + abi);
714    }
715
716    /**
717     * Returns elapsed milliseconds of the time this process has run.
718     * @return  Returns the number of milliseconds this process has return.
719     */
720    public static final native long getElapsedCpuTime();
721
722    /**
723     * Returns the identifier of this process, which can be used with
724     * {@link #killProcess} and {@link #sendSignal}.
725     */
726    public static final int myPid() {
727        return Os.getpid();
728    }
729
730    /**
731     * Returns the identifier of this process' parent.
732     * @hide
733     */
734    public static final int myPpid() {
735        return Os.getppid();
736    }
737
738    /**
739     * Returns the identifier of the calling thread, which be used with
740     * {@link #setThreadPriority(int, int)}.
741     */
742    public static final int myTid() {
743        return Os.gettid();
744    }
745
746    /**
747     * Returns the identifier of this process's uid.  This is the kernel uid
748     * that the process is running under, which is the identity of its
749     * app-specific sandbox.  It is different from {@link #myUserHandle} in that
750     * a uid identifies a specific app sandbox in a specific user.
751     */
752    public static final int myUid() {
753        return Os.getuid();
754    }
755
756    /**
757     * Returns this process's user handle.  This is the
758     * user the process is running under.  It is distinct from
759     * {@link #myUid()} in that a particular user will have multiple
760     * distinct apps running under it each with their own uid.
761     */
762    public static final UserHandle myUserHandle() {
763        return new UserHandle(UserHandle.getUserId(myUid()));
764    }
765
766    /**
767     * Returns whether the current process is in an isolated sandbox.
768     * @hide
769     */
770    public static final boolean isIsolated() {
771        int uid = UserHandle.getAppId(myUid());
772        return uid >= FIRST_ISOLATED_UID && uid <= LAST_ISOLATED_UID;
773    }
774
775    /**
776     * Returns the UID assigned to a particular user name, or -1 if there is
777     * none.  If the given string consists of only numbers, it is converted
778     * directly to a uid.
779     */
780    public static final native int getUidForName(String name);
781
782    /**
783     * Returns the GID assigned to a particular user name, or -1 if there is
784     * none.  If the given string consists of only numbers, it is converted
785     * directly to a gid.
786     */
787    public static final native int getGidForName(String name);
788
789    /**
790     * Returns a uid for a currently running process.
791     * @param pid the process id
792     * @return the uid of the process, or -1 if the process is not running.
793     * @hide pending API council review
794     */
795    public static final int getUidForPid(int pid) {
796        String[] procStatusLabels = { "Uid:" };
797        long[] procStatusValues = new long[1];
798        procStatusValues[0] = -1;
799        Process.readProcLines("/proc/" + pid + "/status", procStatusLabels, procStatusValues);
800        return (int) procStatusValues[0];
801    }
802
803    /**
804     * Returns the parent process id for a currently running process.
805     * @param pid the process id
806     * @return the parent process id of the process, or -1 if the process is not running.
807     * @hide
808     */
809    public static final int getParentPid(int pid) {
810        String[] procStatusLabels = { "PPid:" };
811        long[] procStatusValues = new long[1];
812        procStatusValues[0] = -1;
813        Process.readProcLines("/proc/" + pid + "/status", procStatusLabels, procStatusValues);
814        return (int) procStatusValues[0];
815    }
816
817    /**
818     * Returns the thread group leader id for a currently running thread.
819     * @param tid the thread id
820     * @return the thread group leader id of the thread, or -1 if the thread is not running.
821     *         This is same as what getpid(2) would return if called by tid.
822     * @hide
823     */
824    public static final int getThreadGroupLeader(int tid) {
825        String[] procStatusLabels = { "Tgid:" };
826        long[] procStatusValues = new long[1];
827        procStatusValues[0] = -1;
828        Process.readProcLines("/proc/" + tid + "/status", procStatusLabels, procStatusValues);
829        return (int) procStatusValues[0];
830    }
831
832    /**
833     * Set the priority of a thread, based on Linux priorities.
834     *
835     * @param tid The identifier of the thread/process to change.
836     * @param priority A Linux priority level, from -20 for highest scheduling
837     * priority to 19 for lowest scheduling priority.
838     *
839     * @throws IllegalArgumentException Throws IllegalArgumentException if
840     * <var>tid</var> does not exist.
841     * @throws SecurityException Throws SecurityException if your process does
842     * not have permission to modify the given thread, or to use the given
843     * priority.
844     */
845    public static final native void setThreadPriority(int tid, int priority)
846            throws IllegalArgumentException, SecurityException;
847
848    /**
849     * Call with 'false' to cause future calls to {@link #setThreadPriority(int)} to
850     * throw an exception if passed a background-level thread priority.  This is only
851     * effective if the JNI layer is built with GUARD_THREAD_PRIORITY defined to 1.
852     *
853     * @hide
854     */
855    public static final native void setCanSelfBackground(boolean backgroundOk);
856
857    /**
858     * Sets the scheduling group for a thread.
859     * @hide
860     * @param tid The identifier of the thread to change.
861     * @param group The target group for this thread from THREAD_GROUP_*.
862     *
863     * @throws IllegalArgumentException Throws IllegalArgumentException if
864     * <var>tid</var> does not exist.
865     * @throws SecurityException Throws SecurityException if your process does
866     * not have permission to modify the given thread, or to use the given
867     * priority.
868     * If the thread is a thread group leader, that is it's gettid() == getpid(),
869     * then the other threads in the same thread group are _not_ affected.
870     */
871    public static final native void setThreadGroup(int tid, int group)
872            throws IllegalArgumentException, SecurityException;
873
874    /**
875     * Sets the scheduling group for a process and all child threads
876     * @hide
877     * @param pid The identifier of the process to change.
878     * @param group The target group for this process from THREAD_GROUP_*.
879     *
880     * @throws IllegalArgumentException Throws IllegalArgumentException if
881     * <var>tid</var> does not exist.
882     * @throws SecurityException Throws SecurityException if your process does
883     * not have permission to modify the given thread, or to use the given
884     * priority.
885     *
886     * group == THREAD_GROUP_DEFAULT means to move all non-background priority
887     * threads to the foreground scheduling group, but to leave background
888     * priority threads alone.  group == THREAD_GROUP_BG_NONINTERACTIVE moves all
889     * threads, regardless of priority, to the background scheduling group.
890     * group == THREAD_GROUP_FOREGROUND is not allowed.
891     */
892    public static final native void setProcessGroup(int pid, int group)
893            throws IllegalArgumentException, SecurityException;
894
895    /**
896     * Return the scheduling group of requested process.
897     *
898     * @hide
899     */
900    public static final native int getProcessGroup(int pid)
901            throws IllegalArgumentException, SecurityException;
902
903    /**
904     * Set the priority of the calling thread, based on Linux priorities.  See
905     * {@link #setThreadPriority(int, int)} for more information.
906     *
907     * @param priority A Linux priority level, from -20 for highest scheduling
908     * priority to 19 for lowest scheduling priority.
909     *
910     * @throws IllegalArgumentException Throws IllegalArgumentException if
911     * <var>tid</var> does not exist.
912     * @throws SecurityException Throws SecurityException if your process does
913     * not have permission to modify the given thread, or to use the given
914     * priority.
915     *
916     * @see #setThreadPriority(int, int)
917     */
918    public static final native void setThreadPriority(int priority)
919            throws IllegalArgumentException, SecurityException;
920
921    /**
922     * Return the current priority of a thread, based on Linux priorities.
923     *
924     * @param tid The identifier of the thread/process to change.
925     *
926     * @return Returns the current priority, as a Linux priority level,
927     * from -20 for highest scheduling priority to 19 for lowest scheduling
928     * priority.
929     *
930     * @throws IllegalArgumentException Throws IllegalArgumentException if
931     * <var>tid</var> does not exist.
932     */
933    public static final native int getThreadPriority(int tid)
934            throws IllegalArgumentException;
935
936    /**
937     * Set the scheduling policy and priority of a thread, based on Linux.
938     *
939     * @param tid The identifier of the thread/process to change.
940     * @param policy A Linux scheduling policy such as SCHED_OTHER etc.
941     * @param priority A Linux priority level in a range appropriate for the given policy.
942     *
943     * @throws IllegalArgumentException Throws IllegalArgumentException if
944     * <var>tid</var> does not exist, or if <var>priority</var> is out of range for the policy.
945     * @throws SecurityException Throws SecurityException if your process does
946     * not have permission to modify the given thread, or to use the given
947     * scheduling policy or priority.
948     *
949     * {@hide}
950     */
951    public static final native void setThreadScheduler(int tid, int policy, int priority)
952            throws IllegalArgumentException;
953
954    /**
955     * Determine whether the current environment supports multiple processes.
956     *
957     * @return Returns true if the system can run in multiple processes, else
958     * false if everything is running in a single process.
959     *
960     * @deprecated This method always returns true.  Do not use.
961     */
962    @Deprecated
963    public static final boolean supportsProcesses() {
964        return true;
965    }
966
967    /**
968     * Adjust the swappiness level for a process.
969     *
970     * @param pid The process identifier to set.
971     * @param is_increased Whether swappiness should be increased or default.
972     *
973     * @return Returns true if the underlying system supports this
974     *         feature, else false.
975     *
976     * {@hide}
977     */
978    public static final native boolean setSwappiness(int pid, boolean is_increased);
979
980    /**
981     * Change this process's argv[0] parameter.  This can be useful to show
982     * more descriptive information in things like the 'ps' command.
983     *
984     * @param text The new name of this process.
985     *
986     * {@hide}
987     */
988    public static final native void setArgV0(String text);
989
990    /**
991     * Kill the process with the given PID.
992     * Note that, though this API allows us to request to
993     * kill any process based on its PID, the kernel will
994     * still impose standard restrictions on which PIDs you
995     * are actually able to kill.  Typically this means only
996     * the process running the caller's packages/application
997     * and any additional processes created by that app; packages
998     * sharing a common UID will also be able to kill each
999     * other's processes.
1000     */
1001    public static final void killProcess(int pid) {
1002        sendSignal(pid, SIGNAL_KILL);
1003    }
1004
1005    /** @hide */
1006    public static final native int setUid(int uid);
1007
1008    /** @hide */
1009    public static final native int setGid(int uid);
1010
1011    /**
1012     * Send a signal to the given process.
1013     *
1014     * @param pid The pid of the target process.
1015     * @param signal The signal to send.
1016     */
1017    public static final native void sendSignal(int pid, int signal);
1018
1019    /**
1020     * @hide
1021     * Private impl for avoiding a log message...  DO NOT USE without doing
1022     * your own log, or the Android Illuminati will find you some night and
1023     * beat you up.
1024     */
1025    public static final void killProcessQuiet(int pid) {
1026        sendSignalQuiet(pid, SIGNAL_KILL);
1027    }
1028
1029    /**
1030     * @hide
1031     * Private impl for avoiding a log message...  DO NOT USE without doing
1032     * your own log, or the Android Illuminati will find you some night and
1033     * beat you up.
1034     */
1035    public static final native void sendSignalQuiet(int pid, int signal);
1036
1037    /** @hide */
1038    public static final native long getFreeMemory();
1039
1040    /** @hide */
1041    public static final native long getTotalMemory();
1042
1043    /** @hide */
1044    public static final native void readProcLines(String path,
1045            String[] reqFields, long[] outSizes);
1046
1047    /** @hide */
1048    public static final native int[] getPids(String path, int[] lastArray);
1049
1050    /** @hide */
1051    public static final int PROC_TERM_MASK = 0xff;
1052    /** @hide */
1053    public static final int PROC_ZERO_TERM = 0;
1054    /** @hide */
1055    public static final int PROC_SPACE_TERM = (int)' ';
1056    /** @hide */
1057    public static final int PROC_TAB_TERM = (int)'\t';
1058    /** @hide */
1059    public static final int PROC_COMBINE = 0x100;
1060    /** @hide */
1061    public static final int PROC_PARENS = 0x200;
1062    /** @hide */
1063    public static final int PROC_QUOTES = 0x400;
1064    /** @hide */
1065    public static final int PROC_OUT_STRING = 0x1000;
1066    /** @hide */
1067    public static final int PROC_OUT_LONG = 0x2000;
1068    /** @hide */
1069    public static final int PROC_OUT_FLOAT = 0x4000;
1070
1071    /** @hide */
1072    public static final native boolean readProcFile(String file, int[] format,
1073            String[] outStrings, long[] outLongs, float[] outFloats);
1074
1075    /** @hide */
1076    public static final native boolean parseProcLine(byte[] buffer, int startIndex,
1077            int endIndex, int[] format, String[] outStrings, long[] outLongs, float[] outFloats);
1078
1079    /** @hide */
1080    public static final native int[] getPidsForCommands(String[] cmds);
1081
1082    /**
1083     * Gets the total Pss value for a given process, in bytes.
1084     *
1085     * @param pid the process to the Pss for
1086     * @return the total Pss value for the given process in bytes,
1087     *  or -1 if the value cannot be determined
1088     * @hide
1089     */
1090    public static final native long getPss(int pid);
1091
1092    /**
1093     * Specifies the outcome of having started a process.
1094     * @hide
1095     */
1096    public static final class ProcessStartResult {
1097        /**
1098         * The PID of the newly started process.
1099         * Always >= 0.  (If the start failed, an exception will have been thrown instead.)
1100         */
1101        public int pid;
1102
1103        /**
1104         * True if the process was started with a wrapper attached.
1105         */
1106        public boolean usingWrapper;
1107    }
1108
1109    /**
1110     * Kill all processes in a process group started for the given
1111     * pid.
1112     * @hide
1113     */
1114    public static final native int killProcessGroup(int uid, int pid);
1115
1116    /**
1117     * Remove all process groups.  Expected to be called when ActivityManager
1118     * is restarted.
1119     * @hide
1120     */
1121    public static final native void removeAllProcessGroups();
1122}
1123