Community
Participate
Working Groups
Created attachment 243657 [details] Mr. Navarro's original documentation regarding ETFw PerfSuite support Per Ms. Tibbitts' request, Mr. Chris Navarro kindly provided documentation regarding the ETFw PerfSuite support, and asked for comments from Rui Liu, the current PerfSuite maintainer. Rui gave some suggestions. Ms. Tibbitts and Mr. Navarro would like a bug created to track the discussion and item. So here it is. Uploaded Mr. Navarro's original documentation regarding ETFw PerfSuite support in the attachment.
This is Chris' email containing the documentation file (perfsuite.tar.gz)... -------- Original Message -------- Subject: Re: Perfsuite in PTP help docs Date: Wed, 21 May 2014 12:52:13 -0500 From: Christopher Navarro <cmnavarr@illinois.edu> To: Beth Tibbitts <beth@tibweb.com>, "Liu, Rui" <ruiliu@illinois.edu> I've attached a short example of using psrun and psprocess within Eclipse - I'm not sure if Rui has seen what I've done so I'm cc'ing him in case he's interested. I don't think all of the possible parameters for those two executables are exposed, but this is a start. I also probably should rename the "Perfsuite" tab to "PSRun" in the UI at some point (but this can be done through the XML since that is where it is parsed). Until Rui's work on the feedback view, I had not added psprocess to the workflow so it was only a single tab under "Performance Analysis". Let me know if you need me to tweak anything. Chris
Rui's suggestions... -------- Original Message -------- Subject: Re: Perfsuite in PTP help docs Date: Tue, 27 May 2014 10:47:05 -0500 From: Rui Liu <ruiliu@illinois.edu> Organization: NCSA, UIUC To: Christopher Navarro <cmnavarr@illinois.edu> CC: Beth Tibbitts <beth@tibweb.com> Hi Chris, Thanks a lot for the write-up! Looks quite good. :-) > I don't think all of the possible parameters for those two executables are exposed, but this is a start. ... >Let me know if you need me to tweak anything. For "psrun", could you please add the "fork" option (translates to "-f" in the command line), and change the name in the page "POSIX" to "Enable POSIX threads (pthreads) support"? These are two important options, usually required for measuring/profiling parallel applications: the former to support MPI programs, the latter to support pthreads/OpenMP programs. Also, could we change "Output" to "Output file name prefix" to make it more clear please? For "psprocess", the "-b", "-t" and "-m" are probably the most frequently used options, so they have higher priorities if you are to add them. For more details, please use "psrun -h", "psprocess -h", "man psprun", or "man psprocess". Please let me know if you have questions. Thanks a lot! Thanks, Rui
Created attachment 243659 [details] ETFw PerfSuite "psrun" support screenshot, highlighted with Rui's suggestions
Created attachment 243660 [details] ETFw PerfSuite "psprocess" support screenshot, highlighted with Rui's suggestions
Rui's clarifications. Uploaded the pictures "perfsuite-psrun.png" and "perfsuite-psprocess.png", highlighted with Rui's suggestions in the attachments... -------- Original Message -------- Subject: Re: Perfsuite in PTP help docs Date: Tue, 27 May 2014 14:23:37 -0500 From: Rui Liu <ruiliu@illinois.edu> Organization: NCSA, UIUC To: Beth Tibbitts <beth@tibweb.com>, Chris Navarro <cmnavarr@illinois.edu> Hi Beth and Chris, Sorry for not making my suggestions clear! Attached are 2 screenshots in Chris' original tar ball, with my edits, to highlight what I suggested. > For "psprocess", the "-b", "-t" and "-m" are probably the most frequently used options, so they have higher priorities if you are to add them. Sorry, just for the specific purpose of running psrun and psprocess to generate a file ("mhpr.xml") for the PerfSuite feedback view plugin to show, maybe let's forget about this suggestion. This suggestion is for the case where you'd like to to use "psprocess" for general purposes -- in that case, you can add them just like what you did for the various options for "psrun" -- add them in the tab in "perfsuite-psprocess.png". Please let me know if you have further questions. Thanks! Thanks, Rui On 05/27/2014 11:11 AM, Beth Tibbitts wrote: > Rui, can you please make the changes and do a Gerrit patch to the bug report > so we know exactly what you are suggesting > > ...Beth > > Beth Tibbitts > beth@tibweb.com <mailto:beth@tibweb.com>
Created attachment 243662 [details] psprocess UI
Created attachment 243663 [details] PSRUN UI
I've attached the proposed UI for psrun and psprocess, please comment (or modify the attached screenshot) to show which labels you would change. I think the checkbox implies enable/disable so I'd leave keywords like that out of the UI label. Each UI field has a mouseover that displays the help associated with psrun/psprocess for that field. I think we can assume users of Eclipse will have a mouse available (I don't think Eclipse IDE runs on any mobile devices. I think all the changes suggested are clear except for -b (brief output) which I labeled "Limit Output". Let me know if this should be changed to something else. Once we have a consensus on the field labels, I can push my changes to Gerrit and update the documentation.
Hi Chris, Thanks a lot for your prompt response! Regarding the two proposed UI pictures you just uploaded: - for psrun UI, maybe you could change the example/default text in the "Output" field to "shallow", as this example app is shallow, and by default, psrun uses the program name as the prefix. Putting "psprocess" in that field as the prefix might be confusing; - for psprocess UI 1). In the "Reporting Threshold" field, a good default value would be 5 or 1, meaning displaying only functions/lines/... that take 5% (or 1%) or more samples, instead of 25; 2). In the "Custom Metrics" field, a user-provided custom metrics definition file needs to be an XML file in a certain format, so it might be better to use some "*.xml" as an example value, instead of "*.txt"; 3). psprocess does not use a file name prefix for output, so not sure what the "Output file pattern" is -- maybe you wanted to mean "input file name pattern"? Thanks, Rui
Sorry, I should have clarified, some of my "inputs" were simply to test that parameters were getting passed, they were not intended to be seen as defaults. Please ignore the actual values unless you want defaults to be set (e.g. I can set a default threshold value, what do you prefer, 1 or 5)? I want the focus to be on the field labels (e.g. your suggestion about the output file pattern, yes, that should be input file pattern). If you have any other defaults you would like for a field, let me know and I'll update the screenshots. Thanks, Chris
Rui, Are there any other defaults I should set? I'd like to commit this for the final RC3 build this Tuesday and get it into the release. We can always modify labels for clarification in later releases if necessary, which we will need to do anyway to expose all options of psrun/psprocess, which hasn't been done yet. I'll leave this until Monday for comments/suggested other changes and then commit what I have Monday afternoon. Chris
Chris, Thanks a lot for your prompt response! Regarding default values, in the psprocess UI the "Output" field does not need a default value -- it is the file name for psprocess to write the output into. In the image in the attachments, likely you checked it and entered the value "mhpr.xml" -- then that's OK, otherwise it does not need a default value. Thanks, Rui
I don't think there are any default values set for anything. So most of what you see were simply my own selections for testing value passing to the psrun/psprocess executables to make sure the command line was getting built properly. If any of the UI fields you see should have default values, let me know and I can add it to the ETFw description file. Otherwise, most, if not all selections will be blank and up to the user to set them.
Gerrit - https://git.eclipse.org/r/#/c/27756/
Fixed in master. If there are additional changes for Perfsuite in the future, please open a bug and specify changes/updates.
*** Bug 435990 has been marked as a duplicate of this bug. ***
