Os.java revision 895a613aa2aec6aa6d03b29755cf2fea584909ad
1ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes/*
2ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes * Copyright (C) 2011 The Android Open Source Project
3ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes *
4ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes * Licensed under the Apache License, Version 2.0 (the "License");
5ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes * you may not use this file except in compliance with the License.
6ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes * You may obtain a copy of the License at
7ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes *
8ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes *      http://www.apache.org/licenses/LICENSE-2.0
9ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes *
10ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes * Unless required by applicable law or agreed to in writing, software
11ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes * distributed under the License is distributed on an "AS IS" BASIS,
12ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes * See the License for the specific language governing permissions and
14ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes * limitations under the License.
15ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes */
16ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes
17ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughespackage libcore.io;
18ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes
1952724d3ebd4ccaaa4b9f5576e329d4272cde8ea9Elliott Hughesimport java.io.FileDescriptor;
200a9d1ee45a9884a9616624d747172e18734e8fe0Elliott Hughesimport java.net.InetAddress;
2123ec09188303a874b3b391f96ae0a29af002bff9Elliott Hughesimport java.net.InetSocketAddress;
220a9d1ee45a9884a9616624d747172e18734e8fe0Elliott Hughesimport java.net.SocketAddress;
2326010ab930a2cee3bf10b9612cf070183c21228bElliott Hughesimport java.net.SocketException;
2426c7025a7a919044771fb89031161bd26fe03032Elliott Hughesimport java.nio.ByteBuffer;
258b15dcc5890963edad4dfcf558cc16027c7985e5Elliott Hughesimport libcore.util.MutableInt;
268b15dcc5890963edad4dfcf558cc16027c7985e5Elliott Hughesimport libcore.util.MutableLong;
2752724d3ebd4ccaaa4b9f5576e329d4272cde8ea9Elliott Hughes
28ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughespublic interface Os {
2926010ab930a2cee3bf10b9612cf070183c21228bElliott Hughes    public FileDescriptor accept(FileDescriptor fd, InetSocketAddress peerAddress) throws ErrnoException, SocketException;
30ddfdbb9d172fe9b72e08e8d7deab0aa3b8acf044Elliott Hughes    public boolean access(String path, int mode) throws ErrnoException;
3126010ab930a2cee3bf10b9612cf070183c21228bElliott Hughes    public void bind(FileDescriptor fd, InetAddress address, int port) throws ErrnoException, SocketException;
32b7190190e0ef8de883c952efb319ce7748831faaElliott Hughes    public void chmod(String path, int mode) throws ErrnoException;
3344f7875f2985d7944c5afecc8394ad9f2219c806Elliott Hughes    public void chown(String path, int uid, int gid) throws ErrnoException;
34462bdac45c10f43d88d8f07f6994e272a27c14a2Elliott Hughes    public void close(FileDescriptor fd) throws ErrnoException;
3526010ab930a2cee3bf10b9612cf070183c21228bElliott Hughes    public void connect(FileDescriptor fd, InetAddress address, int port) throws ErrnoException, SocketException;
36396a9c666da353b910b515d12eb1c43adfddb0c8Elliott Hughes    public FileDescriptor dup(FileDescriptor oldFd) throws ErrnoException;
37396a9c666da353b910b515d12eb1c43adfddb0c8Elliott Hughes    public FileDescriptor dup2(FileDescriptor oldFd, int newFd) throws ErrnoException;
38ddfdbb9d172fe9b72e08e8d7deab0aa3b8acf044Elliott Hughes    public String[] environ();
3944f7875f2985d7944c5afecc8394ad9f2219c806Elliott Hughes    public void fchmod(FileDescriptor fd, int mode) throws ErrnoException;
4044f7875f2985d7944c5afecc8394ad9f2219c806Elliott Hughes    public void fchown(FileDescriptor fd, int uid, int gid) throws ErrnoException;
41fc549a0b0388987b26dea524894d75a63d14783bElliott Hughes    public int fcntlVoid(FileDescriptor fd, int cmd) throws ErrnoException;
42fc549a0b0388987b26dea524894d75a63d14783bElliott Hughes    public int fcntlLong(FileDescriptor fd, int cmd, long arg) throws ErrnoException;
43fc549a0b0388987b26dea524894d75a63d14783bElliott Hughes    public int fcntlFlock(FileDescriptor fd, int cmd, StructFlock arg) throws ErrnoException;
4452724d3ebd4ccaaa4b9f5576e329d4272cde8ea9Elliott Hughes    public void fdatasync(FileDescriptor fd) throws ErrnoException;
4547cb338d43f75dd998b29caaaa9446c5705217d1Elliott Hughes    public StructStat fstat(FileDescriptor fd) throws ErrnoException;
4659fa7163774d6930a174bc038414a4b780581957Elliott Hughes    public StructStatFs fstatfs(FileDescriptor fd) throws ErrnoException;
4752724d3ebd4ccaaa4b9f5576e329d4272cde8ea9Elliott Hughes    public void fsync(FileDescriptor fd) throws ErrnoException;
48f5333fd2094bdac4d6506177b1964b79afa64d77Elliott Hughes    public void ftruncate(FileDescriptor fd, long length) throws ErrnoException;
494f11ebea266eada830d507b8f011e811a8e5d7bcElliott Hughes    public String gai_strerror(int error);
501c039d71d3879f39e3a75b8788e656f7b4f88f08Elliott Hughes    public InetAddress[] getaddrinfo(String node, StructAddrinfo hints) throws GaiException;
51396a9c666da353b910b515d12eb1c43adfddb0c8Elliott Hughes    public int getegid();
52396a9c666da353b910b515d12eb1c43adfddb0c8Elliott Hughes    public int geteuid();
53396a9c666da353b910b515d12eb1c43adfddb0c8Elliott Hughes    public int getgid();
54ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes    public String getenv(String name);
554f11ebea266eada830d507b8f011e811a8e5d7bcElliott Hughes    /* TODO: break into getnameinfoHost and getnameinfoService? */
564f11ebea266eada830d507b8f011e811a8e5d7bcElliott Hughes    public String getnameinfo(InetAddress address, int flags) throws GaiException;
57396a9c666da353b910b515d12eb1c43adfddb0c8Elliott Hughes    public int getpid();
58396a9c666da353b910b515d12eb1c43adfddb0c8Elliott Hughes    public int getppid();
59d4419fce71d11ec8494525eca65e54d1aab51de6Elliott Hughes    public StructPasswd getpwnam(String name) throws ErrnoException;
60d4419fce71d11ec8494525eca65e54d1aab51de6Elliott Hughes    public StructPasswd getpwuid(int uid) throws ErrnoException;
610a9d1ee45a9884a9616624d747172e18734e8fe0Elliott Hughes    public SocketAddress getsockname(FileDescriptor fd) throws ErrnoException;
620a9d1ee45a9884a9616624d747172e18734e8fe0Elliott Hughes    public int getsockoptByte(FileDescriptor fd, int level, int option) throws ErrnoException;
630a9d1ee45a9884a9616624d747172e18734e8fe0Elliott Hughes    public InetAddress getsockoptInAddr(FileDescriptor fd, int level, int option) throws ErrnoException;
640a9d1ee45a9884a9616624d747172e18734e8fe0Elliott Hughes    public int getsockoptInt(FileDescriptor fd, int level, int option) throws ErrnoException;
650a9d1ee45a9884a9616624d747172e18734e8fe0Elliott Hughes    public StructLinger getsockoptLinger(FileDescriptor fd, int level, int option) throws ErrnoException;
660a9d1ee45a9884a9616624d747172e18734e8fe0Elliott Hughes    public StructTimeval getsockoptTimeval(FileDescriptor fd, int level, int option) throws ErrnoException;
67396a9c666da353b910b515d12eb1c43adfddb0c8Elliott Hughes    public int getuid();
68a37e971343883bb582a93ffbd9f0ba84f10e55baElliott Hughes    public String if_indextoname(int index);
69fc041ff241f9a7556e72236f130de0215ecd17dbElliott Hughes    public InetAddress inet_pton(int family, String address);
70a37e971343883bb582a93ffbd9f0ba84f10e55baElliott Hughes    public InetAddress ioctlInetAddress(FileDescriptor fd, int cmd, String interfaceName) throws ErrnoException;
718b15dcc5890963edad4dfcf558cc16027c7985e5Elliott Hughes    public int ioctlInt(FileDescriptor fd, int cmd, MutableInt arg) throws ErrnoException;
729a3f363523000704205df288f8b6f2f48c0d8563Elliott Hughes    public boolean isatty(FileDescriptor fd);
73a5fb706fe4a6dbeaaf4cb1f8bbc2c68b0a2a3f3cElliott Hughes    public void kill(int pid, int signal) throws ErrnoException;
7444f7875f2985d7944c5afecc8394ad9f2219c806Elliott Hughes    public void lchown(String path, int uid, int gid) throws ErrnoException;
75e1502d64e937001636fca3d62b2552ef2a34d05fElliott Hughes    public void listen(FileDescriptor fd, int backlog) throws ErrnoException;
76dedaccdfa07c370a58cba08b096133ad9eec0ec3Elliott Hughes    public long lseek(FileDescriptor fd, long offset, int whence) throws ErrnoException;
77e3b6fa2bf357f2712ab2ee9e8487f157595ea0c7Elliott Hughes    public StructStat lstat(String path) throws ErrnoException;
780f746ff511162add42eeabaf14ba70ace874c6f4Elliott Hughes    public void mincore(long address, long byteCount, byte[] vector) throws ErrnoException;
79c7fa20701d5e9398c38f4615ed293acfce1c0cf6Elliott Hughes    public void mkdir(String path, int mode) throws ErrnoException;
807e13c0f05ac9e7c55682d10e953dd4cbd5e6107cElliott Hughes    public void mlock(long address, long byteCount) throws ErrnoException;
817e25eff38a191d9c19e45093f4fde5102fb09d78Elliott Hughes    public long mmap(long address, long byteCount, int prot, int flags, FileDescriptor fd, long offset) throws ErrnoException;
827e25eff38a191d9c19e45093f4fde5102fb09d78Elliott Hughes    public void msync(long address, long byteCount, int flags) throws ErrnoException;
837e13c0f05ac9e7c55682d10e953dd4cbd5e6107cElliott Hughes    public void munlock(long address, long byteCount) throws ErrnoException;
847e25eff38a191d9c19e45093f4fde5102fb09d78Elliott Hughes    public void munmap(long address, long byteCount) throws ErrnoException;
850ac77ac8e915bff1a863e371f9b363033f9cf759Elliott Hughes    public FileDescriptor open(String path, int flags, int mode) throws ErrnoException;
8641f0605d2c809bd9bc1c0fb68d86b49a0f59b6c5Elliott Hughes    public FileDescriptor[] pipe() throws ErrnoException;
8770c820401677ca251ad09ac64cc23c760764e75dElliott Hughes    /* TODO: if we used the non-standard ppoll(2) behind the scenes, we could take a long timeout. */
8870c820401677ca251ad09ac64cc23c760764e75dElliott Hughes    public int poll(StructPollfd[] fds, int timeoutMs) throws ErrnoException;
89e3b6fa2bf357f2712ab2ee9e8487f157595ea0c7Elliott Hughes    public int pread(FileDescriptor fd, ByteBuffer buffer, long offset) throws ErrnoException;
90e3b6fa2bf357f2712ab2ee9e8487f157595ea0c7Elliott Hughes    public int pread(FileDescriptor fd, byte[] bytes, int byteOffset, int byteCount, long offset) throws ErrnoException;
91e3b6fa2bf357f2712ab2ee9e8487f157595ea0c7Elliott Hughes    public int pwrite(FileDescriptor fd, ByteBuffer buffer, long offset) throws ErrnoException;
92e3b6fa2bf357f2712ab2ee9e8487f157595ea0c7Elliott Hughes    public int pwrite(FileDescriptor fd, byte[] bytes, int byteOffset, int byteCount, long offset) throws ErrnoException;
9326c7025a7a919044771fb89031161bd26fe03032Elliott Hughes    public int read(FileDescriptor fd, ByteBuffer buffer) throws ErrnoException;
9426c7025a7a919044771fb89031161bd26fe03032Elliott Hughes    public int read(FileDescriptor fd, byte[] bytes, int byteOffset, int byteCount) throws ErrnoException;
95bbac92e691de7d570928ddfba639067978e55b06Elliott Hughes    public int readv(FileDescriptor fd, Object[] buffers, int[] offsets, int[] byteCounts) throws ErrnoException;
9626010ab930a2cee3bf10b9612cf070183c21228bElliott Hughes    public int recvfrom(FileDescriptor fd, ByteBuffer buffer, int flags, InetSocketAddress srcAddress) throws ErrnoException, SocketException;
9726010ab930a2cee3bf10b9612cf070183c21228bElliott Hughes    public int recvfrom(FileDescriptor fd, byte[] bytes, int byteOffset, int byteCount, int flags, InetSocketAddress srcAddress) throws ErrnoException, SocketException;
98c7fa20701d5e9398c38f4615ed293acfce1c0cf6Elliott Hughes    public void remove(String path) throws ErrnoException;
99a20cc6fca30d18e05db67ceeb0403b7b58ffd364Elliott Hughes    public void rename(String oldPath, String newPath) throws ErrnoException;
10026010ab930a2cee3bf10b9612cf070183c21228bElliott Hughes    public int sendto(FileDescriptor fd, ByteBuffer buffer, int flags, InetAddress inetAddress, int port) throws ErrnoException, SocketException;
10126010ab930a2cee3bf10b9612cf070183c21228bElliott Hughes    public int sendto(FileDescriptor fd, byte[] bytes, int byteOffset, int byteCount, int flags, InetAddress inetAddress, int port) throws ErrnoException, SocketException;
1028b15dcc5890963edad4dfcf558cc16027c7985e5Elliott Hughes    public long sendfile(FileDescriptor outFd, FileDescriptor inFd, MutableLong inOffset, long byteCount) throws ErrnoException;
103396a9c666da353b910b515d12eb1c43adfddb0c8Elliott Hughes    public void setegid(int egid) throws ErrnoException;
104895a613aa2aec6aa6d03b29755cf2fea584909adElliott Hughes    public void setenv(String name, String value, boolean overwrite) throws ErrnoException;
105396a9c666da353b910b515d12eb1c43adfddb0c8Elliott Hughes    public void seteuid(int euid) throws ErrnoException;
106396a9c666da353b910b515d12eb1c43adfddb0c8Elliott Hughes    public void setgid(int gid) throws ErrnoException;
1076c9b5377550a9649ed1532d1fcdfeba116c74eadElliott Hughes    public int setsid() throws ErrnoException;
108c63f0d4e80a9fd3bdf99cd438d108b750226736aElliott Hughes    public void setsockoptByte(FileDescriptor fd, int level, int option, int value) throws ErrnoException;
109b974666d79ebc392b37ec1ae83aae57ae6331c08Elliott Hughes    public void setsockoptIfreq(FileDescriptor fd, int level, int option, String value) throws ErrnoException;
110454a95f6a28855aa3c88d168b15a45bf315efc99Elliott Hughes    public void setsockoptInt(FileDescriptor fd, int level, int option, int value) throws ErrnoException;
111b974666d79ebc392b37ec1ae83aae57ae6331c08Elliott Hughes    public void setsockoptIpMreqn(FileDescriptor fd, int level, int option, int value) throws ErrnoException;
112438cb9e440d250c8aa5daf4fae0c400dce8b1499Elliott Hughes    public void setsockoptGroupReq(FileDescriptor fd, int level, int option, StructGroupReq value) throws ErrnoException;
113c63f0d4e80a9fd3bdf99cd438d108b750226736aElliott Hughes    public void setsockoptLinger(FileDescriptor fd, int level, int option, StructLinger value) throws ErrnoException;
114c63f0d4e80a9fd3bdf99cd438d108b750226736aElliott Hughes    public void setsockoptTimeval(FileDescriptor fd, int level, int option, StructTimeval value) throws ErrnoException;
115396a9c666da353b910b515d12eb1c43adfddb0c8Elliott Hughes    public void setuid(int uid) throws ErrnoException;
11659e4744d27231f260271dbbca406e0cc39768116Elliott Hughes    public void shutdown(FileDescriptor fd, int how) throws ErrnoException;
117454a95f6a28855aa3c88d168b15a45bf315efc99Elliott Hughes    public FileDescriptor socket(int domain, int type, int protocol) throws ErrnoException;
1183218082325b6b8713a8ac15731482e3da86a7df9Elliott Hughes    public void socketpair(int domain, int type, int protocol, FileDescriptor fd1, FileDescriptor fd2) throws ErrnoException;
11947cb338d43f75dd998b29caaaa9446c5705217d1Elliott Hughes    public StructStat stat(String path) throws ErrnoException;
120461d0d860814c68154d8dd06d24f94118f33d28aElliott Hughes    /* TODO: replace statfs with statvfs. */
12159fa7163774d6930a174bc038414a4b780581957Elliott Hughes    public StructStatFs statfs(String path) throws ErrnoException;
122ddfdbb9d172fe9b72e08e8d7deab0aa3b8acf044Elliott Hughes    public String strerror(int errno);
123a20cc6fca30d18e05db67ceeb0403b7b58ffd364Elliott Hughes    public void symlink(String oldPath, String newPath) throws ErrnoException;
1246fc1a0e1e68dc2e0d12341548e58fa7f1c5dafc4Elliott Hughes    public long sysconf(int name);
125bb5816aa1626eb2f6263bd21479600b114c8a1bdJohan Redestig    public void tcdrain(FileDescriptor fd) throws ErrnoException;
12644f7875f2985d7944c5afecc8394ad9f2219c806Elliott Hughes    public int umask(int mask);
1279b510df35b57946d843ffc34cf23fdcfc84c5220Elliott Hughes    public StructUtsname uname();
128895a613aa2aec6aa6d03b29755cf2fea584909adElliott Hughes    public void unsetenv(String name) throws ErrnoException;
1299e67ca71d3d4a489a157abadc5ba519ced7a0b50Elliott Hughes    public int waitpid(int pid, MutableInt status, int options) throws ErrnoException;
13078c7cc547101002b9f9043cf3845970719d1bda8Elliott Hughes    public int write(FileDescriptor fd, ByteBuffer buffer) throws ErrnoException;
13178c7cc547101002b9f9043cf3845970719d1bda8Elliott Hughes    public int write(FileDescriptor fd, byte[] bytes, int byteOffset, int byteCount) throws ErrnoException;
132bbac92e691de7d570928ddfba639067978e55b06Elliott Hughes    public int writev(FileDescriptor fd, Object[] buffers, int[] offsets, int[] byteCounts) throws ErrnoException;
133ec617e2cb4a374f0fd8fbda4a633214cf23a59a9Elliott Hughes}
134