diff options
| -rw-r--r-- | README.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..43df49b --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# Profile + +Profile a single program giving stats for CPU, memory and other things (see man +2 getrusage). The standard input is closed for the child process, so programs +like `cat` or `xargs` can't be profiled (for now). + +## Example + + > ./profile echo hello world + user CPU time used: 0 3333 + system CPU time used: 0 0 + residet set size used: 2336 + +## TODO + +* [x] user CPU time used +* [x] system CPU time used +* [x] maximum resident set size +* [ ] integral shared memory size +* [ ] integral unshared data size +* [ ] integral unshared stack size +* [ ] page reclaims (soft page faults) +* [ ] page faults (hard page faults) +* [ ] swaps +* [ ] block input operations +* [ ] block output operations +* [ ] IPC messages sent +* [ ] IPC messages received +* [ ] signals received +* [ ] voluntary context switches +* [ ] involuntary context switches + +## Copyright + +The MIT License (MIT) + +Copyright (c) 2016 Matias Linares. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. |