]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/i386/linux/linux.h
MFV r325013,r325034: 640 number_to_scaled_string is duplicated in several commands
[FreeBSD/FreeBSD.git] / sys / i386 / linux / linux.h
1 /*-
2  * Copyright (c) 1994-1996 Søren Schmidt
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer
10  *    in this position and unchanged.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. The name of the author may not be used to endorse or promote products
15  *    derived from this software without specific prior written permission
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30
31 #ifndef _I386_LINUX_H_
32 #define _I386_LINUX_H_
33
34 #include <sys/signal.h> /* for sigval union */
35
36 #include <compat/linux/linux.h>
37 #include <i386/linux/linux_syscall.h>
38
39 /*
40  * debugging support
41  */
42 extern u_char linux_debug_map[];
43 #define ldebug(name)    isclr(linux_debug_map, LINUX_SYS_linux_ ## name)
44 #define ARGS(nm, fmt)   "linux(%ld/%ld): "#nm"("fmt")\n",                       \
45                         (long)td->td_proc->p_pid, (long)td->td_tid
46 #define LMSG(fmt)       "linux(%ld/%ld): "fmt"\n",                              \
47                         (long)td->td_proc->p_pid, (long)td->td_tid
48 #define LINUX_DTRACE    linuxulator
49
50 #define LINUX_SHAREDPAGE        (VM_MAXUSER_ADDRESS - PAGE_SIZE)
51 #define LINUX_USRSTACK          LINUX_SHAREDPAGE
52
53 #define PTRIN(v)        (void *)(v)
54 #define PTROUT(v)       (l_uintptr_t)(v)
55
56 #define CP(src,dst,fld) do { (dst).fld = (src).fld; } while (0)
57 #define CP2(src,dst,sfld,dfld) do { (dst).dfld = (src).sfld; } while (0)
58 #define PTRIN_CP(src,dst,fld) \
59         do { (dst).fld = PTRIN((src).fld); } while (0)
60
61 /*
62  * Provide a separate set of types for the Linux types.
63  */
64 typedef int             l_int;
65 typedef int32_t         l_long;
66 typedef int64_t         l_longlong;
67 typedef short           l_short;
68 typedef unsigned int    l_uint;
69 typedef uint32_t        l_ulong;
70 typedef uint64_t        l_ulonglong;
71 typedef unsigned short  l_ushort;
72
73 typedef char            *l_caddr_t;
74 typedef l_ulong         l_uintptr_t;
75 typedef l_long          l_clock_t;
76 typedef l_int           l_daddr_t;
77 typedef l_ushort        l_dev_t;
78 typedef l_uint          l_gid_t;
79 typedef l_ushort        l_gid16_t;
80 typedef l_ulong         l_ino_t;
81 typedef l_int           l_key_t;
82 typedef l_longlong      l_loff_t;
83 typedef l_ushort        l_mode_t;
84 typedef l_long          l_off_t;
85 typedef l_int           l_pid_t;
86 typedef l_uint          l_size_t;
87 typedef l_long          l_suseconds_t;
88 typedef l_long          l_time_t;
89 typedef l_uint          l_uid_t;
90 typedef l_ushort        l_uid16_t;
91 typedef l_int           l_timer_t;
92 typedef l_int           l_mqd_t;
93 typedef l_ulong         l_fd_mask;
94
95 typedef struct {
96         l_int           val[2];
97 } l_fsid_t;
98
99 typedef struct {
100         l_time_t        tv_sec;
101         l_suseconds_t   tv_usec;
102 } l_timeval;
103
104 #define l_fd_set        fd_set
105
106 /*
107  * Miscellaneous
108  */
109 #define LINUX_AT_COUNT          20      /* Count of used aux entry types.
110                                          * Keep this synchronized with
111                                          * elf_linux_fixup() code.
112                                          */
113 struct l___sysctl_args
114 {
115         l_int           *name;
116         l_int           nlen;
117         void            *oldval;
118         l_size_t        *oldlenp;
119         void            *newval;
120         l_size_t        newlen;
121         l_ulong         __spare[4];
122 };
123
124 /* Resource limits */
125 #define LINUX_RLIMIT_CPU        0
126 #define LINUX_RLIMIT_FSIZE      1
127 #define LINUX_RLIMIT_DATA       2
128 #define LINUX_RLIMIT_STACK      3
129 #define LINUX_RLIMIT_CORE       4
130 #define LINUX_RLIMIT_RSS        5
131 #define LINUX_RLIMIT_NPROC      6
132 #define LINUX_RLIMIT_NOFILE     7
133 #define LINUX_RLIMIT_MEMLOCK    8
134 #define LINUX_RLIMIT_AS         9       /* Address space limit */
135
136 #define LINUX_RLIM_NLIMITS      10
137
138 struct l_rlimit {
139         l_ulong rlim_cur;
140         l_ulong rlim_max;
141 };
142
143 struct l_mmap_argv {
144         l_uintptr_t     addr;
145         l_size_t        len;
146         l_int           prot;
147         l_int           flags;
148         l_int           fd;
149         l_off_t         pgoff;
150 } __packed;
151
152 /*
153  * stat family of syscalls
154  */
155 struct l_timespec {
156         l_time_t        tv_sec;
157         l_long          tv_nsec;
158 };
159
160 struct l_newstat {
161         l_ushort        st_dev;
162         l_ushort        __pad1;
163         l_ulong         st_ino;
164         l_ushort        st_mode;
165         l_ushort        st_nlink;
166         l_ushort        st_uid;
167         l_ushort        st_gid;
168         l_ushort        st_rdev;
169         l_ushort        __pad2;
170         l_ulong         st_size;
171         l_ulong         st_blksize;
172         l_ulong         st_blocks;
173         struct l_timespec       st_atim;
174         struct l_timespec       st_mtim;
175         struct l_timespec       st_ctim;
176         l_ulong         __unused4;
177         l_ulong         __unused5;
178 };
179
180 struct l_stat {
181         l_ushort        st_dev;
182         l_ulong         st_ino;
183         l_ushort        st_mode;
184         l_ushort        st_nlink;
185         l_ushort        st_uid;
186         l_ushort        st_gid;
187         l_ushort        st_rdev;
188         l_long          st_size;
189         struct l_timespec       st_atim;
190         struct l_timespec       st_mtim;
191         struct l_timespec       st_ctim;
192         l_long          st_blksize;
193         l_long          st_blocks;
194         l_ulong         st_flags;
195         l_ulong         st_gen;
196 };
197
198 struct l_stat64 {
199         l_ushort        st_dev;
200         u_char          __pad0[10];
201         l_ulong         __st_ino;
202         l_uint          st_mode;
203         l_uint          st_nlink;
204         l_ulong         st_uid;
205         l_ulong         st_gid;
206         l_ushort        st_rdev;
207         u_char          __pad3[10];
208         l_longlong      st_size;
209         l_ulong         st_blksize;
210         l_ulong         st_blocks;
211         l_ulong         __pad4;
212         struct l_timespec       st_atim;
213         struct l_timespec       st_mtim;
214         struct l_timespec       st_ctim;
215         l_ulonglong     st_ino;
216 };
217
218 struct l_statfs64 { 
219         l_int           f_type; 
220         l_int           f_bsize; 
221         uint64_t        f_blocks; 
222         uint64_t        f_bfree; 
223         uint64_t        f_bavail; 
224         uint64_t        f_files; 
225         uint64_t        f_ffree; 
226         l_fsid_t        f_fsid;
227         l_int           f_namelen;
228         l_int           f_frsize;
229         l_int           f_flags;
230         l_int           f_spare[4];
231 };
232
233 #define LINUX_NSIG_WORDS        2
234
235 /* sigaction flags */
236 #define LINUX_SA_NOCLDSTOP      0x00000001
237 #define LINUX_SA_NOCLDWAIT      0x00000002
238 #define LINUX_SA_SIGINFO        0x00000004
239 #define LINUX_SA_RESTORER       0x04000000
240 #define LINUX_SA_ONSTACK        0x08000000
241 #define LINUX_SA_RESTART        0x10000000
242 #define LINUX_SA_INTERRUPT      0x20000000
243 #define LINUX_SA_NOMASK         0x40000000
244 #define LINUX_SA_ONESHOT        0x80000000
245
246 /* sigprocmask actions */
247 #define LINUX_SIG_BLOCK         0
248 #define LINUX_SIG_UNBLOCK       1
249 #define LINUX_SIG_SETMASK       2
250
251 /* sigaltstack */
252 #define LINUX_MINSIGSTKSZ       2048
253
254 typedef void    (*l_handler_t)(l_int);
255 typedef l_ulong l_osigset_t;
256
257 typedef struct {
258         l_handler_t     lsa_handler;
259         l_osigset_t     lsa_mask;
260         l_ulong         lsa_flags;
261         void    (*lsa_restorer)(void);
262 } l_osigaction_t;
263
264 typedef struct {
265         l_handler_t     lsa_handler;
266         l_ulong         lsa_flags;
267         void    (*lsa_restorer)(void);
268         l_sigset_t      lsa_mask;
269 } l_sigaction_t;
270
271 typedef struct {
272         void            *ss_sp;
273         l_int           ss_flags;
274         l_size_t        ss_size;
275 } l_stack_t;
276
277 /* The Linux sigcontext, pretty much a standard 386 trapframe. */
278 struct l_sigcontext {
279         l_int           sc_gs;
280         l_int           sc_fs;
281         l_int           sc_es;
282         l_int           sc_ds;
283         l_int           sc_edi;
284         l_int           sc_esi;
285         l_int           sc_ebp;
286         l_int           sc_esp;
287         l_int           sc_ebx;
288         l_int           sc_edx;
289         l_int           sc_ecx;
290         l_int           sc_eax;
291         l_int           sc_trapno;
292         l_int           sc_err;
293         l_int           sc_eip;
294         l_int           sc_cs;
295         l_int           sc_eflags;
296         l_int           sc_esp_at_signal;
297         l_int           sc_ss;
298         l_int           sc_387;
299         l_int           sc_mask;
300         l_int           sc_cr2;
301 };
302
303 struct l_ucontext {
304         l_ulong         uc_flags;
305         void            *uc_link;
306         l_stack_t       uc_stack;
307         struct l_sigcontext     uc_mcontext;
308         l_sigset_t      uc_sigmask;
309 };
310
311 #define LINUX_SI_MAX_SIZE       128
312 #define LINUX_SI_PAD_SIZE       ((LINUX_SI_MAX_SIZE/sizeof(l_int)) - 3)
313
314 typedef union l_sigval {
315         l_int           sival_int;
316         l_uintptr_t     sival_ptr;
317 } l_sigval_t;
318
319 typedef struct l_siginfo {
320         l_int           lsi_signo;
321         l_int           lsi_errno;
322         l_int           lsi_code;
323         union {
324                 l_int   _pad[LINUX_SI_PAD_SIZE];
325
326                 struct {
327                         l_pid_t         _pid;
328                         l_uid_t         _uid;
329                 } _kill;
330
331                 struct {
332                         l_timer_t       _tid;
333                         l_int           _overrun;
334                         char            _pad[sizeof(l_uid_t) - sizeof(l_int)];
335                         l_sigval_t      _sigval;
336                         l_int           _sys_private;
337                 } _timer;
338
339                 struct {
340                         l_pid_t         _pid;           /* sender's pid */
341                         l_uid_t         _uid;           /* sender's uid */
342                         l_sigval_t      _sigval;
343                 } _rt;
344
345                 struct {
346                         l_pid_t         _pid;           /* which child */
347                         l_uid_t         _uid;           /* sender's uid */
348                         l_int           _status;        /* exit code */
349                         l_clock_t       _utime;
350                         l_clock_t       _stime;
351                 } _sigchld;
352
353                 struct {
354                         l_uintptr_t     _addr;  /* Faulting insn/memory ref. */
355                 } _sigfault;
356
357                 struct {
358                         l_long          _band;  /* POLL_IN,POLL_OUT,POLL_MSG */
359                         l_int           _fd;
360                 } _sigpoll;
361         } _sifields;
362 } l_siginfo_t;
363
364 #define lsi_pid         _sifields._kill._pid
365 #define lsi_uid         _sifields._kill._uid
366 #define lsi_tid         _sifields._timer._tid
367 #define lsi_overrun     _sifields._timer._overrun
368 #define lsi_sys_private _sifields._timer._sys_private
369 #define lsi_status      _sifields._sigchld._status
370 #define lsi_utime       _sifields._sigchld._utime
371 #define lsi_stime       _sifields._sigchld._stime
372 #define lsi_value       _sifields._rt._sigval
373 #define lsi_int         _sifields._rt._sigval.sival_int
374 #define lsi_ptr         _sifields._rt._sigval.sival_ptr
375 #define lsi_addr        _sifields._sigfault._addr
376 #define lsi_band        _sifields._sigpoll._band
377 #define lsi_fd          _sifields._sigpoll._fd
378
379 struct l_fpreg {
380         u_int16_t       significand[4];
381         u_int16_t       exponent;
382 };
383
384 struct l_fpxreg {
385         u_int16_t       significand[4];
386         u_int16_t       exponent;
387         u_int16_t       padding[3];
388 };
389
390 struct l_xmmreg {
391         u_int32_t       element[4];
392 };
393
394 struct l_fpstate {
395         /* Regular FPU environment */
396         u_int32_t               cw;
397         u_int32_t               sw;
398         u_int32_t               tag;
399         u_int32_t               ipoff;
400         u_int32_t               cssel;
401         u_int32_t               dataoff;
402         u_int32_t               datasel;
403         struct l_fpreg          _st[8];
404         u_int16_t               status;
405         u_int16_t               magic;          /* 0xffff = regular FPU data */
406
407         /* FXSR FPU environment */
408         u_int32_t               _fxsr_env[6];   /* env is ignored. */
409         u_int32_t               mxcsr;
410         u_int32_t               reserved;
411         struct l_fpxreg         _fxsr_st[8];    /* reg data is ignored. */
412         struct l_xmmreg         _xmm[8];
413         u_int32_t               padding[56];
414 };
415
416 /*
417  * We make the stack look like Linux expects it when calling a signal
418  * handler, but use the BSD way of calling the handler and sigreturn().
419  * This means that we need to pass the pointer to the handler too.
420  * It is appended to the frame to not interfere with the rest of it.
421  */
422 struct l_sigframe {
423         l_int                   sf_sig;
424         struct l_sigcontext     sf_sc;
425         struct l_fpstate        sf_fpstate;
426         l_uint                  sf_extramask[LINUX_NSIG_WORDS-1];
427         l_handler_t             sf_handler;
428 };
429
430 struct l_rt_sigframe {
431         l_int                   sf_sig;
432         l_siginfo_t             *sf_siginfo;
433         struct l_ucontext       *sf_ucontext;
434         l_siginfo_t             sf_si;
435         struct l_ucontext       sf_sc;
436         l_handler_t             sf_handler;
437 };
438
439 extern struct sysentvec linux_sysvec;
440
441 /*
442  * arch specific open/fcntl flags
443  */
444 #define LINUX_F_GETLK64         12
445 #define LINUX_F_SETLK64         13
446 #define LINUX_F_SETLKW64        14
447
448 union l_semun {
449         l_int           val;
450         struct l_semid_ds       *buf;
451         l_ushort        *array;
452         struct l_seminfo        *__buf;
453         void            *__pad;
454 };
455
456 struct l_sockaddr {
457         l_ushort        sa_family;
458         char            sa_data[14];
459 };
460
461 struct l_ifmap {
462         l_ulong         mem_start;
463         l_ulong         mem_end;
464         l_ushort        base_addr;
465         u_char          irq;
466         u_char          dma;
467         u_char          port;
468 };
469
470 #define LINUX_IFHWADDRLEN       6
471 #define LINUX_IFNAMSIZ          16
472
473 struct l_ifreq {
474         union {
475                 char    ifrn_name[LINUX_IFNAMSIZ];
476         } ifr_ifrn;
477
478         union {
479                 struct l_sockaddr       ifru_addr;
480                 struct l_sockaddr       ifru_dstaddr;
481                 struct l_sockaddr       ifru_broadaddr;
482                 struct l_sockaddr       ifru_netmask;
483                 struct l_sockaddr       ifru_hwaddr;
484                 l_short         ifru_flags[1];
485                 l_int           ifru_ivalue;
486                 l_int           ifru_mtu;
487                 struct l_ifmap  ifru_map;
488                 char            ifru_slave[LINUX_IFNAMSIZ];
489                 l_caddr_t       ifru_data;
490         } ifr_ifru;
491 };
492
493 #define ifr_name        ifr_ifrn.ifrn_name      /* Interface name */
494 #define ifr_hwaddr      ifr_ifru.ifru_hwaddr    /* MAC address */
495 #define ifr_ifindex     ifr_ifru.ifru_ivalue    /* Interface index */
496
497 /*
498  * poll()
499  */
500 #define LINUX_POLLIN            0x0001
501 #define LINUX_POLLPRI           0x0002
502 #define LINUX_POLLOUT           0x0004
503 #define LINUX_POLLERR           0x0008
504 #define LINUX_POLLHUP           0x0010
505 #define LINUX_POLLNVAL          0x0020
506 #define LINUX_POLLRDNORM        0x0040
507 #define LINUX_POLLRDBAND        0x0080
508 #define LINUX_POLLWRNORM        0x0100
509 #define LINUX_POLLWRBAND        0x0200
510 #define LINUX_POLLMSG           0x0400
511
512 struct l_pollfd {
513         l_int           fd;
514         l_short         events;
515         l_short         revents;
516 };
517
518 struct l_user_desc {
519         l_uint          entry_number;
520         l_uint          base_addr;
521         l_uint          limit;
522         l_uint          seg_32bit:1;
523         l_uint          contents:2;
524         l_uint          read_exec_only:1;
525         l_uint          limit_in_pages:1;
526         l_uint          seg_not_present:1;
527         l_uint          useable:1;
528 };
529
530 struct l_desc_struct {
531         unsigned long   a, b;
532 };
533
534
535 #define LINUX_LOWERWORD 0x0000ffff
536
537 /*
538  * Macros which does the same thing as those in Linux include/asm-um/ldt-i386.h.
539  * These convert Linux user space descriptor to machine one.
540  */
541 #define LINUX_LDT_entry_a(info)                                 \
542         ((((info)->base_addr & LINUX_LOWERWORD) << 16) |        \
543         ((info)->limit & LINUX_LOWERWORD))
544
545 #define LINUX_ENTRY_B_READ_EXEC_ONLY    9
546 #define LINUX_ENTRY_B_CONTENTS          10
547 #define LINUX_ENTRY_B_SEG_NOT_PRESENT   15
548 #define LINUX_ENTRY_B_BASE_ADDR         16
549 #define LINUX_ENTRY_B_USEABLE           20
550 #define LINUX_ENTRY_B_SEG32BIT          22
551 #define LINUX_ENTRY_B_LIMIT             23
552
553 #define LINUX_LDT_entry_b(info)                                                 \
554         (((info)->base_addr & 0xff000000) |                                     \
555         ((info)->limit & 0xf0000) |                                             \
556         ((info)->contents << LINUX_ENTRY_B_CONTENTS) |                          \
557         (((info)->seg_not_present == 0) << LINUX_ENTRY_B_SEG_NOT_PRESENT) |     \
558         (((info)->base_addr & 0x00ff0000) >> LINUX_ENTRY_B_BASE_ADDR) |         \
559         (((info)->read_exec_only == 0) << LINUX_ENTRY_B_READ_EXEC_ONLY) |       \
560         ((info)->seg_32bit << LINUX_ENTRY_B_SEG32BIT) |                         \
561         ((info)->useable << LINUX_ENTRY_B_USEABLE) |                            \
562         ((info)->limit_in_pages << LINUX_ENTRY_B_LIMIT) | 0x7000)
563
564 #define LINUX_LDT_empty(info)           \
565         ((info)->base_addr == 0 &&      \
566         (info)->limit == 0 &&           \
567         (info)->contents == 0 &&        \
568         (info)->seg_not_present == 1 && \
569         (info)->read_exec_only == 1 &&  \
570         (info)->seg_32bit == 0 &&       \
571         (info)->limit_in_pages == 0 &&  \
572         (info)->useable == 0)
573
574 /*
575  * Macros for converting segments.
576  * They do the same as those in arch/i386/kernel/process.c in Linux.
577  */
578 #define LINUX_GET_BASE(desc)                            \
579         ((((desc)->a >> 16) & LINUX_LOWERWORD) |        \
580         (((desc)->b << 16) & 0x00ff0000) |              \
581         ((desc)->b & 0xff000000))
582
583 #define LINUX_GET_LIMIT(desc)                   \
584         (((desc)->a & LINUX_LOWERWORD) |        \
585         ((desc)->b & 0xf0000))
586
587 #define LINUX_GET_32BIT(desc)           \
588         (((desc)->b >> LINUX_ENTRY_B_SEG32BIT) & 1)
589 #define LINUX_GET_CONTENTS(desc)        \
590         (((desc)->b >> LINUX_ENTRY_B_CONTENTS) & 3)
591 #define LINUX_GET_WRITABLE(desc)        \
592         (((desc)->b >> LINUX_ENTRY_B_READ_EXEC_ONLY) & 1)
593 #define LINUX_GET_LIMIT_PAGES(desc)     \
594         (((desc)->b >> LINUX_ENTRY_B_LIMIT) & 1)
595 #define LINUX_GET_PRESENT(desc)         \
596         (((desc)->b >> LINUX_ENTRY_B_SEG_NOT_PRESENT) & 1)
597 #define LINUX_GET_USEABLE(desc)         \
598         (((desc)->b >> LINUX_ENTRY_B_USEABLE) & 1)
599
600 #define linux_copyout_rusage(r, u)      copyout(r, u, sizeof(*r))
601
602 /* robust futexes */
603 struct linux_robust_list {
604         struct linux_robust_list        *next;
605 };
606
607 struct linux_robust_list_head {
608         struct linux_robust_list        list;
609         l_long                          futex_offset;
610         struct linux_robust_list        *pending_list;
611 };
612
613 #endif /* !_I386_LINUX_H_ */