Correct BSD License clause numbering from 1-2-4 to 1-2-3.
[dragonfly.git] / sys / vfs / procfs / procfs_map.c
1 /*
2  * Copyright (c) 1993 Jan-Simon Pendry
3  * Copyright (c) 1993
4  *      The Regents of the University of California.  All rights reserved.
5  *
6  * This code is derived from software contributed to Berkeley by
7  * Jan-Simon Pendry.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *      @(#)procfs_status.c     8.3 (Berkeley) 2/17/94
34  *
35  * $FreeBSD: src/sys/miscfs/procfs/procfs_map.c,v 1.24.2.1 2001/08/04 13:12:24 rwatson Exp $
36  * $DragonFly: src/sys/vfs/procfs/procfs_map.c,v 1.7 2007/02/19 01:14:24 corecode Exp $
37  */
38
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/proc.h>
42 #include <sys/vnode.h>
43 #include <vfs/procfs/procfs.h>
44
45 #include <vm/vm.h>
46 #include <sys/lock.h>
47 #include <vm/pmap.h>
48 #include <vm/vm_map.h>
49 #include <vm/vm_page.h>
50 #include <vm/vm_object.h>
51
52 #include <machine/limits.h>
53
54 #define MEBUFFERSIZE 256
55
56 /*
57  * The map entries can *almost* be read with programs like cat.  However,
58  * large maps need special programs to read.  It is not easy to implement
59  * a program that can sense the required size of the buffer, and then
60  * subsequently do a read with the appropriate size.  This operation cannot
61  * be atomic.  The best that we can do is to allow the program to do a read
62  * with an arbitrarily large buffer, and return as much as we can.  We can
63  * return an error code if the buffer is too small (EFBIG), then the program
64  * can try a bigger buffer.
65  */
66 int
67 procfs_domap(struct proc *curp, struct lwp *lp, struct pfsnode *pfs,
68              struct uio *uio)
69 {
70         struct proc *p = lp->lwp_proc;
71         int len;
72         struct vnode *vp;
73         char *fullpath, *freepath;
74         int error;
75         vm_map_t map = &p->p_vmspace->vm_map;
76         pmap_t pmap = vmspace_pmap(p->p_vmspace);
77         vm_map_entry_t entry;
78         char mebuffer[MEBUFFERSIZE];
79
80         if (uio->uio_rw != UIO_READ)
81                 return (EOPNOTSUPP);
82
83         if (uio->uio_offset != 0)
84                 return (0);
85         
86         error = 0;
87         vm_map_lock_read(map);
88         for (entry = map->header.next;
89                 ((uio->uio_resid > 0) && (entry != &map->header));
90                 entry = entry->next) {
91                 vm_object_t obj, tobj, lobj;
92                 int ref_count, shadow_count, flags;
93                 vm_offset_t addr;
94                 vm_offset_t ostart;
95                 int resident, privateresident;
96                 char *type;
97
98                 if (entry->maptype != VM_MAPTYPE_NORMAL &&
99                     entry->maptype != VM_MAPTYPE_VPAGETABLE) {
100                         continue;
101                 }
102
103                 obj = entry->object.vm_object;
104                 if (obj)
105                         vm_object_hold(obj);
106
107                 if (obj && (obj->shadow_count == 1))
108                         privateresident = obj->resident_page_count;
109                 else
110                         privateresident = 0;
111
112                 /*
113                  * Use map->hint as a poor man's ripout detector.
114                  */
115                 map->hint = entry;
116                 ostart = entry->start;
117
118                 /*
119                  * Count resident pages (XXX can be horrible on 64-bit)
120                  */
121                 resident = 0;
122                 addr = entry->start;
123                 while (addr < entry->end) {
124                         if (pmap_extract(pmap, addr))
125                                 resident++;
126                         addr += PAGE_SIZE;
127                 }
128                 if (obj) {
129                         lobj = obj;
130                         while ((tobj = lobj->backing_object) != NULL) {
131                                 KKASSERT(tobj != obj);
132                                 vm_object_hold(tobj);
133                                 if (tobj == lobj->backing_object) {
134                                         if (lobj != obj) {
135                                                 vm_object_lock_swap();
136                                                 vm_object_drop(lobj);
137                                         }
138                                         lobj = tobj;
139                                 } else {
140                                         vm_object_drop(tobj);
141                                 }
142                         }
143                 } else {
144                         lobj = NULL;
145                 }
146
147                 freepath = NULL;
148                 fullpath = "-";
149                 if (lobj) {
150                         switch(lobj->type) {
151                         default:
152                         case OBJT_DEFAULT:
153                                 type = "default";
154                                 vp = NULL;
155                                 break;
156                         case OBJT_VNODE:
157                                 type = "vnode";
158                                 vp = lobj->handle;
159                                 vref(vp);
160                                 break;
161                         case OBJT_SWAP:
162                                 type = "swap";
163                                 vp = NULL;
164                                 break;
165                         case OBJT_DEVICE:
166                                 type = "device";
167                                 vp = NULL;
168                                 break;
169                         }
170                         
171                         flags = obj->flags;
172                         ref_count = obj->ref_count;
173                         shadow_count = obj->shadow_count;
174                         if (vp != NULL) {
175                                 vn_fullpath(p, vp, &fullpath, &freepath, 1);
176                                 vrele(vp);
177                         }
178                         if (lobj != obj)
179                                 vm_object_drop(lobj);
180                 } else {
181                         type = "none";
182                         flags = 0;
183                         ref_count = 0;
184                         shadow_count = 0;
185                 }
186
187                 /*
188                  * format:
189                  *  start, end, res, priv res, cow, access, type, (fullpath).
190                  */
191                 ksnprintf(mebuffer, sizeof(mebuffer),
192 #if LONG_BIT == 64
193                           "0x%016lx 0x%016lx %d %d %p %s%s%s %d %d "
194 #else
195                           "0x%08lx 0x%08lx %d %d %p %s%s%s %d %d "
196 #endif
197                           "0x%04x %s %s %s %s\n",
198                         (u_long)entry->start, (u_long)entry->end,
199                         resident, privateresident, obj,
200                         (entry->protection & VM_PROT_READ)?"r":"-",
201                         (entry->protection & VM_PROT_WRITE)?"w":"-",
202                         (entry->protection & VM_PROT_EXECUTE)?"x":"-",
203                         ref_count, shadow_count, flags,
204                         (entry->eflags & MAP_ENTRY_COW)?"COW":"NCOW",
205                         (entry->eflags & MAP_ENTRY_NEEDS_COPY)?"NC":"NNC",
206                         type, fullpath);
207
208                 if (obj)
209                         vm_object_drop(obj);
210
211                 if (freepath != NULL) {
212                         kfree(freepath, M_TEMP);
213                         freepath = NULL;
214                 }
215
216                 len = strlen(mebuffer);
217                 if (len > uio->uio_resid) {
218                         error = EFBIG;
219                         break;
220                 }
221
222                 /*
223                  * We cannot safely hold the map locked while accessing
224                  * userspace as a VM fault might recurse the locked map.
225                  */
226                 vm_map_unlock_read(map);
227                 error = uiomove(mebuffer, len, uio);
228                 vm_map_lock_read(map);
229                 if (error)
230                         break;
231
232                 /*
233                  * We use map->hint as a poor man's ripout detector.  If
234                  * it does not match the entry we set it to prior to
235                  * unlocking the map the entry MIGHT now be stale.  In
236                  * this case we do an expensive lookup to find our place
237                  * in the iteration again.
238                  */
239                 if (map->hint != entry) {
240                         vm_map_entry_t reentry;
241
242                         vm_map_lookup_entry(map, ostart, &reentry);
243                         entry = reentry;
244                 }
245         }
246         vm_map_unlock_read(map);
247
248         return error;
249 }
250
251 int
252 procfs_validmap(struct lwp *lp)
253 {
254         return ((lp->lwp_proc->p_flags & P_SYSTEM) == 0);
255 }