src.android.system.Os Maven / Gradle / Ivy
Show all versions of android-all Show documentation
/*
* Copyright (C) 2011 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.system;
import static android.annotation.SystemApi.Client.MODULE_LIBRARIES;
import android.annotation.SystemApi;
import android.compat.annotation.UnsupportedAppUsage;
import libcore.io.Libcore;
import libcore.util.NonNull;
import libcore.util.Nullable;
import java.io.FileDescriptor;
import java.io.InterruptedIOException;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.net.SocketException;
import java.nio.ByteBuffer;
/**
* Access to low-level system functionality. Most of these are system calls. Most users will want
* to use higher-level APIs where available, but this class provides access to the underlying
* primitives used to implement the higher-level APIs.
*
* The corresponding constants can be found in {@link OsConstants}.
*/
public final class Os {
private Os() {}
// Ideally we'd just have the version that accepts SocketAddress but we're stuck with
// this one for legacy reasons. http://b/123568439
/**
* See accept(2).
*/
public static FileDescriptor accept(FileDescriptor fd, InetSocketAddress peerAddress) throws ErrnoException, SocketException { return accept(fd, (SocketAddress) peerAddress); }
/**
* See accept(2).
* @hide
*/
public static FileDescriptor accept(FileDescriptor fd, SocketAddress peerAddress) throws ErrnoException, SocketException { return Libcore.os.accept(fd, peerAddress); }
/**
* See access(2).
*/
public static boolean access(String path, int mode) throws ErrnoException { return Libcore.os.access(path, mode); }
/** @hide */
public static InetAddress[] android_getaddrinfo(String node, StructAddrinfo hints, int netId) throws GaiException { return Libcore.os.android_getaddrinfo(node, hints, netId); }
/**
* See bind(2).
*/
public static void bind(FileDescriptor fd, InetAddress address, int port) throws ErrnoException, SocketException { Libcore.os.bind(fd, address, port); }
/**
* See bind(2).
*/
public static void bind(@NonNull FileDescriptor fd, @NonNull SocketAddress address) throws ErrnoException, SocketException { Libcore.os.bind(fd, address); }
/**
* See capget(2).
*
* @param hdr capabilities header, containing version and pid
* @return list of capabilities data structures, each containing effective, permitted,
* and inheritable fields are bit masks of the capabilities
* @throws ErrnoException if {@code hdr} structure contains invalid data
*
* @hide
*/
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
public static @Nullable StructCapUserData[] capget(@NonNull StructCapUserHeader hdr) throws ErrnoException {
return Libcore.os.capget(hdr);
}
/**
* See capset(2).
*
* @param hdr capabilities header, containing version and pid
* @param data capabilities data list, containing effective, permitted,
* and inheritable fields. Must be the same length as returned value
* @throws ErrnoException if {@code hdr} structure contains invalid data; or
* an attempt was made to add a capability to the permitted
* set, or to set a capability in the effective set that is
* not in the permitted set; or
* the caller attempted to use
* {@link capset(StructCapUserHeader, StructCapUserData[])}
* to modify the capabilities of a thread other than itself,
* but lacked sufficient privilege;
* or there is no such thread.
*
* @hide
*/
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
public static void capset(@NonNull StructCapUserHeader hdr, @NonNull StructCapUserData[] data)
throws ErrnoException {
Libcore.os.capset(hdr, data);
}
/**
* See chmod(2).
*/
public static void chmod(String path, int mode) throws ErrnoException { Libcore.os.chmod(path, mode); }
/**
* See chown(2).
*/
public static void chown(String path, int uid, int gid) throws ErrnoException { Libcore.os.chown(path, uid, gid); }
/**
* See close(2).
*/
public static void close(FileDescriptor fd) throws ErrnoException { Libcore.os.close(fd); }
/**
* See connect(2).
*/
public static void connect(FileDescriptor fd, InetAddress address, int port) throws ErrnoException, SocketException { Libcore.os.connect(fd, address, port); }
/**
* See connect(2).
*/
public static void connect(@NonNull FileDescriptor fd, @NonNull SocketAddress address) throws ErrnoException, SocketException { Libcore.os.connect(fd, address); }
/**
* See dup(2).
*/
public static FileDescriptor dup(FileDescriptor oldFd) throws ErrnoException { return Libcore.os.dup(oldFd); }
/**
* See dup2(2).
*/
public static FileDescriptor dup2(FileDescriptor oldFd, int newFd) throws ErrnoException { return Libcore.os.dup2(oldFd, newFd); }
/**
* See environ(3).
*/
public static String[] environ() { return Libcore.os.environ(); }
/**
* See execv(2).
*/
public static void execv(String filename, String[] argv) throws ErrnoException { Libcore.os.execv(filename, argv); }
/**
* See execve(2).
*/
public static void execve(String filename, String[] argv, String[] envp) throws ErrnoException { Libcore.os.execve(filename, argv, envp); }
/**
* See fchmod(2).
*/
public static void fchmod(FileDescriptor fd, int mode) throws ErrnoException { Libcore.os.fchmod(fd, mode); }
/**
* See fchown(2).
*/
public static void fchown(FileDescriptor fd, int uid, int gid) throws ErrnoException { Libcore.os.fchown(fd, uid, gid); }
/**
* See fcntl(2).
*/
public static int fcntlInt(@NonNull FileDescriptor fd, int cmd, int arg) throws ErrnoException { return Libcore.os.fcntlInt(fd, cmd, arg); }
/** @hide */
public static int fcntlVoid(FileDescriptor fd, int cmd) throws ErrnoException { return Libcore.os.fcntlVoid(fd, cmd); }
/**
* See fdatasync(2).
*/
public static void fdatasync(FileDescriptor fd) throws ErrnoException { Libcore.os.fdatasync(fd); }
/**
* See fstat(2).
*/
public static StructStat fstat(FileDescriptor fd) throws ErrnoException { return Libcore.os.fstat(fd); }
/**
* See fstatvfs(2).
*/
public static StructStatVfs fstatvfs(FileDescriptor fd) throws ErrnoException { return Libcore.os.fstatvfs(fd); }
/**
* See fsync(2).
*/
public static void fsync(FileDescriptor fd) throws ErrnoException { Libcore.os.fsync(fd); }
/**
* See ftruncate(2).
*/
public static void ftruncate(FileDescriptor fd, long length) throws ErrnoException { Libcore.os.ftruncate(fd, length); }
/**
* See gai_strerror(3).
*/
public static String gai_strerror(int error) { return Libcore.os.gai_strerror(error); }
/**
* See getegid(2).
*/
public static int getegid() { return Libcore.os.getegid(); }
/**
* See geteuid(2).
*/
public static int geteuid() { return Libcore.os.geteuid(); }
/**
* See getgid(2).
*/
public static int getgid() { return Libcore.os.getgid(); }
/**
* See getenv(3).
*/
public static String getenv(String name) { return Libcore.os.getenv(name); }
/**
* See getifaddrs(3).
* @hide
*/
public static StructIfaddrs[] getifaddrs() throws ErrnoException { return Libcore.os.getifaddrs(); }
/** @hide */
public static String getnameinfo(InetAddress address, int flags) throws GaiException { return Libcore.os.getnameinfo(address, flags); }
/**
* See getpeername(2).
*/
public static SocketAddress getpeername(FileDescriptor fd) throws ErrnoException { return Libcore.os.getpeername(fd); }
/**
* Gets process's pgid (process group ID).
*
* See getpgid(2).
*
* @param pid process id to get the pgid of
* @return process's pgid
* @throws ErrnoException if {@code pid} does not match any process
*
* @hide
*/
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
public static int getpgid(int pid) throws ErrnoException { return Libcore.os.getpgid(pid); }
/**
* See getpid(2).
*/
public static int getpid() { return Libcore.os.getpid(); }
/**
* See getppid(2).
*/
public static int getppid() { return Libcore.os.getppid(); }
/** @hide */
public static StructPasswd getpwnam(String name) throws ErrnoException { return Libcore.os.getpwnam(name); }
/** @hide */
public static StructPasswd getpwuid(int uid) throws ErrnoException { return Libcore.os.getpwuid(uid); }
/**
* Gets the resource limit.
*
* See getrlimit(2).
*
* @param resource resource id
* @return the limit of the given resource
* @throws ErrnoException the value specified in {@code resource} is not valid
*
* @hide
*/
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
public static @Nullable StructRlimit getrlimit(int resource) throws ErrnoException { return Libcore.os.getrlimit(resource); }
/**
* See getsockname(2).
*/
public static SocketAddress getsockname(FileDescriptor fd) throws ErrnoException { return Libcore.os.getsockname(fd); }
/** @hide */
public static int getsockoptByte(FileDescriptor fd, int level, int option) throws ErrnoException { return Libcore.os.getsockoptByte(fd, level, option); }
/** @hide */
public static InetAddress getsockoptInAddr(FileDescriptor fd, int level, int option) throws ErrnoException { return Libcore.os.getsockoptInAddr(fd, level, option); }
/**
* Gets socket options for the socket referred to by the file descriptor {@code fd}.
*
* See getsockopt(2).
* For the list of available options see socket(7).
*
* @param fd file descriptor of the socket to get options of
* @param level level at which the {@code option} resides. For example,
* to indicate that an option is to be interpreted by the TCP protocol,
* level should be set to the protocol number of TCP
* @param option name of the option to get
* @return socket options for file descriptor {@code fd}
* @throws ErrnoException if {@code fd} is invalid; or
* {@code option} is unknown at given {@code level}
*
* @hide
*/
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
public static int getsockoptInt(@NonNull FileDescriptor fd, int level, int option) throws ErrnoException { return Libcore.os.getsockoptInt(fd, level, option); }
/**
* Gets {@link OsConstants#SO_LINGER} option for the socket referred to by the file descriptor {@code fd}.
* When enabled, a {@link close(FileDescriptor) or {@link shutdown(FileDescriptor, int)} will
* not return until all queued messages for the socket have been successfully sent or the
* linger timeout has been reached. Otherwise, the call returns immediately and the closing is
* done in the background.
*
* See socket(7).
*
* @param fd file descriptor of the socket to get {@code OsConstants.SO_LINGER} option of
* @param level level at which the {@code option} resides
* @param option name of the option to get
* @return {@link StructLinger} associated with given {@code fd}
* @throws ErrnoException
*
* @hide
*/
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
public static @Nullable StructLinger getsockoptLinger(@NonNull FileDescriptor fd, int level, int option) throws ErrnoException { return Libcore.os.getsockoptLinger(fd, level, option); }
/**
* See getsockopt(2).
*
*
Only for use with {@code option} values that return a {@code struct timeval} such as
* {@link OsConstants#SO_RCVTIMEO} and {@link OsConstants#SO_SNDTIMEO}. Use with other
* options may throw an {@code IllegalArgumentException} or return junk values.
*/
public static @NonNull StructTimeval getsockoptTimeval(@NonNull FileDescriptor fd, int level, int option) throws ErrnoException { return Libcore.os.getsockoptTimeval(fd, level, option); }
/** @hide */
public static StructUcred getsockoptUcred(FileDescriptor fd, int level, int option) throws ErrnoException { return Libcore.os.getsockoptUcred(fd, level, option); }
/**
* See gettid(2).
*/
public static int gettid() { return Libcore.os.gettid(); }
/**
* See getuid(2).
*/
public static int getuid() { return Libcore.os.getuid(); }
/**
* See getxattr(2)
*/
public static byte[] getxattr(String path, String name) throws ErrnoException { return Libcore.os.getxattr(path, name); }
/**
* See if_indextoname(3).
*/
public static String if_indextoname(int index) { return Libcore.os.if_indextoname(index); }
/**
* See if_nametoindex(3).
*/
public static int if_nametoindex(String name) { return Libcore.os.if_nametoindex(name); }
/**
* See inet_pton(3).
*/
public static InetAddress inet_pton(int family, String address) { return Libcore.os.inet_pton(family, address); }
/** @hide */
public static InetAddress ioctlInetAddress(FileDescriptor fd, int cmd, String interfaceName) throws ErrnoException { return Libcore.os.ioctlInetAddress(fd, cmd, interfaceName); }
/**
* See ioctl(3).
* System call manipulates the underlying device parameters of special files. In particular,
* many operating characteristics of character special files.
*
* @param fd an open file descriptor
* @param cmd encoded in it whether the argument is an "in" parameter or "out" parameter
* @return returns a nonnegative value on success
* @throws ErrnoException A checked exception thrown when {@link Os} methods fail.
* {@see android.system.ErrnoException}
*
* @hide
*/
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
public static int ioctlInt(@NonNull FileDescriptor fd, int cmd) throws ErrnoException {
return Libcore.os.ioctlInt(fd, cmd);
}
/**
* See isatty(3).
*/
public static boolean isatty(FileDescriptor fd) { return Libcore.os.isatty(fd); }
/**
* See kill(2).
*/
public static void kill(int pid, int signal) throws ErrnoException { Libcore.os.kill(pid, signal); }
/**
* See lchown(2).
*/
public static void lchown(String path, int uid, int gid) throws ErrnoException { Libcore.os.lchown(path, uid, gid); }
/**
* See link(2).
*/
public static void link(String oldPath, String newPath) throws ErrnoException { Libcore.os.link(oldPath, newPath); }
/**
* See listen(2).
*/
public static void listen(FileDescriptor fd, int backlog) throws ErrnoException { Libcore.os.listen(fd, backlog); }
/**
* See listxattr(2)
*/
public static String[] listxattr(String path) throws ErrnoException { return Libcore.os.listxattr(path); }
/**
* See lseek(2).
*/
public static long lseek(FileDescriptor fd, long offset, int whence) throws ErrnoException { return Libcore.os.lseek(fd, offset, whence); }
/**
* See lstat(2).
*/
public static StructStat lstat(String path) throws ErrnoException { return Libcore.os.lstat(path); }
/**
* See memfd_create(2).
*/
public static @NonNull FileDescriptor memfd_create(@NonNull String name, int flags) throws ErrnoException { return Libcore.os.memfd_create(name, flags); }
/**
* See mincore(2).
*/
public static void mincore(long address, long byteCount, byte[] vector) throws ErrnoException { Libcore.os.mincore(address, byteCount, vector); }
/**
* See mkdir(2).
*/
public static void mkdir(String path, int mode) throws ErrnoException { Libcore.os.mkdir(path, mode); }
/**
* See mkfifo(3).
*/
public static void mkfifo(String path, int mode) throws ErrnoException { Libcore.os.mkfifo(path, mode); }
/**
* See mlock(2).
*/
public static void mlock(long address, long byteCount) throws ErrnoException { Libcore.os.mlock(address, byteCount); }
/**
* See mmap(2).
*/
public static long mmap(long address, long byteCount, int prot, int flags, FileDescriptor fd, long offset) throws ErrnoException { return Libcore.os.mmap(address, byteCount, prot, flags, fd, offset); }
/**
* See msync(2).
*/
public static void msync(long address, long byteCount, int flags) throws ErrnoException { Libcore.os.msync(address, byteCount, flags); }
/**
* See munlock(2).
*/
public static void munlock(long address, long byteCount) throws ErrnoException { Libcore.os.munlock(address, byteCount); }
/**
* See munmap(2).
*/
public static void munmap(long address, long byteCount) throws ErrnoException { Libcore.os.munmap(address, byteCount); }
/**
* See open(2).
*/
public static FileDescriptor open(String path, int flags, int mode) throws ErrnoException { return Libcore.os.open(path, flags, mode); }
/**
* See pipe(2).
*/
public static FileDescriptor[] pipe() throws ErrnoException { return Libcore.os.pipe2(0); }
/**
* Creates a pipe, a unidirectional data channel that can be used for interprocess communication.
*
* See pipe(2).
*
* @param flags bitmask of options, e.g. {@link OsConstants#O_CLOEXEC}, {@link OsConstants#O_DIRECT}
* or {@link OsConstants#O_NONBLOCK}.
* If {@code flags} is {@code 0}, then {@link pipe2(int)} is the same as {@link pipe()}.
* @return array of two file descriptors referring to the ends of the pipe, where
* first file descriptor is the read end of the pipe, and second is a write end
* @throws ErrnoException if {@code flags} contains invalid value; or
* the per-process limit on the number of open file
* descriptors has been reached; or
* the system-wide limit on the total number of open files
* has been reached; or
* the user hard limit on memory that can be allocated for
* pipes has been reached and the caller is not privileged
*
* @hide
*/
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
public static @Nullable FileDescriptor[] pipe2(int flags) throws ErrnoException { return Libcore.os.pipe2(flags); }
/**
* See poll(2).
*
*
Note that in Lollipop this could throw an {@code ErrnoException} with {@code EINTR}.
* In later releases, the implementation will automatically just restart the system call with
* an appropriately reduced timeout.
*/
public static int poll(StructPollfd[] fds, int timeoutMs) throws ErrnoException { return Libcore.os.poll(fds, timeoutMs); }
/**
* See posix_fallocate(3).
*/
public static void posix_fallocate(FileDescriptor fd, long offset, long length) throws ErrnoException { Libcore.os.posix_fallocate(fd, offset, length); }
/**
* See prctl(2).
*/
public static int prctl(int option, long arg2, long arg3, long arg4, long arg5) throws ErrnoException { return Libcore.os.prctl(option, arg2, arg3, arg4, arg5); };
/**
* See pread(2).
*/
public static int pread(FileDescriptor fd, ByteBuffer buffer, long offset) throws ErrnoException, InterruptedIOException { return Libcore.os.pread(fd, buffer, offset); }
/**
* See pread(2).
*/
public static int pread(FileDescriptor fd, byte[] bytes, int byteOffset, int byteCount, long offset) throws ErrnoException, InterruptedIOException { return Libcore.os.pread(fd, bytes, byteOffset, byteCount, offset); }
/**
* See pwrite(2).
*/
public static int pwrite(FileDescriptor fd, ByteBuffer buffer, long offset) throws ErrnoException, InterruptedIOException { return Libcore.os.pwrite(fd, buffer, offset); }
/**
* See pwrite(2).
*/
public static int pwrite(FileDescriptor fd, byte[] bytes, int byteOffset, int byteCount, long offset) throws ErrnoException, InterruptedIOException { return Libcore.os.pwrite(fd, bytes, byteOffset, byteCount, offset); }
/**
* See read(2).
*/
public static int read(FileDescriptor fd, ByteBuffer buffer) throws ErrnoException, InterruptedIOException { return Libcore.os.read(fd, buffer); }
/**
* See read(2).
*/
public static int read(FileDescriptor fd, byte[] bytes, int byteOffset, int byteCount) throws ErrnoException, InterruptedIOException { return Libcore.os.read(fd, bytes, byteOffset, byteCount); }
/**
* See readlink(2).
*/
public static String readlink(String path) throws ErrnoException { return Libcore.os.readlink(path); }
/**
* Eexpands all symbolic links and resolves references to {@code /./},
* {@code /../} and extra {@code /} characters string named by path
* to produce a canonicalized absolute pathname.
*
* See realpath(3).
*
* @param path string to resolve
* @return resolved path if no error occurred. Returns {@code null} if {@code path}
* is {@code null}
* @throws ErrnoException read or search permission was denied for a component of
* the path prefix; or an I/O error occurred while reading
* from the filesystem; or too many symbolic links were
* encountered in translating the pathname; or
* the named file does not exist; or a component of the path
* prefix is not a directory
*
* @hide
*/
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
@libcore.api.IntraCoreApi
public static @Nullable String realpath(@Nullable String path) throws ErrnoException { return Libcore.os.realpath(path); }
/**
* See readv(2).
*/
public static int readv(FileDescriptor fd, Object[] buffers, int[] offsets, int[] byteCounts) throws ErrnoException, InterruptedIOException { return Libcore.os.readv(fd, buffers, offsets, byteCounts); }
/**
* See recvfrom(2).
*/
public static int recvfrom(FileDescriptor fd, ByteBuffer buffer, int flags, InetSocketAddress srcAddress) throws ErrnoException, SocketException { return Libcore.os.recvfrom(fd, buffer, flags, srcAddress); }
/**
* See recvfrom(2).
*/
public static int recvfrom(FileDescriptor fd, byte[] bytes, int byteOffset, int byteCount, int flags, InetSocketAddress srcAddress) throws ErrnoException, SocketException { return Libcore.os.recvfrom(fd, bytes, byteOffset, byteCount, flags, srcAddress); }
/**
* See recvmsg(2).
*/
public static int recvmsg(@NonNull FileDescriptor fd, @NonNull StructMsghdr msg, int flags) throws ErrnoException, SocketException { return Libcore.os.recvmsg(fd, msg, flags); }
/**
* See remove(3).
*/
public static void remove(String path) throws ErrnoException { Libcore.os.remove(path); }
/**
* See removexattr(2).
*/
public static void removexattr(String path, String name) throws ErrnoException { Libcore.os.removexattr(path, name); }
/**
* See rename(2).
*/
public static void rename(String oldPath, String newPath) throws ErrnoException { Libcore.os.rename(oldPath, newPath); }
/**
* See sendfile(2).
*/
public static long sendfile(FileDescriptor outFd, FileDescriptor inFd, Int64Ref offset, long byteCount) throws ErrnoException {
return Libcore.os.sendfile(outFd, inFd, offset, byteCount);
}
/**
* See sendmsg(2).
*/
public static int sendmsg(@NonNull FileDescriptor fd, @NonNull StructMsghdr msg, int flags) throws ErrnoException, SocketException {
return Libcore.os.sendmsg(fd, msg, flags);
}
/**
* See sendto(2).
*/
public static int sendto(FileDescriptor fd, ByteBuffer buffer, int flags, InetAddress inetAddress, int port) throws ErrnoException, SocketException { return Libcore.os.sendto(fd, buffer, flags, inetAddress, port); }
/**
* See sendto(2).
*/
public static int sendto(FileDescriptor fd, byte[] bytes, int byteOffset, int byteCount, int flags, InetAddress inetAddress, int port) throws ErrnoException, SocketException { return Libcore.os.sendto(fd, bytes, byteOffset, byteCount, flags, inetAddress, port); }
/**
* See sendto(2).
*/
public static int sendto(@NonNull FileDescriptor fd, @NonNull byte[] bytes, int byteOffset, int byteCount, int flags, @Nullable SocketAddress address) throws ErrnoException, SocketException { return Libcore.os.sendto(fd, bytes, byteOffset, byteCount, flags, address); }
/**
* See setegid(2).
* @deprecated Android Applications do not have sufficient privileges to call this method.
*/
@Deprecated
public static void setegid(int egid) throws ErrnoException { Libcore.os.setegid(egid); }
/**
* See setenv(3).
*/
public static void setenv(String name, String value, boolean overwrite) throws ErrnoException { Libcore.os.setenv(name, value, overwrite); }
/**
* See seteuid(2).
* @deprecated Android Applications do not have sufficient privileges to call this method.
*/
@Deprecated
public static void seteuid(int euid) throws ErrnoException { Libcore.os.seteuid(euid); }
/**
* See setgid(2).
* @deprecated Android Applications do not have sufficient privileges to call this method.
*/
@Deprecated
public static void setgid(int gid) throws ErrnoException { Libcore.os.setgid(gid); }
/**
* Sets process's pgid (process group ID).
*
* See setpgid(2).
*
* @param pid process id to set the pgid of
* @param pgid new pgid for process {@code pid}
* @throws ErrnoException an attempt was made to change the process group ID of one
* of the children of the calling process and the child had
* already performed an {@link execve(String, String[], String[])}; or
* {@code pgid} is less than {@code 0}; or
* an attempt was made to move a process into a process group
* in a different session, or to change the process group ID
* of one of the children of the calling process and the
* child was in a different session, or to change the process
* group ID of a session leader; or
* {@code pid} is not the calling process and not a child
* of the calling process
*
* @hide
*/
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
public static void setpgid(int pid, int pgid) throws ErrnoException { Libcore.os.setpgid(pid, pgid); }
/**
* Set real and/or effective group ID of the calling process.
*
* See setregid(2).
*
* @param rgid real group ID
* @param egid effective group ID
* @throws ErrnoException one or more of the target group IDs is not valid
* in this user namespace; or the calling process is
* not privileged
*
* @hide
*/
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
public static void setregid(int rgid, int egid) throws ErrnoException { Libcore.os.setregid(rgid, egid); }
/**
* Set real and/or effective user ID of the calling process.
*
* See setreuid(2).
*
* @param ruid real user ID
* @param euid effective user ID
* @throws ErrnoException one or more of the target user IDs is not valid
* in this user namespace; or the calling process is
* not privileged
*
* @hide
*/
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
public static void setreuid(int ruid, int euid) throws ErrnoException { Libcore.os.setreuid(ruid, euid); }
/**
* See setsid(2).
*/
public static int setsid() throws ErrnoException { return Libcore.os.setsid(); }
/** @hide */
public static void setsockoptByte(FileDescriptor fd, int level, int option, int value) throws ErrnoException { Libcore.os.setsockoptByte(fd, level, option, value); }
/**
* Sets a supplied socket {@code option} to {@code value}.
*
* See getsockopt(2).
* For the list of available options see socket(7).
* Corresponding socket options constants reside in {@link OsCosntants}, e.g. {@link OsConstants#SO_REUSEADDR}.
*
* @param fd file descriptor of the socket to set options of
* @param level level at which the {@code option} resides. For example,
* to indicate that an option is to be interpreted by the TCP protocol,
* level should be set to the protocol number of TCP
* @param option name of the option to set
* @param value interface name
* @return socket options for file descriptor {@code fd}
* @throws ErrnoException if {@code fd} is invalid; or
* {@code option} is unknown at given {@code level}
*
* @hide
*/
@UnsupportedAppUsage
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
public static void setsockoptIfreq(@NonNull FileDescriptor fd, int level, int option, @Nullable String value) throws ErrnoException { Libcore.os.setsockoptIfreq(fd, level, option, value); }
/**
* See setsockopt(2).
*/
public static void setsockoptInt(FileDescriptor fd, int level, int option, int value) throws ErrnoException { Libcore.os.setsockoptInt(fd, level, option, value); }
/** @hide */
public static void setsockoptIpMreqn(FileDescriptor fd, int level, int option, int value) throws ErrnoException { Libcore.os.setsockoptIpMreqn(fd, level, option, value); }
/** @hide */
public static void setsockoptGroupReq(FileDescriptor fd, int level, int option, StructGroupReq value) throws ErrnoException { Libcore.os.setsockoptGroupReq(fd, level, option, value); }
/**
* Sets {@link OsConstants#SO_LINGER} option for the socket referred to by the file descriptor
* {@code fd}.
*
* @param fd file descriptor
* @param level level at which the {@code option} resides
* @param option name of the option to set
* @param value {@link StructLinger} to set for {@code fd}
* @throws ErrnoException if {@code fd} is invalid; or
* {@code option} is unknown at given {@code level}
*
* @hide
*/
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
public static void setsockoptLinger(@NonNull FileDescriptor fd, int level, int option, @NonNull StructLinger value) throws ErrnoException { Libcore.os.setsockoptLinger(fd, level, option, value); }
/**
* See setsockopt(2).
*
*
Only for use with {@code option} values that take a {@code struct timeval} such as
* {@link OsConstants#SO_RCVTIMEO} and {@link OsConstants#SO_SNDTIMEO}. Use with other
* options is likely to cause incorrect behavior.
*/
public static void setsockoptTimeval(@NonNull FileDescriptor fd, int level, int option, @NonNull StructTimeval value) throws ErrnoException { Libcore.os.setsockoptTimeval(fd, level, option, value); }
/**
* See setuid(2).
* @deprecated Android Applications do not have sufficient privileges to call this method.
*/
@Deprecated
public static void setuid(int uid) throws ErrnoException { Libcore.os.setuid(uid); }
/**
* See setxattr(2)
*/
public static void setxattr(String path, String name, byte[] value, int flags) throws ErrnoException { Libcore.os.setxattr(path, name, value, flags); };
/**
* See shutdown(2).
*/
public static void shutdown(FileDescriptor fd, int how) throws ErrnoException { Libcore.os.shutdown(fd, how); }
/**
* See socket(2).
*/
public static FileDescriptor socket(int domain, int type, int protocol) throws ErrnoException { return Libcore.os.socket(domain, type, protocol); }
/**
* See socketpair(2).
*/
public static void socketpair(int domain, int type, int protocol, FileDescriptor fd1, FileDescriptor fd2) throws ErrnoException { Libcore.os.socketpair(domain, type, protocol, fd1, fd2); }
/**
* Moves data between two file descriptors without copying
* between kernel address space and user address space. It
* transfers up to {@code len} bytes of data from the file descriptor {@code fdIn}
* to the file descriptor {@code fdOut}, where one of the file descriptors
* must refer to a pipe.
*
* The following semantics apply for {@code fdIn} and {@code offIn}:
*
* - If {@code fdIn} refers to a pipe, then {@code offIn} must be {@code null}.
* - If {@code fdIn} does not refer to a pipe and {@code offIn} is {@code null}, then
* bytes are read from {@code fdIn} starting from the file offset, and
* the file offset is adjusted appropriately.
* - If {@code fdIn} does not refer to a pipe and {@code offIn} is not {@code null}, then
* {@code offIn} must point to a buffer which specifies the starting
* offset from which bytes will be read from {@code fdIn}; in this case,
* the file offset of {@code fdIn} is not changed.
*
*
* Analogous statements apply for {@code fdOut} and {@code offOut}.
*
* The flags argument is a bit mask that is composed by ORing
* together zero or more of the following values:
*
* - {@link OsConstants#SPLICE_F_MOVE}
* Attempt to move pages instead of copying. This is only a
* hint to the kernel: pages may still be copied if the
* kernel cannot move the pages from the pipe, or if the pipe
* buffers don't refer to full pages.
* - {@link OsConstants#SPLICE_F_NONBLOCK}
* Do not block on I/O. This makes the splice pipe
* operations nonblocking, but
* {@link splice(FileDescriptor, Int64Ref, FileDescriptor, Int64Ref, long, int)}
* may nevertheless block because the file descriptors that are spliced
* to/from may block (unless they have the {@link OsConstants#O_NONBLOCK} flag set).
* - {@link OsConstants#SPLICE_F_MORE}
* More data will be coming in a subsequent splice.
* - {@link OsConstants#SPLICE_F_GIFT} Unused
*
*
* See splice(2).
*
* @param fdIn file descriptor to read from
* @param offIn {@code null} for pipe; file offset; or pointer to a buffer that specifies starting offset
* @param fdOut file descriptor to write to
* @param offOut {@code null} for pipe; file offset; or pointer to a buffer that specifies starting offset
* @param len number of bytes to read/write
* @param flags bitmask of options
* @return number of bytes spliced on success. A return value of {@code 0} means end of input.
* @throws ErrnoException if target fs does not support splicing; or
* target file opened in append mode; or
* one or both file descriptors are invalid; or
* neither of file descriptors refer to a pipe; or
* {@code fdIn} and {@code fdOut} refer to a same pipe
*
* @hide
*/
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
public static long splice(@NonNull FileDescriptor fdIn, @Nullable Int64Ref offIn, @NonNull FileDescriptor fdOut, @Nullable Int64Ref offOut, long len, int flags) throws ErrnoException { return Libcore.os.splice(fdIn, offIn, fdOut, offOut, len, flags); }
/**
* See stat(2).
*/
public static StructStat stat(String path) throws ErrnoException { return Libcore.os.stat(path); }
/**
* See statvfs(2).
*/
public static StructStatVfs statvfs(String path) throws ErrnoException { return Libcore.os.statvfs(path); }
/**
* See strerror(2).
*/
public static String strerror(int errno) { return Libcore.os.strerror(errno); }
/**
* See strsignal(3).
*/
public static String strsignal(int signal) { return Libcore.os.strsignal(signal); }
/**
* See symlink(2).
*/
public static void symlink(String oldPath, String newPath) throws ErrnoException { Libcore.os.symlink(oldPath, newPath); }
/**
* See sysconf(3).
*/
public static long sysconf(int name) { return Libcore.os.sysconf(name); }
/**
* See tcdrain(3).
*/
public static void tcdrain(FileDescriptor fd) throws ErrnoException { Libcore.os.tcdrain(fd); }
/**
* See tcsendbreak(3).
*/
public static void tcsendbreak(FileDescriptor fd, int duration) throws ErrnoException { Libcore.os.tcsendbreak(fd, duration); }
/**
* See umask(2).
*/
public static int umask(int mask) { return Libcore.os.umask(mask); }
/**
* See uname(2).
*/
public static StructUtsname uname() { return Libcore.os.uname(); }
/**
* Deletes a name from the filesystem. If that name was the last link to a file
* and no processes have the file open, the file is deleted and the space it was
* using is made available for reuse.
*
* See unlink(2).
*
* @param pathname name in the filesystem to delete
* @throws ErrnoException write access to {@code pathname} is not allowed; or
* I/O error occurred; or
* {@code pathname} refers to directory; or
* too many symbolic links were encountered in translating {@code pathname}; or
* {@code pathname} is used by the system or another process
*
* @hide
*/
@SystemApi(client = MODULE_LIBRARIES)
@libcore.api.CorePlatformApi(status = libcore.api.CorePlatformApi.Status.STABLE)
public static void unlink(@Nullable String pathname) throws ErrnoException { Libcore.os.unlink(pathname); }
/**
* See unsetenv(3).
*/
public static void unsetenv(String name) throws ErrnoException { Libcore.os.unsetenv(name); }
/**
* @hide See waitpid(2).
*
* @throws IllegalArgumentException if {@code status != null && status.length != 1}
*/
public static int waitpid(int pid, Int32Ref status, int options) throws ErrnoException {
return Libcore.os.waitpid(pid, status, options);
}
/**
* See write(2).
*/
public static int write(FileDescriptor fd, ByteBuffer buffer) throws ErrnoException, InterruptedIOException { return Libcore.os.write(fd, buffer); }
/**
* See write(2).
*/
public static int write(FileDescriptor fd, byte[] bytes, int byteOffset, int byteCount) throws ErrnoException, InterruptedIOException { return Libcore.os.write(fd, bytes, byteOffset, byteCount); }
/**
* See writev(2).
*/
public static int writev(FileDescriptor fd, Object[] buffers, int[] offsets, int[] byteCounts) throws ErrnoException, InterruptedIOException { return Libcore.os.writev(fd, buffers, offsets, byteCounts); }
}