summaryrefslogtreecommitdiff
path: root/community/procfs.mdwn
blob: 4f4da72239eb67cda6ad31dacc1dbe9cfe0941a7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
[[meta copyright="Copyright © 2008 Free Software Foundation, Inc."]]

[[meta license="""[[toggle id="license" text="GFDL 1.2+"]][[toggleable
id="license" text="Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no Invariant
Sections, no Front-Cover Texts, and no Back-Cover Texts.  A copy of the license
is included in the section entitled
[[GNU_Free_Documentation_License|/fdl]]."]]"""]]

[[!meta title="GNU/Linux compatible procfs"]]

[[!toc ]]
----

 Project Name 
----

GNU/Linux compatible procfs pseudo-filesystem

------

 Project Description
----
I wish to provide a sophisticated procfs pseudo-filesystem to “the Hurd”. An implementation of /proc pseudo-filesystem already exists in hurdextras repository. After skimming through the code it is clear that it needs a lot 
of rework and tuning. Experiences from GNU/Linux have proven procfs to be a very useful facility in implementing 
many of the process management tools. So the goal of this project is to rework on the existing procfs on “the Hurd” 
so that its not only reliable and robust but also more importantly it is fully compatible with the GNU/Linux procfs. 
The project thus aims at making the GNU/Linux process management tools  like top, sysctl, kill, 
skill, nice, snice, pgrep, free, tload, uptime, fuser, killall, pidof, pstree, etc., to run out of the box.

------

 Mentor
----

Olaf Buddenhagen

------

 Project Schedule
----

#####     1. Initial preparation and migration (Community Bonding Period: has already started – May 25th)

      This phase involves improving my translator programming skills by gaining
      hands-on experience in it and becoming well versed in it. I will also go
      through the Hurd code to understand its architecture in depth and will read
      documentations related to obtaining process related information in Hurd.
      This phase also involves the migration of existing procfs to use libnetfs.

#####     2. Analysis and Design (May 26th – June 11th )

      This phase involves the analysis of previous migration. Also involves 
      interacting with the mentor, the Hurd community and other people involved
      in development of ps. tools to draw the exact design of the proposed procfs
      including the algorithms required for coding.

#####     3.  Coding Stage I (June 12th – June 22nd )

      Finishing up the migration to libnetfs based on the finalized design and
      making necessary changes to the  existing procfs. Coding up to
      /proc/<pid>/exe in the features list.

#####&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;4.&nbsp;Coding Stage II (June 23rd – July 13th)

      Involves coding of the features from /proc/<pid>/environ, up to 
      /proc/<pid>/maps. These contain most of the information required for ps.
      tools and hence form the heart of the project. Will be completed by
      mid-term evaluation deadline.

#####&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;5. &nbsp;Coding Stage III (July 14th – July 26th )

      Coding the rest of the features in the list including any necessary
      features that may be added in the analysis phase.

#####&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;6. &nbsp;Final Testing and evaluation (July 27th – August 8th )

      Closely interacting with the community and requesting them to help me
      in overall testing and reviewing and making changes as per their 
      suggestions. Also involves testing with the ps. tools and consolidating 
      the documentation.

#####&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;7. &nbsp;Packaging and Wrap-up (August 9th - August 18th )

      Final phase of testing and fixing remaining bugs. Working with the
      community to merge the project with the CVS HEAD of Hurd. Documentation
      reviews, making necessary changes as per the suggestions and wrapping 
      up the documentation.

------

 Deliverables
----

1. /proc filesystem that uses libnetfs. Using this library makes it easier for implementing a large set of functionalities and hence makes the implementation robust.
2. The core GNU/Linux compatible /proc filesystem with functionalities to support and provide information for ps. tools like procps, psmisc etc.

Non-code deliverables include an exhaustive Documentation. This documents the code of the Hurd's procfs which explains in detail the implementation of each of the functionalities of procfs implemented
during the course of this project.

------

 Code Repository
----

[http://github.com/madhusudancs/procfs/tree/master](http://github.com/madhusudancs/procfs/tree/master)

Clone URL: [git://github.com/madhusudancs/procfs.git](git://github.com/madhusudancs/procfs.git)

------

 Progress
----

1. Packages Ported: [http://www.madhusudancs.info/parted-hurdi386 parted-1.7.1]
2. Packages Porting in progress: autogen_1:5.9.4-1. Error installing texlive-bin. Error tracked to some post installation scripts of texlive-bin. Problem seems to be in fmutil. Trying to debug.
3. Have to start coding libnetfs skeleton for procfs translator.
    
**Target for next week**

      Task                                                                      To be completed by         Status Now

   1. Finish Defining the necessary netfs call  backs&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;25-05-2008&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Completed
   2. Create Directories for each process with pid directory name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;27-05-2008&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Completed
   3. Create stat file for each process within this directory and<br/> 
      put atleast 1 information into it&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;                  31-05-2008&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;In Progress

**Documentations Read/Reading**

1. [Hurd Hacking Guide](http://www.gnu.org/software/hurd/hacking-guide/hhg.html) (Have Concentrated mainly on Translator part)
2. [Linux Kernel Implementation of procfs](http://users.sosdg.org/~qiyong/lxr/source/Documentation/filesystems/proc.txt)

**Code Being Read**

1. libps
2. libnetfs
3. [procfs implementation in Linux kernel](http://users.sosdg.org/~qiyong/lxr/source/fs/proc/)
4. ftpfs (In Hurd main)
5. cvsfs (In Hurd extras)
6. xmlfs (In Hurd extras)
7. httpfs (In Hurd extras)
8. gopherfs (In Hurd extras)
9. libfuse (In Hurd extras)
10. procfs (libtrivfs based, In Hurd extras)

------

 Code Updates
----

1. May, 14, 2008
2. May, 18, 2008
3. May, 28, 2008
4. June, 1, 2008
5. June, 2, 2008
6. June, 4, 2008
7. June, 5, 2008 (3 commits, 00:30 HRS, 02:30 HRS, 11:15HRS, all in IST)
8. June, 9, 2008
9. June, 19, 2008 (Targets 1 and 2 successfully accomplished. Duration between the commits became inevitably longer because of the large amount of time spent on debugging the code.)

------

 Contact Details
----

Name : Madhusudan.C.S

Email  : [madhusudancs@gmail.com](mailto:madhusudancs@gmail.com)

Blog   : [http://www.madhusudancs.info](http://www.madhusudancs.info/)

Detailed proposal: [http://www.madhusudancs.info/gnu-hurd-procfs-proposal](http://www.madhusudancs.info/gnu-hurd-procfs-proposal)

Google Summer of Code Site Link: [Abstract](http://code.google.com/soc/2008/hurd/appinfo.html?csaid=D2E9266819D2EEF9)